google-cloud-dataform-v1 0.1.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 (34) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +154 -0
  6. data/lib/google/cloud/dataform/v1/bindings_override.rb +159 -0
  7. data/lib/google/cloud/dataform/v1/dataform/client.rb +5766 -0
  8. data/lib/google/cloud/dataform/v1/dataform/credentials.rb +48 -0
  9. data/lib/google/cloud/dataform/v1/dataform/paths.rb +273 -0
  10. data/lib/google/cloud/dataform/v1/dataform/rest/client.rb +5371 -0
  11. data/lib/google/cloud/dataform/v1/dataform/rest/service_stub.rb +3398 -0
  12. data/lib/google/cloud/dataform/v1/dataform/rest.rb +54 -0
  13. data/lib/google/cloud/dataform/v1/dataform.rb +56 -0
  14. data/lib/google/cloud/dataform/v1/dataform_pb.rb +200 -0
  15. data/lib/google/cloud/dataform/v1/dataform_services_pb.rb +180 -0
  16. data/lib/google/cloud/dataform/v1/rest.rb +38 -0
  17. data/lib/google/cloud/dataform/v1/version.rb +28 -0
  18. data/lib/google/cloud/dataform/v1.rb +45 -0
  19. data/lib/google-cloud-dataform-v1.rb +21 -0
  20. data/proto_docs/README.md +4 -0
  21. data/proto_docs/google/api/client.rb +473 -0
  22. data/proto_docs/google/api/field_behavior.rb +85 -0
  23. data/proto_docs/google/api/launch_stage.rb +71 -0
  24. data/proto_docs/google/api/resource.rb +227 -0
  25. data/proto_docs/google/cloud/dataform/v1/dataform.rb +2552 -0
  26. data/proto_docs/google/protobuf/any.rb +145 -0
  27. data/proto_docs/google/protobuf/duration.rb +98 -0
  28. data/proto_docs/google/protobuf/empty.rb +34 -0
  29. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  30. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  31. data/proto_docs/google/rpc/status.rb +48 -0
  32. data/proto_docs/google/type/expr.rb +75 -0
  33. data/proto_docs/google/type/interval.rb +45 -0
  34. metadata +131 -0
@@ -0,0 +1,2552 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Dataform
23
+ module V1
24
+ # Describes encryption state of a resource.
25
+ # @!attribute [rw] kms_key_version_name
26
+ # @return [::String]
27
+ # Required. The KMS key version name with which data of a resource is
28
+ # encrypted.
29
+ class DataEncryptionState
30
+ include ::Google::Protobuf::MessageExts
31
+ extend ::Google::Protobuf::MessageExts::ClassMethods
32
+ end
33
+
34
+ # Represents a Dataform Git repository.
35
+ # @!attribute [rw] name
36
+ # @return [::String]
37
+ # Identifier. The repository's name.
38
+ # @!attribute [r] create_time
39
+ # @return [::Google::Protobuf::Timestamp]
40
+ # Output only. The timestamp of when the repository was created.
41
+ # @!attribute [rw] display_name
42
+ # @return [::String]
43
+ # Optional. The repository's user-friendly name.
44
+ # @!attribute [rw] git_remote_settings
45
+ # @return [::Google::Cloud::Dataform::V1::Repository::GitRemoteSettings]
46
+ # Optional. If set, configures this repository to be linked to a Git remote.
47
+ # @!attribute [rw] npmrc_environment_variables_secret_version
48
+ # @return [::String]
49
+ # Optional. The name of the Secret Manager secret version to be used to
50
+ # interpolate variables into the .npmrc file for package installation
51
+ # operations. Must be in the format `projects/*/secrets/*/versions/*`. The
52
+ # file itself must be in a JSON format.
53
+ # @!attribute [rw] workspace_compilation_overrides
54
+ # @return [::Google::Cloud::Dataform::V1::Repository::WorkspaceCompilationOverrides]
55
+ # Optional. If set, fields of `workspace_compilation_overrides` override the
56
+ # default compilation settings that are specified in dataform.json when
57
+ # creating workspace-scoped compilation results. See documentation for
58
+ # `WorkspaceCompilationOverrides` for more information.
59
+ # @!attribute [rw] labels
60
+ # @return [::Google::Protobuf::Map{::String => ::String}]
61
+ # Optional. Repository user labels.
62
+ # @!attribute [rw] set_authenticated_user_admin
63
+ # @return [::Boolean]
64
+ # Optional. Input only. If set to true, the authenticated user will be
65
+ # granted the roles/dataform.admin role on the created repository.
66
+ # @!attribute [rw] service_account
67
+ # @return [::String]
68
+ # Optional. The service account to run workflow invocations under.
69
+ # @!attribute [rw] kms_key_name
70
+ # @return [::String]
71
+ # Optional. The reference to a KMS encryption key. If provided, it will be
72
+ # used to encrypt user data in the repository and all child resources. It is
73
+ # not possible to add or update the encryption key after the repository is
74
+ # created. Example:
75
+ # `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
76
+ # @!attribute [r] data_encryption_state
77
+ # @return [::Google::Cloud::Dataform::V1::DataEncryptionState]
78
+ # Output only. A data encryption state of a Git repository if this Repository
79
+ # is protected by a KMS key.
80
+ # @!attribute [r] internal_metadata
81
+ # @return [::String]
82
+ # Output only. All the metadata information that is used internally to serve
83
+ # the resource. For example: timestamps, flags, status fields, etc. The
84
+ # format of this field is a JSON string.
85
+ class Repository
86
+ include ::Google::Protobuf::MessageExts
87
+ extend ::Google::Protobuf::MessageExts::ClassMethods
88
+
89
+ # Controls Git remote configuration for a repository.
90
+ # @!attribute [rw] url
91
+ # @return [::String]
92
+ # Required. The Git remote's URL.
93
+ # @!attribute [rw] default_branch
94
+ # @return [::String]
95
+ # Required. The Git remote's default branch name.
96
+ # @!attribute [rw] authentication_token_secret_version
97
+ # @return [::String]
98
+ # Optional. The name of the Secret Manager secret version to use as an
99
+ # authentication token for Git operations. Must be in the format
100
+ # `projects/*/secrets/*/versions/*`.
101
+ # @!attribute [rw] ssh_authentication_config
102
+ # @return [::Google::Cloud::Dataform::V1::Repository::GitRemoteSettings::SshAuthenticationConfig]
103
+ # Optional. Authentication fields for remote uris using SSH protocol.
104
+ # @!attribute [r] token_status
105
+ # @deprecated This field is deprecated and may be removed in the next major version update.
106
+ # @return [::Google::Cloud::Dataform::V1::Repository::GitRemoteSettings::TokenStatus]
107
+ # Output only. Deprecated: The field does not contain any token status
108
+ # information.
109
+ class GitRemoteSettings
110
+ include ::Google::Protobuf::MessageExts
111
+ extend ::Google::Protobuf::MessageExts::ClassMethods
112
+
113
+ # Configures fields for performing SSH authentication.
114
+ # @!attribute [rw] user_private_key_secret_version
115
+ # @return [::String]
116
+ # Required. The name of the Secret Manager secret version to use as a
117
+ # ssh private key for Git operations.
118
+ # Must be in the format `projects/*/secrets/*/versions/*`.
119
+ # @!attribute [rw] host_public_key
120
+ # @return [::String]
121
+ # Required. Content of a public SSH key to verify an identity of a remote
122
+ # Git host.
123
+ class SshAuthenticationConfig
124
+ include ::Google::Protobuf::MessageExts
125
+ extend ::Google::Protobuf::MessageExts::ClassMethods
126
+ end
127
+
128
+ # The status of the authentication token.
129
+ module TokenStatus
130
+ # Default value. This value is unused.
131
+ TOKEN_STATUS_UNSPECIFIED = 0
132
+
133
+ # The token could not be found in Secret Manager (or the Dataform
134
+ # Service Account did not have permission to access it).
135
+ NOT_FOUND = 1
136
+
137
+ # The token could not be used to authenticate against the Git remote.
138
+ INVALID = 2
139
+
140
+ # The token was used successfully to authenticate against the Git remote.
141
+ VALID = 3
142
+ end
143
+ end
144
+
145
+ # Configures workspace compilation overrides for a repository.
146
+ # @!attribute [rw] default_database
147
+ # @return [::String]
148
+ # Optional. The default database (Google Cloud project ID).
149
+ # @!attribute [rw] schema_suffix
150
+ # @return [::String]
151
+ # Optional. The suffix that should be appended to all schema (BigQuery
152
+ # dataset ID) names.
153
+ # @!attribute [rw] table_prefix
154
+ # @return [::String]
155
+ # Optional. The prefix that should be prepended to all table names.
156
+ class WorkspaceCompilationOverrides
157
+ include ::Google::Protobuf::MessageExts
158
+ extend ::Google::Protobuf::MessageExts::ClassMethods
159
+ end
160
+
161
+ # @!attribute [rw] key
162
+ # @return [::String]
163
+ # @!attribute [rw] value
164
+ # @return [::String]
165
+ class LabelsEntry
166
+ include ::Google::Protobuf::MessageExts
167
+ extend ::Google::Protobuf::MessageExts::ClassMethods
168
+ end
169
+ end
170
+
171
+ # `ListRepositories` request message.
172
+ # @!attribute [rw] parent
173
+ # @return [::String]
174
+ # Required. The location in which to list repositories. Must be in the format
175
+ # `projects/*/locations/*`.
176
+ # @!attribute [rw] page_size
177
+ # @return [::Integer]
178
+ # Optional. Maximum number of repositories to return. The server may return
179
+ # fewer items than requested. If unspecified, the server will pick an
180
+ # appropriate default.
181
+ # @!attribute [rw] page_token
182
+ # @return [::String]
183
+ # Optional. Page token received from a previous `ListRepositories` call.
184
+ # Provide this to retrieve the subsequent page.
185
+ #
186
+ # When paginating, all other parameters provided to `ListRepositories`,
187
+ # with the exception of `page_size`, must match the call that provided the
188
+ # page token.
189
+ # @!attribute [rw] order_by
190
+ # @return [::String]
191
+ # Optional. This field only supports ordering by `name`. If unspecified, the
192
+ # server will choose the ordering. If specified, the default order is
193
+ # ascending for the `name` field.
194
+ # @!attribute [rw] filter
195
+ # @return [::String]
196
+ # Optional. Filter for the returned list.
197
+ class ListRepositoriesRequest
198
+ include ::Google::Protobuf::MessageExts
199
+ extend ::Google::Protobuf::MessageExts::ClassMethods
200
+ end
201
+
202
+ # `ListRepositories` response message.
203
+ # @!attribute [rw] repositories
204
+ # @return [::Array<::Google::Cloud::Dataform::V1::Repository>]
205
+ # List of repositories.
206
+ # @!attribute [rw] next_page_token
207
+ # @return [::String]
208
+ # A token which can be sent as `page_token` to retrieve the next page.
209
+ # If this field is omitted, there are no subsequent pages.
210
+ # @!attribute [rw] unreachable
211
+ # @return [::Array<::String>]
212
+ # Locations which could not be reached.
213
+ class ListRepositoriesResponse
214
+ include ::Google::Protobuf::MessageExts
215
+ extend ::Google::Protobuf::MessageExts::ClassMethods
216
+ end
217
+
218
+ # `GetRepository` request message.
219
+ # @!attribute [rw] name
220
+ # @return [::String]
221
+ # Required. The repository's name.
222
+ class GetRepositoryRequest
223
+ include ::Google::Protobuf::MessageExts
224
+ extend ::Google::Protobuf::MessageExts::ClassMethods
225
+ end
226
+
227
+ # `CreateRepository` request message.
228
+ # @!attribute [rw] parent
229
+ # @return [::String]
230
+ # Required. The location in which to create the repository. Must be in the
231
+ # format `projects/*/locations/*`.
232
+ # @!attribute [rw] repository
233
+ # @return [::Google::Cloud::Dataform::V1::Repository]
234
+ # Required. The repository to create.
235
+ # @!attribute [rw] repository_id
236
+ # @return [::String]
237
+ # Required. The ID to use for the repository, which will become the final
238
+ # component of the repository's resource name.
239
+ class CreateRepositoryRequest
240
+ include ::Google::Protobuf::MessageExts
241
+ extend ::Google::Protobuf::MessageExts::ClassMethods
242
+ end
243
+
244
+ # `UpdateRepository` request message.
245
+ # @!attribute [rw] update_mask
246
+ # @return [::Google::Protobuf::FieldMask]
247
+ # Optional. Specifies the fields to be updated in the repository. If left
248
+ # unset, all fields will be updated.
249
+ # @!attribute [rw] repository
250
+ # @return [::Google::Cloud::Dataform::V1::Repository]
251
+ # Required. The repository to update.
252
+ class UpdateRepositoryRequest
253
+ include ::Google::Protobuf::MessageExts
254
+ extend ::Google::Protobuf::MessageExts::ClassMethods
255
+ end
256
+
257
+ # `DeleteRepository` request message.
258
+ # @!attribute [rw] name
259
+ # @return [::String]
260
+ # Required. The repository's name.
261
+ # @!attribute [rw] force
262
+ # @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.)
266
+ class DeleteRepositoryRequest
267
+ include ::Google::Protobuf::MessageExts
268
+ extend ::Google::Protobuf::MessageExts::ClassMethods
269
+ end
270
+
271
+ # `CommitRepositoryChanges` request message.
272
+ # @!attribute [rw] name
273
+ # @return [::String]
274
+ # Required. The repository's name.
275
+ # @!attribute [rw] commit_metadata
276
+ # @return [::Google::Cloud::Dataform::V1::CommitMetadata]
277
+ # Required. The changes to commit to the repository.
278
+ # @!attribute [rw] required_head_commit_sha
279
+ # @return [::String]
280
+ # Optional. The commit SHA which must be the repository's current HEAD before
281
+ # applying this commit; otherwise this request will fail. If unset, no
282
+ # validation on the current HEAD commit SHA is performed.
283
+ # @!attribute [rw] file_operations
284
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dataform::V1::CommitRepositoryChangesRequest::FileOperation}]
285
+ # Optional. A map to the path of the file to the operation. The path is the
286
+ # full file path including filename, from repository root.
287
+ class CommitRepositoryChangesRequest
288
+ include ::Google::Protobuf::MessageExts
289
+ extend ::Google::Protobuf::MessageExts::ClassMethods
290
+
291
+ # Represents a single file operation to the repository.
292
+ # @!attribute [rw] write_file
293
+ # @return [::Google::Cloud::Dataform::V1::CommitRepositoryChangesRequest::FileOperation::WriteFile]
294
+ # Represents the write operation.
295
+ #
296
+ # Note: The following fields are mutually exclusive: `write_file`, `delete_file`. If a field in that set is populated, all other fields in the set will automatically be cleared.
297
+ # @!attribute [rw] delete_file
298
+ # @return [::Google::Cloud::Dataform::V1::CommitRepositoryChangesRequest::FileOperation::DeleteFile]
299
+ # Represents the delete operation.
300
+ #
301
+ # Note: The following fields are mutually exclusive: `delete_file`, `write_file`. If a field in that set is populated, all other fields in the set will automatically be cleared.
302
+ class FileOperation
303
+ include ::Google::Protobuf::MessageExts
304
+ extend ::Google::Protobuf::MessageExts::ClassMethods
305
+
306
+ # Represents the write file operation (for files added or modified).
307
+ # @!attribute [rw] contents
308
+ # @return [::String]
309
+ # The file's contents.
310
+ class WriteFile
311
+ include ::Google::Protobuf::MessageExts
312
+ extend ::Google::Protobuf::MessageExts::ClassMethods
313
+ end
314
+
315
+ # Represents the delete file operation.
316
+ class DeleteFile
317
+ include ::Google::Protobuf::MessageExts
318
+ extend ::Google::Protobuf::MessageExts::ClassMethods
319
+ end
320
+ end
321
+
322
+ # @!attribute [rw] key
323
+ # @return [::String]
324
+ # @!attribute [rw] value
325
+ # @return [::Google::Cloud::Dataform::V1::CommitRepositoryChangesRequest::FileOperation]
326
+ class FileOperationsEntry
327
+ include ::Google::Protobuf::MessageExts
328
+ extend ::Google::Protobuf::MessageExts::ClassMethods
329
+ end
330
+ end
331
+
332
+ # `CommitRepositoryChanges` response message.
333
+ # @!attribute [rw] commit_sha
334
+ # @return [::String]
335
+ # The commit SHA of the current commit.
336
+ class CommitRepositoryChangesResponse
337
+ include ::Google::Protobuf::MessageExts
338
+ extend ::Google::Protobuf::MessageExts::ClassMethods
339
+ end
340
+
341
+ # `ReadRepositoryFile` request message.
342
+ # @!attribute [rw] name
343
+ # @return [::String]
344
+ # Required. The repository's name.
345
+ # @!attribute [rw] commit_sha
346
+ # @return [::String]
347
+ # Optional. The commit SHA for the commit to read from. If unset, the file
348
+ # will be read from HEAD.
349
+ # @!attribute [rw] path
350
+ # @return [::String]
351
+ # Required. Full file path to read including filename, from repository root.
352
+ class ReadRepositoryFileRequest
353
+ include ::Google::Protobuf::MessageExts
354
+ extend ::Google::Protobuf::MessageExts::ClassMethods
355
+ end
356
+
357
+ # `ReadRepositoryFile` response message.
358
+ # @!attribute [rw] contents
359
+ # @return [::String]
360
+ # The file's contents.
361
+ class ReadRepositoryFileResponse
362
+ include ::Google::Protobuf::MessageExts
363
+ extend ::Google::Protobuf::MessageExts::ClassMethods
364
+ end
365
+
366
+ # `QueryRepositoryDirectoryContents` request message.
367
+ # @!attribute [rw] name
368
+ # @return [::String]
369
+ # Required. The repository's name.
370
+ # @!attribute [rw] commit_sha
371
+ # @return [::String]
372
+ # Optional. The Commit SHA for the commit to query from. If unset, the
373
+ # directory will be queried from HEAD.
374
+ # @!attribute [rw] path
375
+ # @return [::String]
376
+ # Optional. The directory's full path including directory name, relative to
377
+ # root. If left unset, the root is used.
378
+ # @!attribute [rw] page_size
379
+ # @return [::Integer]
380
+ # Optional. Maximum number of paths to return. The server may return fewer
381
+ # items than requested. If unspecified, the server will pick an appropriate
382
+ # default.
383
+ # @!attribute [rw] page_token
384
+ # @return [::String]
385
+ # Optional. Page token received from a previous
386
+ # `QueryRepositoryDirectoryContents` call. Provide this to retrieve the
387
+ # subsequent page.
388
+ #
389
+ # When paginating, all other parameters provided to
390
+ # `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must
391
+ # match the call that provided the page token.
392
+ class QueryRepositoryDirectoryContentsRequest
393
+ include ::Google::Protobuf::MessageExts
394
+ extend ::Google::Protobuf::MessageExts::ClassMethods
395
+ end
396
+
397
+ # `QueryRepositoryDirectoryContents` response message.
398
+ # @!attribute [rw] directory_entries
399
+ # @return [::Array<::Google::Cloud::Dataform::V1::DirectoryEntry>]
400
+ # List of entries in the directory.
401
+ # @!attribute [rw] next_page_token
402
+ # @return [::String]
403
+ # A token, which can be sent as `page_token` to retrieve the next page.
404
+ # If this field is omitted, there are no subsequent pages.
405
+ class QueryRepositoryDirectoryContentsResponse
406
+ include ::Google::Protobuf::MessageExts
407
+ extend ::Google::Protobuf::MessageExts::ClassMethods
408
+ end
409
+
410
+ # `FetchRepositoryHistory` request message.
411
+ # @!attribute [rw] name
412
+ # @return [::String]
413
+ # Required. The repository's name.
414
+ # @!attribute [rw] page_size
415
+ # @return [::Integer]
416
+ # Optional. Maximum number of commits to return. The server may return fewer
417
+ # items than requested. If unspecified, the server will pick an appropriate
418
+ # default.
419
+ # @!attribute [rw] page_token
420
+ # @return [::String]
421
+ # Optional. Page token received from a previous `FetchRepositoryHistory`
422
+ # call. Provide this to retrieve the subsequent page.
423
+ #
424
+ # When paginating, all other parameters provided to `FetchRepositoryHistory`,
425
+ # with the exception of `page_size`, must match the call that provided the
426
+ # page token.
427
+ class FetchRepositoryHistoryRequest
428
+ include ::Google::Protobuf::MessageExts
429
+ extend ::Google::Protobuf::MessageExts::ClassMethods
430
+ end
431
+
432
+ # `FetchRepositoryHistory` response message.
433
+ # @!attribute [rw] commits
434
+ # @return [::Array<::Google::Cloud::Dataform::V1::CommitLogEntry>]
435
+ # A list of commit logs, ordered by 'git log' default order.
436
+ # @!attribute [rw] next_page_token
437
+ # @return [::String]
438
+ # A token, which can be sent as `page_token` to retrieve the next page.
439
+ # If this field is omitted, there are no subsequent pages.
440
+ class FetchRepositoryHistoryResponse
441
+ include ::Google::Protobuf::MessageExts
442
+ extend ::Google::Protobuf::MessageExts::ClassMethods
443
+ end
444
+
445
+ # Represents a single commit log.
446
+ # @!attribute [rw] commit_time
447
+ # @return [::Google::Protobuf::Timestamp]
448
+ # Commit timestamp.
449
+ # @!attribute [rw] commit_sha
450
+ # @return [::String]
451
+ # The commit SHA for this commit log entry.
452
+ # @!attribute [rw] author
453
+ # @return [::Google::Cloud::Dataform::V1::CommitAuthor]
454
+ # The commit author for this commit log entry.
455
+ # @!attribute [rw] commit_message
456
+ # @return [::String]
457
+ # The commit message for this commit log entry.
458
+ class CommitLogEntry
459
+ include ::Google::Protobuf::MessageExts
460
+ extend ::Google::Protobuf::MessageExts::ClassMethods
461
+ end
462
+
463
+ # Represents a Dataform Git commit.
464
+ # @!attribute [rw] author
465
+ # @return [::Google::Cloud::Dataform::V1::CommitAuthor]
466
+ # Required. The commit's author.
467
+ # @!attribute [rw] commit_message
468
+ # @return [::String]
469
+ # Optional. The commit's message.
470
+ class CommitMetadata
471
+ include ::Google::Protobuf::MessageExts
472
+ extend ::Google::Protobuf::MessageExts::ClassMethods
473
+ end
474
+
475
+ # `ComputeRepositoryAccessTokenStatus` request message.
476
+ # @!attribute [rw] name
477
+ # @return [::String]
478
+ # Required. The repository's name.
479
+ class ComputeRepositoryAccessTokenStatusRequest
480
+ include ::Google::Protobuf::MessageExts
481
+ extend ::Google::Protobuf::MessageExts::ClassMethods
482
+ end
483
+
484
+ # `ComputeRepositoryAccessTokenStatus` response message.
485
+ # @!attribute [rw] token_status
486
+ # @return [::Google::Cloud::Dataform::V1::ComputeRepositoryAccessTokenStatusResponse::TokenStatus]
487
+ # Indicates the status of the Git access token.
488
+ class ComputeRepositoryAccessTokenStatusResponse
489
+ include ::Google::Protobuf::MessageExts
490
+ extend ::Google::Protobuf::MessageExts::ClassMethods
491
+
492
+ # Indicates the status of a Git authentication token.
493
+ module TokenStatus
494
+ # Default value. This value is unused.
495
+ TOKEN_STATUS_UNSPECIFIED = 0
496
+
497
+ # The token could not be found in Secret Manager (or the Dataform
498
+ # Service Account did not have permission to access it).
499
+ NOT_FOUND = 1
500
+
501
+ # The token could not be used to authenticate against the Git remote.
502
+ INVALID = 2
503
+
504
+ # The token was used successfully to authenticate against the Git remote.
505
+ VALID = 3
506
+ end
507
+ end
508
+
509
+ # `FetchRemoteBranches` request message.
510
+ # @!attribute [rw] name
511
+ # @return [::String]
512
+ # Required. The repository's name.
513
+ class FetchRemoteBranchesRequest
514
+ include ::Google::Protobuf::MessageExts
515
+ extend ::Google::Protobuf::MessageExts::ClassMethods
516
+ end
517
+
518
+ # `FetchRemoteBranches` response message.
519
+ # @!attribute [rw] branches
520
+ # @return [::Array<::String>]
521
+ # The remote repository's branch names.
522
+ class FetchRemoteBranchesResponse
523
+ include ::Google::Protobuf::MessageExts
524
+ extend ::Google::Protobuf::MessageExts::ClassMethods
525
+ end
526
+
527
+ # Represents a Dataform Git workspace.
528
+ # @!attribute [rw] name
529
+ # @return [::String]
530
+ # Identifier. The workspace's name.
531
+ # @!attribute [r] create_time
532
+ # @return [::Google::Protobuf::Timestamp]
533
+ # Output only. The timestamp of when the workspace was created.
534
+ # @!attribute [r] data_encryption_state
535
+ # @return [::Google::Cloud::Dataform::V1::DataEncryptionState]
536
+ # Output only. A data encryption state of a Git repository if this Workspace
537
+ # is protected by a KMS key.
538
+ # @!attribute [r] internal_metadata
539
+ # @return [::String]
540
+ # Output only. All the metadata information that is used internally to serve
541
+ # the resource. For example: timestamps, flags, status fields, etc. The
542
+ # format of this field is a JSON string.
543
+ class Workspace
544
+ include ::Google::Protobuf::MessageExts
545
+ extend ::Google::Protobuf::MessageExts::ClassMethods
546
+ end
547
+
548
+ # `ListWorkspaces` request message.
549
+ # @!attribute [rw] parent
550
+ # @return [::String]
551
+ # Required. The repository in which to list workspaces. Must be in the
552
+ # format `projects/*/locations/*/repositories/*`.
553
+ # @!attribute [rw] page_size
554
+ # @return [::Integer]
555
+ # Optional. Maximum number of workspaces to return. The server may return
556
+ # fewer items than requested. If unspecified, the server will pick an
557
+ # appropriate default.
558
+ # @!attribute [rw] page_token
559
+ # @return [::String]
560
+ # Optional. Page token received from a previous `ListWorkspaces` call.
561
+ # Provide this to retrieve the subsequent page.
562
+ #
563
+ # When paginating, all other parameters provided to `ListWorkspaces`, with
564
+ # the exception of `page_size`, must match the call that provided the page
565
+ # token.
566
+ # @!attribute [rw] order_by
567
+ # @return [::String]
568
+ # Optional. This field only supports ordering by `name`. If unspecified, the
569
+ # server will choose the ordering. If specified, the default order is
570
+ # ascending for the `name` field.
571
+ # @!attribute [rw] filter
572
+ # @return [::String]
573
+ # Optional. Filter for the returned list.
574
+ class ListWorkspacesRequest
575
+ include ::Google::Protobuf::MessageExts
576
+ extend ::Google::Protobuf::MessageExts::ClassMethods
577
+ end
578
+
579
+ # `ListWorkspaces` response message.
580
+ # @!attribute [rw] workspaces
581
+ # @return [::Array<::Google::Cloud::Dataform::V1::Workspace>]
582
+ # List of workspaces.
583
+ # @!attribute [rw] next_page_token
584
+ # @return [::String]
585
+ # A token, which can be sent as `page_token` to retrieve the next page.
586
+ # If this field is omitted, there are no subsequent pages.
587
+ # @!attribute [rw] unreachable
588
+ # @return [::Array<::String>]
589
+ # Locations which could not be reached.
590
+ class ListWorkspacesResponse
591
+ include ::Google::Protobuf::MessageExts
592
+ extend ::Google::Protobuf::MessageExts::ClassMethods
593
+ end
594
+
595
+ # `GetWorkspace` request message.
596
+ # @!attribute [rw] name
597
+ # @return [::String]
598
+ # Required. The workspace's name.
599
+ class GetWorkspaceRequest
600
+ include ::Google::Protobuf::MessageExts
601
+ extend ::Google::Protobuf::MessageExts::ClassMethods
602
+ end
603
+
604
+ # `CreateWorkspace` request message.
605
+ # @!attribute [rw] parent
606
+ # @return [::String]
607
+ # Required. The repository in which to create the workspace. Must be in the
608
+ # format `projects/*/locations/*/repositories/*`.
609
+ # @!attribute [rw] workspace
610
+ # @return [::Google::Cloud::Dataform::V1::Workspace]
611
+ # Required. The workspace to create.
612
+ # @!attribute [rw] workspace_id
613
+ # @return [::String]
614
+ # Required. The ID to use for the workspace, which will become the final
615
+ # component of the workspace's resource name.
616
+ class CreateWorkspaceRequest
617
+ include ::Google::Protobuf::MessageExts
618
+ extend ::Google::Protobuf::MessageExts::ClassMethods
619
+ end
620
+
621
+ # `DeleteWorkspace` request message.
622
+ # @!attribute [rw] name
623
+ # @return [::String]
624
+ # Required. The workspace resource's name.
625
+ class DeleteWorkspaceRequest
626
+ include ::Google::Protobuf::MessageExts
627
+ extend ::Google::Protobuf::MessageExts::ClassMethods
628
+ end
629
+
630
+ # Represents the author of a Git commit.
631
+ # @!attribute [rw] name
632
+ # @return [::String]
633
+ # Required. The commit author's name.
634
+ # @!attribute [rw] email_address
635
+ # @return [::String]
636
+ # Required. The commit author's email address.
637
+ class CommitAuthor
638
+ include ::Google::Protobuf::MessageExts
639
+ extend ::Google::Protobuf::MessageExts::ClassMethods
640
+ end
641
+
642
+ # `PullGitCommits` request message.
643
+ # @!attribute [rw] name
644
+ # @return [::String]
645
+ # Required. The workspace's name.
646
+ # @!attribute [rw] remote_branch
647
+ # @return [::String]
648
+ # Optional. The name of the branch in the Git remote from which to pull
649
+ # commits. If left unset, the repository's default branch name will be used.
650
+ # @!attribute [rw] author
651
+ # @return [::Google::Cloud::Dataform::V1::CommitAuthor]
652
+ # Required. The author of any merge commit which may be created as a result
653
+ # of merging fetched Git commits into this workspace.
654
+ class PullGitCommitsRequest
655
+ include ::Google::Protobuf::MessageExts
656
+ extend ::Google::Protobuf::MessageExts::ClassMethods
657
+ end
658
+
659
+ # `PullGitCommits` response message.
660
+ class PullGitCommitsResponse
661
+ include ::Google::Protobuf::MessageExts
662
+ extend ::Google::Protobuf::MessageExts::ClassMethods
663
+ end
664
+
665
+ # `PushGitCommits` request message.
666
+ # @!attribute [rw] name
667
+ # @return [::String]
668
+ # Required. The workspace's name.
669
+ # @!attribute [rw] remote_branch
670
+ # @return [::String]
671
+ # Optional. The name of the branch in the Git remote to which commits should
672
+ # be pushed. If left unset, the repository's default branch name will be
673
+ # used.
674
+ class PushGitCommitsRequest
675
+ include ::Google::Protobuf::MessageExts
676
+ extend ::Google::Protobuf::MessageExts::ClassMethods
677
+ end
678
+
679
+ # `PushGitCommits` response message.
680
+ class PushGitCommitsResponse
681
+ include ::Google::Protobuf::MessageExts
682
+ extend ::Google::Protobuf::MessageExts::ClassMethods
683
+ end
684
+
685
+ # `FetchFileGitStatuses` request message.
686
+ # @!attribute [rw] name
687
+ # @return [::String]
688
+ # Required. The workspace's name.
689
+ class FetchFileGitStatusesRequest
690
+ include ::Google::Protobuf::MessageExts
691
+ extend ::Google::Protobuf::MessageExts::ClassMethods
692
+ end
693
+
694
+ # `FetchFileGitStatuses` response message.
695
+ # @!attribute [rw] uncommitted_file_changes
696
+ # @return [::Array<::Google::Cloud::Dataform::V1::FetchFileGitStatusesResponse::UncommittedFileChange>]
697
+ # A list of all files which have uncommitted Git changes. There will only be
698
+ # a single entry for any given file.
699
+ class FetchFileGitStatusesResponse
700
+ include ::Google::Protobuf::MessageExts
701
+ extend ::Google::Protobuf::MessageExts::ClassMethods
702
+
703
+ # Represents the Git state of a file with uncommitted changes.
704
+ # @!attribute [rw] path
705
+ # @return [::String]
706
+ # The file's full path including filename, relative to the workspace root.
707
+ # @!attribute [r] state
708
+ # @return [::Google::Cloud::Dataform::V1::FetchFileGitStatusesResponse::UncommittedFileChange::State]
709
+ # Output only. Indicates the status of the file.
710
+ class UncommittedFileChange
711
+ include ::Google::Protobuf::MessageExts
712
+ extend ::Google::Protobuf::MessageExts::ClassMethods
713
+
714
+ # Indicates the status of an uncommitted file change.
715
+ module State
716
+ # Default value. This value is unused.
717
+ STATE_UNSPECIFIED = 0
718
+
719
+ # The file has been newly added.
720
+ ADDED = 1
721
+
722
+ # The file has been deleted.
723
+ DELETED = 2
724
+
725
+ # The file has been modified.
726
+ MODIFIED = 3
727
+
728
+ # The file contains merge conflicts.
729
+ HAS_CONFLICTS = 4
730
+ end
731
+ end
732
+ end
733
+
734
+ # `FetchGitAheadBehind` request message.
735
+ # @!attribute [rw] name
736
+ # @return [::String]
737
+ # Required. The workspace's name.
738
+ # @!attribute [rw] remote_branch
739
+ # @return [::String]
740
+ # Optional. The name of the branch in the Git remote against which this
741
+ # workspace should be compared. If left unset, the repository's default
742
+ # branch name will be used.
743
+ class FetchGitAheadBehindRequest
744
+ include ::Google::Protobuf::MessageExts
745
+ extend ::Google::Protobuf::MessageExts::ClassMethods
746
+ end
747
+
748
+ # `FetchGitAheadBehind` response message.
749
+ # @!attribute [rw] commits_ahead
750
+ # @return [::Integer]
751
+ # The number of commits in the remote branch that are not in the workspace.
752
+ # @!attribute [rw] commits_behind
753
+ # @return [::Integer]
754
+ # The number of commits in the workspace that are not in the remote branch.
755
+ class FetchGitAheadBehindResponse
756
+ include ::Google::Protobuf::MessageExts
757
+ extend ::Google::Protobuf::MessageExts::ClassMethods
758
+ end
759
+
760
+ # `CommitWorkspaceChanges` request message.
761
+ # @!attribute [rw] name
762
+ # @return [::String]
763
+ # Required. The workspace's name.
764
+ # @!attribute [rw] author
765
+ # @return [::Google::Cloud::Dataform::V1::CommitAuthor]
766
+ # Required. The commit's author.
767
+ # @!attribute [rw] commit_message
768
+ # @return [::String]
769
+ # Optional. The commit's message.
770
+ # @!attribute [rw] paths
771
+ # @return [::Array<::String>]
772
+ # Optional. Full file paths to commit including filename, rooted at workspace
773
+ # root. If left empty, all files will be committed.
774
+ class CommitWorkspaceChangesRequest
775
+ include ::Google::Protobuf::MessageExts
776
+ extend ::Google::Protobuf::MessageExts::ClassMethods
777
+ end
778
+
779
+ # `CommitWorkspaceChanges` response message.
780
+ class CommitWorkspaceChangesResponse
781
+ include ::Google::Protobuf::MessageExts
782
+ extend ::Google::Protobuf::MessageExts::ClassMethods
783
+ end
784
+
785
+ # `ResetWorkspaceChanges` request message.
786
+ # @!attribute [rw] name
787
+ # @return [::String]
788
+ # Required. The workspace's name.
789
+ # @!attribute [rw] paths
790
+ # @return [::Array<::String>]
791
+ # Optional. Full file paths to reset back to their committed state including
792
+ # filename, rooted at workspace root. If left empty, all files will be reset.
793
+ # @!attribute [rw] clean
794
+ # @return [::Boolean]
795
+ # Optional. If set to true, untracked files will be deleted.
796
+ class ResetWorkspaceChangesRequest
797
+ include ::Google::Protobuf::MessageExts
798
+ extend ::Google::Protobuf::MessageExts::ClassMethods
799
+ end
800
+
801
+ # `ResetWorkspaceChanges` response message.
802
+ class ResetWorkspaceChangesResponse
803
+ include ::Google::Protobuf::MessageExts
804
+ extend ::Google::Protobuf::MessageExts::ClassMethods
805
+ end
806
+
807
+ # `FetchFileDiff` request message.
808
+ # @!attribute [rw] workspace
809
+ # @return [::String]
810
+ # Required. The workspace's name.
811
+ # @!attribute [rw] path
812
+ # @return [::String]
813
+ # Required. The file's full path including filename, relative to the
814
+ # workspace root.
815
+ class FetchFileDiffRequest
816
+ include ::Google::Protobuf::MessageExts
817
+ extend ::Google::Protobuf::MessageExts::ClassMethods
818
+ end
819
+
820
+ # `FetchFileDiff` response message.
821
+ # @!attribute [rw] formatted_diff
822
+ # @return [::String]
823
+ # The raw formatted Git diff for the file.
824
+ class FetchFileDiffResponse
825
+ include ::Google::Protobuf::MessageExts
826
+ extend ::Google::Protobuf::MessageExts::ClassMethods
827
+ end
828
+
829
+ # `QueryDirectoryContents` request message.
830
+ # @!attribute [rw] workspace
831
+ # @return [::String]
832
+ # Required. The workspace's name.
833
+ # @!attribute [rw] path
834
+ # @return [::String]
835
+ # Optional. The directory's full path including directory name, relative to
836
+ # the workspace root. If left unset, the workspace root is used.
837
+ # @!attribute [rw] page_size
838
+ # @return [::Integer]
839
+ # Optional. Maximum number of paths to return. The server may return fewer
840
+ # items than requested. If unspecified, the server will pick an appropriate
841
+ # default.
842
+ # @!attribute [rw] page_token
843
+ # @return [::String]
844
+ # Optional. Page token received from a previous `QueryDirectoryContents`
845
+ # call. Provide this to retrieve the subsequent page.
846
+ #
847
+ # When paginating, all other parameters provided to
848
+ # `QueryDirectoryContents`, with the exception of `page_size`, must match the
849
+ # call that provided the page token.
850
+ class QueryDirectoryContentsRequest
851
+ include ::Google::Protobuf::MessageExts
852
+ extend ::Google::Protobuf::MessageExts::ClassMethods
853
+ end
854
+
855
+ # `QueryDirectoryContents` response message.
856
+ # @!attribute [rw] directory_entries
857
+ # @return [::Array<::Google::Cloud::Dataform::V1::DirectoryEntry>]
858
+ # List of entries in the directory.
859
+ # @!attribute [rw] next_page_token
860
+ # @return [::String]
861
+ # A token, which can be sent as `page_token` to retrieve the next page.
862
+ # If this field is omitted, there are no subsequent pages.
863
+ class QueryDirectoryContentsResponse
864
+ include ::Google::Protobuf::MessageExts
865
+ extend ::Google::Protobuf::MessageExts::ClassMethods
866
+ end
867
+
868
+ # Represents a single entry in a directory.
869
+ # @!attribute [rw] file
870
+ # @return [::String]
871
+ # A file in the directory.
872
+ #
873
+ # 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.
874
+ # @!attribute [rw] directory
875
+ # @return [::String]
876
+ # A child directory in the directory.
877
+ #
878
+ # 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.
879
+ class DirectoryEntry
880
+ include ::Google::Protobuf::MessageExts
881
+ extend ::Google::Protobuf::MessageExts::ClassMethods
882
+ end
883
+
884
+ # Configuration containing file search request parameters.
885
+ # @!attribute [rw] workspace
886
+ # @return [::String]
887
+ # Required. The workspace's name.
888
+ # @!attribute [rw] page_size
889
+ # @return [::Integer]
890
+ # Optional. Maximum number of search results to return. The server may return
891
+ # fewer items than requested. If unspecified, the server will pick an
892
+ # appropriate default.
893
+ # @!attribute [rw] page_token
894
+ # @return [::String]
895
+ # Optional. Page token received from a previous `SearchFilesRequest`
896
+ # call. Provide this to retrieve the subsequent page.
897
+ #
898
+ # When paginating, all other parameters provided to `SearchFilesRequest`,
899
+ # with the exception of `page_size`, must match the call that provided the
900
+ # page token.
901
+ # @!attribute [rw] filter
902
+ # @return [::String]
903
+ # Optional. Optional filter for the returned list in filtering format.
904
+ # Filtering is only currently supported on the `path` field.
905
+ # See https://google.aip.dev/160 for details.
906
+ class SearchFilesRequest
907
+ include ::Google::Protobuf::MessageExts
908
+ extend ::Google::Protobuf::MessageExts::ClassMethods
909
+ end
910
+
911
+ # Client-facing representation of a file search response.
912
+ # @!attribute [rw] search_results
913
+ # @return [::Array<::Google::Cloud::Dataform::V1::SearchResult>]
914
+ # List of matched results.
915
+ # @!attribute [rw] next_page_token
916
+ # @return [::String]
917
+ # Optional. A token, which can be sent as `page_token` to retrieve the next
918
+ # page. If this field is omitted, there are no subsequent pages.
919
+ class SearchFilesResponse
920
+ include ::Google::Protobuf::MessageExts
921
+ extend ::Google::Protobuf::MessageExts::ClassMethods
922
+ end
923
+
924
+ # Client-facing representation of a search result entry.
925
+ # @!attribute [rw] file
926
+ # @return [::Google::Cloud::Dataform::V1::FileSearchResult]
927
+ # Details when search result is a file.
928
+ #
929
+ # 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.
930
+ # @!attribute [rw] directory
931
+ # @return [::Google::Cloud::Dataform::V1::DirectorySearchResult]
932
+ # Details when search result is a directory.
933
+ #
934
+ # 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.
935
+ class SearchResult
936
+ include ::Google::Protobuf::MessageExts
937
+ extend ::Google::Protobuf::MessageExts::ClassMethods
938
+ end
939
+
940
+ # Client-facing representation of a file entry in search results.
941
+ # @!attribute [rw] path
942
+ # @return [::String]
943
+ # File system path relative to the workspace root.
944
+ class FileSearchResult
945
+ include ::Google::Protobuf::MessageExts
946
+ extend ::Google::Protobuf::MessageExts::ClassMethods
947
+ end
948
+
949
+ # Client-facing representation of a directory entry in search results.
950
+ # @!attribute [rw] path
951
+ # @return [::String]
952
+ # File system path relative to the workspace root.
953
+ class DirectorySearchResult
954
+ include ::Google::Protobuf::MessageExts
955
+ extend ::Google::Protobuf::MessageExts::ClassMethods
956
+ end
957
+
958
+ # `MakeDirectory` request message.
959
+ # @!attribute [rw] workspace
960
+ # @return [::String]
961
+ # Required. The workspace's name.
962
+ # @!attribute [rw] path
963
+ # @return [::String]
964
+ # Required. The directory's full path including directory name, relative to
965
+ # the workspace root.
966
+ class MakeDirectoryRequest
967
+ include ::Google::Protobuf::MessageExts
968
+ extend ::Google::Protobuf::MessageExts::ClassMethods
969
+ end
970
+
971
+ # `MakeDirectory` response message.
972
+ class MakeDirectoryResponse
973
+ include ::Google::Protobuf::MessageExts
974
+ extend ::Google::Protobuf::MessageExts::ClassMethods
975
+ end
976
+
977
+ # `RemoveDirectory` request message.
978
+ # @!attribute [rw] workspace
979
+ # @return [::String]
980
+ # Required. The workspace's name.
981
+ # @!attribute [rw] path
982
+ # @return [::String]
983
+ # Required. The directory's full path including directory name, relative to
984
+ # the workspace root.
985
+ class RemoveDirectoryRequest
986
+ include ::Google::Protobuf::MessageExts
987
+ extend ::Google::Protobuf::MessageExts::ClassMethods
988
+ end
989
+
990
+ # `RemoveDirectory` response message.
991
+ class RemoveDirectoryResponse
992
+ include ::Google::Protobuf::MessageExts
993
+ extend ::Google::Protobuf::MessageExts::ClassMethods
994
+ end
995
+
996
+ # `MoveDirectory` request message.
997
+ # @!attribute [rw] workspace
998
+ # @return [::String]
999
+ # Required. The workspace's name.
1000
+ # @!attribute [rw] path
1001
+ # @return [::String]
1002
+ # Required. The directory's full path including directory name, relative to
1003
+ # the workspace root.
1004
+ # @!attribute [rw] new_path
1005
+ # @return [::String]
1006
+ # Required. The new path for the directory including directory name, rooted
1007
+ # at workspace root.
1008
+ class MoveDirectoryRequest
1009
+ include ::Google::Protobuf::MessageExts
1010
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1011
+ end
1012
+
1013
+ # `MoveDirectory` response message.
1014
+ class MoveDirectoryResponse
1015
+ include ::Google::Protobuf::MessageExts
1016
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1017
+ end
1018
+
1019
+ # `ReadFile` request message.
1020
+ # @!attribute [rw] workspace
1021
+ # @return [::String]
1022
+ # Required. The workspace's name.
1023
+ # @!attribute [rw] path
1024
+ # @return [::String]
1025
+ # Required. The file's full path including filename, relative to the
1026
+ # workspace root.
1027
+ # @!attribute [rw] revision
1028
+ # @return [::String]
1029
+ # Optional. The Git revision of the file to return. If left empty, the
1030
+ # current contents of `path` will be returned.
1031
+ class ReadFileRequest
1032
+ include ::Google::Protobuf::MessageExts
1033
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1034
+ end
1035
+
1036
+ # `ReadFile` response message.
1037
+ # @!attribute [rw] file_contents
1038
+ # @return [::String]
1039
+ # The file's contents.
1040
+ class ReadFileResponse
1041
+ include ::Google::Protobuf::MessageExts
1042
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1043
+ end
1044
+
1045
+ # `RemoveFile` request message.
1046
+ # @!attribute [rw] workspace
1047
+ # @return [::String]
1048
+ # Required. The workspace's name.
1049
+ # @!attribute [rw] path
1050
+ # @return [::String]
1051
+ # Required. The file's full path including filename, relative to the
1052
+ # workspace root.
1053
+ class RemoveFileRequest
1054
+ include ::Google::Protobuf::MessageExts
1055
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1056
+ end
1057
+
1058
+ # `RemoveFile` response message.
1059
+ class RemoveFileResponse
1060
+ include ::Google::Protobuf::MessageExts
1061
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1062
+ end
1063
+
1064
+ # `MoveFile` request message.
1065
+ # @!attribute [rw] workspace
1066
+ # @return [::String]
1067
+ # Required. The workspace's name.
1068
+ # @!attribute [rw] path
1069
+ # @return [::String]
1070
+ # Required. The file's full path including filename, relative to the
1071
+ # workspace root.
1072
+ # @!attribute [rw] new_path
1073
+ # @return [::String]
1074
+ # Required. The file's new path including filename, relative to the workspace
1075
+ # root.
1076
+ class MoveFileRequest
1077
+ include ::Google::Protobuf::MessageExts
1078
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1079
+ end
1080
+
1081
+ # `MoveFile` response message.
1082
+ class MoveFileResponse
1083
+ include ::Google::Protobuf::MessageExts
1084
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1085
+ end
1086
+
1087
+ # `WriteFile` request message.
1088
+ # @!attribute [rw] workspace
1089
+ # @return [::String]
1090
+ # Required. The workspace's name.
1091
+ # @!attribute [rw] path
1092
+ # @return [::String]
1093
+ # Required. The file.
1094
+ # @!attribute [rw] contents
1095
+ # @return [::String]
1096
+ # Required. The file's contents.
1097
+ class WriteFileRequest
1098
+ include ::Google::Protobuf::MessageExts
1099
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1100
+ end
1101
+
1102
+ # `WriteFile` response message.
1103
+ class WriteFileResponse
1104
+ include ::Google::Protobuf::MessageExts
1105
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1106
+ end
1107
+
1108
+ # `InstallNpmPackages` request message.
1109
+ # @!attribute [rw] workspace
1110
+ # @return [::String]
1111
+ # Required. The workspace's name.
1112
+ class InstallNpmPackagesRequest
1113
+ include ::Google::Protobuf::MessageExts
1114
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1115
+ end
1116
+
1117
+ # `InstallNpmPackages` response message.
1118
+ class InstallNpmPackagesResponse
1119
+ include ::Google::Protobuf::MessageExts
1120
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1121
+ end
1122
+
1123
+ # Represents a Dataform release configuration.
1124
+ # @!attribute [rw] name
1125
+ # @return [::String]
1126
+ # Identifier. The release config's name.
1127
+ # @!attribute [rw] git_commitish
1128
+ # @return [::String]
1129
+ # Required. Git commit/tag/branch name at which the repository should be
1130
+ # compiled. Must exist in the remote repository. Examples:
1131
+ # - a commit SHA: `12ade345`
1132
+ # - a tag: `tag1`
1133
+ # - a branch name: `branch1`
1134
+ # @!attribute [rw] code_compilation_config
1135
+ # @return [::Google::Cloud::Dataform::V1::CodeCompilationConfig]
1136
+ # Optional. If set, fields of `code_compilation_config` override the default
1137
+ # compilation settings that are specified in dataform.json.
1138
+ # @!attribute [rw] cron_schedule
1139
+ # @return [::String]
1140
+ # Optional. Optional schedule (in cron format) for automatic creation of
1141
+ # compilation results.
1142
+ # @!attribute [rw] time_zone
1143
+ # @return [::String]
1144
+ # Optional. Specifies the time zone to be used when interpreting
1145
+ # cron_schedule. Must be a time zone name from the time zone database
1146
+ # (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left
1147
+ # unspecified, the default is UTC.
1148
+ # @!attribute [r] recent_scheduled_release_records
1149
+ # @return [::Array<::Google::Cloud::Dataform::V1::ReleaseConfig::ScheduledReleaseRecord>]
1150
+ # Output only. Records of the 10 most recent scheduled release attempts,
1151
+ # ordered in descending order of `release_time`. Updated whenever automatic
1152
+ # creation of a compilation result is triggered by cron_schedule.
1153
+ # @!attribute [rw] release_compilation_result
1154
+ # @return [::String]
1155
+ # Optional. The name of the currently released compilation result for this
1156
+ # release config. This value is updated when a compilation result is
1157
+ # automatically created from this release config (using cron_schedule), or
1158
+ # when this resource is updated by API call (perhaps to roll back to an
1159
+ # earlier release). The compilation result must have been created using this
1160
+ # release config. Must be in the format
1161
+ # `projects/*/locations/*/repositories/*/compilationResults/*`.
1162
+ # @!attribute [rw] disabled
1163
+ # @return [::Boolean]
1164
+ # Optional. Disables automatic creation of compilation results.
1165
+ # @!attribute [r] internal_metadata
1166
+ # @return [::String]
1167
+ # Output only. All the metadata information that is used internally to serve
1168
+ # the resource. For example: timestamps, flags, status fields, etc. The
1169
+ # format of this field is a JSON string.
1170
+ class ReleaseConfig
1171
+ include ::Google::Protobuf::MessageExts
1172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1173
+
1174
+ # A record of an attempt to create a compilation result for this release
1175
+ # config.
1176
+ # @!attribute [rw] compilation_result
1177
+ # @return [::String]
1178
+ # The name of the created compilation result, if one was successfully
1179
+ # created. Must be in the format
1180
+ # `projects/*/locations/*/repositories/*/compilationResults/*`.
1181
+ #
1182
+ # Note: The following fields are mutually exclusive: `compilation_result`, `error_status`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1183
+ # @!attribute [rw] error_status
1184
+ # @return [::Google::Rpc::Status]
1185
+ # The error status encountered upon this attempt to create the
1186
+ # compilation result, if the attempt was unsuccessful.
1187
+ #
1188
+ # Note: The following fields are mutually exclusive: `error_status`, `compilation_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1189
+ # @!attribute [r] release_time
1190
+ # @return [::Google::Protobuf::Timestamp]
1191
+ # Output only. The timestamp of this release attempt.
1192
+ class ScheduledReleaseRecord
1193
+ include ::Google::Protobuf::MessageExts
1194
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1195
+ end
1196
+ end
1197
+
1198
+ # `ListReleaseConfigs` request message.
1199
+ # @!attribute [rw] parent
1200
+ # @return [::String]
1201
+ # Required. The repository in which to list release configs. Must be in the
1202
+ # format `projects/*/locations/*/repositories/*`.
1203
+ # @!attribute [rw] page_size
1204
+ # @return [::Integer]
1205
+ # Optional. Maximum number of release configs to return. The server may
1206
+ # return fewer items than requested. If unspecified, the server will pick an
1207
+ # appropriate default.
1208
+ # @!attribute [rw] page_token
1209
+ # @return [::String]
1210
+ # Optional. Page token received from a previous `ListReleaseConfigs` call.
1211
+ # Provide this to retrieve the subsequent page.
1212
+ #
1213
+ # When paginating, all other parameters provided to `ListReleaseConfigs`,
1214
+ # with the exception of `page_size`, must match the call that provided the
1215
+ # page token.
1216
+ class ListReleaseConfigsRequest
1217
+ include ::Google::Protobuf::MessageExts
1218
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1219
+ end
1220
+
1221
+ # `ListReleaseConfigs` response message.
1222
+ # @!attribute [rw] release_configs
1223
+ # @return [::Array<::Google::Cloud::Dataform::V1::ReleaseConfig>]
1224
+ # List of release configs.
1225
+ # @!attribute [rw] next_page_token
1226
+ # @return [::String]
1227
+ # A token, which can be sent as `page_token` to retrieve the next page.
1228
+ # If this field is omitted, there are no subsequent pages.
1229
+ # @!attribute [rw] unreachable
1230
+ # @return [::Array<::String>]
1231
+ # Locations which could not be reached.
1232
+ class ListReleaseConfigsResponse
1233
+ include ::Google::Protobuf::MessageExts
1234
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1235
+ end
1236
+
1237
+ # `GetReleaseConfig` request message.
1238
+ # @!attribute [rw] name
1239
+ # @return [::String]
1240
+ # Required. The release config's name.
1241
+ class GetReleaseConfigRequest
1242
+ include ::Google::Protobuf::MessageExts
1243
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1244
+ end
1245
+
1246
+ # `CreateReleaseConfig` request message.
1247
+ # @!attribute [rw] parent
1248
+ # @return [::String]
1249
+ # Required. The repository in which to create the release config. Must be in
1250
+ # the format `projects/*/locations/*/repositories/*`.
1251
+ # @!attribute [rw] release_config
1252
+ # @return [::Google::Cloud::Dataform::V1::ReleaseConfig]
1253
+ # Required. The release config to create.
1254
+ # @!attribute [rw] release_config_id
1255
+ # @return [::String]
1256
+ # Required. The ID to use for the release config, which will become the final
1257
+ # component of the release config's resource name.
1258
+ class CreateReleaseConfigRequest
1259
+ include ::Google::Protobuf::MessageExts
1260
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1261
+ end
1262
+
1263
+ # `UpdateReleaseConfig` request message.
1264
+ # @!attribute [rw] update_mask
1265
+ # @return [::Google::Protobuf::FieldMask]
1266
+ # Optional. Specifies the fields to be updated in the release config. If left
1267
+ # unset, all fields will be updated.
1268
+ # @!attribute [rw] release_config
1269
+ # @return [::Google::Cloud::Dataform::V1::ReleaseConfig]
1270
+ # Required. The release config to update.
1271
+ class UpdateReleaseConfigRequest
1272
+ include ::Google::Protobuf::MessageExts
1273
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1274
+ end
1275
+
1276
+ # `DeleteReleaseConfig` request message.
1277
+ # @!attribute [rw] name
1278
+ # @return [::String]
1279
+ # Required. The release config's name.
1280
+ class DeleteReleaseConfigRequest
1281
+ include ::Google::Protobuf::MessageExts
1282
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1283
+ end
1284
+
1285
+ # Represents the result of compiling a Dataform project.
1286
+ # @!attribute [rw] git_commitish
1287
+ # @return [::String]
1288
+ # Immutable. Git commit/tag/branch name at which the repository should be
1289
+ # compiled. Must exist in the remote repository. Examples:
1290
+ # - a commit SHA: `12ade345`
1291
+ # - a tag: `tag1`
1292
+ # - a branch name: `branch1`
1293
+ #
1294
+ # Note: The following fields are mutually exclusive: `git_commitish`, `workspace`, `release_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1295
+ # @!attribute [rw] workspace
1296
+ # @return [::String]
1297
+ # Immutable. The name of the workspace to compile. Must be in the format
1298
+ # `projects/*/locations/*/repositories/*/workspaces/*`.
1299
+ #
1300
+ # Note: The following fields are mutually exclusive: `workspace`, `git_commitish`, `release_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1301
+ # @!attribute [rw] release_config
1302
+ # @return [::String]
1303
+ # Immutable. The name of the release config to compile. Must be in the
1304
+ # format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
1305
+ #
1306
+ # Note: The following fields are mutually exclusive: `release_config`, `git_commitish`, `workspace`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1307
+ # @!attribute [r] name
1308
+ # @return [::String]
1309
+ # Output only. The compilation result's name.
1310
+ # @!attribute [rw] code_compilation_config
1311
+ # @return [::Google::Cloud::Dataform::V1::CodeCompilationConfig]
1312
+ # Immutable. If set, fields of `code_compilation_config` override the default
1313
+ # compilation settings that are specified in dataform.json.
1314
+ # @!attribute [r] resolved_git_commit_sha
1315
+ # @return [::String]
1316
+ # Output only. The fully resolved Git commit SHA of the code that was
1317
+ # compiled. Not set for compilation results whose source is a workspace.
1318
+ # @!attribute [r] dataform_core_version
1319
+ # @return [::String]
1320
+ # Output only. The version of `@dataform/core` that was used for compilation.
1321
+ # @!attribute [r] compilation_errors
1322
+ # @return [::Array<::Google::Cloud::Dataform::V1::CompilationResult::CompilationError>]
1323
+ # Output only. Errors encountered during project compilation.
1324
+ # @!attribute [r] data_encryption_state
1325
+ # @return [::Google::Cloud::Dataform::V1::DataEncryptionState]
1326
+ # Output only. Only set if the repository has a KMS Key.
1327
+ # @!attribute [r] create_time
1328
+ # @return [::Google::Protobuf::Timestamp]
1329
+ # Output only. The timestamp of when the compilation result was created.
1330
+ # @!attribute [r] internal_metadata
1331
+ # @return [::String]
1332
+ # Output only. All the metadata information that is used internally to serve
1333
+ # the resource. For example: timestamps, flags, status fields, etc. The
1334
+ # format of this field is a JSON string.
1335
+ class CompilationResult
1336
+ include ::Google::Protobuf::MessageExts
1337
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1338
+
1339
+ # An error encountered when attempting to compile a Dataform project.
1340
+ # @!attribute [r] message
1341
+ # @return [::String]
1342
+ # Output only. The error's top level message.
1343
+ # @!attribute [r] stack
1344
+ # @return [::String]
1345
+ # Output only. The error's full stack trace.
1346
+ # @!attribute [r] path
1347
+ # @return [::String]
1348
+ # Output only. The path of the file where this error occurred, if
1349
+ # available, relative to the project root.
1350
+ # @!attribute [r] action_target
1351
+ # @return [::Google::Cloud::Dataform::V1::Target]
1352
+ # Output only. The identifier of the action where this error occurred, if
1353
+ # available.
1354
+ class CompilationError
1355
+ include ::Google::Protobuf::MessageExts
1356
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1357
+ end
1358
+ end
1359
+
1360
+ # Configures various aspects of Dataform code compilation.
1361
+ # @!attribute [rw] default_database
1362
+ # @return [::String]
1363
+ # Optional. The default database (Google Cloud project ID).
1364
+ # @!attribute [rw] default_schema
1365
+ # @return [::String]
1366
+ # Optional. The default schema (BigQuery dataset ID).
1367
+ # @!attribute [rw] default_location
1368
+ # @return [::String]
1369
+ # Optional. The default BigQuery location to use. Defaults to "US".
1370
+ # See the BigQuery docs for a full list of locations:
1371
+ # https://cloud.google.com/bigquery/docs/locations.
1372
+ # @!attribute [rw] assertion_schema
1373
+ # @return [::String]
1374
+ # Optional. The default schema (BigQuery dataset ID) for assertions.
1375
+ # @!attribute [rw] vars
1376
+ # @return [::Google::Protobuf::Map{::String => ::String}]
1377
+ # Optional. User-defined variables that are made available to project code
1378
+ # during compilation.
1379
+ # @!attribute [rw] database_suffix
1380
+ # @return [::String]
1381
+ # Optional. The suffix that should be appended to all database (Google Cloud
1382
+ # project ID) names.
1383
+ # @!attribute [rw] schema_suffix
1384
+ # @return [::String]
1385
+ # Optional. The suffix that should be appended to all schema (BigQuery
1386
+ # dataset ID) names.
1387
+ # @!attribute [rw] table_prefix
1388
+ # @return [::String]
1389
+ # Optional. The prefix that should be prepended to all table names.
1390
+ # @!attribute [rw] builtin_assertion_name_prefix
1391
+ # @return [::String]
1392
+ # Optional. The prefix to prepend to built-in assertion names.
1393
+ # @!attribute [rw] default_notebook_runtime_options
1394
+ # @return [::Google::Cloud::Dataform::V1::NotebookRuntimeOptions]
1395
+ # Optional. The default notebook runtime options.
1396
+ class CodeCompilationConfig
1397
+ include ::Google::Protobuf::MessageExts
1398
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1399
+
1400
+ # @!attribute [rw] key
1401
+ # @return [::String]
1402
+ # @!attribute [rw] value
1403
+ # @return [::String]
1404
+ class VarsEntry
1405
+ include ::Google::Protobuf::MessageExts
1406
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1407
+ end
1408
+ end
1409
+
1410
+ # Configures various aspects of Dataform notebook runtime.
1411
+ # @!attribute [rw] gcs_output_bucket
1412
+ # @return [::String]
1413
+ # Optional. The Google Cloud Storage location to upload the result to.
1414
+ # Format: `gs://bucket-name`.
1415
+ # @!attribute [rw] ai_platform_notebook_runtime_template
1416
+ # @return [::String]
1417
+ # Optional. The resource name of the [Colab runtime template]
1418
+ # (https://cloud.google.com/colab/docs/runtimes), from which a runtime is
1419
+ # created for notebook executions. If not specified, a runtime is created
1420
+ # with Colab's default specifications.
1421
+ class NotebookRuntimeOptions
1422
+ include ::Google::Protobuf::MessageExts
1423
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1424
+ end
1425
+
1426
+ # `ListCompilationResults` request message.
1427
+ # @!attribute [rw] parent
1428
+ # @return [::String]
1429
+ # Required. The repository in which to list compilation results. Must be in
1430
+ # the format `projects/*/locations/*/repositories/*`.
1431
+ # @!attribute [rw] page_size
1432
+ # @return [::Integer]
1433
+ # Optional. Maximum number of compilation results to return. The server may
1434
+ # return fewer items than requested. If unspecified, the server will pick an
1435
+ # appropriate default.
1436
+ # @!attribute [rw] page_token
1437
+ # @return [::String]
1438
+ # Optional. Page token received from a previous `ListCompilationResults`
1439
+ # call. Provide this to retrieve the subsequent page.
1440
+ #
1441
+ # When paginating, all other parameters provided to `ListCompilationResults`,
1442
+ # with the exception of `page_size`, must match the call that provided the
1443
+ # page token.
1444
+ # @!attribute [rw] order_by
1445
+ # @return [::String]
1446
+ # Optional. This field only supports ordering by `name` and `create_time`.
1447
+ # If unspecified, the server will choose the ordering.
1448
+ # If specified, the default order is ascending for the `name` field.
1449
+ # @!attribute [rw] filter
1450
+ # @return [::String]
1451
+ # Optional. Filter for the returned list.
1452
+ class ListCompilationResultsRequest
1453
+ include ::Google::Protobuf::MessageExts
1454
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1455
+ end
1456
+
1457
+ # `ListCompilationResults` response message.
1458
+ # @!attribute [rw] compilation_results
1459
+ # @return [::Array<::Google::Cloud::Dataform::V1::CompilationResult>]
1460
+ # List of compilation results.
1461
+ # @!attribute [rw] next_page_token
1462
+ # @return [::String]
1463
+ # A token, which can be sent as `page_token` to retrieve the next page.
1464
+ # If this field is omitted, there are no subsequent pages.
1465
+ # @!attribute [rw] unreachable
1466
+ # @return [::Array<::String>]
1467
+ # Locations which could not be reached.
1468
+ class ListCompilationResultsResponse
1469
+ include ::Google::Protobuf::MessageExts
1470
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1471
+ end
1472
+
1473
+ # `GetCompilationResult` request message.
1474
+ # @!attribute [rw] name
1475
+ # @return [::String]
1476
+ # Required. The compilation result's name.
1477
+ class GetCompilationResultRequest
1478
+ include ::Google::Protobuf::MessageExts
1479
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1480
+ end
1481
+
1482
+ # `CreateCompilationResult` request message.
1483
+ # @!attribute [rw] parent
1484
+ # @return [::String]
1485
+ # Required. The repository in which to create the compilation result. Must be
1486
+ # in the format `projects/*/locations/*/repositories/*`.
1487
+ # @!attribute [rw] compilation_result
1488
+ # @return [::Google::Cloud::Dataform::V1::CompilationResult]
1489
+ # Required. The compilation result to create.
1490
+ class CreateCompilationResultRequest
1491
+ include ::Google::Protobuf::MessageExts
1492
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1493
+ end
1494
+
1495
+ # Represents an action identifier. If the action writes output, the output
1496
+ # will be written to the referenced database object.
1497
+ # @!attribute [rw] database
1498
+ # @return [::String]
1499
+ # Optional. The action's database (Google Cloud project ID) .
1500
+ # @!attribute [rw] schema
1501
+ # @return [::String]
1502
+ # Optional. The action's schema (BigQuery dataset ID), within `database`.
1503
+ # @!attribute [rw] name
1504
+ # @return [::String]
1505
+ # Optional. The action's name, within `database` and `schema`.
1506
+ class Target
1507
+ include ::Google::Protobuf::MessageExts
1508
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1509
+ end
1510
+
1511
+ # Describes a relation and its columns.
1512
+ # @!attribute [rw] description
1513
+ # @return [::String]
1514
+ # A text description of the relation.
1515
+ # @!attribute [rw] columns
1516
+ # @return [::Array<::Google::Cloud::Dataform::V1::RelationDescriptor::ColumnDescriptor>]
1517
+ # A list of descriptions of columns within the relation.
1518
+ # @!attribute [rw] bigquery_labels
1519
+ # @return [::Google::Protobuf::Map{::String => ::String}]
1520
+ # A set of BigQuery labels that should be applied to the relation.
1521
+ class RelationDescriptor
1522
+ include ::Google::Protobuf::MessageExts
1523
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1524
+
1525
+ # Describes a column.
1526
+ # @!attribute [rw] path
1527
+ # @return [::Array<::String>]
1528
+ # The identifier for the column. Each entry in `path` represents one level
1529
+ # of nesting.
1530
+ # @!attribute [rw] description
1531
+ # @return [::String]
1532
+ # A textual description of the column.
1533
+ # @!attribute [rw] bigquery_policy_tags
1534
+ # @return [::Array<::String>]
1535
+ # A list of BigQuery policy tags that will be applied to the column.
1536
+ class ColumnDescriptor
1537
+ include ::Google::Protobuf::MessageExts
1538
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1539
+ end
1540
+
1541
+ # @!attribute [rw] key
1542
+ # @return [::String]
1543
+ # @!attribute [rw] value
1544
+ # @return [::String]
1545
+ class BigqueryLabelsEntry
1546
+ include ::Google::Protobuf::MessageExts
1547
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1548
+ end
1549
+ end
1550
+
1551
+ # Represents a single Dataform action in a compilation result.
1552
+ # @!attribute [rw] relation
1553
+ # @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation]
1554
+ # The database relation created/updated by this action.
1555
+ #
1556
+ # Note: The following fields are mutually exclusive: `relation`, `operations`, `assertion`, `declaration`, `notebook`, `data_preparation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1557
+ # @!attribute [rw] operations
1558
+ # @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Operations]
1559
+ # The database operations executed by this action.
1560
+ #
1561
+ # Note: The following fields are mutually exclusive: `operations`, `relation`, `assertion`, `declaration`, `notebook`, `data_preparation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1562
+ # @!attribute [rw] assertion
1563
+ # @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Assertion]
1564
+ # The assertion executed by this action.
1565
+ #
1566
+ # Note: The following fields are mutually exclusive: `assertion`, `relation`, `operations`, `declaration`, `notebook`, `data_preparation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1567
+ # @!attribute [rw] declaration
1568
+ # @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Declaration]
1569
+ # The declaration declared by this action.
1570
+ #
1571
+ # Note: The following fields are mutually exclusive: `declaration`, `relation`, `operations`, `assertion`, `notebook`, `data_preparation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1572
+ # @!attribute [rw] notebook
1573
+ # @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Notebook]
1574
+ # The notebook executed by this action.
1575
+ #
1576
+ # Note: The following fields are mutually exclusive: `notebook`, `relation`, `operations`, `assertion`, `declaration`, `data_preparation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1577
+ # @!attribute [rw] data_preparation
1578
+ # @return [::Google::Cloud::Dataform::V1::CompilationResultAction::DataPreparation]
1579
+ # The data preparation executed by this action.
1580
+ #
1581
+ # Note: The following fields are mutually exclusive: `data_preparation`, `relation`, `operations`, `assertion`, `declaration`, `notebook`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1582
+ # @!attribute [rw] target
1583
+ # @return [::Google::Cloud::Dataform::V1::Target]
1584
+ # This action's identifier. Unique within the compilation result.
1585
+ # @!attribute [rw] canonical_target
1586
+ # @return [::Google::Cloud::Dataform::V1::Target]
1587
+ # The action's identifier if the project had been compiled without any
1588
+ # overrides configured. Unique within the compilation result.
1589
+ # @!attribute [rw] file_path
1590
+ # @return [::String]
1591
+ # The full path including filename in which this action is located, relative
1592
+ # to the workspace root.
1593
+ # @!attribute [r] internal_metadata
1594
+ # @return [::String]
1595
+ # Output only. All the metadata information that is used internally to serve
1596
+ # the resource. For example: timestamps, flags, status fields, etc. The
1597
+ # format of this field is a JSON string.
1598
+ class CompilationResultAction
1599
+ include ::Google::Protobuf::MessageExts
1600
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1601
+
1602
+ # Represents a database relation.
1603
+ # @!attribute [rw] dependency_targets
1604
+ # @return [::Array<::Google::Cloud::Dataform::V1::Target>]
1605
+ # A list of actions that this action depends on.
1606
+ # @!attribute [rw] disabled
1607
+ # @return [::Boolean]
1608
+ # Whether this action is disabled (i.e. should not be run).
1609
+ # @!attribute [rw] tags
1610
+ # @return [::Array<::String>]
1611
+ # Arbitrary, user-defined tags on this action.
1612
+ # @!attribute [rw] relation_descriptor
1613
+ # @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
1614
+ # Descriptor for the relation and its columns.
1615
+ # @!attribute [rw] relation_type
1616
+ # @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::RelationType]
1617
+ # The type of this relation.
1618
+ # @!attribute [rw] select_query
1619
+ # @return [::String]
1620
+ # The SELECT query which returns rows which this relation should contain.
1621
+ # @!attribute [rw] pre_operations
1622
+ # @return [::Array<::String>]
1623
+ # SQL statements to be executed before creating the relation.
1624
+ # @!attribute [rw] post_operations
1625
+ # @return [::Array<::String>]
1626
+ # SQL statements to be executed after creating the relation.
1627
+ # @!attribute [rw] incremental_table_config
1628
+ # @return [::Google::Cloud::Dataform::V1::CompilationResultAction::Relation::IncrementalTableConfig]
1629
+ # Configures `INCREMENTAL_TABLE` settings for this relation. Only set if
1630
+ # `relation_type` is `INCREMENTAL_TABLE`.
1631
+ # @!attribute [rw] partition_expression
1632
+ # @return [::String]
1633
+ # The SQL expression used to partition the relation.
1634
+ # @!attribute [rw] cluster_expressions
1635
+ # @return [::Array<::String>]
1636
+ # A list of columns or SQL expressions used to cluster the table.
1637
+ # @!attribute [rw] partition_expiration_days
1638
+ # @return [::Integer]
1639
+ # Sets the partition expiration in days.
1640
+ # @!attribute [rw] require_partition_filter
1641
+ # @return [::Boolean]
1642
+ # Specifies whether queries on this table must include a predicate filter
1643
+ # that filters on the partitioning column.
1644
+ # @!attribute [rw] additional_options
1645
+ # @return [::Google::Protobuf::Map{::String => ::String}]
1646
+ # Additional options that will be provided as key/value pairs into the
1647
+ # options clause of a create table/view statement. See
1648
+ # https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language
1649
+ # for more information on which options are supported.
1650
+ class Relation
1651
+ include ::Google::Protobuf::MessageExts
1652
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1653
+
1654
+ # Contains settings for relations of type `INCREMENTAL_TABLE`.
1655
+ # @!attribute [rw] incremental_select_query
1656
+ # @return [::String]
1657
+ # The SELECT query which returns rows which should be inserted into the
1658
+ # relation if it already exists and is not being refreshed.
1659
+ # @!attribute [rw] refresh_disabled
1660
+ # @return [::Boolean]
1661
+ # Whether this table should be protected from being refreshed.
1662
+ # @!attribute [rw] unique_key_parts
1663
+ # @return [::Array<::String>]
1664
+ # A set of columns or SQL expressions used to define row uniqueness.
1665
+ # If any duplicates are discovered (as defined by `unique_key_parts`),
1666
+ # only the newly selected rows (as defined by `incremental_select_query`)
1667
+ # will be included in the relation.
1668
+ # @!attribute [rw] update_partition_filter
1669
+ # @return [::String]
1670
+ # A SQL expression conditional used to limit the set of existing rows
1671
+ # considered for a merge operation (see `unique_key_parts` for more
1672
+ # information).
1673
+ # @!attribute [rw] incremental_pre_operations
1674
+ # @return [::Array<::String>]
1675
+ # SQL statements to be executed before inserting new rows into the
1676
+ # relation.
1677
+ # @!attribute [rw] incremental_post_operations
1678
+ # @return [::Array<::String>]
1679
+ # SQL statements to be executed after inserting new rows into the
1680
+ # relation.
1681
+ class IncrementalTableConfig
1682
+ include ::Google::Protobuf::MessageExts
1683
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1684
+ end
1685
+
1686
+ # @!attribute [rw] key
1687
+ # @return [::String]
1688
+ # @!attribute [rw] value
1689
+ # @return [::String]
1690
+ class AdditionalOptionsEntry
1691
+ include ::Google::Protobuf::MessageExts
1692
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1693
+ end
1694
+
1695
+ # Indicates the type of this relation.
1696
+ module RelationType
1697
+ # Default value. This value is unused.
1698
+ RELATION_TYPE_UNSPECIFIED = 0
1699
+
1700
+ # The relation is a table.
1701
+ TABLE = 1
1702
+
1703
+ # The relation is a view.
1704
+ VIEW = 2
1705
+
1706
+ # The relation is an incrementalized table.
1707
+ INCREMENTAL_TABLE = 3
1708
+
1709
+ # The relation is a materialized view.
1710
+ MATERIALIZED_VIEW = 4
1711
+ end
1712
+ end
1713
+
1714
+ # Represents a list of arbitrary database operations.
1715
+ # @!attribute [rw] dependency_targets
1716
+ # @return [::Array<::Google::Cloud::Dataform::V1::Target>]
1717
+ # A list of actions that this action depends on.
1718
+ # @!attribute [rw] disabled
1719
+ # @return [::Boolean]
1720
+ # Whether this action is disabled (i.e. should not be run).
1721
+ # @!attribute [rw] tags
1722
+ # @return [::Array<::String>]
1723
+ # Arbitrary, user-defined tags on this action.
1724
+ # @!attribute [rw] relation_descriptor
1725
+ # @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
1726
+ # Descriptor for any output relation and its columns. Only set if
1727
+ # `has_output` is true.
1728
+ # @!attribute [rw] queries
1729
+ # @return [::Array<::String>]
1730
+ # A list of arbitrary SQL statements that will be executed without
1731
+ # alteration.
1732
+ # @!attribute [rw] has_output
1733
+ # @return [::Boolean]
1734
+ # Whether these operations produce an output relation.
1735
+ class Operations
1736
+ include ::Google::Protobuf::MessageExts
1737
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1738
+ end
1739
+
1740
+ # Represents an assertion upon a SQL query which is required return zero
1741
+ # rows.
1742
+ # @!attribute [rw] dependency_targets
1743
+ # @return [::Array<::Google::Cloud::Dataform::V1::Target>]
1744
+ # A list of actions that this action depends on.
1745
+ # @!attribute [rw] parent_action
1746
+ # @return [::Google::Cloud::Dataform::V1::Target]
1747
+ # The parent action of this assertion. Only set if this assertion was
1748
+ # automatically generated.
1749
+ # @!attribute [rw] disabled
1750
+ # @return [::Boolean]
1751
+ # Whether this action is disabled (i.e. should not be run).
1752
+ # @!attribute [rw] tags
1753
+ # @return [::Array<::String>]
1754
+ # Arbitrary, user-defined tags on this action.
1755
+ # @!attribute [rw] select_query
1756
+ # @return [::String]
1757
+ # The SELECT query which must return zero rows in order for this assertion
1758
+ # to succeed.
1759
+ # @!attribute [rw] relation_descriptor
1760
+ # @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
1761
+ # Descriptor for the assertion's automatically-generated view and its
1762
+ # columns.
1763
+ class Assertion
1764
+ include ::Google::Protobuf::MessageExts
1765
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1766
+ end
1767
+
1768
+ # Represents a relation which is not managed by Dataform but which may be
1769
+ # referenced by Dataform actions.
1770
+ # @!attribute [rw] relation_descriptor
1771
+ # @return [::Google::Cloud::Dataform::V1::RelationDescriptor]
1772
+ # Descriptor for the relation and its columns. Used as documentation only,
1773
+ # i.e. values here will result in no changes to the relation's metadata.
1774
+ class Declaration
1775
+ include ::Google::Protobuf::MessageExts
1776
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1777
+ end
1778
+
1779
+ # Represents a notebook.
1780
+ # @!attribute [rw] dependency_targets
1781
+ # @return [::Array<::Google::Cloud::Dataform::V1::Target>]
1782
+ # A list of actions that this action depends on.
1783
+ # @!attribute [rw] disabled
1784
+ # @return [::Boolean]
1785
+ # Whether this action is disabled (i.e. should not be run).
1786
+ # @!attribute [rw] contents
1787
+ # @return [::String]
1788
+ # The contents of the notebook.
1789
+ # @!attribute [rw] tags
1790
+ # @return [::Array<::String>]
1791
+ # Arbitrary, user-defined tags on this action.
1792
+ class Notebook
1793
+ include ::Google::Protobuf::MessageExts
1794
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1795
+ end
1796
+
1797
+ # Defines a compiled Data Preparation entity
1798
+ # @!attribute [rw] contents_yaml
1799
+ # @return [::String]
1800
+ # The data preparation definition, stored as a YAML string.
1801
+ #
1802
+ # Note: The following fields are mutually exclusive: `contents_yaml`, `contents_sql`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1803
+ # @!attribute [rw] contents_sql
1804
+ # @return [::Google::Cloud::Dataform::V1::CompilationResultAction::DataPreparation::SqlDefinition]
1805
+ # SQL definition for a Data Preparation. Contains a SQL query and
1806
+ # additional context information.
1807
+ #
1808
+ # Note: The following fields are mutually exclusive: `contents_sql`, `contents_yaml`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1809
+ # @!attribute [rw] dependency_targets
1810
+ # @return [::Array<::Google::Cloud::Dataform::V1::Target>]
1811
+ # A list of actions that this action depends on.
1812
+ # @!attribute [rw] disabled
1813
+ # @return [::Boolean]
1814
+ # Whether this action is disabled (i.e. should not be run).
1815
+ # @!attribute [rw] tags
1816
+ # @return [::Array<::String>]
1817
+ # Arbitrary, user-defined tags on this action.
1818
+ class DataPreparation
1819
+ include ::Google::Protobuf::MessageExts
1820
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1821
+
1822
+ # Definition of a SQL Data Preparation
1823
+ # @!attribute [rw] query
1824
+ # @return [::String]
1825
+ # The SQL query representing the data preparation steps. Formatted as a
1826
+ # Pipe SQL query statement.
1827
+ # @!attribute [rw] error_table
1828
+ # @return [::Google::Cloud::Dataform::V1::CompilationResultAction::DataPreparation::ErrorTable]
1829
+ # Error table configuration,
1830
+ # @!attribute [rw] load
1831
+ # @return [::Google::Cloud::Dataform::V1::CompilationResultAction::LoadConfig]
1832
+ # Load configuration.
1833
+ class SqlDefinition
1834
+ include ::Google::Protobuf::MessageExts
1835
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1836
+ end
1837
+
1838
+ # Error table information, used to write error data into a BigQuery
1839
+ # table.
1840
+ # @!attribute [rw] target
1841
+ # @return [::Google::Cloud::Dataform::V1::Target]
1842
+ # Error Table target.
1843
+ # @!attribute [rw] retention_days
1844
+ # @return [::Integer]
1845
+ # Error table partition expiration in days. Only positive values are
1846
+ # allowed.
1847
+ class ErrorTable
1848
+ include ::Google::Protobuf::MessageExts
1849
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1850
+ end
1851
+ end
1852
+
1853
+ # Simplified load configuration for actions
1854
+ # @!attribute [rw] replace
1855
+ # @return [::Google::Cloud::Dataform::V1::CompilationResultAction::SimpleLoadMode]
1856
+ # Replace destination table
1857
+ #
1858
+ # Note: The following fields are mutually exclusive: `replace`, `append`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1859
+ # @!attribute [rw] append
1860
+ # @return [::Google::Cloud::Dataform::V1::CompilationResultAction::SimpleLoadMode]
1861
+ # Append into destination table
1862
+ #
1863
+ # Note: The following fields are mutually exclusive: `append`, `replace`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1864
+ # @!attribute [rw] maximum
1865
+ # @return [::Google::Cloud::Dataform::V1::CompilationResultAction::IncrementalLoadMode]
1866
+ # Insert records where the value exceeds the previous maximum value for a
1867
+ # column in the destination table
1868
+ #
1869
+ # Note: The following fields are mutually exclusive: `maximum`, `replace`, `append`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1870
+ # @!attribute [rw] unique
1871
+ # @return [::Google::Cloud::Dataform::V1::CompilationResultAction::IncrementalLoadMode]
1872
+ # Insert records where the value of a column is not already present in
1873
+ # the destination table
1874
+ #
1875
+ # Note: The following fields are mutually exclusive: `unique`, `replace`, `append`, `maximum`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1876
+ class LoadConfig
1877
+ include ::Google::Protobuf::MessageExts
1878
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1879
+ end
1880
+
1881
+ # Simple load definition
1882
+ class SimpleLoadMode
1883
+ include ::Google::Protobuf::MessageExts
1884
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1885
+ end
1886
+
1887
+ # Load definition for incremental load modes
1888
+ # @!attribute [rw] column
1889
+ # @return [::String]
1890
+ # Column name for incremental load modes
1891
+ class IncrementalLoadMode
1892
+ include ::Google::Protobuf::MessageExts
1893
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1894
+ end
1895
+ end
1896
+
1897
+ # `QueryCompilationResultActions` request message.
1898
+ # @!attribute [rw] name
1899
+ # @return [::String]
1900
+ # Required. The compilation result's name.
1901
+ # @!attribute [rw] page_size
1902
+ # @return [::Integer]
1903
+ # Optional. Maximum number of compilation results to return. The server may
1904
+ # return fewer items than requested. If unspecified, the server will pick an
1905
+ # appropriate default.
1906
+ # @!attribute [rw] page_token
1907
+ # @return [::String]
1908
+ # Optional. Page token received from a previous
1909
+ # `QueryCompilationResultActions` call. Provide this to retrieve the
1910
+ # subsequent page.
1911
+ #
1912
+ # When paginating, all other parameters provided to
1913
+ # `QueryCompilationResultActions`, with the exception of `page_size`, must
1914
+ # match the call that provided the page token.
1915
+ # @!attribute [rw] filter
1916
+ # @return [::String]
1917
+ # Optional. Optional filter for the returned list. Filtering is only
1918
+ # currently supported on the `file_path` field.
1919
+ class QueryCompilationResultActionsRequest
1920
+ include ::Google::Protobuf::MessageExts
1921
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1922
+ end
1923
+
1924
+ # `QueryCompilationResultActions` response message.
1925
+ # @!attribute [rw] compilation_result_actions
1926
+ # @return [::Array<::Google::Cloud::Dataform::V1::CompilationResultAction>]
1927
+ # List of compilation result actions.
1928
+ # @!attribute [rw] next_page_token
1929
+ # @return [::String]
1930
+ # A token, which can be sent as `page_token` to retrieve the next page.
1931
+ # If this field is omitted, there are no subsequent pages.
1932
+ class QueryCompilationResultActionsResponse
1933
+ include ::Google::Protobuf::MessageExts
1934
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1935
+ end
1936
+
1937
+ # Represents a Dataform workflow configuration.
1938
+ # @!attribute [rw] name
1939
+ # @return [::String]
1940
+ # Identifier. The workflow config's name.
1941
+ # @!attribute [rw] release_config
1942
+ # @return [::String]
1943
+ # Required. The name of the release config whose release_compilation_result
1944
+ # should be executed. Must be in the format
1945
+ # `projects/*/locations/*/repositories/*/releaseConfigs/*`.
1946
+ # @!attribute [rw] invocation_config
1947
+ # @return [::Google::Cloud::Dataform::V1::InvocationConfig]
1948
+ # Optional. If left unset, a default InvocationConfig will be used.
1949
+ # @!attribute [rw] cron_schedule
1950
+ # @return [::String]
1951
+ # Optional. Optional schedule (in cron format) for automatic execution of
1952
+ # this workflow config.
1953
+ # @!attribute [rw] time_zone
1954
+ # @return [::String]
1955
+ # Optional. Specifies the time zone to be used when interpreting
1956
+ # cron_schedule. Must be a time zone name from the time zone database
1957
+ # (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left
1958
+ # unspecified, the default is UTC.
1959
+ # @!attribute [r] recent_scheduled_execution_records
1960
+ # @return [::Array<::Google::Cloud::Dataform::V1::WorkflowConfig::ScheduledExecutionRecord>]
1961
+ # Output only. Records of the 10 most recent scheduled execution attempts,
1962
+ # ordered in descending order of `execution_time`. Updated whenever automatic
1963
+ # creation of a workflow invocation is triggered by cron_schedule.
1964
+ # @!attribute [rw] disabled
1965
+ # @return [::Boolean]
1966
+ # Optional. Disables automatic creation of workflow invocations.
1967
+ # @!attribute [r] create_time
1968
+ # @return [::Google::Protobuf::Timestamp]
1969
+ # Output only. The timestamp of when the WorkflowConfig was created.
1970
+ # @!attribute [r] update_time
1971
+ # @return [::Google::Protobuf::Timestamp]
1972
+ # Output only. The timestamp of when the WorkflowConfig was last updated.
1973
+ # @!attribute [r] internal_metadata
1974
+ # @return [::String]
1975
+ # Output only. All the metadata information that is used internally to serve
1976
+ # the resource. For example: timestamps, flags, status fields, etc. The
1977
+ # format of this field is a JSON string.
1978
+ class WorkflowConfig
1979
+ include ::Google::Protobuf::MessageExts
1980
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1981
+
1982
+ # A record of an attempt to create a workflow invocation for this workflow
1983
+ # config.
1984
+ # @!attribute [rw] workflow_invocation
1985
+ # @return [::String]
1986
+ # The name of the created workflow invocation, if one was successfully
1987
+ # created. Must be in the format
1988
+ # `projects/*/locations/*/repositories/*/workflowInvocations/*`.
1989
+ #
1990
+ # Note: The following fields are mutually exclusive: `workflow_invocation`, `error_status`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1991
+ # @!attribute [rw] error_status
1992
+ # @return [::Google::Rpc::Status]
1993
+ # The error status encountered upon this attempt to create the
1994
+ # workflow invocation, if the attempt was unsuccessful.
1995
+ #
1996
+ # Note: The following fields are mutually exclusive: `error_status`, `workflow_invocation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1997
+ # @!attribute [r] execution_time
1998
+ # @return [::Google::Protobuf::Timestamp]
1999
+ # Output only. The timestamp of this execution attempt.
2000
+ class ScheduledExecutionRecord
2001
+ include ::Google::Protobuf::MessageExts
2002
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2003
+ end
2004
+ end
2005
+
2006
+ # Includes various configuration options for a workflow invocation.
2007
+ # If both `included_targets` and `included_tags` are unset, all actions
2008
+ # will be included.
2009
+ # @!attribute [rw] included_targets
2010
+ # @return [::Array<::Google::Cloud::Dataform::V1::Target>]
2011
+ # Optional. The set of action identifiers to include.
2012
+ # @!attribute [rw] included_tags
2013
+ # @return [::Array<::String>]
2014
+ # Optional. The set of tags to include.
2015
+ # @!attribute [rw] transitive_dependencies_included
2016
+ # @return [::Boolean]
2017
+ # Optional. When set to true, transitive dependencies of included actions
2018
+ # will be executed.
2019
+ # @!attribute [rw] transitive_dependents_included
2020
+ # @return [::Boolean]
2021
+ # Optional. When set to true, transitive dependents of included actions will
2022
+ # be executed.
2023
+ # @!attribute [rw] fully_refresh_incremental_tables_enabled
2024
+ # @return [::Boolean]
2025
+ # Optional. When set to true, any incremental tables will be fully refreshed.
2026
+ # @!attribute [rw] service_account
2027
+ # @return [::String]
2028
+ # Optional. The service account to run workflow invocations under.
2029
+ class InvocationConfig
2030
+ include ::Google::Protobuf::MessageExts
2031
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2032
+ end
2033
+
2034
+ # `ListWorkflowConfigs` request message.
2035
+ # @!attribute [rw] parent
2036
+ # @return [::String]
2037
+ # Required. The repository in which to list workflow configs. Must be in the
2038
+ # format `projects/*/locations/*/repositories/*`.
2039
+ # @!attribute [rw] page_size
2040
+ # @return [::Integer]
2041
+ # Optional. Maximum number of workflow configs to return. The server may
2042
+ # return fewer items than requested. If unspecified, the server will pick an
2043
+ # appropriate default.
2044
+ # @!attribute [rw] page_token
2045
+ # @return [::String]
2046
+ # Optional. Page token received from a previous `ListWorkflowConfigs` call.
2047
+ # Provide this to retrieve the subsequent page.
2048
+ #
2049
+ # When paginating, all other parameters provided to `ListWorkflowConfigs`,
2050
+ # with the exception of `page_size`, must match the call that provided the
2051
+ # page token.
2052
+ class ListWorkflowConfigsRequest
2053
+ include ::Google::Protobuf::MessageExts
2054
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2055
+ end
2056
+
2057
+ # `ListWorkflowConfigs` response message.
2058
+ # @!attribute [rw] workflow_configs
2059
+ # @return [::Array<::Google::Cloud::Dataform::V1::WorkflowConfig>]
2060
+ # List of workflow configs.
2061
+ # @!attribute [rw] next_page_token
2062
+ # @return [::String]
2063
+ # A token, which can be sent as `page_token` to retrieve the next page.
2064
+ # If this field is omitted, there are no subsequent pages.
2065
+ # @!attribute [rw] unreachable
2066
+ # @return [::Array<::String>]
2067
+ # Locations which could not be reached.
2068
+ class ListWorkflowConfigsResponse
2069
+ include ::Google::Protobuf::MessageExts
2070
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2071
+ end
2072
+
2073
+ # `GetWorkflowConfig` request message.
2074
+ # @!attribute [rw] name
2075
+ # @return [::String]
2076
+ # Required. The workflow config's name.
2077
+ class GetWorkflowConfigRequest
2078
+ include ::Google::Protobuf::MessageExts
2079
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2080
+ end
2081
+
2082
+ # `CreateWorkflowConfig` request message.
2083
+ # @!attribute [rw] parent
2084
+ # @return [::String]
2085
+ # Required. The repository in which to create the workflow config. Must be in
2086
+ # the format `projects/*/locations/*/repositories/*`.
2087
+ # @!attribute [rw] workflow_config
2088
+ # @return [::Google::Cloud::Dataform::V1::WorkflowConfig]
2089
+ # Required. The workflow config to create.
2090
+ # @!attribute [rw] workflow_config_id
2091
+ # @return [::String]
2092
+ # Required. The ID to use for the workflow config, which will become the
2093
+ # final component of the workflow config's resource name.
2094
+ class CreateWorkflowConfigRequest
2095
+ include ::Google::Protobuf::MessageExts
2096
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2097
+ end
2098
+
2099
+ # `UpdateWorkflowConfig` request message.
2100
+ # @!attribute [rw] update_mask
2101
+ # @return [::Google::Protobuf::FieldMask]
2102
+ # Optional. Specifies the fields to be updated in the workflow config. If
2103
+ # left unset, all fields will be updated.
2104
+ # @!attribute [rw] workflow_config
2105
+ # @return [::Google::Cloud::Dataform::V1::WorkflowConfig]
2106
+ # Required. The workflow config to update.
2107
+ class UpdateWorkflowConfigRequest
2108
+ include ::Google::Protobuf::MessageExts
2109
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2110
+ end
2111
+
2112
+ # `DeleteWorkflowConfig` request message.
2113
+ # @!attribute [rw] name
2114
+ # @return [::String]
2115
+ # Required. The workflow config's name.
2116
+ class DeleteWorkflowConfigRequest
2117
+ include ::Google::Protobuf::MessageExts
2118
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2119
+ end
2120
+
2121
+ # Represents a single invocation of a compilation result.
2122
+ # @!attribute [rw] compilation_result
2123
+ # @return [::String]
2124
+ # Immutable. The name of the compilation result to use for this invocation.
2125
+ # Must be in the format
2126
+ # `projects/*/locations/*/repositories/*/compilationResults/*`.
2127
+ #
2128
+ # Note: The following fields are mutually exclusive: `compilation_result`, `workflow_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2129
+ # @!attribute [rw] workflow_config
2130
+ # @return [::String]
2131
+ # Immutable. The name of the workflow config to invoke. Must be in the
2132
+ # format `projects/*/locations/*/repositories/*/workflowConfigs/*`.
2133
+ #
2134
+ # Note: The following fields are mutually exclusive: `workflow_config`, `compilation_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2135
+ # @!attribute [r] name
2136
+ # @return [::String]
2137
+ # Output only. The workflow invocation's name.
2138
+ # @!attribute [rw] invocation_config
2139
+ # @return [::Google::Cloud::Dataform::V1::InvocationConfig]
2140
+ # Immutable. If left unset, a default InvocationConfig will be used.
2141
+ # @!attribute [r] state
2142
+ # @return [::Google::Cloud::Dataform::V1::WorkflowInvocation::State]
2143
+ # Output only. This workflow invocation's current state.
2144
+ # @!attribute [r] invocation_timing
2145
+ # @return [::Google::Type::Interval]
2146
+ # Output only. This workflow invocation's timing details.
2147
+ # @!attribute [r] resolved_compilation_result
2148
+ # @return [::String]
2149
+ # Output only. The resolved compilation result that was used to create this
2150
+ # invocation. Will be in the format
2151
+ # `projects/*/locations/*/repositories/*/compilationResults/*`.
2152
+ # @!attribute [r] data_encryption_state
2153
+ # @return [::Google::Cloud::Dataform::V1::DataEncryptionState]
2154
+ # Output only. Only set if the repository has a KMS Key.
2155
+ # @!attribute [r] internal_metadata
2156
+ # @return [::String]
2157
+ # Output only. All the metadata information that is used internally to serve
2158
+ # the resource. For example: timestamps, flags, status fields, etc. The
2159
+ # format of this field is a JSON string.
2160
+ class WorkflowInvocation
2161
+ include ::Google::Protobuf::MessageExts
2162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2163
+
2164
+ # Represents the current state of a workflow invocation.
2165
+ module State
2166
+ # Default value. This value is unused.
2167
+ STATE_UNSPECIFIED = 0
2168
+
2169
+ # The workflow invocation is currently running.
2170
+ RUNNING = 1
2171
+
2172
+ # The workflow invocation succeeded. A terminal state.
2173
+ SUCCEEDED = 2
2174
+
2175
+ # The workflow invocation was cancelled. A terminal state.
2176
+ CANCELLED = 3
2177
+
2178
+ # The workflow invocation failed. A terminal state.
2179
+ FAILED = 4
2180
+
2181
+ # The workflow invocation is being cancelled, but some actions are still
2182
+ # running.
2183
+ CANCELING = 5
2184
+ end
2185
+ end
2186
+
2187
+ # `ListWorkflowInvocations` request message.
2188
+ # @!attribute [rw] parent
2189
+ # @return [::String]
2190
+ # Required. The parent resource of the WorkflowInvocation type. Must be in
2191
+ # the format `projects/*/locations/*/repositories/*`.
2192
+ # @!attribute [rw] page_size
2193
+ # @return [::Integer]
2194
+ # Optional. Maximum number of workflow invocations to return. The server may
2195
+ # return fewer items than requested. If unspecified, the server will pick an
2196
+ # appropriate default.
2197
+ # @!attribute [rw] page_token
2198
+ # @return [::String]
2199
+ # Optional. Page token received from a previous `ListWorkflowInvocations`
2200
+ # call. Provide this to retrieve the subsequent page.
2201
+ #
2202
+ # When paginating, all other parameters provided to
2203
+ # `ListWorkflowInvocations`, with the exception of `page_size`, must match
2204
+ # the call that provided the page token.
2205
+ # @!attribute [rw] order_by
2206
+ # @return [::String]
2207
+ # Optional. This field only supports ordering by `name`. If unspecified, the
2208
+ # server will choose the ordering. If specified, the default order is
2209
+ # ascending for the `name` field.
2210
+ # @!attribute [rw] filter
2211
+ # @return [::String]
2212
+ # Optional. Filter for the returned list.
2213
+ class ListWorkflowInvocationsRequest
2214
+ include ::Google::Protobuf::MessageExts
2215
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2216
+ end
2217
+
2218
+ # `ListWorkflowInvocations` response message.
2219
+ # @!attribute [rw] workflow_invocations
2220
+ # @return [::Array<::Google::Cloud::Dataform::V1::WorkflowInvocation>]
2221
+ # List of workflow invocations.
2222
+ # @!attribute [rw] next_page_token
2223
+ # @return [::String]
2224
+ # A token, which can be sent as `page_token` to retrieve the next page.
2225
+ # If this field is omitted, there are no subsequent pages.
2226
+ # @!attribute [rw] unreachable
2227
+ # @return [::Array<::String>]
2228
+ # Locations which could not be reached.
2229
+ class ListWorkflowInvocationsResponse
2230
+ include ::Google::Protobuf::MessageExts
2231
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2232
+ end
2233
+
2234
+ # `GetWorkflowInvocation` request message.
2235
+ # @!attribute [rw] name
2236
+ # @return [::String]
2237
+ # Required. The workflow invocation resource's name.
2238
+ class GetWorkflowInvocationRequest
2239
+ include ::Google::Protobuf::MessageExts
2240
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2241
+ end
2242
+
2243
+ # `CreateWorkflowInvocation` request message.
2244
+ # @!attribute [rw] parent
2245
+ # @return [::String]
2246
+ # Required. The repository in which to create the workflow invocation. Must
2247
+ # be in the format `projects/*/locations/*/repositories/*`.
2248
+ # @!attribute [rw] workflow_invocation
2249
+ # @return [::Google::Cloud::Dataform::V1::WorkflowInvocation]
2250
+ # Required. The workflow invocation resource to create.
2251
+ class CreateWorkflowInvocationRequest
2252
+ include ::Google::Protobuf::MessageExts
2253
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2254
+ end
2255
+
2256
+ # `DeleteWorkflowInvocation` request message.
2257
+ # @!attribute [rw] name
2258
+ # @return [::String]
2259
+ # Required. The workflow invocation resource's name.
2260
+ class DeleteWorkflowInvocationRequest
2261
+ include ::Google::Protobuf::MessageExts
2262
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2263
+ end
2264
+
2265
+ # `CancelWorkflowInvocation` request message.
2266
+ # @!attribute [rw] name
2267
+ # @return [::String]
2268
+ # Required. The workflow invocation resource's name.
2269
+ class CancelWorkflowInvocationRequest
2270
+ include ::Google::Protobuf::MessageExts
2271
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2272
+ end
2273
+
2274
+ # `CancelWorkflowInvocation` response message.
2275
+ class CancelWorkflowInvocationResponse
2276
+ include ::Google::Protobuf::MessageExts
2277
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2278
+ end
2279
+
2280
+ # Represents a single action in a workflow invocation.
2281
+ # @!attribute [r] bigquery_action
2282
+ # @return [::Google::Cloud::Dataform::V1::WorkflowInvocationAction::BigQueryAction]
2283
+ # Output only. The workflow action's bigquery action details.
2284
+ #
2285
+ # Note: The following fields are mutually exclusive: `bigquery_action`, `notebook_action`, `data_preparation_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2286
+ # @!attribute [r] notebook_action
2287
+ # @return [::Google::Cloud::Dataform::V1::WorkflowInvocationAction::NotebookAction]
2288
+ # Output only. The workflow action's notebook action details.
2289
+ #
2290
+ # Note: The following fields are mutually exclusive: `notebook_action`, `bigquery_action`, `data_preparation_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2291
+ # @!attribute [r] data_preparation_action
2292
+ # @return [::Google::Cloud::Dataform::V1::WorkflowInvocationAction::DataPreparationAction]
2293
+ # Output only. The workflow action's data preparation action details.
2294
+ #
2295
+ # Note: The following fields are mutually exclusive: `data_preparation_action`, `bigquery_action`, `notebook_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2296
+ # @!attribute [r] target
2297
+ # @return [::Google::Cloud::Dataform::V1::Target]
2298
+ # Output only. This action's identifier. Unique within the workflow
2299
+ # invocation.
2300
+ # @!attribute [r] canonical_target
2301
+ # @return [::Google::Cloud::Dataform::V1::Target]
2302
+ # Output only. The action's identifier if the project had been compiled
2303
+ # without any overrides configured. Unique within the compilation result.
2304
+ # @!attribute [r] state
2305
+ # @return [::Google::Cloud::Dataform::V1::WorkflowInvocationAction::State]
2306
+ # Output only. This action's current state.
2307
+ # @!attribute [r] failure_reason
2308
+ # @return [::String]
2309
+ # Output only. If and only if action's state is FAILED a failure reason is
2310
+ # set.
2311
+ # @!attribute [r] invocation_timing
2312
+ # @return [::Google::Type::Interval]
2313
+ # Output only. This action's timing details.
2314
+ # `start_time` will be set if the action is in [RUNNING, SUCCEEDED,
2315
+ # CANCELLED, FAILED] state.
2316
+ # `end_time` will be set if the action is in [SUCCEEDED, CANCELLED, FAILED]
2317
+ # state.
2318
+ # @!attribute [r] internal_metadata
2319
+ # @return [::String]
2320
+ # Output only. All the metadata information that is used internally to serve
2321
+ # the resource. For example: timestamps, flags, status fields, etc. The
2322
+ # format of this field is a JSON string.
2323
+ class WorkflowInvocationAction
2324
+ include ::Google::Protobuf::MessageExts
2325
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2326
+
2327
+ # Represents a workflow action that will run against BigQuery.
2328
+ # @!attribute [r] sql_script
2329
+ # @return [::String]
2330
+ # Output only. The generated BigQuery SQL script that will be executed.
2331
+ # @!attribute [r] job_id
2332
+ # @return [::String]
2333
+ # Output only. The ID of the BigQuery job that executed the SQL in
2334
+ # sql_script. Only set once the job has started to run.
2335
+ class BigQueryAction
2336
+ include ::Google::Protobuf::MessageExts
2337
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2338
+ end
2339
+
2340
+ # Represents a workflow action that will run against a Notebook runtime.
2341
+ # @!attribute [r] contents
2342
+ # @return [::String]
2343
+ # Output only. The code contents of a Notebook to be run.
2344
+ # @!attribute [r] job_id
2345
+ # @return [::String]
2346
+ # Output only. The ID of the Vertex job that executed the notebook in
2347
+ # contents and also the ID used for the outputs created in Google Cloud
2348
+ # Storage buckets. Only set once the job has started to run.
2349
+ class NotebookAction
2350
+ include ::Google::Protobuf::MessageExts
2351
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2352
+ end
2353
+
2354
+ # Represents a workflow action that will run a Data Preparation.
2355
+ # @!attribute [r] contents_yaml
2356
+ # @return [::String]
2357
+ # Output only. YAML representing the contents of the data preparation.
2358
+ # Can be used to show the customer what the input was to their workflow.
2359
+ #
2360
+ # Note: The following fields are mutually exclusive: `contents_yaml`, `contents_sql`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2361
+ # @!attribute [rw] contents_sql
2362
+ # @return [::Google::Cloud::Dataform::V1::WorkflowInvocationAction::DataPreparationAction::ActionSqlDefinition]
2363
+ # SQL definition for a Data Preparation. Contains a SQL query and
2364
+ # additional context information.
2365
+ #
2366
+ # Note: The following fields are mutually exclusive: `contents_sql`, `contents_yaml`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2367
+ # @!attribute [r] generated_sql
2368
+ # @return [::String]
2369
+ # Output only. The generated BigQuery SQL script that will be executed. For
2370
+ # reference only.
2371
+ # @!attribute [r] job_id
2372
+ # @return [::String]
2373
+ # Output only. The ID of the BigQuery job that executed the SQL in
2374
+ # sql_script. Only set once the job has started to run.
2375
+ class DataPreparationAction
2376
+ include ::Google::Protobuf::MessageExts
2377
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2378
+
2379
+ # Definition of a SQL Data Preparation
2380
+ # @!attribute [rw] query
2381
+ # @return [::String]
2382
+ # The SQL query representing the data preparation steps. Formatted as a
2383
+ # Pipe SQL query statement.
2384
+ # @!attribute [rw] error_table
2385
+ # @return [::Google::Cloud::Dataform::V1::WorkflowInvocationAction::DataPreparationAction::ActionErrorTable]
2386
+ # Error table configuration,
2387
+ # @!attribute [rw] load_config
2388
+ # @return [::Google::Cloud::Dataform::V1::WorkflowInvocationAction::DataPreparationAction::ActionLoadConfig]
2389
+ # Load configuration.
2390
+ class ActionSqlDefinition
2391
+ include ::Google::Protobuf::MessageExts
2392
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2393
+ end
2394
+
2395
+ # Error table information, used to write error data into a BigQuery
2396
+ # table.
2397
+ # @!attribute [rw] target
2398
+ # @return [::Google::Cloud::Dataform::V1::Target]
2399
+ # Error Table target.
2400
+ # @!attribute [rw] retention_days
2401
+ # @return [::Integer]
2402
+ # Error table partition expiration in days. Only positive values are
2403
+ # allowed.
2404
+ class ActionErrorTable
2405
+ include ::Google::Protobuf::MessageExts
2406
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2407
+ end
2408
+
2409
+ # Simplified load configuration for actions
2410
+ # @!attribute [rw] replace
2411
+ # @return [::Google::Cloud::Dataform::V1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
2412
+ # Replace destination table
2413
+ #
2414
+ # Note: The following fields are mutually exclusive: `replace`, `append`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2415
+ # @!attribute [rw] append
2416
+ # @return [::Google::Cloud::Dataform::V1::WorkflowInvocationAction::DataPreparationAction::ActionSimpleLoadMode]
2417
+ # Append into destination table
2418
+ #
2419
+ # Note: The following fields are mutually exclusive: `append`, `replace`, `maximum`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2420
+ # @!attribute [rw] maximum
2421
+ # @return [::Google::Cloud::Dataform::V1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
2422
+ # Insert records where the value exceeds the previous maximum value for
2423
+ # a column in the destination table
2424
+ #
2425
+ # Note: The following fields are mutually exclusive: `maximum`, `replace`, `append`, `unique`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2426
+ # @!attribute [rw] unique
2427
+ # @return [::Google::Cloud::Dataform::V1::WorkflowInvocationAction::DataPreparationAction::ActionIncrementalLoadMode]
2428
+ # Insert records where the value of a column is not already present in
2429
+ # the destination table
2430
+ #
2431
+ # Note: The following fields are mutually exclusive: `unique`, `replace`, `append`, `maximum`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2432
+ class ActionLoadConfig
2433
+ include ::Google::Protobuf::MessageExts
2434
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2435
+ end
2436
+
2437
+ # Simple load definition
2438
+ class ActionSimpleLoadMode
2439
+ include ::Google::Protobuf::MessageExts
2440
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2441
+ end
2442
+
2443
+ # Load definition for incremental load modes
2444
+ # @!attribute [rw] column
2445
+ # @return [::String]
2446
+ # Column name for incremental load modes
2447
+ class ActionIncrementalLoadMode
2448
+ include ::Google::Protobuf::MessageExts
2449
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2450
+ end
2451
+ end
2452
+
2453
+ # Represents the current state of a workflow invocation action.
2454
+ module State
2455
+ # The action has not yet been considered for invocation.
2456
+ PENDING = 0
2457
+
2458
+ # The action is currently running.
2459
+ RUNNING = 1
2460
+
2461
+ # Execution of the action was skipped because upstream dependencies did not
2462
+ # all complete successfully. A terminal state.
2463
+ SKIPPED = 2
2464
+
2465
+ # Execution of the action was disabled as per the configuration of the
2466
+ # corresponding compilation result action. A terminal state.
2467
+ DISABLED = 3
2468
+
2469
+ # The action succeeded. A terminal state.
2470
+ SUCCEEDED = 4
2471
+
2472
+ # The action was cancelled. A terminal state.
2473
+ CANCELLED = 5
2474
+
2475
+ # The action failed. A terminal state.
2476
+ FAILED = 6
2477
+ end
2478
+ end
2479
+
2480
+ # `QueryWorkflowInvocationActions` request message.
2481
+ # @!attribute [rw] name
2482
+ # @return [::String]
2483
+ # Required. The workflow invocation's name.
2484
+ # @!attribute [rw] page_size
2485
+ # @return [::Integer]
2486
+ # Optional. Maximum number of workflow invocations to return. The server may
2487
+ # return fewer items than requested. If unspecified, the server will pick an
2488
+ # appropriate default.
2489
+ # @!attribute [rw] page_token
2490
+ # @return [::String]
2491
+ # Optional. Page token received from a previous
2492
+ # `QueryWorkflowInvocationActions` call. Provide this to retrieve the
2493
+ # subsequent page.
2494
+ #
2495
+ # When paginating, all other parameters provided to
2496
+ # `QueryWorkflowInvocationActions`, with the exception of `page_size`, must
2497
+ # match the call that provided the page token.
2498
+ class QueryWorkflowInvocationActionsRequest
2499
+ include ::Google::Protobuf::MessageExts
2500
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2501
+ end
2502
+
2503
+ # `QueryWorkflowInvocationActions` response message.
2504
+ # @!attribute [rw] workflow_invocation_actions
2505
+ # @return [::Array<::Google::Cloud::Dataform::V1::WorkflowInvocationAction>]
2506
+ # List of workflow invocation actions.
2507
+ # @!attribute [rw] next_page_token
2508
+ # @return [::String]
2509
+ # A token, which can be sent as `page_token` to retrieve the next page.
2510
+ # If this field is omitted, there are no subsequent pages.
2511
+ class QueryWorkflowInvocationActionsResponse
2512
+ include ::Google::Protobuf::MessageExts
2513
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2514
+ end
2515
+
2516
+ # Config for all repositories in a given project and location.
2517
+ # @!attribute [rw] name
2518
+ # @return [::String]
2519
+ # Identifier. The config name.
2520
+ # @!attribute [rw] default_kms_key_name
2521
+ # @return [::String]
2522
+ # Optional. The default KMS key that is used if no encryption key is provided
2523
+ # when a repository is created.
2524
+ class Config
2525
+ include ::Google::Protobuf::MessageExts
2526
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2527
+ end
2528
+
2529
+ # `GetConfig` request message.
2530
+ # @!attribute [rw] name
2531
+ # @return [::String]
2532
+ # Required. The config name.
2533
+ class GetConfigRequest
2534
+ include ::Google::Protobuf::MessageExts
2535
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2536
+ end
2537
+
2538
+ # `UpdateConfig` request message.
2539
+ # @!attribute [rw] config
2540
+ # @return [::Google::Cloud::Dataform::V1::Config]
2541
+ # Required. The config to update.
2542
+ # @!attribute [rw] update_mask
2543
+ # @return [::Google::Protobuf::FieldMask]
2544
+ # Optional. Specifies the fields to be updated in the config.
2545
+ class UpdateConfigRequest
2546
+ include ::Google::Protobuf::MessageExts
2547
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2548
+ end
2549
+ end
2550
+ end
2551
+ end
2552
+ end