google-cloud-dataform-v1beta1 0.14.1 → 0.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +4 -4
  3. data/README.md +5 -5
  4. data/lib/google/cloud/dataform/v1beta1/bindings_override.rb +0 -57
  5. data/lib/google/cloud/dataform/v1beta1/dataform/client.rb +1846 -54
  6. data/lib/google/cloud/dataform/v1beta1/dataform/operations.rb +843 -0
  7. data/lib/google/cloud/dataform/v1beta1/dataform/paths.rb +38 -0
  8. data/lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb +1742 -70
  9. data/lib/google/cloud/dataform/v1beta1/dataform/rest/operations.rb +927 -0
  10. data/lib/google/cloud/dataform/v1beta1/dataform/rest/service_stub.rb +1592 -478
  11. data/lib/google/cloud/dataform/v1beta1/dataform/rest.rb +1 -0
  12. data/lib/google/cloud/dataform/v1beta1/dataform.rb +1 -0
  13. data/lib/google/cloud/dataform/v1beta1/dataform_pb.rb +38 -28
  14. data/lib/google/cloud/dataform/v1beta1/dataform_services_pb.rb +48 -0
  15. data/lib/google/cloud/dataform/v1beta1/version.rb +1 -1
  16. data/lib/google/longrunning/bindings_override.rb +71 -0
  17. data/lib/google/longrunning/operations/client.rb +954 -0
  18. data/lib/google/longrunning/operations/credentials.rb +40 -0
  19. data/lib/google/longrunning/operations/operations.rb +839 -0
  20. data/lib/google/longrunning/operations/rest/client.rb +777 -0
  21. data/lib/google/longrunning/operations/rest/operations.rb +923 -0
  22. data/lib/google/longrunning/operations/rest/service_stub.rb +322 -0
  23. data/lib/google/longrunning/operations/rest.rb +57 -0
  24. data/lib/google/longrunning/operations.rb +59 -0
  25. data/lib/google/longrunning/rest.rb +34 -0
  26. data/lib/google/longrunning.rb +41 -0
  27. data/lib/google-cloud-dataform-v1beta1.rb +1 -0
  28. data/proto_docs/google/api/client.rb +149 -29
  29. data/proto_docs/google/cloud/dataform/v1beta1/dataform.rb +648 -3
  30. data/proto_docs/google/longrunning/operations.rb +191 -0
  31. metadata +32 -4
@@ -35,6 +35,19 @@ module Google
35
35
  # @!attribute [rw] name
36
36
  # @return [::String]
37
37
  # Identifier. The repository's name.
38
+ # @!attribute [rw] containing_folder
39
+ # @return [::String]
40
+ # Optional. The name of the containing folder of the repository.
41
+ # The field is immutable and it can be modified via a MoveRepository
42
+ # operation.
43
+ # Format: `projects/*/locations/*/folders/*`. or
44
+ # `projects/*/locations/*/teamFolders/*`.
45
+ # @!attribute [r] team_folder_name
46
+ # @return [::String]
47
+ # Output only. The resource name of the TeamFolder that this Repository is
48
+ # associated with. This should take the format:
49
+ # projects/\\{project}/locations/\\{location}/teamFolders/\\{teamFolder}. If this
50
+ # is not set, the Repository is not associated with a TeamFolder.
38
51
  # @!attribute [r] create_time
39
52
  # @return [::Google::Protobuf::Timestamp]
40
53
  # Output only. The timestamp of when the repository was created.
@@ -178,6 +191,16 @@ module Google
178
191
  end
179
192
  end
180
193
 
194
+ # Metadata used to identify if a resource is user scoped.
195
+ # @!attribute [r] user_scoped
196
+ # @return [::Boolean]
197
+ # Output only. If true, this resource is user-scoped, meaning it is either a
198
+ # workspace or sourced from a workspace.
199
+ class PrivateResourceMetadata
200
+ include ::Google::Protobuf::MessageExts
201
+ extend ::Google::Protobuf::MessageExts::ClassMethods
202
+ end
203
+
181
204
  # `ListRepositories` request message.
182
205
  # @!attribute [rw] parent
183
206
  # @return [::String]
@@ -225,6 +248,21 @@ module Google
225
248
  extend ::Google::Protobuf::MessageExts::ClassMethods
226
249
  end
227
250
 
251
+ # `MoveRepository` request message.
252
+ # @!attribute [rw] name
253
+ # @return [::String]
254
+ # Required. The full resource name of the repository to move.
255
+ # @!attribute [rw] destination_containing_folder
256
+ # @return [::String]
257
+ # Optional. The name of the Folder, TeamFolder, or root location to move the
258
+ # repository to. Can be in the format of: "" to move into the root User
259
+ # folder, `projects/*/locations/*/folders/*`,
260
+ # `projects/*/locations/*/teamFolders/*`
261
+ class MoveRepositoryRequest
262
+ include ::Google::Protobuf::MessageExts
263
+ extend ::Google::Protobuf::MessageExts::ClassMethods
264
+ end
265
+
228
266
  # `GetRepository` request message.
229
267
  # @!attribute [rw] name
230
268
  # @return [::String]
@@ -270,9 +308,13 @@ module Google
270
308
  # Required. The repository's name.
271
309
  # @!attribute [rw] force
272
310
  # @return [::Boolean]
273
- # Optional. If set to true, any child resources of this repository will also
274
- # be deleted. (Otherwise, the request will only succeed if the repository has
275
- # no child resources.)
311
+ # Optional. If set to true, child resources of this repository (compilation
312
+ # results and workflow invocations) will also be deleted. Otherwise, the
313
+ # request will only succeed if the repository has no child resources.
314
+ #
315
+ # **Note:** *This flag doesn't support deletion of workspaces, release
316
+ # configs or workflow configs. If any of such resources exists in the
317
+ # repository, the request will fail.*.
276
318
  class DeleteRepositoryRequest
277
319
  include ::Google::Protobuf::MessageExts
278
320
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -550,6 +592,14 @@ module Google
550
592
  # Output only. All the metadata information that is used internally to serve
551
593
  # the resource. For example: timestamps, flags, status fields, etc. The
552
594
  # format of this field is a JSON string.
595
+ # @!attribute [rw] disable_moves
596
+ # @return [::Boolean]
597
+ # Optional. If set to true, workspaces will not be moved if its linked
598
+ # Repository is moved. Instead, it will be deleted.
599
+ # @!attribute [r] private_resource_metadata
600
+ # @return [::Google::Cloud::Dataform::V1beta1::PrivateResourceMetadata]
601
+ # Output only. Metadata indicating whether this resource is user-scoped. For
602
+ # `Workspace` resources, the `user_scoped` field is always `true`.
553
603
  class Workspace
554
604
  include ::Google::Protobuf::MessageExts
555
605
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1342,6 +1392,11 @@ module Google
1342
1392
  # Output only. All the metadata information that is used internally to serve
1343
1393
  # the resource. For example: timestamps, flags, status fields, etc. The
1344
1394
  # format of this field is a JSON string.
1395
+ # @!attribute [r] private_resource_metadata
1396
+ # @return [::Google::Cloud::Dataform::V1beta1::PrivateResourceMetadata]
1397
+ # Output only. Metadata indicating whether this resource is user-scoped.
1398
+ # `CompilationResult` resource is `user_scoped` only if it is sourced
1399
+ # from a workspace.
1345
1400
  class CompilationResult
1346
1401
  include ::Google::Protobuf::MessageExts
1347
1402
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1657,6 +1712,24 @@ module Google
1657
1712
  # options clause of a create table/view statement. See
1658
1713
  # https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language
1659
1714
  # for more information on which options are supported.
1715
+ # @!attribute [rw] connection
1716
+ # @return [::String]
1717
+ # Optional. The connection specifying the credentials to be used to read
1718
+ # and write to external storage, such as Cloud Storage. The connection can
1719
+ # have the form `{project}.{location}.{connection_id}` or
1720
+ # `projects/{project}/locations/{location}/connections/{connection_id}`,
1721
+ # or be set to DEFAULT.
1722
+ # @!attribute [rw] table_format
1723
+ # @return [::Google::Cloud::Dataform::V1beta1::CompilationResultAction::Relation::TableFormat]
1724
+ # Optional. The table format for the BigQuery table.
1725
+ # @!attribute [rw] file_format
1726
+ # @return [::Google::Cloud::Dataform::V1beta1::CompilationResultAction::Relation::FileFormat]
1727
+ # Optional. The file format for the BigQuery table.
1728
+ # @!attribute [rw] storage_uri
1729
+ # @return [::String]
1730
+ # Optional. The fully qualified location prefix of the external folder
1731
+ # where table data is stored. The URI should be in the format
1732
+ # `gs://bucket/path_to_table/`.
1660
1733
  class Relation
1661
1734
  include ::Google::Protobuf::MessageExts
1662
1735
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1719,6 +1792,24 @@ module Google
1719
1792
  # The relation is a materialized view.
1720
1793
  MATERIALIZED_VIEW = 4
1721
1794
  end
1795
+
1796
+ # Supported table formats for BigQuery tables.
1797
+ module TableFormat
1798
+ # Default value.
1799
+ TABLE_FORMAT_UNSPECIFIED = 0
1800
+
1801
+ # Apache Iceberg format.
1802
+ ICEBERG = 1
1803
+ end
1804
+
1805
+ # Supported file formats for BigQuery tables.
1806
+ module FileFormat
1807
+ # Default value.
1808
+ FILE_FORMAT_UNSPECIFIED = 0
1809
+
1810
+ # Apache Parquet format.
1811
+ PARQUET = 1
1812
+ end
1722
1813
  end
1723
1814
 
1724
1815
  # Represents a list of arbitrary database operations.
@@ -2036,9 +2127,30 @@ module Google
2036
2127
  # @!attribute [rw] service_account
2037
2128
  # @return [::String]
2038
2129
  # Optional. The service account to run workflow invocations under.
2130
+ # @!attribute [rw] query_priority
2131
+ # @return [::Google::Cloud::Dataform::V1beta1::InvocationConfig::QueryPriority]
2132
+ # Optional. Specifies the priority for query execution in BigQuery.
2133
+ # More information can be found at
2134
+ # https://cloud.google.com/bigquery/docs/running-queries#queries.
2039
2135
  class InvocationConfig
2040
2136
  include ::Google::Protobuf::MessageExts
2041
2137
  extend ::Google::Protobuf::MessageExts::ClassMethods
2138
+
2139
+ # Types of priority for query execution in BigQuery.
2140
+ module QueryPriority
2141
+ # Default value. This value is unused.
2142
+ QUERY_PRIORITY_UNSPECIFIED = 0
2143
+
2144
+ # Query will be executed in BigQuery with interactive priority.
2145
+ # More information can be found at
2146
+ # https://cloud.google.com/bigquery/docs/running-queries#queries.
2147
+ INTERACTIVE = 1
2148
+
2149
+ # Query will be executed in BigQuery with batch priority.
2150
+ # More information can be found at
2151
+ # https://cloud.google.com/bigquery/docs/running-queries#batchqueries.
2152
+ BATCH = 2
2153
+ end
2042
2154
  end
2043
2155
 
2044
2156
  # `ListWorkflowConfigs` request message.
@@ -2167,6 +2279,11 @@ module Google
2167
2279
  # Output only. All the metadata information that is used internally to serve
2168
2280
  # the resource. For example: timestamps, flags, status fields, etc. The
2169
2281
  # format of this field is a JSON string.
2282
+ # @!attribute [r] private_resource_metadata
2283
+ # @return [::Google::Cloud::Dataform::V1beta1::PrivateResourceMetadata]
2284
+ # Output only. Metadata indicating whether this resource is user-scoped.
2285
+ # `WorkflowInvocation` resource is `user_scoped` only if it is sourced
2286
+ # from a compilation result and the compilation result is user-scoped.
2170
2287
  class WorkflowInvocation
2171
2288
  include ::Google::Protobuf::MessageExts
2172
2289
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -2531,6 +2648,11 @@ module Google
2531
2648
  # @return [::String]
2532
2649
  # Optional. The default KMS key that is used if no encryption key is provided
2533
2650
  # when a repository is created.
2651
+ # @!attribute [r] internal_metadata
2652
+ # @return [::String]
2653
+ # Output only. All the metadata information that is used internally to serve
2654
+ # the resource. For example: timestamps, flags, status fields, etc. The
2655
+ # format of this field is a JSON string.
2534
2656
  class Config
2535
2657
  include ::Google::Protobuf::MessageExts
2536
2658
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -2556,6 +2678,529 @@ module Google
2556
2678
  include ::Google::Protobuf::MessageExts
2557
2679
  extend ::Google::Protobuf::MessageExts::ClassMethods
2558
2680
  end
2681
+
2682
+ # Represents a Dataform Folder. This is a resource that is used to organize
2683
+ # Files and other Folders and provide hierarchical access controls.
2684
+ # @!attribute [rw] name
2685
+ # @return [::String]
2686
+ # Identifier. The Folder's name.
2687
+ # @!attribute [rw] display_name
2688
+ # @return [::String]
2689
+ # Required. The Folder's user-friendly name.
2690
+ # @!attribute [rw] containing_folder
2691
+ # @return [::String]
2692
+ # Optional. The containing Folder resource name. This should take
2693
+ # the format: projects/\\{project}/locations/\\{location}/folders/\\{folder},
2694
+ # projects/\\{project}/locations/\\{location}/teamFolders/\\{teamFolder}, or just
2695
+ # projects/\\{project}/locations/\\{location} if this is a root Folder. This
2696
+ # field can only be updated through MoveFolder.
2697
+ # @!attribute [r] team_folder_name
2698
+ # @return [::String]
2699
+ # Output only. The resource name of the TeamFolder that this Folder is
2700
+ # associated with. This should take the format:
2701
+ # projects/\\{project}/locations/\\{location}/teamFolders/\\{teamFolder}. If this
2702
+ # is not set, the Folder is not associated with a TeamFolder and is a
2703
+ # UserFolder.
2704
+ # @!attribute [r] create_time
2705
+ # @return [::Google::Protobuf::Timestamp]
2706
+ # Output only. The timestamp of when the Folder was created.
2707
+ # @!attribute [r] update_time
2708
+ # @return [::Google::Protobuf::Timestamp]
2709
+ # Output only. The timestamp of when the Folder was last updated.
2710
+ # @!attribute [r] internal_metadata
2711
+ # @return [::String]
2712
+ # Output only. All the metadata information that is used internally to serve
2713
+ # the resource. For example: timestamps, flags, status fields, etc. The
2714
+ # format of this field is a JSON string.
2715
+ # @!attribute [r] creator_iam_principal
2716
+ # @return [::String]
2717
+ # Output only. The IAM principal identifier of the creator of the Folder.
2718
+ class Folder
2719
+ include ::Google::Protobuf::MessageExts
2720
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2721
+ end
2722
+
2723
+ # `CreateFolder` request message.
2724
+ # @!attribute [rw] parent
2725
+ # @return [::String]
2726
+ # Required. The location in which to create the Folder. Must be in the format
2727
+ # `projects/*/locations/*`.
2728
+ # @!attribute [rw] folder
2729
+ # @return [::Google::Cloud::Dataform::V1beta1::Folder]
2730
+ # Required. The Folder to create.
2731
+ # @!attribute [rw] folder_id
2732
+ # @return [::String]
2733
+ # The ID to use for the Folder, which will become the final component of
2734
+ # the Folder's resource name.
2735
+ class CreateFolderRequest
2736
+ include ::Google::Protobuf::MessageExts
2737
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2738
+ end
2739
+
2740
+ # `MoveFolder` request message.
2741
+ # @!attribute [rw] name
2742
+ # @return [::String]
2743
+ # Required. The full resource name of the Folder to move.
2744
+ # @!attribute [rw] destination_containing_folder
2745
+ # @return [::String]
2746
+ # Optional. The name of the Folder, TeamFolder, or root location to move the
2747
+ # Folder to. Can be in the format of: "" to move into the root User folder,
2748
+ # `projects/*/locations/*/folders/*`, `projects/*/locations/*/teamFolders/*`
2749
+ class MoveFolderRequest
2750
+ include ::Google::Protobuf::MessageExts
2751
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2752
+ end
2753
+
2754
+ # `GetFolder` request message.
2755
+ # @!attribute [rw] name
2756
+ # @return [::String]
2757
+ # Required. The Folder's name.
2758
+ class GetFolderRequest
2759
+ include ::Google::Protobuf::MessageExts
2760
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2761
+ end
2762
+
2763
+ # `UpdateFolder` request message.
2764
+ # @!attribute [rw] update_mask
2765
+ # @return [::Google::Protobuf::FieldMask]
2766
+ # Optional. Specifies the fields to be updated in the Folder. If left unset,
2767
+ # all fields that can be updated, will be updated. A few fields cannot be
2768
+ # updated and will be ignored if specified in the update_mask (e.g.
2769
+ # parent_name, team_folder_name).
2770
+ # @!attribute [rw] folder
2771
+ # @return [::Google::Cloud::Dataform::V1beta1::Folder]
2772
+ # Required. The updated Folder.
2773
+ class UpdateFolderRequest
2774
+ include ::Google::Protobuf::MessageExts
2775
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2776
+ end
2777
+
2778
+ # `DeleteFolder` request message.
2779
+ # @!attribute [rw] name
2780
+ # @return [::String]
2781
+ # Required. The Folder's name.
2782
+ class DeleteFolderRequest
2783
+ include ::Google::Protobuf::MessageExts
2784
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2785
+ end
2786
+
2787
+ # `QueryFolderContents` request message.
2788
+ # @!attribute [rw] folder
2789
+ # @return [::String]
2790
+ # Required. Name of the folder whose contents to list.
2791
+ # Format: projects/*/locations/*/folders/*
2792
+ # @!attribute [rw] page_size
2793
+ # @return [::Integer]
2794
+ # Optional. Maximum number of paths to return. The server may return fewer
2795
+ # items than requested. If unspecified, the server will pick an appropriate
2796
+ # default.
2797
+ # @!attribute [rw] page_token
2798
+ # @return [::String]
2799
+ # Optional. Page token received from a previous `QueryFolderContents` call.
2800
+ # Provide this to retrieve the subsequent page.
2801
+ #
2802
+ # When paginating, all other parameters provided to
2803
+ # `QueryFolderContents`, with the exception of `page_size`, must match the
2804
+ # call that provided the page token.
2805
+ # @!attribute [rw] order_by
2806
+ # @return [::String]
2807
+ # Optional. Field to additionally sort results by.
2808
+ # Will order Folders before Repositories, and then by `order_by` in ascending
2809
+ # order. Supported keywords: display_name (default), create_time,
2810
+ # last_modified_time.
2811
+ # Examples:
2812
+ # - `orderBy="display_name"`
2813
+ # - `orderBy="display_name desc"`
2814
+ # @!attribute [rw] filter
2815
+ # @return [::String]
2816
+ # Optional. Optional filtering for the returned list. Filtering is currently
2817
+ # only supported on the `display_name` field.
2818
+ #
2819
+ # Example:
2820
+ # - `filter="display_name="MyFolder""`
2821
+ class QueryFolderContentsRequest
2822
+ include ::Google::Protobuf::MessageExts
2823
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2824
+ end
2825
+
2826
+ # `QueryFolderContents` response message.
2827
+ # @!attribute [rw] entries
2828
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::QueryFolderContentsResponse::FolderContentsEntry>]
2829
+ # List of entries in the folder.
2830
+ # @!attribute [rw] next_page_token
2831
+ # @return [::String]
2832
+ # A token, which can be sent as `page_token` to retrieve the next page.
2833
+ # If this field is omitted, there are no subsequent pages.
2834
+ class QueryFolderContentsResponse
2835
+ include ::Google::Protobuf::MessageExts
2836
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2837
+
2838
+ # Represents a single content entry.
2839
+ # @!attribute [rw] folder
2840
+ # @return [::Google::Cloud::Dataform::V1beta1::Folder]
2841
+ # A subfolder.
2842
+ #
2843
+ # Note: The following fields are mutually exclusive: `folder`, `repository`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2844
+ # @!attribute [rw] repository
2845
+ # @return [::Google::Cloud::Dataform::V1beta1::Repository]
2846
+ # A repository.
2847
+ #
2848
+ # Note: The following fields are mutually exclusive: `repository`, `folder`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2849
+ class FolderContentsEntry
2850
+ include ::Google::Protobuf::MessageExts
2851
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2852
+ end
2853
+ end
2854
+
2855
+ # `QueryUserRootContents` request message.
2856
+ # @!attribute [rw] location
2857
+ # @return [::String]
2858
+ # Required. Location of the user root folder whose contents to list.
2859
+ # Format: projects/*/locations/*
2860
+ # @!attribute [rw] page_size
2861
+ # @return [::Integer]
2862
+ # Optional. Maximum number of paths to return. The server may return fewer
2863
+ # items than requested. If unspecified, the server will pick an appropriate
2864
+ # default.
2865
+ # @!attribute [rw] page_token
2866
+ # @return [::String]
2867
+ # Optional. Page token received from a previous `QueryUserRootContents` call.
2868
+ # Provide this to retrieve the subsequent page.
2869
+ #
2870
+ # When paginating, all other parameters provided to
2871
+ # `QueryUserRootFolderContents`, with the exception of `page_size`, must
2872
+ # match the call that provided the page token.
2873
+ # @!attribute [rw] order_by
2874
+ # @return [::String]
2875
+ # Optional. Field to additionally sort results by.
2876
+ # Will order Folders before Repositories, and then by `order_by` in ascending
2877
+ # order. Supported keywords: display_name (default), created_at,
2878
+ # last_modified_at. Examples:
2879
+ # - `orderBy="display_name"`
2880
+ # - `orderBy="display_name desc"`
2881
+ # @!attribute [rw] filter
2882
+ # @return [::String]
2883
+ # Optional. Optional filtering for the returned list. Filtering is currently
2884
+ # only supported on the `display_name` field.
2885
+ #
2886
+ # Example:
2887
+ # - `filter="display_name="MyFolder""`
2888
+ class QueryUserRootContentsRequest
2889
+ include ::Google::Protobuf::MessageExts
2890
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2891
+ end
2892
+
2893
+ # `QueryUserRootContents` response message.
2894
+ # @!attribute [rw] entries
2895
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::QueryUserRootContentsResponse::RootContentsEntry>]
2896
+ # List of entries in the folder.
2897
+ # @!attribute [rw] next_page_token
2898
+ # @return [::String]
2899
+ # A token, which can be sent as `page_token` to retrieve the next page.
2900
+ # If this field is omitted, there are no subsequent pages.
2901
+ class QueryUserRootContentsResponse
2902
+ include ::Google::Protobuf::MessageExts
2903
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2904
+
2905
+ # Represents a single content entry.
2906
+ # @!attribute [rw] folder
2907
+ # @return [::Google::Cloud::Dataform::V1beta1::Folder]
2908
+ # A subfolder.
2909
+ #
2910
+ # Note: The following fields are mutually exclusive: `folder`, `repository`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2911
+ # @!attribute [rw] repository
2912
+ # @return [::Google::Cloud::Dataform::V1beta1::Repository]
2913
+ # A repository.
2914
+ #
2915
+ # Note: The following fields are mutually exclusive: `repository`, `folder`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2916
+ class RootContentsEntry
2917
+ include ::Google::Protobuf::MessageExts
2918
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2919
+ end
2920
+ end
2921
+
2922
+ # Represents a Dataform TeamFolder. This is a resource that sits at the project
2923
+ # level and is used to organize Repositories and Folders with hierarchical
2924
+ # access controls. They provide a team context and stricter access controls.
2925
+ # @!attribute [rw] name
2926
+ # @return [::String]
2927
+ # Identifier. The TeamFolder's name.
2928
+ # @!attribute [rw] display_name
2929
+ # @return [::String]
2930
+ # Required. The TeamFolder's user-friendly name.
2931
+ # @!attribute [r] create_time
2932
+ # @return [::Google::Protobuf::Timestamp]
2933
+ # Output only. The timestamp of when the TeamFolder was created.
2934
+ # @!attribute [r] update_time
2935
+ # @return [::Google::Protobuf::Timestamp]
2936
+ # Output only. The timestamp of when the TeamFolder was last updated.
2937
+ # @!attribute [r] internal_metadata
2938
+ # @return [::String]
2939
+ # Output only. All the metadata information that is used internally to serve
2940
+ # the resource. For example: timestamps, flags, status fields, etc. The
2941
+ # format of this field is a JSON string.
2942
+ # @!attribute [r] creator_iam_principal
2943
+ # @return [::String]
2944
+ # Output only. The IAM principal identifier of the creator of the TeamFolder.
2945
+ class TeamFolder
2946
+ include ::Google::Protobuf::MessageExts
2947
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2948
+ end
2949
+
2950
+ # `CreateTeamFolder` request message.
2951
+ # @!attribute [rw] parent
2952
+ # @return [::String]
2953
+ # Required. The location in which to create the TeamFolder. Must be in the
2954
+ # format `projects/*/locations/*`.
2955
+ # @!attribute [rw] team_folder
2956
+ # @return [::Google::Cloud::Dataform::V1beta1::TeamFolder]
2957
+ # Required. The TeamFolder to create.
2958
+ # @!attribute [rw] team_folder_id
2959
+ # @return [::String]
2960
+ # The ID to use for the TeamFolder, which will become the final component of
2961
+ # the TeamFolder's resource name.
2962
+ class CreateTeamFolderRequest
2963
+ include ::Google::Protobuf::MessageExts
2964
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2965
+ end
2966
+
2967
+ # `GetTeamFolder` request message.
2968
+ # @!attribute [rw] name
2969
+ # @return [::String]
2970
+ # Required. The TeamFolder's name.
2971
+ class GetTeamFolderRequest
2972
+ include ::Google::Protobuf::MessageExts
2973
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2974
+ end
2975
+
2976
+ # `UpdateTeamFolder` request message.
2977
+ # @!attribute [rw] update_mask
2978
+ # @return [::Google::Protobuf::FieldMask]
2979
+ # Optional. Specifies the fields to be updated in the Folder. If left unset,
2980
+ # all fields will be updated.
2981
+ # @!attribute [rw] team_folder
2982
+ # @return [::Google::Cloud::Dataform::V1beta1::TeamFolder]
2983
+ # Required. The updated TeamFolder.
2984
+ class UpdateTeamFolderRequest
2985
+ include ::Google::Protobuf::MessageExts
2986
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2987
+ end
2988
+
2989
+ # `DeleteTeamFolder` request message.
2990
+ # @!attribute [rw] name
2991
+ # @return [::String]
2992
+ # Required. The TeamFolder's name.
2993
+ class DeleteTeamFolderRequest
2994
+ include ::Google::Protobuf::MessageExts
2995
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2996
+ end
2997
+
2998
+ # `QueryTeamFolderContents` request message.
2999
+ # @!attribute [rw] team_folder
3000
+ # @return [::String]
3001
+ # Required. Name of the team_folder whose contents to list.
3002
+ # Format: `projects/*/locations/*/teamFolders/*`.
3003
+ # @!attribute [rw] page_size
3004
+ # @return [::Integer]
3005
+ # Optional. Maximum number of paths to return. The server may return fewer
3006
+ # items than requested. If unspecified, the server will pick an appropriate
3007
+ # default.
3008
+ # @!attribute [rw] page_token
3009
+ # @return [::String]
3010
+ # Optional. Page token received from a previous `QueryTeamFolderContents`
3011
+ # call. Provide this to retrieve the subsequent page.
3012
+ #
3013
+ # When paginating, all other parameters provided to
3014
+ # `QueryTeamFolderContents`, with the exception of `page_size`, must match
3015
+ # the call that provided the page token.
3016
+ # @!attribute [rw] order_by
3017
+ # @return [::String]
3018
+ # Optional. Field to additionally sort results by.
3019
+ # Will order Folders before Repositories, and then by `order_by` in ascending
3020
+ # order. Supported keywords: `display_name` (default), `create_time`,
3021
+ # last_modified_time.
3022
+ # Examples:
3023
+ # - `orderBy="display_name"`
3024
+ # - `orderBy="display_name desc"`
3025
+ # @!attribute [rw] filter
3026
+ # @return [::String]
3027
+ # Optional. Optional filtering for the returned list. Filtering is currently
3028
+ # only supported on the `display_name` field.
3029
+ #
3030
+ # Example:
3031
+ # - `filter="display_name="MyFolder""`
3032
+ class QueryTeamFolderContentsRequest
3033
+ include ::Google::Protobuf::MessageExts
3034
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3035
+ end
3036
+
3037
+ # `QueryTeamFolderContents` response message.
3038
+ # @!attribute [rw] entries
3039
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::QueryTeamFolderContentsResponse::TeamFolderContentsEntry>]
3040
+ # List of entries in the TeamFolder.
3041
+ # @!attribute [rw] next_page_token
3042
+ # @return [::String]
3043
+ # A token, which can be sent as `page_token` to retrieve the next page.
3044
+ # If this field is omitted, there are no subsequent pages.
3045
+ class QueryTeamFolderContentsResponse
3046
+ include ::Google::Protobuf::MessageExts
3047
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3048
+
3049
+ # Represents a single content entry.
3050
+ # @!attribute [rw] folder
3051
+ # @return [::Google::Cloud::Dataform::V1beta1::Folder]
3052
+ # A subfolder.
3053
+ #
3054
+ # Note: The following fields are mutually exclusive: `folder`, `repository`. If a field in that set is populated, all other fields in the set will automatically be cleared.
3055
+ # @!attribute [rw] repository
3056
+ # @return [::Google::Cloud::Dataform::V1beta1::Repository]
3057
+ # A repository.
3058
+ #
3059
+ # Note: The following fields are mutually exclusive: `repository`, `folder`. If a field in that set is populated, all other fields in the set will automatically be cleared.
3060
+ class TeamFolderContentsEntry
3061
+ include ::Google::Protobuf::MessageExts
3062
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3063
+ end
3064
+ end
3065
+
3066
+ # `SearchTeamFolders` request message.
3067
+ # @!attribute [rw] location
3068
+ # @return [::String]
3069
+ # Required. Location in which to query TeamFolders.
3070
+ # Format: `projects/*/locations/*`.
3071
+ # @!attribute [rw] page_size
3072
+ # @return [::Integer]
3073
+ # Optional. Maximum number of TeamFolders to return. The server may return
3074
+ # fewer items than requested. If unspecified, the server will pick an
3075
+ # appropriate default.
3076
+ # @!attribute [rw] page_token
3077
+ # @return [::String]
3078
+ # Optional. Page token received from a previous `SearchTeamFolders` call.
3079
+ # Provide this to retrieve the subsequent page.
3080
+ #
3081
+ # When paginating, all other parameters provided to
3082
+ # `SearchTeamFolders`, with the exception of `page_size`, must
3083
+ # match the call that provided the page token.
3084
+ # @!attribute [rw] order_by
3085
+ # @return [::String]
3086
+ # Optional. Field to additionally sort results by.
3087
+ # Supported keywords: `display_name` (default), `create_time`,
3088
+ # `last_modified_time`. Examples:
3089
+ # - `orderBy="display_name"`
3090
+ # - `orderBy="display_name desc"`
3091
+ # @!attribute [rw] filter
3092
+ # @return [::String]
3093
+ # Optional. Optional filtering for the returned list. Filtering is currently
3094
+ # only supported on the `display_name` field.
3095
+ #
3096
+ # Example:
3097
+ # - `filter="display_name="MyFolder""`
3098
+ class SearchTeamFoldersRequest
3099
+ include ::Google::Protobuf::MessageExts
3100
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3101
+ end
3102
+
3103
+ # `SearchTeamFolders` response message.
3104
+ # @!attribute [rw] results
3105
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::SearchTeamFoldersResponse::TeamFolderSearchResult>]
3106
+ # List of TeamFolders that match the search query.
3107
+ # @!attribute [rw] next_page_token
3108
+ # @return [::String]
3109
+ # A token, which can be sent as `page_token` to retrieve the next page.
3110
+ # If this field is omitted, there are no subsequent pages.
3111
+ class SearchTeamFoldersResponse
3112
+ include ::Google::Protobuf::MessageExts
3113
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3114
+
3115
+ # Represents a single content entry.
3116
+ # @!attribute [rw] team_folder
3117
+ # @return [::Google::Cloud::Dataform::V1beta1::TeamFolder]
3118
+ # A TeamFolder resource that is in the project / location.
3119
+ class TeamFolderSearchResult
3120
+ include ::Google::Protobuf::MessageExts
3121
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3122
+ end
3123
+ end
3124
+
3125
+ # Contains metadata about the progress of the MoveFolder Long-running
3126
+ # operations.
3127
+ # @!attribute [r] create_time
3128
+ # @return [::Google::Protobuf::Timestamp]
3129
+ # Output only. The time the operation was created.
3130
+ # @!attribute [r] end_time
3131
+ # @return [::Google::Protobuf::Timestamp]
3132
+ # Output only. The time the operation finished running.
3133
+ # @!attribute [r] target
3134
+ # @return [::String]
3135
+ # Output only. Server-defined resource path for the target of the operation.
3136
+ # @!attribute [rw] state
3137
+ # @return [::Google::Cloud::Dataform::V1beta1::MoveFolderMetadata::State]
3138
+ # The state of the move.
3139
+ # @!attribute [rw] percent_complete
3140
+ # @return [::Integer]
3141
+ # Percent complete of the move [0, 100].
3142
+ class MoveFolderMetadata
3143
+ include ::Google::Protobuf::MessageExts
3144
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3145
+
3146
+ # Different states of the move.
3147
+ module State
3148
+ # The state is unspecified.
3149
+ STATE_UNSPECIFIED = 0
3150
+
3151
+ # The move was initialized and recorded by the server, but not yet started.
3152
+ INITIALIZED = 1
3153
+
3154
+ # The move is in progress.
3155
+ IN_PROGRESS = 2
3156
+
3157
+ # The move has completed successfully.
3158
+ SUCCESS = 3
3159
+
3160
+ # The move has failed.
3161
+ FAILED = 4
3162
+ end
3163
+ end
3164
+
3165
+ # Contains metadata about the progress of the MoveRepository Long-running
3166
+ # operations.
3167
+ # @!attribute [r] create_time
3168
+ # @return [::Google::Protobuf::Timestamp]
3169
+ # Output only. The time the operation was created.
3170
+ # @!attribute [r] end_time
3171
+ # @return [::Google::Protobuf::Timestamp]
3172
+ # Output only. The time the operation finished running.
3173
+ # @!attribute [r] target
3174
+ # @return [::String]
3175
+ # Output only. Server-defined resource path for the target of the operation.
3176
+ # @!attribute [rw] state
3177
+ # @return [::Google::Cloud::Dataform::V1beta1::MoveRepositoryMetadata::State]
3178
+ # The state of the move.
3179
+ # @!attribute [rw] percent_complete
3180
+ # @return [::Integer]
3181
+ # Percent complete of the move [0, 100].
3182
+ class MoveRepositoryMetadata
3183
+ include ::Google::Protobuf::MessageExts
3184
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3185
+
3186
+ # Different states of the move.
3187
+ module State
3188
+ # The state is unspecified.
3189
+ STATE_UNSPECIFIED = 0
3190
+
3191
+ # The move was initialized and recorded by the server, but not yet started.
3192
+ INITIALIZED = 1
3193
+
3194
+ # The move is in progress.
3195
+ IN_PROGRESS = 2
3196
+
3197
+ # The move has completed successfully.
3198
+ SUCCESS = 3
3199
+
3200
+ # The move has failed.
3201
+ FAILED = 4
3202
+ end
3203
+ end
2559
3204
  end
2560
3205
  end
2561
3206
  end