google-cloud-dataform-v1 0.3.0 → 0.4.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/v1/bindings_override.rb +0 -57
  5. data/lib/google/cloud/dataform/v1/dataform/client.rb +2061 -48
  6. data/lib/google/cloud/dataform/v1/dataform/operations.rb +843 -0
  7. data/lib/google/cloud/dataform/v1/dataform/paths.rb +38 -0
  8. data/lib/google/cloud/dataform/v1/dataform/rest/client.rb +1944 -65
  9. data/lib/google/cloud/dataform/v1/dataform/rest/operations.rb +927 -0
  10. data/lib/google/cloud/dataform/v1/dataform/rest/service_stub.rb +1719 -481
  11. data/lib/google/cloud/dataform/v1/dataform/rest.rb +1 -0
  12. data/lib/google/cloud/dataform/v1/dataform.rb +1 -0
  13. data/lib/google/cloud/dataform/v1/dataform_pb.rb +42 -1
  14. data/lib/google/cloud/dataform/v1/dataform_services_pb.rb +54 -0
  15. data/lib/google/cloud/dataform/v1/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-v1.rb +1 -0
  28. data/proto_docs/google/api/client.rb +149 -29
  29. data/proto_docs/google/cloud/dataform/v1/dataform.rb +759 -3
  30. data/proto_docs/google/longrunning/operations.rb +191 -0
  31. metadata +17 -3
@@ -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.
@@ -168,6 +181,16 @@ module Google
168
181
  end
169
182
  end
170
183
 
184
+ # Metadata used to identify if a resource is user scoped.
185
+ # @!attribute [r] user_scoped
186
+ # @return [::Boolean]
187
+ # Output only. If true, this resource is user-scoped, meaning it is either a
188
+ # workspace or sourced from a workspace.
189
+ class PrivateResourceMetadata
190
+ include ::Google::Protobuf::MessageExts
191
+ extend ::Google::Protobuf::MessageExts::ClassMethods
192
+ end
193
+
171
194
  # `ListRepositories` request message.
172
195
  # @!attribute [rw] parent
173
196
  # @return [::String]
@@ -215,6 +238,21 @@ module Google
215
238
  extend ::Google::Protobuf::MessageExts::ClassMethods
216
239
  end
217
240
 
241
+ # `MoveRepository` request message.
242
+ # @!attribute [rw] name
243
+ # @return [::String]
244
+ # Required. The full resource name of the repository to move.
245
+ # @!attribute [rw] destination_containing_folder
246
+ # @return [::String]
247
+ # Optional. The name of the Folder, TeamFolder, or root location to move the
248
+ # repository to. Can be in the format of: "" to move into the root User
249
+ # folder, `projects/*/locations/*/folders/*`,
250
+ # `projects/*/locations/*/teamFolders/*`
251
+ class MoveRepositoryRequest
252
+ include ::Google::Protobuf::MessageExts
253
+ extend ::Google::Protobuf::MessageExts::ClassMethods
254
+ end
255
+
218
256
  # `GetRepository` request message.
219
257
  # @!attribute [rw] name
220
258
  # @return [::String]
@@ -260,9 +298,13 @@ module Google
260
298
  # Required. The repository's name.
261
299
  # @!attribute [rw] force
262
300
  # @return [::Boolean]
263
- # Optional. If set to true, any child resources of this repository will also
264
- # be deleted. (Otherwise, the request will only succeed if the repository has
265
- # no child resources.)
301
+ # Optional. If set to true, child resources of this repository (compilation
302
+ # results and workflow invocations) will also be deleted. Otherwise, the
303
+ # request will only succeed if the repository has no child resources.
304
+ #
305
+ # **Note:** *This flag doesn't support deletion of workspaces, release
306
+ # configs or workflow configs. If any of such resources exists in the
307
+ # repository, the request will fail.*.
266
308
  class DeleteRepositoryRequest
267
309
  include ::Google::Protobuf::MessageExts
268
310
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -503,6 +545,9 @@ module Google
503
545
 
504
546
  # The token was used successfully to authenticate against the Git remote.
505
547
  VALID = 3
548
+
549
+ # The token is not accessible due to permission issues.
550
+ PERMISSION_DENIED = 4
506
551
  end
507
552
  end
508
553
 
@@ -540,6 +585,14 @@ module Google
540
585
  # Output only. All the metadata information that is used internally to serve
541
586
  # the resource. For example: timestamps, flags, status fields, etc. The
542
587
  # format of this field is a JSON string.
588
+ # @!attribute [rw] disable_moves
589
+ # @return [::Boolean]
590
+ # Optional. If set to true, workspaces will not be moved if its linked
591
+ # Repository is moved. Instead, it will be deleted.
592
+ # @!attribute [r] private_resource_metadata
593
+ # @return [::Google::Cloud::Dataform::V1::PrivateResourceMetadata]
594
+ # Output only. Metadata indicating whether this resource is user-scoped. For
595
+ # `Workspace` resources, the `user_scoped` field is always `true`.
543
596
  class Workspace
544
597
  include ::Google::Protobuf::MessageExts
545
598
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -847,6 +900,12 @@ module Google
847
900
  # When paginating, all other parameters provided to
848
901
  # `QueryDirectoryContents`, with the exception of `page_size`, must match the
849
902
  # call that provided the page token.
903
+ # @!attribute [rw] view
904
+ # @return [::Google::Cloud::Dataform::V1::DirectoryContentsView]
905
+ # Optional. Specifies the metadata to return for each directory entry.
906
+ # If unspecified, the default is `DIRECTORY_CONTENTS_VIEW_BASIC`.
907
+ # Currently the `DIRECTORY_CONTENTS_VIEW_METADATA` view is not supported by
908
+ # CMEK-protected workspaces.
850
909
  class QueryDirectoryContentsRequest
851
910
  include ::Google::Protobuf::MessageExts
852
911
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -876,11 +935,27 @@ module Google
876
935
  # A child directory in the directory.
877
936
  #
878
937
  # Note: The following fields are mutually exclusive: `directory`, `file`. If a field in that set is populated, all other fields in the set will automatically be cleared.
938
+ # @!attribute [rw] metadata
939
+ # @return [::Google::Cloud::Dataform::V1::FilesystemEntryMetadata]
940
+ # Entry with metadata.
879
941
  class DirectoryEntry
880
942
  include ::Google::Protobuf::MessageExts
881
943
  extend ::Google::Protobuf::MessageExts::ClassMethods
882
944
  end
883
945
 
946
+ # Represents metadata for a single entry in a filesystem.
947
+ # @!attribute [r] size_bytes
948
+ # @return [::Integer]
949
+ # Output only. Provides the size of the entry in bytes. For directories, this
950
+ # will be 0.
951
+ # @!attribute [r] update_time
952
+ # @return [::Google::Protobuf::Timestamp]
953
+ # Output only. Represents the time of the last modification of the entry.
954
+ class FilesystemEntryMetadata
955
+ include ::Google::Protobuf::MessageExts
956
+ extend ::Google::Protobuf::MessageExts::ClassMethods
957
+ end
958
+
884
959
  # Configuration containing file search request parameters.
885
960
  # @!attribute [rw] workspace
886
961
  # @return [::String]
@@ -1332,6 +1407,11 @@ module Google
1332
1407
  # Output only. All the metadata information that is used internally to serve
1333
1408
  # the resource. For example: timestamps, flags, status fields, etc. The
1334
1409
  # format of this field is a JSON string.
1410
+ # @!attribute [r] private_resource_metadata
1411
+ # @return [::Google::Cloud::Dataform::V1::PrivateResourceMetadata]
1412
+ # Output only. Metadata indicating whether this resource is user-scoped.
1413
+ # `CompilationResult` resource is `user_scoped` only if it is sourced
1414
+ # from a workspace.
1335
1415
  class CompilationResult
1336
1416
  include ::Google::Protobuf::MessageExts
1337
1417
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1647,6 +1727,24 @@ module Google
1647
1727
  # options clause of a create table/view statement. See
1648
1728
  # https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language
1649
1729
  # for more information on which options are supported.
1730
+ # @!attribute [rw] connection
1731
+ # @return [::String]
1732
+ # Optional. The connection specifying the credentials to be used to read
1733
+ # and write to external storage, such as Cloud Storage. The connection can
1734
+ # have the form `{project}.{location}.{connection_id}` or
1735
+ # `projects/{project}/locations/{location}/connections/{connection_id}`,
1736
+ # or be set to DEFAULT.
1737
+ # @!attribute [rw] table_format
1738
+ # @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::TableFormat]
1739
+ # Optional. The table format for the BigQuery table.
1740
+ # @!attribute [rw] file_format
1741
+ # @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::FileFormat]
1742
+ # Optional. The file format for the BigQuery table.
1743
+ # @!attribute [rw] storage_uri
1744
+ # @return [::String]
1745
+ # Optional. The fully qualified location prefix of the external folder
1746
+ # where table data is stored. The URI should be in the format
1747
+ # `gs://bucket/path_to_table/`.
1650
1748
  class Relation
1651
1749
  include ::Google::Protobuf::MessageExts
1652
1750
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1709,6 +1807,24 @@ module Google
1709
1807
  # The relation is a materialized view.
1710
1808
  MATERIALIZED_VIEW = 4
1711
1809
  end
1810
+
1811
+ # Supported table formats for BigQuery tables.
1812
+ module TableFormat
1813
+ # Default value.
1814
+ TABLE_FORMAT_UNSPECIFIED = 0
1815
+
1816
+ # Apache Iceberg format.
1817
+ ICEBERG = 1
1818
+ end
1819
+
1820
+ # Supported file formats for BigQuery tables.
1821
+ module FileFormat
1822
+ # Default value.
1823
+ FILE_FORMAT_UNSPECIFIED = 0
1824
+
1825
+ # Apache Parquet format.
1826
+ PARQUET = 1
1827
+ end
1712
1828
  end
1713
1829
 
1714
1830
  # Represents a list of arbitrary database operations.
@@ -2026,9 +2142,30 @@ module Google
2026
2142
  # @!attribute [rw] service_account
2027
2143
  # @return [::String]
2028
2144
  # Optional. The service account to run workflow invocations under.
2145
+ # @!attribute [rw] query_priority
2146
+ # @return [::Google::Cloud::Dataform::V1::InvocationConfig::QueryPriority]
2147
+ # Optional. Specifies the priority for query execution in BigQuery.
2148
+ # More information can be found at
2149
+ # https://cloud.google.com/bigquery/docs/running-queries#queries.
2029
2150
  class InvocationConfig
2030
2151
  include ::Google::Protobuf::MessageExts
2031
2152
  extend ::Google::Protobuf::MessageExts::ClassMethods
2153
+
2154
+ # Types of priority for query execution in BigQuery.
2155
+ module QueryPriority
2156
+ # Default value. This value is unused.
2157
+ QUERY_PRIORITY_UNSPECIFIED = 0
2158
+
2159
+ # Query will be executed in BigQuery with interactive priority.
2160
+ # More information can be found at
2161
+ # https://cloud.google.com/bigquery/docs/running-queries#queries.
2162
+ INTERACTIVE = 1
2163
+
2164
+ # Query will be executed in BigQuery with batch priority.
2165
+ # More information can be found at
2166
+ # https://cloud.google.com/bigquery/docs/running-queries#batchqueries.
2167
+ BATCH = 2
2168
+ end
2032
2169
  end
2033
2170
 
2034
2171
  # `ListWorkflowConfigs` request message.
@@ -2157,6 +2294,11 @@ module Google
2157
2294
  # Output only. All the metadata information that is used internally to serve
2158
2295
  # the resource. For example: timestamps, flags, status fields, etc. The
2159
2296
  # format of this field is a JSON string.
2297
+ # @!attribute [r] private_resource_metadata
2298
+ # @return [::Google::Cloud::Dataform::V1::PrivateResourceMetadata]
2299
+ # Output only. Metadata indicating whether this resource is user-scoped.
2300
+ # `WorkflowInvocation` resource is `user_scoped` only if it is sourced
2301
+ # from a compilation result and the compilation result is user-scoped.
2160
2302
  class WorkflowInvocation
2161
2303
  include ::Google::Protobuf::MessageExts
2162
2304
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -2521,6 +2663,11 @@ module Google
2521
2663
  # @return [::String]
2522
2664
  # Optional. The default KMS key that is used if no encryption key is provided
2523
2665
  # when a repository is created.
2666
+ # @!attribute [r] internal_metadata
2667
+ # @return [::String]
2668
+ # Output only. All the metadata information that is used internally to serve
2669
+ # the resource. For example: timestamps, flags, status fields, etc. The
2670
+ # format of this field is a JSON string.
2524
2671
  class Config
2525
2672
  include ::Google::Protobuf::MessageExts
2526
2673
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -2546,6 +2693,615 @@ module Google
2546
2693
  include ::Google::Protobuf::MessageExts
2547
2694
  extend ::Google::Protobuf::MessageExts::ClassMethods
2548
2695
  end
2696
+
2697
+ # Represents a Dataform Folder. This is a resource that is used to organize
2698
+ # Files and other Folders and provide hierarchical access controls.
2699
+ # @!attribute [rw] name
2700
+ # @return [::String]
2701
+ # Identifier. The Folder's name.
2702
+ # @!attribute [rw] display_name
2703
+ # @return [::String]
2704
+ # Required. The Folder's user-friendly name.
2705
+ # @!attribute [rw] containing_folder
2706
+ # @return [::String]
2707
+ # Optional. The containing Folder resource name. This should take
2708
+ # the format: projects/\\{project}/locations/\\{location}/folders/\\{folder},
2709
+ # projects/\\{project}/locations/\\{location}/teamFolders/\\{teamFolder}, or just
2710
+ # projects/\\{project}/locations/\\{location} if this is a root Folder. This
2711
+ # field can only be updated through MoveFolder.
2712
+ # @!attribute [r] team_folder_name
2713
+ # @return [::String]
2714
+ # Output only. The resource name of the TeamFolder that this Folder is
2715
+ # associated with. This should take the format:
2716
+ # projects/\\{project}/locations/\\{location}/teamFolders/\\{teamFolder}. If this
2717
+ # is not set, the Folder is not associated with a TeamFolder and is a
2718
+ # UserFolder.
2719
+ # @!attribute [r] create_time
2720
+ # @return [::Google::Protobuf::Timestamp]
2721
+ # Output only. The timestamp of when the Folder was created.
2722
+ # @!attribute [r] update_time
2723
+ # @return [::Google::Protobuf::Timestamp]
2724
+ # Output only. The timestamp of when the Folder was last updated.
2725
+ # @!attribute [r] internal_metadata
2726
+ # @return [::String]
2727
+ # Output only. All the metadata information that is used internally to serve
2728
+ # the resource. For example: timestamps, flags, status fields, etc. The
2729
+ # format of this field is a JSON string.
2730
+ # @!attribute [r] creator_iam_principal
2731
+ # @return [::String]
2732
+ # Output only. The IAM principal identifier of the creator of the Folder.
2733
+ class Folder
2734
+ include ::Google::Protobuf::MessageExts
2735
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2736
+ end
2737
+
2738
+ # `CreateFolder` request message.
2739
+ # @!attribute [rw] parent
2740
+ # @return [::String]
2741
+ # Required. The location in which to create the Folder. Must be in the format
2742
+ # `projects/*/locations/*`.
2743
+ # @!attribute [rw] folder
2744
+ # @return [::Google::Cloud::Dataform::V1::Folder]
2745
+ # Required. The Folder to create.
2746
+ class CreateFolderRequest
2747
+ include ::Google::Protobuf::MessageExts
2748
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2749
+ end
2750
+
2751
+ # `MoveFolder` request message.
2752
+ # @!attribute [rw] name
2753
+ # @return [::String]
2754
+ # Required. The full resource name of the Folder to move.
2755
+ # @!attribute [rw] destination_containing_folder
2756
+ # @return [::String]
2757
+ # Optional. The name of the Folder, TeamFolder, or root location to move the
2758
+ # Folder to. Can be in the format of: "" to move into the root User folder,
2759
+ # `projects/*/locations/*/folders/*`, `projects/*/locations/*/teamFolders/*`
2760
+ class MoveFolderRequest
2761
+ include ::Google::Protobuf::MessageExts
2762
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2763
+ end
2764
+
2765
+ # `GetFolder` request message.
2766
+ # @!attribute [rw] name
2767
+ # @return [::String]
2768
+ # Required. The Folder's name.
2769
+ class GetFolderRequest
2770
+ include ::Google::Protobuf::MessageExts
2771
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2772
+ end
2773
+
2774
+ # `UpdateFolder` request message.
2775
+ # @!attribute [rw] update_mask
2776
+ # @return [::Google::Protobuf::FieldMask]
2777
+ # Optional. Specifies the fields to be updated in the Folder. If left unset,
2778
+ # all fields that can be updated, will be updated. A few fields cannot be
2779
+ # updated and will be ignored if specified in the update_mask (e.g.
2780
+ # parent_name, team_folder_name).
2781
+ # @!attribute [rw] folder
2782
+ # @return [::Google::Cloud::Dataform::V1::Folder]
2783
+ # Required. The updated Folder.
2784
+ class UpdateFolderRequest
2785
+ include ::Google::Protobuf::MessageExts
2786
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2787
+ end
2788
+
2789
+ # `DeleteFolder` request message.
2790
+ # @!attribute [rw] name
2791
+ # @return [::String]
2792
+ # Required. The Folder's name.
2793
+ class DeleteFolderRequest
2794
+ include ::Google::Protobuf::MessageExts
2795
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2796
+ end
2797
+
2798
+ # `DeleteFolderTree` request message.
2799
+ # @!attribute [rw] name
2800
+ # @return [::String]
2801
+ # Required. The Folder's name.
2802
+ # Format: projects/\\{project}/locations/\\{location}/folders/\\{folder}
2803
+ # @!attribute [rw] force
2804
+ # @return [::Boolean]
2805
+ # Optional. If `false` (default): The operation will fail if any
2806
+ # Repository within the folder hierarchy has associated Release Configs or
2807
+ # Workflow Configs.
2808
+ #
2809
+ # If `true`: The operation will attempt to delete everything, including any
2810
+ # Release Configs and Workflow Configs linked to Repositories within the
2811
+ # folder hierarchy. This permanently removes schedules and resources.
2812
+ class DeleteFolderTreeRequest
2813
+ include ::Google::Protobuf::MessageExts
2814
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2815
+ end
2816
+
2817
+ # `DeleteTeamFolderTree` request message.
2818
+ # @!attribute [rw] name
2819
+ # @return [::String]
2820
+ # Required. The TeamFolder's name.
2821
+ # Format: projects/\\{project}/locations/\\{location}/teamFolders/\\{team_folder}
2822
+ # @!attribute [rw] force
2823
+ # @return [::Boolean]
2824
+ # Optional. If `false` (default): The operation will fail if any
2825
+ # Repository within the folder hierarchy has associated Release Configs or
2826
+ # Workflow Configs.
2827
+ #
2828
+ # If `true`: The operation will attempt to delete everything, including any
2829
+ # Release Configs and Workflow Configs linked to Repositories within the
2830
+ # folder hierarchy. This permanently removes schedules and resources.
2831
+ class DeleteTeamFolderTreeRequest
2832
+ include ::Google::Protobuf::MessageExts
2833
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2834
+ end
2835
+
2836
+ # Contains metadata about the progress of the DeleteFolderTree Long-running
2837
+ # operations.
2838
+ # @!attribute [r] create_time
2839
+ # @return [::Google::Protobuf::Timestamp]
2840
+ # Output only. The time the operation was created.
2841
+ # @!attribute [r] end_time
2842
+ # @return [::Google::Protobuf::Timestamp]
2843
+ # Output only. The time the operation finished running.
2844
+ # @!attribute [r] target
2845
+ # @return [::String]
2846
+ # Output only. Resource name of the target of the operation.
2847
+ # Format: projects/\\{project}/locations/\\{location}/folders/\\{folder} or
2848
+ # projects/\\{project}/locations/\\{location}/teamFolders/\\{team_folder}
2849
+ # @!attribute [r] state
2850
+ # @return [::Google::Cloud::Dataform::V1::DeleteFolderTreeMetadata::State]
2851
+ # Output only. The state of the operation.
2852
+ # @!attribute [r] percent_complete
2853
+ # @return [::Integer]
2854
+ # Output only. Percent complete of the operation [0, 100].
2855
+ class DeleteFolderTreeMetadata
2856
+ include ::Google::Protobuf::MessageExts
2857
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2858
+
2859
+ # Different states of the DeleteFolderTree operation.
2860
+ module State
2861
+ # The state is unspecified.
2862
+ STATE_UNSPECIFIED = 0
2863
+
2864
+ # The operation was initialized and recorded by the server, but not yet
2865
+ # started.
2866
+ INITIALIZED = 1
2867
+
2868
+ # The operation is in progress.
2869
+ IN_PROGRESS = 2
2870
+
2871
+ # The operation has completed successfully.
2872
+ SUCCEEDED = 3
2873
+
2874
+ # The operation has failed.
2875
+ FAILED = 4
2876
+ end
2877
+ end
2878
+
2879
+ # `QueryFolderContents` request message.
2880
+ # @!attribute [rw] folder
2881
+ # @return [::String]
2882
+ # Required. Name of the folder whose contents to list.
2883
+ # Format: projects/*/locations/*/folders/*
2884
+ # @!attribute [rw] page_size
2885
+ # @return [::Integer]
2886
+ # Optional. Maximum number of paths to return. The server may return fewer
2887
+ # items than requested. If unspecified, the server will pick an appropriate
2888
+ # default.
2889
+ # @!attribute [rw] page_token
2890
+ # @return [::String]
2891
+ # Optional. Page token received from a previous `QueryFolderContents` call.
2892
+ # Provide this to retrieve the subsequent page.
2893
+ #
2894
+ # When paginating, all other parameters provided to
2895
+ # `QueryFolderContents`, with the exception of `page_size`, must match the
2896
+ # call that provided the page token.
2897
+ # @!attribute [rw] order_by
2898
+ # @return [::String]
2899
+ # Optional. Field to additionally sort results by.
2900
+ # Will order Folders before Repositories, and then by `order_by` in ascending
2901
+ # order. Supported keywords: display_name (default), create_time,
2902
+ # last_modified_time.
2903
+ # Examples:
2904
+ # - `orderBy="display_name"`
2905
+ # - `orderBy="display_name desc"`
2906
+ # @!attribute [rw] filter
2907
+ # @return [::String]
2908
+ # Optional. Optional filtering for the returned list. Filtering is currently
2909
+ # only supported on the `display_name` field.
2910
+ #
2911
+ # Example:
2912
+ # - `filter="display_name="MyFolder""`
2913
+ class QueryFolderContentsRequest
2914
+ include ::Google::Protobuf::MessageExts
2915
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2916
+ end
2917
+
2918
+ # `QueryFolderContents` response message.
2919
+ # @!attribute [rw] entries
2920
+ # @return [::Array<::Google::Cloud::Dataform::V1::QueryFolderContentsResponse::FolderContentsEntry>]
2921
+ # List of entries in the folder.
2922
+ # @!attribute [rw] next_page_token
2923
+ # @return [::String]
2924
+ # A token, which can be sent as `page_token` to retrieve the next page.
2925
+ # If this field is omitted, there are no subsequent pages.
2926
+ class QueryFolderContentsResponse
2927
+ include ::Google::Protobuf::MessageExts
2928
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2929
+
2930
+ # Represents a single content entry.
2931
+ # @!attribute [rw] folder
2932
+ # @return [::Google::Cloud::Dataform::V1::Folder]
2933
+ # A subfolder.
2934
+ #
2935
+ # 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.
2936
+ # @!attribute [rw] repository
2937
+ # @return [::Google::Cloud::Dataform::V1::Repository]
2938
+ # A repository.
2939
+ #
2940
+ # 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.
2941
+ class FolderContentsEntry
2942
+ include ::Google::Protobuf::MessageExts
2943
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2944
+ end
2945
+ end
2946
+
2947
+ # `QueryUserRootContents` request message.
2948
+ # @!attribute [rw] location
2949
+ # @return [::String]
2950
+ # Required. Location of the user root folder whose contents to list.
2951
+ # Format: projects/*/locations/*
2952
+ # @!attribute [rw] page_size
2953
+ # @return [::Integer]
2954
+ # Optional. Maximum number of paths to return. The server may return fewer
2955
+ # items than requested. If unspecified, the server will pick an appropriate
2956
+ # default.
2957
+ # @!attribute [rw] page_token
2958
+ # @return [::String]
2959
+ # Optional. Page token received from a previous `QueryUserRootContents` call.
2960
+ # Provide this to retrieve the subsequent page.
2961
+ #
2962
+ # When paginating, all other parameters provided to
2963
+ # `QueryUserRootFolderContents`, with the exception of `page_size`, must
2964
+ # match the call that provided the page token.
2965
+ # @!attribute [rw] order_by
2966
+ # @return [::String]
2967
+ # Optional. Field to additionally sort results by.
2968
+ # Will order Folders before Repositories, and then by `order_by` in ascending
2969
+ # order. Supported keywords: display_name (default), created_at,
2970
+ # last_modified_at. Examples:
2971
+ # - `orderBy="display_name"`
2972
+ # - `orderBy="display_name desc"`
2973
+ # @!attribute [rw] filter
2974
+ # @return [::String]
2975
+ # Optional. Optional filtering for the returned list. Filtering is currently
2976
+ # only supported on the `display_name` field.
2977
+ #
2978
+ # Example:
2979
+ # - `filter="display_name="MyFolder""`
2980
+ class QueryUserRootContentsRequest
2981
+ include ::Google::Protobuf::MessageExts
2982
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2983
+ end
2984
+
2985
+ # `QueryUserRootContents` response message.
2986
+ # @!attribute [rw] entries
2987
+ # @return [::Array<::Google::Cloud::Dataform::V1::QueryUserRootContentsResponse::RootContentsEntry>]
2988
+ # List of entries in the folder.
2989
+ # @!attribute [rw] next_page_token
2990
+ # @return [::String]
2991
+ # A token, which can be sent as `page_token` to retrieve the next page.
2992
+ # If this field is omitted, there are no subsequent pages.
2993
+ class QueryUserRootContentsResponse
2994
+ include ::Google::Protobuf::MessageExts
2995
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2996
+
2997
+ # Represents a single content entry.
2998
+ # @!attribute [rw] folder
2999
+ # @return [::Google::Cloud::Dataform::V1::Folder]
3000
+ # A subfolder.
3001
+ #
3002
+ # 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.
3003
+ # @!attribute [rw] repository
3004
+ # @return [::Google::Cloud::Dataform::V1::Repository]
3005
+ # A repository.
3006
+ #
3007
+ # 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.
3008
+ class RootContentsEntry
3009
+ include ::Google::Protobuf::MessageExts
3010
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3011
+ end
3012
+ end
3013
+
3014
+ # Represents a Dataform TeamFolder. This is a resource that sits at the project
3015
+ # level and is used to organize Repositories and Folders with hierarchical
3016
+ # access controls. They provide a team context and stricter access controls.
3017
+ # @!attribute [rw] name
3018
+ # @return [::String]
3019
+ # Identifier. The TeamFolder's name.
3020
+ # @!attribute [rw] display_name
3021
+ # @return [::String]
3022
+ # Required. The TeamFolder's user-friendly name.
3023
+ # @!attribute [r] create_time
3024
+ # @return [::Google::Protobuf::Timestamp]
3025
+ # Output only. The timestamp of when the TeamFolder was created.
3026
+ # @!attribute [r] update_time
3027
+ # @return [::Google::Protobuf::Timestamp]
3028
+ # Output only. The timestamp of when the TeamFolder was last updated.
3029
+ # @!attribute [r] internal_metadata
3030
+ # @return [::String]
3031
+ # Output only. All the metadata information that is used internally to serve
3032
+ # the resource. For example: timestamps, flags, status fields, etc. The
3033
+ # format of this field is a JSON string.
3034
+ # @!attribute [r] creator_iam_principal
3035
+ # @return [::String]
3036
+ # Output only. The IAM principal identifier of the creator of the TeamFolder.
3037
+ class TeamFolder
3038
+ include ::Google::Protobuf::MessageExts
3039
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3040
+ end
3041
+
3042
+ # `CreateTeamFolder` request message.
3043
+ # @!attribute [rw] parent
3044
+ # @return [::String]
3045
+ # Required. The location in which to create the TeamFolder. Must be in the
3046
+ # format `projects/*/locations/*`.
3047
+ # @!attribute [rw] team_folder
3048
+ # @return [::Google::Cloud::Dataform::V1::TeamFolder]
3049
+ # Required. The TeamFolder to create.
3050
+ class CreateTeamFolderRequest
3051
+ include ::Google::Protobuf::MessageExts
3052
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3053
+ end
3054
+
3055
+ # `GetTeamFolder` request message.
3056
+ # @!attribute [rw] name
3057
+ # @return [::String]
3058
+ # Required. The TeamFolder's name.
3059
+ class GetTeamFolderRequest
3060
+ include ::Google::Protobuf::MessageExts
3061
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3062
+ end
3063
+
3064
+ # `UpdateTeamFolder` request message.
3065
+ # @!attribute [rw] update_mask
3066
+ # @return [::Google::Protobuf::FieldMask]
3067
+ # Optional. Specifies the fields to be updated in the Folder. If left unset,
3068
+ # all fields will be updated.
3069
+ # @!attribute [rw] team_folder
3070
+ # @return [::Google::Cloud::Dataform::V1::TeamFolder]
3071
+ # Required. The updated TeamFolder.
3072
+ class UpdateTeamFolderRequest
3073
+ include ::Google::Protobuf::MessageExts
3074
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3075
+ end
3076
+
3077
+ # `DeleteTeamFolder` request message.
3078
+ # @!attribute [rw] name
3079
+ # @return [::String]
3080
+ # Required. The TeamFolder's name.
3081
+ class DeleteTeamFolderRequest
3082
+ include ::Google::Protobuf::MessageExts
3083
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3084
+ end
3085
+
3086
+ # `QueryTeamFolderContents` request message.
3087
+ # @!attribute [rw] team_folder
3088
+ # @return [::String]
3089
+ # Required. Name of the team_folder whose contents to list.
3090
+ # Format: `projects/*/locations/*/teamFolders/*`.
3091
+ # @!attribute [rw] page_size
3092
+ # @return [::Integer]
3093
+ # Optional. Maximum number of paths to return. The server may return fewer
3094
+ # items than requested. If unspecified, the server will pick an appropriate
3095
+ # default.
3096
+ # @!attribute [rw] page_token
3097
+ # @return [::String]
3098
+ # Optional. Page token received from a previous `QueryTeamFolderContents`
3099
+ # call. Provide this to retrieve the subsequent page.
3100
+ #
3101
+ # When paginating, all other parameters provided to
3102
+ # `QueryTeamFolderContents`, with the exception of `page_size`, must match
3103
+ # the call that provided the page token.
3104
+ # @!attribute [rw] order_by
3105
+ # @return [::String]
3106
+ # Optional. Field to additionally sort results by.
3107
+ # Will order Folders before Repositories, and then by `order_by` in ascending
3108
+ # order. Supported keywords: `display_name` (default), `create_time`,
3109
+ # last_modified_time.
3110
+ # Examples:
3111
+ # - `orderBy="display_name"`
3112
+ # - `orderBy="display_name desc"`
3113
+ # @!attribute [rw] filter
3114
+ # @return [::String]
3115
+ # Optional. Optional filtering for the returned list. Filtering is currently
3116
+ # only supported on the `display_name` field.
3117
+ #
3118
+ # Example:
3119
+ # - `filter="display_name="MyFolder""`
3120
+ class QueryTeamFolderContentsRequest
3121
+ include ::Google::Protobuf::MessageExts
3122
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3123
+ end
3124
+
3125
+ # `QueryTeamFolderContents` response message.
3126
+ # @!attribute [rw] entries
3127
+ # @return [::Array<::Google::Cloud::Dataform::V1::QueryTeamFolderContentsResponse::TeamFolderContentsEntry>]
3128
+ # List of entries in the TeamFolder.
3129
+ # @!attribute [rw] next_page_token
3130
+ # @return [::String]
3131
+ # A token, which can be sent as `page_token` to retrieve the next page.
3132
+ # If this field is omitted, there are no subsequent pages.
3133
+ class QueryTeamFolderContentsResponse
3134
+ include ::Google::Protobuf::MessageExts
3135
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3136
+
3137
+ # Represents a single content entry.
3138
+ # @!attribute [rw] folder
3139
+ # @return [::Google::Cloud::Dataform::V1::Folder]
3140
+ # A subfolder.
3141
+ #
3142
+ # 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.
3143
+ # @!attribute [rw] repository
3144
+ # @return [::Google::Cloud::Dataform::V1::Repository]
3145
+ # A repository.
3146
+ #
3147
+ # 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.
3148
+ class TeamFolderContentsEntry
3149
+ include ::Google::Protobuf::MessageExts
3150
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3151
+ end
3152
+ end
3153
+
3154
+ # `SearchTeamFolders` request message.
3155
+ # @!attribute [rw] location
3156
+ # @return [::String]
3157
+ # Required. Location in which to query TeamFolders.
3158
+ # Format: `projects/*/locations/*`.
3159
+ # @!attribute [rw] page_size
3160
+ # @return [::Integer]
3161
+ # Optional. Maximum number of TeamFolders to return. The server may return
3162
+ # fewer items than requested. If unspecified, the server will pick an
3163
+ # appropriate default.
3164
+ # @!attribute [rw] page_token
3165
+ # @return [::String]
3166
+ # Optional. Page token received from a previous `SearchTeamFolders` call.
3167
+ # Provide this to retrieve the subsequent page.
3168
+ #
3169
+ # When paginating, all other parameters provided to
3170
+ # `SearchTeamFolders`, with the exception of `page_size`, must
3171
+ # match the call that provided the page token.
3172
+ # @!attribute [rw] order_by
3173
+ # @return [::String]
3174
+ # Optional. Field to additionally sort results by.
3175
+ # Supported keywords: `display_name` (default), `create_time`,
3176
+ # `last_modified_time`. Examples:
3177
+ # - `orderBy="display_name"`
3178
+ # - `orderBy="display_name desc"`
3179
+ # @!attribute [rw] filter
3180
+ # @return [::String]
3181
+ # Optional. Optional filtering for the returned list. Filtering is currently
3182
+ # only supported on the `display_name` field.
3183
+ #
3184
+ # Example:
3185
+ # - `filter="display_name="MyFolder""`
3186
+ class SearchTeamFoldersRequest
3187
+ include ::Google::Protobuf::MessageExts
3188
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3189
+ end
3190
+
3191
+ # `SearchTeamFolders` response message.
3192
+ # @!attribute [rw] results
3193
+ # @return [::Array<::Google::Cloud::Dataform::V1::SearchTeamFoldersResponse::TeamFolderSearchResult>]
3194
+ # List of TeamFolders that match the search query.
3195
+ # @!attribute [rw] next_page_token
3196
+ # @return [::String]
3197
+ # A token, which can be sent as `page_token` to retrieve the next page.
3198
+ # If this field is omitted, there are no subsequent pages.
3199
+ class SearchTeamFoldersResponse
3200
+ include ::Google::Protobuf::MessageExts
3201
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3202
+
3203
+ # Represents a single content entry.
3204
+ # @!attribute [rw] team_folder
3205
+ # @return [::Google::Cloud::Dataform::V1::TeamFolder]
3206
+ # A TeamFolder resource that is in the project / location.
3207
+ class TeamFolderSearchResult
3208
+ include ::Google::Protobuf::MessageExts
3209
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3210
+ end
3211
+ end
3212
+
3213
+ # Contains metadata about the progress of the MoveFolder Long-running
3214
+ # operations.
3215
+ # @!attribute [r] create_time
3216
+ # @return [::Google::Protobuf::Timestamp]
3217
+ # Output only. The time the operation was created.
3218
+ # @!attribute [r] end_time
3219
+ # @return [::Google::Protobuf::Timestamp]
3220
+ # Output only. The time the operation finished running.
3221
+ # @!attribute [r] target
3222
+ # @return [::String]
3223
+ # Output only. Server-defined resource path for the target of the operation.
3224
+ # @!attribute [rw] state
3225
+ # @return [::Google::Cloud::Dataform::V1::MoveFolderMetadata::State]
3226
+ # The state of the move.
3227
+ # @!attribute [rw] percent_complete
3228
+ # @return [::Integer]
3229
+ # Percent complete of the move [0, 100].
3230
+ class MoveFolderMetadata
3231
+ include ::Google::Protobuf::MessageExts
3232
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3233
+
3234
+ # Different states of the move.
3235
+ module State
3236
+ # The state is unspecified.
3237
+ STATE_UNSPECIFIED = 0
3238
+
3239
+ # The move was initialized and recorded by the server, but not yet started.
3240
+ INITIALIZED = 1
3241
+
3242
+ # The move is in progress.
3243
+ IN_PROGRESS = 2
3244
+
3245
+ # The move has completed successfully.
3246
+ SUCCESS = 3
3247
+
3248
+ # The move has failed.
3249
+ FAILED = 4
3250
+ end
3251
+ end
3252
+
3253
+ # Contains metadata about the progress of the MoveRepository Long-running
3254
+ # operations.
3255
+ # @!attribute [r] create_time
3256
+ # @return [::Google::Protobuf::Timestamp]
3257
+ # Output only. The time the operation was created.
3258
+ # @!attribute [r] end_time
3259
+ # @return [::Google::Protobuf::Timestamp]
3260
+ # Output only. The time the operation finished running.
3261
+ # @!attribute [r] target
3262
+ # @return [::String]
3263
+ # Output only. Server-defined resource path for the target of the operation.
3264
+ # @!attribute [rw] state
3265
+ # @return [::Google::Cloud::Dataform::V1::MoveRepositoryMetadata::State]
3266
+ # The state of the move.
3267
+ # @!attribute [rw] percent_complete
3268
+ # @return [::Integer]
3269
+ # Percent complete of the move [0, 100].
3270
+ class MoveRepositoryMetadata
3271
+ include ::Google::Protobuf::MessageExts
3272
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3273
+
3274
+ # Different states of the move.
3275
+ module State
3276
+ # The state is unspecified.
3277
+ STATE_UNSPECIFIED = 0
3278
+
3279
+ # The move was initialized and recorded by the server, but not yet started.
3280
+ INITIALIZED = 1
3281
+
3282
+ # The move is in progress.
3283
+ IN_PROGRESS = 2
3284
+
3285
+ # The move has completed successfully.
3286
+ SUCCESS = 3
3287
+
3288
+ # The move has failed.
3289
+ FAILED = 4
3290
+ end
3291
+ end
3292
+
3293
+ # Represents the level of detail to return for directory contents.
3294
+ module DirectoryContentsView
3295
+ # The default / unset value. Defaults to DIRECTORY_CONTENTS_VIEW_BASIC.
3296
+ DIRECTORY_CONTENTS_VIEW_UNSPECIFIED = 0
3297
+
3298
+ # Includes only the file or directory name. This is the default behavior.
3299
+ DIRECTORY_CONTENTS_VIEW_BASIC = 1
3300
+
3301
+ # Includes all metadata for each file or directory. Currently not supported
3302
+ # by CMEK-protected workspaces.
3303
+ DIRECTORY_CONTENTS_VIEW_METADATA = 2
3304
+ end
2549
3305
  end
2550
3306
  end
2551
3307
  end