google-cloud-dataform-v1beta1 0.14.1 → 0.16.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.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +4 -4
- data/README.md +5 -5
- data/lib/google/cloud/dataform/v1beta1/bindings_override.rb +0 -57
- data/lib/google/cloud/dataform/v1beta1/dataform/client.rb +2189 -49
- data/lib/google/cloud/dataform/v1beta1/dataform/operations.rb +843 -0
- data/lib/google/cloud/dataform/v1beta1/dataform/paths.rb +59 -0
- data/lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb +2065 -66
- data/lib/google/cloud/dataform/v1beta1/dataform/rest/operations.rb +927 -0
- data/lib/google/cloud/dataform/v1beta1/dataform/rest/service_stub.rb +1782 -482
- data/lib/google/cloud/dataform/v1beta1/dataform/rest.rb +1 -0
- data/lib/google/cloud/dataform/v1beta1/dataform.rb +1 -0
- data/lib/google/cloud/dataform/v1beta1/dataform_pb.rb +48 -28
- data/lib/google/cloud/dataform/v1beta1/dataform_services_pb.rb +56 -0
- data/lib/google/cloud/dataform/v1beta1/version.rb +1 -1
- data/lib/google/longrunning/bindings_override.rb +71 -0
- data/lib/google/longrunning/operations/client.rb +954 -0
- data/lib/google/longrunning/operations/credentials.rb +40 -0
- data/lib/google/longrunning/operations/operations.rb +839 -0
- data/lib/google/longrunning/operations/rest/client.rb +777 -0
- data/lib/google/longrunning/operations/rest/operations.rb +923 -0
- data/lib/google/longrunning/operations/rest/service_stub.rb +322 -0
- data/lib/google/longrunning/operations/rest.rb +57 -0
- data/lib/google/longrunning/operations.rb +59 -0
- data/lib/google/longrunning/rest.rb +34 -0
- data/lib/google/longrunning.rb +41 -0
- data/lib/google-cloud-dataform-v1beta1.rb +1 -0
- data/proto_docs/google/api/client.rb +149 -29
- data/proto_docs/google/cloud/dataform/v1beta1/dataform.rb +870 -9
- data/proto_docs/google/longrunning/operations.rb +191 -0
- 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.
|
|
@@ -94,7 +107,13 @@ module Google
|
|
|
94
107
|
# Required. The Git remote's URL.
|
|
95
108
|
# @!attribute [rw] default_branch
|
|
96
109
|
# @return [::String]
|
|
97
|
-
#
|
|
110
|
+
# Optional. The Git remote's default branch name.
|
|
111
|
+
# If not set, `main` will be used.
|
|
112
|
+
# @!attribute [r] effective_default_branch
|
|
113
|
+
# @return [::String]
|
|
114
|
+
# Output only. The Git remote's effective default branch name.
|
|
115
|
+
# This is the default branch name of the Git remote if it is set,
|
|
116
|
+
# otherwise it is `main`.
|
|
98
117
|
# @!attribute [rw] authentication_token_secret_version
|
|
99
118
|
# @return [::String]
|
|
100
119
|
# Optional. The name of the Secret Manager secret version to use as an
|
|
@@ -103,6 +122,11 @@ module Google
|
|
|
103
122
|
# @!attribute [rw] ssh_authentication_config
|
|
104
123
|
# @return [::Google::Cloud::Dataform::V1beta1::Repository::GitRemoteSettings::SshAuthenticationConfig]
|
|
105
124
|
# Optional. Authentication fields for remote uris using SSH protocol.
|
|
125
|
+
# @!attribute [rw] git_repository_link
|
|
126
|
+
# @return [::String]
|
|
127
|
+
# Optional. Resource name for the `GitRepositoryLink` used for machine
|
|
128
|
+
# credentials. Must be in the format
|
|
129
|
+
# `projects/*/locations/*/connections/*/gitRepositoryLinks/*`
|
|
106
130
|
# @!attribute [r] token_status
|
|
107
131
|
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
108
132
|
# @return [::Google::Cloud::Dataform::V1beta1::Repository::GitRemoteSettings::TokenStatus]
|
|
@@ -178,6 +202,16 @@ module Google
|
|
|
178
202
|
end
|
|
179
203
|
end
|
|
180
204
|
|
|
205
|
+
# Metadata used to identify if a resource is user scoped.
|
|
206
|
+
# @!attribute [r] user_scoped
|
|
207
|
+
# @return [::Boolean]
|
|
208
|
+
# Output only. If true, this resource is user-scoped, meaning it is either a
|
|
209
|
+
# workspace or sourced from a workspace.
|
|
210
|
+
class PrivateResourceMetadata
|
|
211
|
+
include ::Google::Protobuf::MessageExts
|
|
212
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
213
|
+
end
|
|
214
|
+
|
|
181
215
|
# `ListRepositories` request message.
|
|
182
216
|
# @!attribute [rw] parent
|
|
183
217
|
# @return [::String]
|
|
@@ -225,6 +259,21 @@ module Google
|
|
|
225
259
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
226
260
|
end
|
|
227
261
|
|
|
262
|
+
# `MoveRepository` request message.
|
|
263
|
+
# @!attribute [rw] name
|
|
264
|
+
# @return [::String]
|
|
265
|
+
# Required. The full resource name of the repository to move.
|
|
266
|
+
# @!attribute [rw] destination_containing_folder
|
|
267
|
+
# @return [::String]
|
|
268
|
+
# Optional. The name of the Folder, TeamFolder, or root location to move the
|
|
269
|
+
# repository to. Can be in the format of: "" to move into the root User
|
|
270
|
+
# folder, `projects/*/locations/*/folders/*`,
|
|
271
|
+
# `projects/*/locations/*/teamFolders/*`
|
|
272
|
+
class MoveRepositoryRequest
|
|
273
|
+
include ::Google::Protobuf::MessageExts
|
|
274
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
275
|
+
end
|
|
276
|
+
|
|
228
277
|
# `GetRepository` request message.
|
|
229
278
|
# @!attribute [rw] name
|
|
230
279
|
# @return [::String]
|
|
@@ -270,14 +319,42 @@ module Google
|
|
|
270
319
|
# Required. The repository's name.
|
|
271
320
|
# @!attribute [rw] force
|
|
272
321
|
# @return [::Boolean]
|
|
273
|
-
# Optional. If set to true,
|
|
274
|
-
#
|
|
275
|
-
# no child resources.
|
|
322
|
+
# Optional. If set to true, child resources of this repository (compilation
|
|
323
|
+
# results and workflow invocations) will also be deleted. Otherwise, the
|
|
324
|
+
# request will only succeed if the repository has no child resources.
|
|
325
|
+
#
|
|
326
|
+
# **Note:** *This flag doesn't support deletion of workspaces, release
|
|
327
|
+
# configs or workflow configs. If any of such resources exists in the
|
|
328
|
+
# repository, the request will fail.*.
|
|
276
329
|
class DeleteRepositoryRequest
|
|
277
330
|
include ::Google::Protobuf::MessageExts
|
|
278
331
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
279
332
|
end
|
|
280
333
|
|
|
334
|
+
# `DeleteRepositoryLongRunning` response message.
|
|
335
|
+
class DeleteRepositoryLongRunningResponse
|
|
336
|
+
include ::Google::Protobuf::MessageExts
|
|
337
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
338
|
+
end
|
|
339
|
+
|
|
340
|
+
# `DeleteRepositoryLongRunning` request message.
|
|
341
|
+
# @!attribute [rw] name
|
|
342
|
+
# @return [::String]
|
|
343
|
+
# Required. The repository's name.
|
|
344
|
+
# @!attribute [rw] force
|
|
345
|
+
# @return [::Boolean]
|
|
346
|
+
# Optional. If set to true, child resources of this repository (compilation
|
|
347
|
+
# results and workflow invocations) will also be deleted. Otherwise, the
|
|
348
|
+
# request will only succeed if the repository has no child resources.
|
|
349
|
+
#
|
|
350
|
+
# **Note:** *This flag doesn't support deletion of workspaces, release
|
|
351
|
+
# configs or workflow configs. If any of such resources exists in the
|
|
352
|
+
# repository, the request will fail.*
|
|
353
|
+
class DeleteRepositoryLongRunningRequest
|
|
354
|
+
include ::Google::Protobuf::MessageExts
|
|
355
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
356
|
+
end
|
|
357
|
+
|
|
281
358
|
# `CommitRepositoryChanges` request message.
|
|
282
359
|
# @!attribute [rw] name
|
|
283
360
|
# @return [::String]
|
|
@@ -513,6 +590,9 @@ module Google
|
|
|
513
590
|
|
|
514
591
|
# The token was used successfully to authenticate against the Git remote.
|
|
515
592
|
VALID = 3
|
|
593
|
+
|
|
594
|
+
# The token is not accessible due to permission issues.
|
|
595
|
+
PERMISSION_DENIED = 4
|
|
516
596
|
end
|
|
517
597
|
end
|
|
518
598
|
|
|
@@ -550,6 +630,14 @@ module Google
|
|
|
550
630
|
# Output only. All the metadata information that is used internally to serve
|
|
551
631
|
# the resource. For example: timestamps, flags, status fields, etc. The
|
|
552
632
|
# format of this field is a JSON string.
|
|
633
|
+
# @!attribute [rw] disable_moves
|
|
634
|
+
# @return [::Boolean]
|
|
635
|
+
# Optional. If set to true, workspaces will not be moved if its linked
|
|
636
|
+
# Repository is moved. Instead, it will be deleted.
|
|
637
|
+
# @!attribute [r] private_resource_metadata
|
|
638
|
+
# @return [::Google::Cloud::Dataform::V1beta1::PrivateResourceMetadata]
|
|
639
|
+
# Output only. Metadata indicating whether this resource is user-scoped. For
|
|
640
|
+
# `Workspace` resources, the `user_scoped` field is always `true`.
|
|
553
641
|
class Workspace
|
|
554
642
|
include ::Google::Protobuf::MessageExts
|
|
555
643
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -857,6 +945,12 @@ module Google
|
|
|
857
945
|
# When paginating, all other parameters provided to
|
|
858
946
|
# `QueryDirectoryContents`, with the exception of `page_size`, must match the
|
|
859
947
|
# call that provided the page token.
|
|
948
|
+
# @!attribute [rw] view
|
|
949
|
+
# @return [::Google::Cloud::Dataform::V1beta1::DirectoryContentsView]
|
|
950
|
+
# Optional. Specifies the metadata to return for each directory entry.
|
|
951
|
+
# If unspecified, the default is `DIRECTORY_CONTENTS_VIEW_BASIC`.
|
|
952
|
+
# Currently the `DIRECTORY_CONTENTS_VIEW_METADATA` view is not supported by
|
|
953
|
+
# CMEK-protected workspaces.
|
|
860
954
|
class QueryDirectoryContentsRequest
|
|
861
955
|
include ::Google::Protobuf::MessageExts
|
|
862
956
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -878,19 +972,37 @@ module Google
|
|
|
878
972
|
# Represents a single entry in a directory.
|
|
879
973
|
# @!attribute [rw] file
|
|
880
974
|
# @return [::String]
|
|
881
|
-
# A file in the directory.
|
|
975
|
+
# A file in the directory. The path is returned including the full
|
|
976
|
+
# folder structure from the root.
|
|
882
977
|
#
|
|
883
978
|
# Note: The following fields are mutually exclusive: `file`, `directory`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
884
979
|
# @!attribute [rw] directory
|
|
885
980
|
# @return [::String]
|
|
886
|
-
# A child directory in the directory.
|
|
981
|
+
# A child directory in the directory. The path is returned including
|
|
982
|
+
# the full folder structure from the root.
|
|
887
983
|
#
|
|
888
984
|
# 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.
|
|
985
|
+
# @!attribute [rw] metadata
|
|
986
|
+
# @return [::Google::Cloud::Dataform::V1beta1::FilesystemEntryMetadata]
|
|
987
|
+
# Entry with metadata.
|
|
889
988
|
class DirectoryEntry
|
|
890
989
|
include ::Google::Protobuf::MessageExts
|
|
891
990
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
892
991
|
end
|
|
893
992
|
|
|
993
|
+
# Represents metadata for a single entry in a filesystem.
|
|
994
|
+
# @!attribute [r] size_bytes
|
|
995
|
+
# @return [::Integer]
|
|
996
|
+
# Output only. Provides the size of the entry in bytes. For directories, this
|
|
997
|
+
# will be 0.
|
|
998
|
+
# @!attribute [r] update_time
|
|
999
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
1000
|
+
# Output only. Represents the time of the last modification of the entry.
|
|
1001
|
+
class FilesystemEntryMetadata
|
|
1002
|
+
include ::Google::Protobuf::MessageExts
|
|
1003
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1004
|
+
end
|
|
1005
|
+
|
|
894
1006
|
# Configuration containing file search request parameters.
|
|
895
1007
|
# @!attribute [rw] workspace
|
|
896
1008
|
# @return [::String]
|
|
@@ -1342,6 +1454,11 @@ module Google
|
|
|
1342
1454
|
# Output only. All the metadata information that is used internally to serve
|
|
1343
1455
|
# the resource. For example: timestamps, flags, status fields, etc. The
|
|
1344
1456
|
# format of this field is a JSON string.
|
|
1457
|
+
# @!attribute [r] private_resource_metadata
|
|
1458
|
+
# @return [::Google::Cloud::Dataform::V1beta1::PrivateResourceMetadata]
|
|
1459
|
+
# Output only. Metadata indicating whether this resource is user-scoped.
|
|
1460
|
+
# `CompilationResult` resource is `user_scoped` only if it is sourced
|
|
1461
|
+
# from a workspace.
|
|
1345
1462
|
class CompilationResult
|
|
1346
1463
|
include ::Google::Protobuf::MessageExts
|
|
1347
1464
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -1657,6 +1774,24 @@ module Google
|
|
|
1657
1774
|
# options clause of a create table/view statement. See
|
|
1658
1775
|
# https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language
|
|
1659
1776
|
# for more information on which options are supported.
|
|
1777
|
+
# @!attribute [rw] connection
|
|
1778
|
+
# @return [::String]
|
|
1779
|
+
# Optional. The connection specifying the credentials to be used to read
|
|
1780
|
+
# and write to external storage, such as Cloud Storage. The connection can
|
|
1781
|
+
# have the form `{project}.{location}.{connection_id}` or
|
|
1782
|
+
# `projects/{project}/locations/{location}/connections/{connection_id}`,
|
|
1783
|
+
# or be set to DEFAULT.
|
|
1784
|
+
# @!attribute [rw] table_format
|
|
1785
|
+
# @return [::Google::Cloud::Dataform::V1beta1::CompilationResultAction::Relation::TableFormat]
|
|
1786
|
+
# Optional. The table format for the BigQuery table.
|
|
1787
|
+
# @!attribute [rw] file_format
|
|
1788
|
+
# @return [::Google::Cloud::Dataform::V1beta1::CompilationResultAction::Relation::FileFormat]
|
|
1789
|
+
# Optional. The file format for the BigQuery table.
|
|
1790
|
+
# @!attribute [rw] storage_uri
|
|
1791
|
+
# @return [::String]
|
|
1792
|
+
# Optional. The fully qualified location prefix of the external folder
|
|
1793
|
+
# where table data is stored. The URI should be in the format
|
|
1794
|
+
# `gs://bucket/path_to_table/`.
|
|
1660
1795
|
class Relation
|
|
1661
1796
|
include ::Google::Protobuf::MessageExts
|
|
1662
1797
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -1719,6 +1854,24 @@ module Google
|
|
|
1719
1854
|
# The relation is a materialized view.
|
|
1720
1855
|
MATERIALIZED_VIEW = 4
|
|
1721
1856
|
end
|
|
1857
|
+
|
|
1858
|
+
# Supported table formats for BigQuery tables.
|
|
1859
|
+
module TableFormat
|
|
1860
|
+
# Default value.
|
|
1861
|
+
TABLE_FORMAT_UNSPECIFIED = 0
|
|
1862
|
+
|
|
1863
|
+
# Apache Iceberg format.
|
|
1864
|
+
ICEBERG = 1
|
|
1865
|
+
end
|
|
1866
|
+
|
|
1867
|
+
# Supported file formats for BigQuery tables.
|
|
1868
|
+
module FileFormat
|
|
1869
|
+
# Default value.
|
|
1870
|
+
FILE_FORMAT_UNSPECIFIED = 0
|
|
1871
|
+
|
|
1872
|
+
# Apache Parquet format.
|
|
1873
|
+
PARQUET = 1
|
|
1874
|
+
end
|
|
1722
1875
|
end
|
|
1723
1876
|
|
|
1724
1877
|
# Represents a list of arbitrary database operations.
|
|
@@ -2036,9 +2189,30 @@ module Google
|
|
|
2036
2189
|
# @!attribute [rw] service_account
|
|
2037
2190
|
# @return [::String]
|
|
2038
2191
|
# Optional. The service account to run workflow invocations under.
|
|
2192
|
+
# @!attribute [rw] query_priority
|
|
2193
|
+
# @return [::Google::Cloud::Dataform::V1beta1::InvocationConfig::QueryPriority]
|
|
2194
|
+
# Optional. Specifies the priority for query execution in BigQuery.
|
|
2195
|
+
# More information can be found at
|
|
2196
|
+
# https://cloud.google.com/bigquery/docs/running-queries#queries.
|
|
2039
2197
|
class InvocationConfig
|
|
2040
2198
|
include ::Google::Protobuf::MessageExts
|
|
2041
2199
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
2200
|
+
|
|
2201
|
+
# Types of priority for query execution in BigQuery.
|
|
2202
|
+
module QueryPriority
|
|
2203
|
+
# Default value. This value is unused.
|
|
2204
|
+
QUERY_PRIORITY_UNSPECIFIED = 0
|
|
2205
|
+
|
|
2206
|
+
# Query will be executed in BigQuery with interactive priority.
|
|
2207
|
+
# More information can be found at
|
|
2208
|
+
# https://cloud.google.com/bigquery/docs/running-queries#queries.
|
|
2209
|
+
INTERACTIVE = 1
|
|
2210
|
+
|
|
2211
|
+
# Query will be executed in BigQuery with batch priority.
|
|
2212
|
+
# More information can be found at
|
|
2213
|
+
# https://cloud.google.com/bigquery/docs/running-queries#batchqueries.
|
|
2214
|
+
BATCH = 2
|
|
2215
|
+
end
|
|
2042
2216
|
end
|
|
2043
2217
|
|
|
2044
2218
|
# `ListWorkflowConfigs` request message.
|
|
@@ -2167,6 +2341,11 @@ module Google
|
|
|
2167
2341
|
# Output only. All the metadata information that is used internally to serve
|
|
2168
2342
|
# the resource. For example: timestamps, flags, status fields, etc. The
|
|
2169
2343
|
# format of this field is a JSON string.
|
|
2344
|
+
# @!attribute [r] private_resource_metadata
|
|
2345
|
+
# @return [::Google::Cloud::Dataform::V1beta1::PrivateResourceMetadata]
|
|
2346
|
+
# Output only. Metadata indicating whether this resource is user-scoped.
|
|
2347
|
+
# `WorkflowInvocation` resource is `user_scoped` only if it is sourced
|
|
2348
|
+
# from a compilation result and the compilation result is user-scoped.
|
|
2170
2349
|
class WorkflowInvocation
|
|
2171
2350
|
include ::Google::Protobuf::MessageExts
|
|
2172
2351
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -2353,9 +2532,10 @@ module Google
|
|
|
2353
2532
|
# Output only. The code contents of a Notebook to be run.
|
|
2354
2533
|
# @!attribute [r] job_id
|
|
2355
2534
|
# @return [::String]
|
|
2356
|
-
# Output only. The ID of the
|
|
2357
|
-
# contents and also the ID used for the outputs
|
|
2358
|
-
# Storage buckets. Only set once the job has
|
|
2535
|
+
# Output only. The ID of the Gemini Enterprise Agent Platform job that
|
|
2536
|
+
# executed the notebook in contents and also the ID used for the outputs
|
|
2537
|
+
# created in Google Cloud Storage buckets. Only set once the job has
|
|
2538
|
+
# started to run.
|
|
2359
2539
|
class NotebookAction
|
|
2360
2540
|
include ::Google::Protobuf::MessageExts
|
|
2361
2541
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -2531,6 +2711,11 @@ module Google
|
|
|
2531
2711
|
# @return [::String]
|
|
2532
2712
|
# Optional. The default KMS key that is used if no encryption key is provided
|
|
2533
2713
|
# when a repository is created.
|
|
2714
|
+
# @!attribute [r] internal_metadata
|
|
2715
|
+
# @return [::String]
|
|
2716
|
+
# Output only. All the metadata information that is used internally to serve
|
|
2717
|
+
# the resource. For example: timestamps, flags, status fields, etc. The
|
|
2718
|
+
# format of this field is a JSON string.
|
|
2534
2719
|
class Config
|
|
2535
2720
|
include ::Google::Protobuf::MessageExts
|
|
2536
2721
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -2556,6 +2741,682 @@ module Google
|
|
|
2556
2741
|
include ::Google::Protobuf::MessageExts
|
|
2557
2742
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
2558
2743
|
end
|
|
2744
|
+
|
|
2745
|
+
# Represents a Dataform Folder. This is a resource that is used to organize
|
|
2746
|
+
# Files and other Folders and provide hierarchical access controls.
|
|
2747
|
+
# @!attribute [rw] name
|
|
2748
|
+
# @return [::String]
|
|
2749
|
+
# Identifier. The Folder's name.
|
|
2750
|
+
# @!attribute [rw] display_name
|
|
2751
|
+
# @return [::String]
|
|
2752
|
+
# Required. The Folder's user-friendly name.
|
|
2753
|
+
# @!attribute [rw] containing_folder
|
|
2754
|
+
# @return [::String]
|
|
2755
|
+
# Optional. The containing Folder resource name. This should take
|
|
2756
|
+
# the format: projects/\\{project}/locations/\\{location}/folders/\\{folder},
|
|
2757
|
+
# projects/\\{project}/locations/\\{location}/teamFolders/\\{teamFolder}, or just
|
|
2758
|
+
# "" if this is a root Folder. This field can only be updated through
|
|
2759
|
+
# MoveFolder.
|
|
2760
|
+
# @!attribute [r] team_folder_name
|
|
2761
|
+
# @return [::String]
|
|
2762
|
+
# Output only. The resource name of the TeamFolder that this Folder is
|
|
2763
|
+
# associated with. This should take the format:
|
|
2764
|
+
# projects/\\{project}/locations/\\{location}/teamFolders/\\{teamFolder}. If this
|
|
2765
|
+
# is not set, the Folder is not associated with a TeamFolder and is a
|
|
2766
|
+
# UserFolder.
|
|
2767
|
+
# @!attribute [r] create_time
|
|
2768
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
2769
|
+
# Output only. The timestamp of when the Folder was created.
|
|
2770
|
+
# @!attribute [r] update_time
|
|
2771
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
2772
|
+
# Output only. The timestamp of when the Folder was last updated.
|
|
2773
|
+
# @!attribute [r] internal_metadata
|
|
2774
|
+
# @return [::String]
|
|
2775
|
+
# Output only. All the metadata information that is used internally to serve
|
|
2776
|
+
# the resource. For example: timestamps, flags, status fields, etc. The
|
|
2777
|
+
# format of this field is a JSON string.
|
|
2778
|
+
# @!attribute [r] creator_iam_principal
|
|
2779
|
+
# @return [::String]
|
|
2780
|
+
# Output only. The IAM principal identifier of the creator of the Folder.
|
|
2781
|
+
class Folder
|
|
2782
|
+
include ::Google::Protobuf::MessageExts
|
|
2783
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
2784
|
+
end
|
|
2785
|
+
|
|
2786
|
+
# `CreateFolder` request message.
|
|
2787
|
+
# @!attribute [rw] parent
|
|
2788
|
+
# @return [::String]
|
|
2789
|
+
# Required. The location in which to create the Folder. Must be in the format
|
|
2790
|
+
# `projects/*/locations/*`.
|
|
2791
|
+
# @!attribute [rw] folder
|
|
2792
|
+
# @return [::Google::Cloud::Dataform::V1beta1::Folder]
|
|
2793
|
+
# Required. The Folder to create.
|
|
2794
|
+
# @!attribute [rw] folder_id
|
|
2795
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
2796
|
+
# @return [::String]
|
|
2797
|
+
# Deprecated: This field is not used. The resource name is generated
|
|
2798
|
+
# automatically.
|
|
2799
|
+
# The ID to use for the Folder, which will become the final component of
|
|
2800
|
+
# the Folder's resource name.
|
|
2801
|
+
class CreateFolderRequest
|
|
2802
|
+
include ::Google::Protobuf::MessageExts
|
|
2803
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
2804
|
+
end
|
|
2805
|
+
|
|
2806
|
+
# `MoveFolder` request message.
|
|
2807
|
+
# @!attribute [rw] name
|
|
2808
|
+
# @return [::String]
|
|
2809
|
+
# Required. The full resource name of the Folder to move.
|
|
2810
|
+
# @!attribute [rw] destination_containing_folder
|
|
2811
|
+
# @return [::String]
|
|
2812
|
+
# Optional. The name of the Folder, TeamFolder, or root location to move the
|
|
2813
|
+
# Folder to. Can be in the format of: "" to move into the root User folder,
|
|
2814
|
+
# `projects/*/locations/*/folders/*`, `projects/*/locations/*/teamFolders/*`
|
|
2815
|
+
class MoveFolderRequest
|
|
2816
|
+
include ::Google::Protobuf::MessageExts
|
|
2817
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
2818
|
+
end
|
|
2819
|
+
|
|
2820
|
+
# `GetFolder` request message.
|
|
2821
|
+
# @!attribute [rw] name
|
|
2822
|
+
# @return [::String]
|
|
2823
|
+
# Required. The Folder's name.
|
|
2824
|
+
class GetFolderRequest
|
|
2825
|
+
include ::Google::Protobuf::MessageExts
|
|
2826
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
2827
|
+
end
|
|
2828
|
+
|
|
2829
|
+
# `UpdateFolder` request message.
|
|
2830
|
+
# @!attribute [rw] update_mask
|
|
2831
|
+
# @return [::Google::Protobuf::FieldMask]
|
|
2832
|
+
# Optional. Specifies the fields to be updated in the Folder. If left unset,
|
|
2833
|
+
# all fields that can be updated, will be updated. A few fields cannot be
|
|
2834
|
+
# updated and will be ignored if specified in the update_mask (e.g.
|
|
2835
|
+
# parent_name, team_folder_name).
|
|
2836
|
+
# @!attribute [rw] folder
|
|
2837
|
+
# @return [::Google::Cloud::Dataform::V1beta1::Folder]
|
|
2838
|
+
# Required. The updated Folder.
|
|
2839
|
+
class UpdateFolderRequest
|
|
2840
|
+
include ::Google::Protobuf::MessageExts
|
|
2841
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
2842
|
+
end
|
|
2843
|
+
|
|
2844
|
+
# `DeleteFolder` request message.
|
|
2845
|
+
# @!attribute [rw] name
|
|
2846
|
+
# @return [::String]
|
|
2847
|
+
# Required. The Folder's name.
|
|
2848
|
+
class DeleteFolderRequest
|
|
2849
|
+
include ::Google::Protobuf::MessageExts
|
|
2850
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
2851
|
+
end
|
|
2852
|
+
|
|
2853
|
+
# `DeleteFolderTree` request message.
|
|
2854
|
+
# @!attribute [rw] name
|
|
2855
|
+
# @return [::String]
|
|
2856
|
+
# Required. The Folder's name.
|
|
2857
|
+
# Format: projects/\\{project}/locations/\\{location}/folders/\\{folder}
|
|
2858
|
+
# @!attribute [rw] force
|
|
2859
|
+
# @return [::Boolean]
|
|
2860
|
+
# Optional. If `false` (default): The operation will fail if any
|
|
2861
|
+
# Repository within the folder hierarchy has associated Release Configs or
|
|
2862
|
+
# Workflow Configs.
|
|
2863
|
+
#
|
|
2864
|
+
# If `true`: The operation will attempt to delete everything, including any
|
|
2865
|
+
# Release Configs and Workflow Configs linked to Repositories within the
|
|
2866
|
+
# folder hierarchy. This permanently removes schedules and resources.
|
|
2867
|
+
class DeleteFolderTreeRequest
|
|
2868
|
+
include ::Google::Protobuf::MessageExts
|
|
2869
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
2870
|
+
end
|
|
2871
|
+
|
|
2872
|
+
# `DeleteTeamFolderTree` request message.
|
|
2873
|
+
# @!attribute [rw] name
|
|
2874
|
+
# @return [::String]
|
|
2875
|
+
# Required. The TeamFolder's name.
|
|
2876
|
+
# Format: projects/\\{project}/locations/\\{location}/teamFolders/\\{team_folder}
|
|
2877
|
+
# @!attribute [rw] force
|
|
2878
|
+
# @return [::Boolean]
|
|
2879
|
+
# Optional. If `false` (default): The operation will fail if any
|
|
2880
|
+
# Repository within the folder hierarchy has associated Release Configs or
|
|
2881
|
+
# Workflow Configs.
|
|
2882
|
+
#
|
|
2883
|
+
# If `true`: The operation will attempt to delete everything, including any
|
|
2884
|
+
# Release Configs and Workflow Configs linked to Repositories within the
|
|
2885
|
+
# folder hierarchy. This permanently removes schedules and resources.
|
|
2886
|
+
class DeleteTeamFolderTreeRequest
|
|
2887
|
+
include ::Google::Protobuf::MessageExts
|
|
2888
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
2889
|
+
end
|
|
2890
|
+
|
|
2891
|
+
# Contains metadata about the progress of the DeleteFolderTree Long-running
|
|
2892
|
+
# operations.
|
|
2893
|
+
# @!attribute [r] create_time
|
|
2894
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
2895
|
+
# Output only. The time the operation was created.
|
|
2896
|
+
# @!attribute [r] end_time
|
|
2897
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
2898
|
+
# Output only. The time the operation finished running.
|
|
2899
|
+
# @!attribute [r] target
|
|
2900
|
+
# @return [::String]
|
|
2901
|
+
# Output only. Resource name of the target of the operation.
|
|
2902
|
+
# Format: projects/\\{project}/locations/\\{location}/folders/\\{folder} or
|
|
2903
|
+
# projects/\\{project}/locations/\\{location}/teamFolders/\\{team_folder}
|
|
2904
|
+
# @!attribute [r] state
|
|
2905
|
+
# @return [::Google::Cloud::Dataform::V1beta1::DeleteFolderTreeMetadata::State]
|
|
2906
|
+
# Output only. The state of the operation.
|
|
2907
|
+
# @!attribute [r] percent_complete
|
|
2908
|
+
# @return [::Integer]
|
|
2909
|
+
# Output only. Percent complete of the operation [0, 100].
|
|
2910
|
+
class DeleteFolderTreeMetadata
|
|
2911
|
+
include ::Google::Protobuf::MessageExts
|
|
2912
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
2913
|
+
|
|
2914
|
+
# Different states of the DeleteFolderTree operation.
|
|
2915
|
+
module State
|
|
2916
|
+
# The state is unspecified.
|
|
2917
|
+
STATE_UNSPECIFIED = 0
|
|
2918
|
+
|
|
2919
|
+
# The operation was initialized and recorded by the server, but not yet
|
|
2920
|
+
# started.
|
|
2921
|
+
INITIALIZED = 1
|
|
2922
|
+
|
|
2923
|
+
# The operation is in progress.
|
|
2924
|
+
IN_PROGRESS = 2
|
|
2925
|
+
|
|
2926
|
+
# The operation has completed successfully.
|
|
2927
|
+
SUCCEEDED = 3
|
|
2928
|
+
|
|
2929
|
+
# The operation has failed.
|
|
2930
|
+
FAILED = 4
|
|
2931
|
+
end
|
|
2932
|
+
end
|
|
2933
|
+
|
|
2934
|
+
# `QueryFolderContents` request message.
|
|
2935
|
+
# @!attribute [rw] folder
|
|
2936
|
+
# @return [::String]
|
|
2937
|
+
# Required. Resource name of the Folder to list contents for.
|
|
2938
|
+
# Format: projects/*/locations/*/folders/*
|
|
2939
|
+
# @!attribute [rw] page_size
|
|
2940
|
+
# @return [::Integer]
|
|
2941
|
+
# Optional. Maximum number of paths to return. The server may return fewer
|
|
2942
|
+
# items than requested. If unspecified, the server will pick an appropriate
|
|
2943
|
+
# default.
|
|
2944
|
+
# @!attribute [rw] page_token
|
|
2945
|
+
# @return [::String]
|
|
2946
|
+
# Optional. Page token received from a previous `QueryFolderContents` call.
|
|
2947
|
+
# Provide this to retrieve the subsequent page.
|
|
2948
|
+
#
|
|
2949
|
+
# When paginating, all other parameters provided to
|
|
2950
|
+
# `QueryFolderContents`, with the exception of `page_size`, must match the
|
|
2951
|
+
# call that provided the page token.
|
|
2952
|
+
# @!attribute [rw] order_by
|
|
2953
|
+
# @return [::String]
|
|
2954
|
+
# Optional. Field to additionally sort results by.
|
|
2955
|
+
# Will order Folders before Repositories, and then by `order_by` in ascending
|
|
2956
|
+
# order. Supported keywords: display_name (default), create_time,
|
|
2957
|
+
# last_modified_time.
|
|
2958
|
+
# Examples:
|
|
2959
|
+
#
|
|
2960
|
+
# * `orderBy="display_name"`
|
|
2961
|
+
# * `orderBy="display_name desc"`
|
|
2962
|
+
# @!attribute [rw] filter
|
|
2963
|
+
# @return [::String]
|
|
2964
|
+
# Optional. Optional filtering for the returned list. Filtering is currently
|
|
2965
|
+
# only supported on the `display_name` field.
|
|
2966
|
+
#
|
|
2967
|
+
# Example:
|
|
2968
|
+
#
|
|
2969
|
+
# * `filter="display_name="MyFolder""`
|
|
2970
|
+
class QueryFolderContentsRequest
|
|
2971
|
+
include ::Google::Protobuf::MessageExts
|
|
2972
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
2973
|
+
end
|
|
2974
|
+
|
|
2975
|
+
# `QueryFolderContents` response message.
|
|
2976
|
+
# @!attribute [rw] entries
|
|
2977
|
+
# @return [::Array<::Google::Cloud::Dataform::V1beta1::QueryFolderContentsResponse::FolderContentsEntry>]
|
|
2978
|
+
# List of entries in the folder.
|
|
2979
|
+
# @!attribute [rw] next_page_token
|
|
2980
|
+
# @return [::String]
|
|
2981
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
|
2982
|
+
# If this field is omitted, there are no subsequent pages.
|
|
2983
|
+
class QueryFolderContentsResponse
|
|
2984
|
+
include ::Google::Protobuf::MessageExts
|
|
2985
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
2986
|
+
|
|
2987
|
+
# Represents a single content entry.
|
|
2988
|
+
# @!attribute [rw] folder
|
|
2989
|
+
# @return [::Google::Cloud::Dataform::V1beta1::Folder]
|
|
2990
|
+
# A subfolder.
|
|
2991
|
+
#
|
|
2992
|
+
# 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.
|
|
2993
|
+
# @!attribute [rw] repository
|
|
2994
|
+
# @return [::Google::Cloud::Dataform::V1beta1::Repository]
|
|
2995
|
+
# A repository.
|
|
2996
|
+
#
|
|
2997
|
+
# 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.
|
|
2998
|
+
class FolderContentsEntry
|
|
2999
|
+
include ::Google::Protobuf::MessageExts
|
|
3000
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3001
|
+
end
|
|
3002
|
+
end
|
|
3003
|
+
|
|
3004
|
+
# `QueryUserRootContents` request message.
|
|
3005
|
+
# @!attribute [rw] location
|
|
3006
|
+
# @return [::String]
|
|
3007
|
+
# Required. Location of the user root folder to list contents for.
|
|
3008
|
+
# Format: projects/*/locations/*
|
|
3009
|
+
# @!attribute [rw] page_size
|
|
3010
|
+
# @return [::Integer]
|
|
3011
|
+
# Optional. Maximum number of paths to return. The server may return fewer
|
|
3012
|
+
# items than requested. If unspecified, the server will pick an appropriate
|
|
3013
|
+
# default.
|
|
3014
|
+
# @!attribute [rw] page_token
|
|
3015
|
+
# @return [::String]
|
|
3016
|
+
# Optional. Page token received from a previous `QueryUserRootContents` call.
|
|
3017
|
+
# Provide this to retrieve the subsequent page.
|
|
3018
|
+
#
|
|
3019
|
+
# When paginating, all other parameters provided to
|
|
3020
|
+
# `QueryUserRootFolderContents`, with the exception of `page_size`, must
|
|
3021
|
+
# match the call that provided the page token.
|
|
3022
|
+
# @!attribute [rw] order_by
|
|
3023
|
+
# @return [::String]
|
|
3024
|
+
# Optional. Field to additionally sort results by.
|
|
3025
|
+
# Will order Folders before Repositories, and then by `order_by` in ascending
|
|
3026
|
+
# order. Supported keywords: display_name (default), created_at,
|
|
3027
|
+
# last_modified_at. Examples:
|
|
3028
|
+
#
|
|
3029
|
+
# * `orderBy="display_name"`
|
|
3030
|
+
# * `orderBy="display_name desc"`
|
|
3031
|
+
# @!attribute [rw] filter
|
|
3032
|
+
# @return [::String]
|
|
3033
|
+
# Optional. Optional filtering for the returned list. Filtering is currently
|
|
3034
|
+
# only supported on the `display_name` field.
|
|
3035
|
+
#
|
|
3036
|
+
# Example:
|
|
3037
|
+
#
|
|
3038
|
+
# * `filter="display_name="MyFolder""`
|
|
3039
|
+
class QueryUserRootContentsRequest
|
|
3040
|
+
include ::Google::Protobuf::MessageExts
|
|
3041
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3042
|
+
end
|
|
3043
|
+
|
|
3044
|
+
# `QueryUserRootContents` response message.
|
|
3045
|
+
# @!attribute [rw] entries
|
|
3046
|
+
# @return [::Array<::Google::Cloud::Dataform::V1beta1::QueryUserRootContentsResponse::RootContentsEntry>]
|
|
3047
|
+
# List of entries in the folder.
|
|
3048
|
+
# @!attribute [rw] next_page_token
|
|
3049
|
+
# @return [::String]
|
|
3050
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
|
3051
|
+
# If this field is omitted, there are no subsequent pages.
|
|
3052
|
+
class QueryUserRootContentsResponse
|
|
3053
|
+
include ::Google::Protobuf::MessageExts
|
|
3054
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3055
|
+
|
|
3056
|
+
# Represents a single content entry.
|
|
3057
|
+
# @!attribute [rw] folder
|
|
3058
|
+
# @return [::Google::Cloud::Dataform::V1beta1::Folder]
|
|
3059
|
+
# A subfolder.
|
|
3060
|
+
#
|
|
3061
|
+
# 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.
|
|
3062
|
+
# @!attribute [rw] repository
|
|
3063
|
+
# @return [::Google::Cloud::Dataform::V1beta1::Repository]
|
|
3064
|
+
# A repository.
|
|
3065
|
+
#
|
|
3066
|
+
# 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.
|
|
3067
|
+
class RootContentsEntry
|
|
3068
|
+
include ::Google::Protobuf::MessageExts
|
|
3069
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3070
|
+
end
|
|
3071
|
+
end
|
|
3072
|
+
|
|
3073
|
+
# Represents a Dataform TeamFolder. This is a resource that sits at the project
|
|
3074
|
+
# level and is used to organize Repositories and Folders with hierarchical
|
|
3075
|
+
# access controls. They provide a team context and stricter access controls.
|
|
3076
|
+
# @!attribute [rw] name
|
|
3077
|
+
# @return [::String]
|
|
3078
|
+
# Identifier. The TeamFolder's name.
|
|
3079
|
+
# @!attribute [rw] display_name
|
|
3080
|
+
# @return [::String]
|
|
3081
|
+
# Required. The TeamFolder's user-friendly name.
|
|
3082
|
+
# @!attribute [r] create_time
|
|
3083
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
3084
|
+
# Output only. The timestamp of when the TeamFolder was created.
|
|
3085
|
+
# @!attribute [r] update_time
|
|
3086
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
3087
|
+
# Output only. The timestamp of when the TeamFolder was last updated.
|
|
3088
|
+
# @!attribute [r] internal_metadata
|
|
3089
|
+
# @return [::String]
|
|
3090
|
+
# Output only. All the metadata information that is used internally to serve
|
|
3091
|
+
# the resource. For example: timestamps, flags, status fields, etc. The
|
|
3092
|
+
# format of this field is a JSON string.
|
|
3093
|
+
# @!attribute [r] creator_iam_principal
|
|
3094
|
+
# @return [::String]
|
|
3095
|
+
# Output only. The IAM principal identifier of the creator of the TeamFolder.
|
|
3096
|
+
class TeamFolder
|
|
3097
|
+
include ::Google::Protobuf::MessageExts
|
|
3098
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3099
|
+
end
|
|
3100
|
+
|
|
3101
|
+
# `CreateTeamFolder` request message.
|
|
3102
|
+
# @!attribute [rw] parent
|
|
3103
|
+
# @return [::String]
|
|
3104
|
+
# Required. The location in which to create the TeamFolder. Must be in the
|
|
3105
|
+
# format `projects/*/locations/*`.
|
|
3106
|
+
# @!attribute [rw] team_folder
|
|
3107
|
+
# @return [::Google::Cloud::Dataform::V1beta1::TeamFolder]
|
|
3108
|
+
# Required. The TeamFolder to create.
|
|
3109
|
+
# @!attribute [rw] team_folder_id
|
|
3110
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
3111
|
+
# @return [::String]
|
|
3112
|
+
# Deprecated: This field is not used. The resource name is generated
|
|
3113
|
+
# automatically.
|
|
3114
|
+
# The ID to use for the TeamFolder, which will become the final component of
|
|
3115
|
+
# the TeamFolder's resource name.
|
|
3116
|
+
class CreateTeamFolderRequest
|
|
3117
|
+
include ::Google::Protobuf::MessageExts
|
|
3118
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3119
|
+
end
|
|
3120
|
+
|
|
3121
|
+
# `GetTeamFolder` request message.
|
|
3122
|
+
# @!attribute [rw] name
|
|
3123
|
+
# @return [::String]
|
|
3124
|
+
# Required. The TeamFolder's name.
|
|
3125
|
+
class GetTeamFolderRequest
|
|
3126
|
+
include ::Google::Protobuf::MessageExts
|
|
3127
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3128
|
+
end
|
|
3129
|
+
|
|
3130
|
+
# `UpdateTeamFolder` request message.
|
|
3131
|
+
# @!attribute [rw] update_mask
|
|
3132
|
+
# @return [::Google::Protobuf::FieldMask]
|
|
3133
|
+
# Optional. Specifies the fields to be updated in the Folder. If left unset,
|
|
3134
|
+
# all fields will be updated.
|
|
3135
|
+
# @!attribute [rw] team_folder
|
|
3136
|
+
# @return [::Google::Cloud::Dataform::V1beta1::TeamFolder]
|
|
3137
|
+
# Required. The updated TeamFolder.
|
|
3138
|
+
class UpdateTeamFolderRequest
|
|
3139
|
+
include ::Google::Protobuf::MessageExts
|
|
3140
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3141
|
+
end
|
|
3142
|
+
|
|
3143
|
+
# `DeleteTeamFolder` request message.
|
|
3144
|
+
# @!attribute [rw] name
|
|
3145
|
+
# @return [::String]
|
|
3146
|
+
# Required. The TeamFolder's name.
|
|
3147
|
+
class DeleteTeamFolderRequest
|
|
3148
|
+
include ::Google::Protobuf::MessageExts
|
|
3149
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3150
|
+
end
|
|
3151
|
+
|
|
3152
|
+
# `QueryTeamFolderContents` request message.
|
|
3153
|
+
# @!attribute [rw] team_folder
|
|
3154
|
+
# @return [::String]
|
|
3155
|
+
# Required. Resource name of the TeamFolder to list contents for.
|
|
3156
|
+
# Format: `projects/*/locations/*/teamFolders/*`.
|
|
3157
|
+
# @!attribute [rw] page_size
|
|
3158
|
+
# @return [::Integer]
|
|
3159
|
+
# Optional. Maximum number of paths to return. The server may return fewer
|
|
3160
|
+
# items than requested. If unspecified, the server will pick an appropriate
|
|
3161
|
+
# default.
|
|
3162
|
+
# @!attribute [rw] page_token
|
|
3163
|
+
# @return [::String]
|
|
3164
|
+
# Optional. Page token received from a previous `QueryTeamFolderContents`
|
|
3165
|
+
# call. Provide this to retrieve the subsequent page.
|
|
3166
|
+
#
|
|
3167
|
+
# When paginating, all other parameters provided to
|
|
3168
|
+
# `QueryTeamFolderContents`, with the exception of `page_size`, must match
|
|
3169
|
+
# the call that provided the page token.
|
|
3170
|
+
# @!attribute [rw] order_by
|
|
3171
|
+
# @return [::String]
|
|
3172
|
+
# Optional. Field to additionally sort results by.
|
|
3173
|
+
# Will order Folders before Repositories, and then by `order_by` in ascending
|
|
3174
|
+
# order. Supported keywords: `display_name` (default), `create_time`,
|
|
3175
|
+
# last_modified_time.
|
|
3176
|
+
# Examples:
|
|
3177
|
+
#
|
|
3178
|
+
# * `orderBy="display_name"`
|
|
3179
|
+
# * `orderBy="display_name desc"`
|
|
3180
|
+
# @!attribute [rw] filter
|
|
3181
|
+
# @return [::String]
|
|
3182
|
+
# Optional. Optional filtering for the returned list. Filtering is currently
|
|
3183
|
+
# only supported on the `display_name` field.
|
|
3184
|
+
#
|
|
3185
|
+
# Example:
|
|
3186
|
+
#
|
|
3187
|
+
# * `filter="display_name="MyFolder""`
|
|
3188
|
+
class QueryTeamFolderContentsRequest
|
|
3189
|
+
include ::Google::Protobuf::MessageExts
|
|
3190
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3191
|
+
end
|
|
3192
|
+
|
|
3193
|
+
# `QueryTeamFolderContents` response message.
|
|
3194
|
+
# @!attribute [rw] entries
|
|
3195
|
+
# @return [::Array<::Google::Cloud::Dataform::V1beta1::QueryTeamFolderContentsResponse::TeamFolderContentsEntry>]
|
|
3196
|
+
# List of entries in the TeamFolder.
|
|
3197
|
+
# @!attribute [rw] next_page_token
|
|
3198
|
+
# @return [::String]
|
|
3199
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
|
3200
|
+
# If this field is omitted, there are no subsequent pages.
|
|
3201
|
+
class QueryTeamFolderContentsResponse
|
|
3202
|
+
include ::Google::Protobuf::MessageExts
|
|
3203
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3204
|
+
|
|
3205
|
+
# Represents a single content entry.
|
|
3206
|
+
# @!attribute [rw] folder
|
|
3207
|
+
# @return [::Google::Cloud::Dataform::V1beta1::Folder]
|
|
3208
|
+
# A subfolder.
|
|
3209
|
+
#
|
|
3210
|
+
# 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.
|
|
3211
|
+
# @!attribute [rw] repository
|
|
3212
|
+
# @return [::Google::Cloud::Dataform::V1beta1::Repository]
|
|
3213
|
+
# A repository.
|
|
3214
|
+
#
|
|
3215
|
+
# 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.
|
|
3216
|
+
class TeamFolderContentsEntry
|
|
3217
|
+
include ::Google::Protobuf::MessageExts
|
|
3218
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3219
|
+
end
|
|
3220
|
+
end
|
|
3221
|
+
|
|
3222
|
+
# `SearchTeamFolders` request message.
|
|
3223
|
+
# @!attribute [rw] location
|
|
3224
|
+
# @return [::String]
|
|
3225
|
+
# Required. Location in which to query TeamFolders.
|
|
3226
|
+
# Format: `projects/*/locations/*`.
|
|
3227
|
+
# @!attribute [rw] page_size
|
|
3228
|
+
# @return [::Integer]
|
|
3229
|
+
# Optional. Maximum number of `TeamFolders` to return. The server may return
|
|
3230
|
+
# fewer items than requested. If unspecified, the server will pick a default
|
|
3231
|
+
# of `page_size` = 50.
|
|
3232
|
+
# @!attribute [rw] page_token
|
|
3233
|
+
# @return [::String]
|
|
3234
|
+
# Optional. Page token received from a previous `SearchTeamFolders` call.
|
|
3235
|
+
# Provide this to retrieve the subsequent page.
|
|
3236
|
+
#
|
|
3237
|
+
# When paginating, all other parameters provided to
|
|
3238
|
+
# `SearchTeamFolders`, with the exception of `page_size`, must
|
|
3239
|
+
# match the call that provided the page token.
|
|
3240
|
+
# @!attribute [rw] order_by
|
|
3241
|
+
# @return [::String]
|
|
3242
|
+
# Optional. Field to additionally sort results by.
|
|
3243
|
+
# Supported keywords: `display_name` (default), `create_time`,
|
|
3244
|
+
# `last_modified_time`. Examples:
|
|
3245
|
+
#
|
|
3246
|
+
# * `orderBy="display_name"`
|
|
3247
|
+
# * `orderBy="display_name desc"`
|
|
3248
|
+
# @!attribute [rw] filter
|
|
3249
|
+
# @return [::String]
|
|
3250
|
+
# Optional. Optional filtering for the returned list. Filtering is currently
|
|
3251
|
+
# only supported on the `display_name` field.
|
|
3252
|
+
#
|
|
3253
|
+
# Example:
|
|
3254
|
+
#
|
|
3255
|
+
# * `filter="display_name="MyFolder""`
|
|
3256
|
+
class SearchTeamFoldersRequest
|
|
3257
|
+
include ::Google::Protobuf::MessageExts
|
|
3258
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3259
|
+
end
|
|
3260
|
+
|
|
3261
|
+
# `SearchTeamFolders` response message.
|
|
3262
|
+
# @!attribute [rw] results
|
|
3263
|
+
# @return [::Array<::Google::Cloud::Dataform::V1beta1::SearchTeamFoldersResponse::TeamFolderSearchResult>]
|
|
3264
|
+
# List of TeamFolders that match the search query.
|
|
3265
|
+
# @!attribute [rw] next_page_token
|
|
3266
|
+
# @return [::String]
|
|
3267
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
|
3268
|
+
# If this field is omitted, there are no subsequent pages.
|
|
3269
|
+
class SearchTeamFoldersResponse
|
|
3270
|
+
include ::Google::Protobuf::MessageExts
|
|
3271
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3272
|
+
|
|
3273
|
+
# Represents a single content entry.
|
|
3274
|
+
# @!attribute [rw] team_folder
|
|
3275
|
+
# @return [::Google::Cloud::Dataform::V1beta1::TeamFolder]
|
|
3276
|
+
# A TeamFolder resource that is in the project / location.
|
|
3277
|
+
class TeamFolderSearchResult
|
|
3278
|
+
include ::Google::Protobuf::MessageExts
|
|
3279
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3280
|
+
end
|
|
3281
|
+
end
|
|
3282
|
+
|
|
3283
|
+
# Contains metadata about the progress of the MoveFolder Long-running
|
|
3284
|
+
# operations.
|
|
3285
|
+
# @!attribute [r] create_time
|
|
3286
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
3287
|
+
# Output only. The time the operation was created.
|
|
3288
|
+
# @!attribute [r] end_time
|
|
3289
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
3290
|
+
# Output only. The time the operation finished running.
|
|
3291
|
+
# @!attribute [r] target
|
|
3292
|
+
# @return [::String]
|
|
3293
|
+
# Output only. Server-defined resource path for the target of the operation.
|
|
3294
|
+
# @!attribute [rw] state
|
|
3295
|
+
# @return [::Google::Cloud::Dataform::V1beta1::MoveFolderMetadata::State]
|
|
3296
|
+
# The state of the move.
|
|
3297
|
+
# @!attribute [rw] percent_complete
|
|
3298
|
+
# @return [::Integer]
|
|
3299
|
+
# Percent complete of the move [0, 100].
|
|
3300
|
+
class MoveFolderMetadata
|
|
3301
|
+
include ::Google::Protobuf::MessageExts
|
|
3302
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3303
|
+
|
|
3304
|
+
# Different states of the move.
|
|
3305
|
+
module State
|
|
3306
|
+
# The state is unspecified.
|
|
3307
|
+
STATE_UNSPECIFIED = 0
|
|
3308
|
+
|
|
3309
|
+
# The move was initialized and recorded by the server, but not yet started.
|
|
3310
|
+
INITIALIZED = 1
|
|
3311
|
+
|
|
3312
|
+
# The move is in progress.
|
|
3313
|
+
IN_PROGRESS = 2
|
|
3314
|
+
|
|
3315
|
+
# The move has completed successfully.
|
|
3316
|
+
SUCCESS = 3
|
|
3317
|
+
|
|
3318
|
+
# The move has failed.
|
|
3319
|
+
FAILED = 4
|
|
3320
|
+
end
|
|
3321
|
+
end
|
|
3322
|
+
|
|
3323
|
+
# Contains metadata about the progress of the MoveRepository Long-running
|
|
3324
|
+
# operations.
|
|
3325
|
+
# @!attribute [r] create_time
|
|
3326
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
3327
|
+
# Output only. The time the operation was created.
|
|
3328
|
+
# @!attribute [r] end_time
|
|
3329
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
3330
|
+
# Output only. The time the operation finished running.
|
|
3331
|
+
# @!attribute [r] target
|
|
3332
|
+
# @return [::String]
|
|
3333
|
+
# Output only. Server-defined resource path for the target of the operation.
|
|
3334
|
+
# @!attribute [rw] state
|
|
3335
|
+
# @return [::Google::Cloud::Dataform::V1beta1::MoveRepositoryMetadata::State]
|
|
3336
|
+
# The state of the move.
|
|
3337
|
+
# @!attribute [rw] percent_complete
|
|
3338
|
+
# @return [::Integer]
|
|
3339
|
+
# Percent complete of the move [0, 100].
|
|
3340
|
+
class MoveRepositoryMetadata
|
|
3341
|
+
include ::Google::Protobuf::MessageExts
|
|
3342
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3343
|
+
|
|
3344
|
+
# Different states of the move.
|
|
3345
|
+
module State
|
|
3346
|
+
# The state is unspecified.
|
|
3347
|
+
STATE_UNSPECIFIED = 0
|
|
3348
|
+
|
|
3349
|
+
# The move was initialized and recorded by the server, but not yet started.
|
|
3350
|
+
INITIALIZED = 1
|
|
3351
|
+
|
|
3352
|
+
# The move is in progress.
|
|
3353
|
+
IN_PROGRESS = 2
|
|
3354
|
+
|
|
3355
|
+
# The move has completed successfully.
|
|
3356
|
+
SUCCESS = 3
|
|
3357
|
+
|
|
3358
|
+
# The move has failed.
|
|
3359
|
+
FAILED = 4
|
|
3360
|
+
end
|
|
3361
|
+
end
|
|
3362
|
+
|
|
3363
|
+
# Represents metadata about the progress of the DeleteRepository long-running
|
|
3364
|
+
# operation.
|
|
3365
|
+
# @!attribute [r] create_time
|
|
3366
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
3367
|
+
# Output only. The time the operation was created.
|
|
3368
|
+
# @!attribute [r] end_time
|
|
3369
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
3370
|
+
# Output only. The time the operation finished running.
|
|
3371
|
+
# @!attribute [r] target
|
|
3372
|
+
# @return [::String]
|
|
3373
|
+
# Output only. Server-defined resource path for the target of the operation.
|
|
3374
|
+
# Format: projects/\\{project}/locations/\\{location}/repositories/\\{repository}
|
|
3375
|
+
# @!attribute [r] state
|
|
3376
|
+
# @return [::Google::Cloud::Dataform::V1beta1::DeleteRepositoryLongRunningMetadata::State]
|
|
3377
|
+
# Output only. The state of the operation.
|
|
3378
|
+
# @!attribute [r] percent_complete
|
|
3379
|
+
# @return [::Integer]
|
|
3380
|
+
# Output only. Percent complete of the operation [0, 100].
|
|
3381
|
+
# @!attribute [r] child_resources_count
|
|
3382
|
+
# @return [::Integer]
|
|
3383
|
+
# Output only. The total number of child resources (Compilation Results,
|
|
3384
|
+
# Workflow Executions) that will be deleted.
|
|
3385
|
+
# @!attribute [r] remaining_child_resources_count
|
|
3386
|
+
# @return [::Integer]
|
|
3387
|
+
# Output only. The remaining number of child resources to be deleted.
|
|
3388
|
+
class DeleteRepositoryLongRunningMetadata
|
|
3389
|
+
include ::Google::Protobuf::MessageExts
|
|
3390
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
3391
|
+
|
|
3392
|
+
# Different states of the DeleteRepositoryLongRunning operation.
|
|
3393
|
+
module State
|
|
3394
|
+
# The state is unspecified.
|
|
3395
|
+
STATE_UNSPECIFIED = 0
|
|
3396
|
+
|
|
3397
|
+
# The operation is running.
|
|
3398
|
+
RUNNING = 1
|
|
3399
|
+
|
|
3400
|
+
# The operation has completed successfully.
|
|
3401
|
+
SUCCEEDED = 2
|
|
3402
|
+
|
|
3403
|
+
# The operation has failed.
|
|
3404
|
+
FAILED = 3
|
|
3405
|
+
end
|
|
3406
|
+
end
|
|
3407
|
+
|
|
3408
|
+
# Represents the level of detail to return for directory contents.
|
|
3409
|
+
module DirectoryContentsView
|
|
3410
|
+
# The default unset value. Defaults to DIRECTORY_CONTENTS_VIEW_BASIC.
|
|
3411
|
+
DIRECTORY_CONTENTS_VIEW_UNSPECIFIED = 0
|
|
3412
|
+
|
|
3413
|
+
# Includes only the file or directory name. This is the default behavior.
|
|
3414
|
+
DIRECTORY_CONTENTS_VIEW_BASIC = 1
|
|
3415
|
+
|
|
3416
|
+
# Includes all metadata for each file or directory. Currently not supported
|
|
3417
|
+
# by CMEK-protected workspaces.
|
|
3418
|
+
DIRECTORY_CONTENTS_VIEW_METADATA = 2
|
|
3419
|
+
end
|
|
2559
3420
|
end
|
|
2560
3421
|
end
|
|
2561
3422
|
end
|