google-cloud-dataform-v1beta1 0.3.0 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -25,9 +25,36 @@ module Google
25
25
  # @!attribute [r] name
26
26
  # @return [::String]
27
27
  # Output only. The repository's name.
28
+ # @!attribute [rw] display_name
29
+ # @return [::String]
30
+ # Optional. The repository's user-friendly name.
28
31
  # @!attribute [rw] git_remote_settings
29
32
  # @return [::Google::Cloud::Dataform::V1beta1::Repository::GitRemoteSettings]
30
33
  # Optional. If set, configures this repository to be linked to a Git remote.
34
+ # @!attribute [rw] npmrc_environment_variables_secret_version
35
+ # @return [::String]
36
+ # Optional. The name of the Secret Manager secret version to be used to
37
+ # interpolate variables into the .npmrc file for package installation
38
+ # operations. Must be in the format `projects/*/secrets/*/versions/*`. The
39
+ # file itself must be in a JSON format.
40
+ # @!attribute [rw] workspace_compilation_overrides
41
+ # @return [::Google::Cloud::Dataform::V1beta1::Repository::WorkspaceCompilationOverrides]
42
+ # Optional. If set, fields of `workspace_compilation_overrides` override the
43
+ # default compilation settings that are specified in dataform.json when
44
+ # creating workspace-scoped compilation results. See documentation for
45
+ # `WorkspaceCompilationOverrides` for more information.
46
+ # @!attribute [rw] labels
47
+ # @return [::Google::Protobuf::Map{::String => ::String}]
48
+ # Optional. Repository user labels.
49
+ # @!attribute [rw] set_authenticated_user_admin
50
+ # @return [::Boolean]
51
+ # Optional. Input only. If set to true, the authenticated user will be
52
+ # granted the roles/dataform.admin role on the created repository. To modify
53
+ # access to the created repository later apply setIamPolicy from
54
+ # https://cloud.google.com/dataform/reference/rest#rest-resource:-v1beta1.projects.locations.repositories
55
+ # @!attribute [rw] service_account
56
+ # @return [::String]
57
+ # Optional. The service account to run workflow invocations under.
31
58
  class Repository
32
59
  include ::Google::Protobuf::MessageExts
33
60
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -41,17 +68,36 @@ module Google
41
68
  # Required. The Git remote's default branch name.
42
69
  # @!attribute [rw] authentication_token_secret_version
43
70
  # @return [::String]
44
- # Required. The name of the Secret Manager secret version to use as an
71
+ # Optional. The name of the Secret Manager secret version to use as an
45
72
  # authentication token for Git operations. Must be in the format
46
73
  # `projects/*/secrets/*/versions/*`.
74
+ # @!attribute [rw] ssh_authentication_config
75
+ # @return [::Google::Cloud::Dataform::V1beta1::Repository::GitRemoteSettings::SshAuthenticationConfig]
76
+ # Optional. Authentication fields for remote uris using SSH protocol.
47
77
  # @!attribute [r] token_status
48
78
  # @return [::Google::Cloud::Dataform::V1beta1::Repository::GitRemoteSettings::TokenStatus]
49
- # Output only. Indicates the status of the Git access token.
79
+ # Output only. Deprecated: The field does not contain any token status
80
+ # information. Instead use
81
+ # https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories/computeAccessTokenStatus
50
82
  class GitRemoteSettings
51
83
  include ::Google::Protobuf::MessageExts
52
84
  extend ::Google::Protobuf::MessageExts::ClassMethods
53
85
 
54
- # Indicates the status of a Git authentication token.
86
+ # Configures fields for performing SSH authentication.
87
+ # @!attribute [rw] user_private_key_secret_version
88
+ # @return [::String]
89
+ # Required. The name of the Secret Manager secret version to use as a
90
+ # ssh private key for Git operations.
91
+ # Must be in the format `projects/*/secrets/*/versions/*`.
92
+ # @!attribute [rw] host_public_key
93
+ # @return [::String]
94
+ # Required. Content of a public SSH key to verify an identity of a remote
95
+ # Git host.
96
+ class SshAuthenticationConfig
97
+ include ::Google::Protobuf::MessageExts
98
+ extend ::Google::Protobuf::MessageExts::ClassMethods
99
+ end
100
+
55
101
  module TokenStatus
56
102
  # Default value. This value is unused.
57
103
  TOKEN_STATUS_UNSPECIFIED = 0
@@ -67,6 +113,39 @@ module Google
67
113
  VALID = 3
68
114
  end
69
115
  end
116
+
117
+ # Configures workspace compilation overrides for a repository.
118
+ # Primarily used by the UI (`console.cloud.google.com`).
119
+ # `schema_suffix` and `table_prefix` can have a special expression -
120
+ # `${workspaceName}`, which refers to the workspace name from which the
121
+ # compilation results will be created. API callers are expected to resolve
122
+ # the expression in these overrides and provide them explicitly in
123
+ # `code_compilation_config`
124
+ # (https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.compilationResults#codecompilationconfig)
125
+ # when creating workspace-scoped compilation results.
126
+ # @!attribute [rw] default_database
127
+ # @return [::String]
128
+ # Optional. The default database (Google Cloud project ID).
129
+ # @!attribute [rw] schema_suffix
130
+ # @return [::String]
131
+ # Optional. The suffix that should be appended to all schema (BigQuery
132
+ # dataset ID) names.
133
+ # @!attribute [rw] table_prefix
134
+ # @return [::String]
135
+ # Optional. The prefix that should be prepended to all table names.
136
+ class WorkspaceCompilationOverrides
137
+ include ::Google::Protobuf::MessageExts
138
+ extend ::Google::Protobuf::MessageExts::ClassMethods
139
+ end
140
+
141
+ # @!attribute [rw] key
142
+ # @return [::String]
143
+ # @!attribute [rw] value
144
+ # @return [::String]
145
+ class LabelsEntry
146
+ include ::Google::Protobuf::MessageExts
147
+ extend ::Google::Protobuf::MessageExts::ClassMethods
148
+ end
70
149
  end
71
150
 
72
151
  # `ListRepositories` request message.
@@ -76,9 +155,9 @@ module Google
76
155
  # `projects/*/locations/*`.
77
156
  # @!attribute [rw] page_size
78
157
  # @return [::Integer]
79
- # Optional. Maximum number of repositories to return. The server may return fewer
80
- # items than requested. If unspecified, the server will pick an appropriate
81
- # default.
158
+ # Optional. Maximum number of repositories to return. The server may return
159
+ # fewer items than requested. If unspecified, the server will pick an
160
+ # appropriate default.
82
161
  # @!attribute [rw] page_token
83
162
  # @return [::String]
84
163
  # Optional. Page token received from a previous `ListRepositories` call.
@@ -88,9 +167,9 @@ module Google
88
167
  # must match the call that provided the page token.
89
168
  # @!attribute [rw] order_by
90
169
  # @return [::String]
91
- # Optional. This field only supports ordering by `name`. If unspecified, the server
92
- # will choose the ordering. If specified, the default order is ascending for
93
- # the `name` field.
170
+ # Optional. This field only supports ordering by `name`. If unspecified, the
171
+ # server will choose the ordering. If specified, the default order is
172
+ # ascending for the `name` field.
94
173
  # @!attribute [rw] filter
95
174
  # @return [::String]
96
175
  # Optional. Filter for the returned list.
@@ -127,15 +206,15 @@ module Google
127
206
  # `CreateRepository` request message.
128
207
  # @!attribute [rw] parent
129
208
  # @return [::String]
130
- # Required. The location in which to create the repository. Must be in the format
131
- # `projects/*/locations/*`.
209
+ # Required. The location in which to create the repository. Must be in the
210
+ # format `projects/*/locations/*`.
132
211
  # @!attribute [rw] repository
133
212
  # @return [::Google::Cloud::Dataform::V1beta1::Repository]
134
213
  # Required. The repository to create.
135
214
  # @!attribute [rw] repository_id
136
215
  # @return [::String]
137
- # Required. The ID to use for the repository, which will become the final component of
138
- # the repository's resource name.
216
+ # Required. The ID to use for the repository, which will become the final
217
+ # component of the repository's resource name.
139
218
  class CreateRepositoryRequest
140
219
  include ::Google::Protobuf::MessageExts
141
220
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -144,8 +223,8 @@ module Google
144
223
  # `UpdateRepository` request message.
145
224
  # @!attribute [rw] update_mask
146
225
  # @return [::Google::Protobuf::FieldMask]
147
- # Optional. Specifies the fields to be updated in the repository. If left unset,
148
- # all fields will be updated.
226
+ # Optional. Specifies the fields to be updated in the repository. If left
227
+ # unset, all fields will be updated.
149
228
  # @!attribute [rw] repository
150
229
  # @return [::Google::Cloud::Dataform::V1beta1::Repository]
151
230
  # Required. The repository to update.
@@ -168,6 +247,230 @@ module Google
168
247
  extend ::Google::Protobuf::MessageExts::ClassMethods
169
248
  end
170
249
 
250
+ # `CommitRepositoryChanges` request message.
251
+ # @!attribute [rw] name
252
+ # @return [::String]
253
+ # Required. The repository's name.
254
+ # @!attribute [rw] commit_metadata
255
+ # @return [::Google::Cloud::Dataform::V1beta1::CommitMetadata]
256
+ # Required. The changes to commit to the repository.
257
+ # @!attribute [rw] required_head_commit_sha
258
+ # @return [::String]
259
+ # Optional. The commit SHA which must be the repository's current HEAD before
260
+ # applying this commit; otherwise this request will fail. If unset, no
261
+ # validation on the current HEAD commit SHA is performed.
262
+ # @!attribute [rw] file_operations
263
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dataform::V1beta1::CommitRepositoryChangesRequest::FileOperation}]
264
+ # A map to the path of the file to the operation. The path is the full file
265
+ # path including filename, from repository root.
266
+ class CommitRepositoryChangesRequest
267
+ include ::Google::Protobuf::MessageExts
268
+ extend ::Google::Protobuf::MessageExts::ClassMethods
269
+
270
+ # Represents a single file operation to the repository.
271
+ # @!attribute [rw] write_file
272
+ # @return [::Google::Cloud::Dataform::V1beta1::CommitRepositoryChangesRequest::FileOperation::WriteFile]
273
+ # Represents the write operation.
274
+ # @!attribute [rw] delete_file
275
+ # @return [::Google::Cloud::Dataform::V1beta1::CommitRepositoryChangesRequest::FileOperation::DeleteFile]
276
+ # Represents the delete operation.
277
+ class FileOperation
278
+ include ::Google::Protobuf::MessageExts
279
+ extend ::Google::Protobuf::MessageExts::ClassMethods
280
+
281
+ # Represents the write file operation (for files added or modified).
282
+ # @!attribute [rw] contents
283
+ # @return [::String]
284
+ # The file's contents.
285
+ class WriteFile
286
+ include ::Google::Protobuf::MessageExts
287
+ extend ::Google::Protobuf::MessageExts::ClassMethods
288
+ end
289
+
290
+ # Represents the delete file operation.
291
+ class DeleteFile
292
+ include ::Google::Protobuf::MessageExts
293
+ extend ::Google::Protobuf::MessageExts::ClassMethods
294
+ end
295
+ end
296
+
297
+ # @!attribute [rw] key
298
+ # @return [::String]
299
+ # @!attribute [rw] value
300
+ # @return [::Google::Cloud::Dataform::V1beta1::CommitRepositoryChangesRequest::FileOperation]
301
+ class FileOperationsEntry
302
+ include ::Google::Protobuf::MessageExts
303
+ extend ::Google::Protobuf::MessageExts::ClassMethods
304
+ end
305
+ end
306
+
307
+ # `ReadRepositoryFile` request message.
308
+ # @!attribute [rw] name
309
+ # @return [::String]
310
+ # Required. The repository's name.
311
+ # @!attribute [rw] commit_sha
312
+ # @return [::String]
313
+ # Optional. The commit SHA for the commit to read from. If unset, the file
314
+ # will be read from HEAD.
315
+ # @!attribute [rw] path
316
+ # @return [::String]
317
+ # Required. Full file path to read including filename, from repository root.
318
+ class ReadRepositoryFileRequest
319
+ include ::Google::Protobuf::MessageExts
320
+ extend ::Google::Protobuf::MessageExts::ClassMethods
321
+ end
322
+
323
+ # `ReadRepositoryFile` response message.
324
+ # @!attribute [rw] contents
325
+ # @return [::String]
326
+ # The file's contents.
327
+ class ReadRepositoryFileResponse
328
+ include ::Google::Protobuf::MessageExts
329
+ extend ::Google::Protobuf::MessageExts::ClassMethods
330
+ end
331
+
332
+ # `QueryRepositoryDirectoryContents` request message.
333
+ # @!attribute [rw] name
334
+ # @return [::String]
335
+ # Required. The repository's name.
336
+ # @!attribute [rw] commit_sha
337
+ # @return [::String]
338
+ # Optional. The Commit SHA for the commit to query from. If unset, the
339
+ # directory will be queried from HEAD.
340
+ # @!attribute [rw] path
341
+ # @return [::String]
342
+ # Optional. The directory's full path including directory name, relative to
343
+ # root. If left unset, the root is used.
344
+ # @!attribute [rw] page_size
345
+ # @return [::Integer]
346
+ # Optional. Maximum number of paths to return. The server may return fewer
347
+ # items than requested. If unspecified, the server will pick an appropriate
348
+ # default.
349
+ # @!attribute [rw] page_token
350
+ # @return [::String]
351
+ # Optional. Page token received from a previous
352
+ # `QueryRepositoryDirectoryContents` call. Provide this to retrieve the
353
+ # subsequent page.
354
+ #
355
+ # When paginating, all other parameters provided to
356
+ # `QueryRepositoryDirectoryContents` must match the call that provided the
357
+ # page token.
358
+ class QueryRepositoryDirectoryContentsRequest
359
+ include ::Google::Protobuf::MessageExts
360
+ extend ::Google::Protobuf::MessageExts::ClassMethods
361
+ end
362
+
363
+ # `QueryRepositoryDirectoryContents` response message.
364
+ # @!attribute [rw] directory_entries
365
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>]
366
+ # List of entries in the directory.
367
+ # @!attribute [rw] next_page_token
368
+ # @return [::String]
369
+ # A token, which can be sent as `page_token` to retrieve the next page.
370
+ # If this field is omitted, there are no subsequent pages.
371
+ class QueryRepositoryDirectoryContentsResponse
372
+ include ::Google::Protobuf::MessageExts
373
+ extend ::Google::Protobuf::MessageExts::ClassMethods
374
+ end
375
+
376
+ # `FetchRepositoryHistory` request message.
377
+ # @!attribute [rw] name
378
+ # @return [::String]
379
+ # Required. The repository's name.
380
+ # @!attribute [rw] page_size
381
+ # @return [::Integer]
382
+ # Optional. Maximum number of commits to return. The server may return fewer
383
+ # items than requested. If unspecified, the server will pick an appropriate
384
+ # default.
385
+ # @!attribute [rw] page_token
386
+ # @return [::String]
387
+ # Optional. Page token received from a previous `FetchRepositoryHistory`
388
+ # call. Provide this to retrieve the subsequent page.
389
+ #
390
+ # When paginating, all other parameters provided to `FetchRepositoryHistory`
391
+ # must match the call that provided the page token.
392
+ class FetchRepositoryHistoryRequest
393
+ include ::Google::Protobuf::MessageExts
394
+ extend ::Google::Protobuf::MessageExts::ClassMethods
395
+ end
396
+
397
+ # `FetchRepositoryHistory` response message.
398
+ # @!attribute [rw] commits
399
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::CommitLogEntry>]
400
+ # A list of commit logs, ordered by 'git log' default order.
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 FetchRepositoryHistoryResponse
406
+ include ::Google::Protobuf::MessageExts
407
+ extend ::Google::Protobuf::MessageExts::ClassMethods
408
+ end
409
+
410
+ # Represents a single commit log.
411
+ # @!attribute [rw] commit_time
412
+ # @return [::Google::Protobuf::Timestamp]
413
+ # Commit timestamp.
414
+ # @!attribute [rw] commit_sha
415
+ # @return [::String]
416
+ # The commit SHA for this commit log entry.
417
+ # @!attribute [rw] author
418
+ # @return [::Google::Cloud::Dataform::V1beta1::CommitAuthor]
419
+ # The commit author for this commit log entry.
420
+ # @!attribute [rw] commit_message
421
+ # @return [::String]
422
+ # The commit message for this commit log entry.
423
+ class CommitLogEntry
424
+ include ::Google::Protobuf::MessageExts
425
+ extend ::Google::Protobuf::MessageExts::ClassMethods
426
+ end
427
+
428
+ # Represents a Dataform Git commit.
429
+ # @!attribute [rw] author
430
+ # @return [::Google::Cloud::Dataform::V1beta1::CommitAuthor]
431
+ # Required. The commit's author.
432
+ # @!attribute [rw] commit_message
433
+ # @return [::String]
434
+ # Optional. The commit's message.
435
+ class CommitMetadata
436
+ include ::Google::Protobuf::MessageExts
437
+ extend ::Google::Protobuf::MessageExts::ClassMethods
438
+ end
439
+
440
+ # `ComputeRepositoryAccessTokenStatus` request message.
441
+ # @!attribute [rw] name
442
+ # @return [::String]
443
+ # Required. The repository's name.
444
+ class ComputeRepositoryAccessTokenStatusRequest
445
+ include ::Google::Protobuf::MessageExts
446
+ extend ::Google::Protobuf::MessageExts::ClassMethods
447
+ end
448
+
449
+ # `ComputeRepositoryAccessTokenStatus` response message.
450
+ # @!attribute [rw] token_status
451
+ # @return [::Google::Cloud::Dataform::V1beta1::ComputeRepositoryAccessTokenStatusResponse::TokenStatus]
452
+ # Indicates the status of the Git access token.
453
+ class ComputeRepositoryAccessTokenStatusResponse
454
+ include ::Google::Protobuf::MessageExts
455
+ extend ::Google::Protobuf::MessageExts::ClassMethods
456
+
457
+ # Indicates the status of a Git authentication token.
458
+ module TokenStatus
459
+ # Default value. This value is unused.
460
+ TOKEN_STATUS_UNSPECIFIED = 0
461
+
462
+ # The token could not be found in Secret Manager (or the Dataform
463
+ # Service Account did not have permission to access it).
464
+ NOT_FOUND = 1
465
+
466
+ # The token could not be used to authenticate against the Git remote.
467
+ INVALID = 2
468
+
469
+ # The token was used successfully to authenticate against the Git remote.
470
+ VALID = 3
471
+ end
472
+ end
473
+
171
474
  # `FetchRemoteBranches` request message.
172
475
  # @!attribute [rw] name
173
476
  # @return [::String]
@@ -202,9 +505,9 @@ module Google
202
505
  # format `projects/*/locations/*/repositories/*`.
203
506
  # @!attribute [rw] page_size
204
507
  # @return [::Integer]
205
- # Optional. Maximum number of workspaces to return. The server may return fewer
206
- # items than requested. If unspecified, the server will pick an appropriate
207
- # default.
508
+ # Optional. Maximum number of workspaces to return. The server may return
509
+ # fewer items than requested. If unspecified, the server will pick an
510
+ # appropriate default.
208
511
  # @!attribute [rw] page_token
209
512
  # @return [::String]
210
513
  # Optional. Page token received from a previous `ListWorkspaces` call.
@@ -214,9 +517,9 @@ module Google
214
517
  # must match the call that provided the page token.
215
518
  # @!attribute [rw] order_by
216
519
  # @return [::String]
217
- # Optional. This field only supports ordering by `name`. If unspecified, the server
218
- # will choose the ordering. If specified, the default order is ascending for
219
- # the `name` field.
520
+ # Optional. This field only supports ordering by `name`. If unspecified, the
521
+ # server will choose the ordering. If specified, the default order is
522
+ # ascending for the `name` field.
220
523
  # @!attribute [rw] filter
221
524
  # @return [::String]
222
525
  # Optional. Filter for the returned list.
@@ -253,15 +556,15 @@ module Google
253
556
  # `CreateWorkspace` request message.
254
557
  # @!attribute [rw] parent
255
558
  # @return [::String]
256
- # Required. The repository in which to create the workspace. Must be in the format
257
- # `projects/*/locations/*/repositories/*`.
559
+ # Required. The repository in which to create the workspace. Must be in the
560
+ # format `projects/*/locations/*/repositories/*`.
258
561
  # @!attribute [rw] workspace
259
562
  # @return [::Google::Cloud::Dataform::V1beta1::Workspace]
260
563
  # Required. The workspace to create.
261
564
  # @!attribute [rw] workspace_id
262
565
  # @return [::String]
263
- # Required. The ID to use for the workspace, which will become the final component of
264
- # the workspace's resource name.
566
+ # Required. The ID to use for the workspace, which will become the final
567
+ # component of the workspace's resource name.
265
568
  class CreateWorkspaceRequest
266
569
  include ::Google::Protobuf::MessageExts
267
570
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -294,12 +597,12 @@ module Google
294
597
  # Required. The workspace's name.
295
598
  # @!attribute [rw] remote_branch
296
599
  # @return [::String]
297
- # Optional. The name of the branch in the Git remote from which to pull commits.
298
- # If left unset, the repository's default branch name will be used.
600
+ # Optional. The name of the branch in the Git remote from which to pull
601
+ # commits. If left unset, the repository's default branch name will be used.
299
602
  # @!attribute [rw] author
300
603
  # @return [::Google::Cloud::Dataform::V1beta1::CommitAuthor]
301
- # Required. The author of any merge commit which may be created as a result of merging
302
- # fetched Git commits into this workspace.
604
+ # Required. The author of any merge commit which may be created as a result
605
+ # of merging fetched Git commits into this workspace.
303
606
  class PullGitCommitsRequest
304
607
  include ::Google::Protobuf::MessageExts
305
608
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -311,8 +614,9 @@ module Google
311
614
  # Required. The workspace's name.
312
615
  # @!attribute [rw] remote_branch
313
616
  # @return [::String]
314
- # Optional. The name of the branch in the Git remote to which commits should be pushed.
315
- # If left unset, the repository's default branch name will be used.
617
+ # Optional. The name of the branch in the Git remote to which commits should
618
+ # be pushed. If left unset, the repository's default branch name will be
619
+ # used.
316
620
  class PushGitCommitsRequest
317
621
  include ::Google::Protobuf::MessageExts
318
622
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -373,9 +677,9 @@ module Google
373
677
  # Required. The workspace's name.
374
678
  # @!attribute [rw] remote_branch
375
679
  # @return [::String]
376
- # Optional. The name of the branch in the Git remote against which this workspace
377
- # should be compared. If left unset, the repository's default branch name
378
- # will be used.
680
+ # Optional. The name of the branch in the Git remote against which this
681
+ # workspace should be compared. If left unset, the repository's default
682
+ # branch name will be used.
379
683
  class FetchGitAheadBehindRequest
380
684
  include ::Google::Protobuf::MessageExts
381
685
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -405,8 +709,8 @@ module Google
405
709
  # Optional. The commit's message.
406
710
  # @!attribute [rw] paths
407
711
  # @return [::Array<::String>]
408
- # Optional. Full file paths to commit including filename, rooted at workspace root. If
409
- # left empty, all files will be committed.
712
+ # Optional. Full file paths to commit including filename, rooted at workspace
713
+ # root. If left empty, all files will be committed.
410
714
  class CommitWorkspaceChangesRequest
411
715
  include ::Google::Protobuf::MessageExts
412
716
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -418,8 +722,8 @@ module Google
418
722
  # Required. The workspace's name.
419
723
  # @!attribute [rw] paths
420
724
  # @return [::Array<::String>]
421
- # Optional. Full file paths to reset back to their committed state including filename,
422
- # rooted at workspace root. If left empty, all files will be reset.
725
+ # Optional. Full file paths to reset back to their committed state including
726
+ # filename, rooted at workspace root. If left empty, all files will be reset.
423
727
  # @!attribute [rw] clean
424
728
  # @return [::Boolean]
425
729
  # Optional. If set to true, untracked files will be deleted.
@@ -434,7 +738,8 @@ module Google
434
738
  # Required. The workspace's name.
435
739
  # @!attribute [rw] path
436
740
  # @return [::String]
437
- # Required. The file's full path including filename, relative to the workspace root.
741
+ # Required. The file's full path including filename, relative to the
742
+ # workspace root.
438
743
  class FetchFileDiffRequest
439
744
  include ::Google::Protobuf::MessageExts
440
745
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -455,8 +760,8 @@ module Google
455
760
  # Required. The workspace's name.
456
761
  # @!attribute [rw] path
457
762
  # @return [::String]
458
- # Optional. The directory's full path including directory name, relative to the
459
- # workspace root. If left unset, the workspace root is used.
763
+ # Optional. The directory's full path including directory name, relative to
764
+ # the workspace root. If left unset, the workspace root is used.
460
765
  # @!attribute [rw] page_size
461
766
  # @return [::Integer]
462
767
  # Optional. Maximum number of paths to return. The server may return fewer
@@ -464,8 +769,8 @@ module Google
464
769
  # default.
465
770
  # @!attribute [rw] page_token
466
771
  # @return [::String]
467
- # Optional. Page token received from a previous `QueryDirectoryContents` call.
468
- # Provide this to retrieve the subsequent page.
772
+ # Optional. Page token received from a previous `QueryDirectoryContents`
773
+ # call. Provide this to retrieve the subsequent page.
469
774
  #
470
775
  # When paginating, all other parameters provided to
471
776
  # `QueryDirectoryContents` must match the call that provided the page
@@ -477,7 +782,7 @@ module Google
477
782
 
478
783
  # `QueryDirectoryContents` response message.
479
784
  # @!attribute [rw] directory_entries
480
- # @return [::Array<::Google::Cloud::Dataform::V1beta1::QueryDirectoryContentsResponse::DirectoryEntry>]
785
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>]
481
786
  # List of entries in the directory.
482
787
  # @!attribute [rw] next_page_token
483
788
  # @return [::String]
@@ -486,18 +791,18 @@ module Google
486
791
  class QueryDirectoryContentsResponse
487
792
  include ::Google::Protobuf::MessageExts
488
793
  extend ::Google::Protobuf::MessageExts::ClassMethods
794
+ end
489
795
 
490
- # Represents a single entry in a workspace directory.
491
- # @!attribute [rw] file
492
- # @return [::String]
493
- # A file in the directory.
494
- # @!attribute [rw] directory
495
- # @return [::String]
496
- # A child directory in the directory.
497
- class DirectoryEntry
498
- include ::Google::Protobuf::MessageExts
499
- extend ::Google::Protobuf::MessageExts::ClassMethods
500
- end
796
+ # Represents a single entry in a directory.
797
+ # @!attribute [rw] file
798
+ # @return [::String]
799
+ # A file in the directory.
800
+ # @!attribute [rw] directory
801
+ # @return [::String]
802
+ # A child directory in the directory.
803
+ class DirectoryEntry
804
+ include ::Google::Protobuf::MessageExts
805
+ extend ::Google::Protobuf::MessageExts::ClassMethods
501
806
  end
502
807
 
503
808
  # `MakeDirectory` request message.
@@ -506,8 +811,8 @@ module Google
506
811
  # Required. The workspace's name.
507
812
  # @!attribute [rw] path
508
813
  # @return [::String]
509
- # Required. The directory's full path including directory name, relative to the
510
- # workspace root.
814
+ # Required. The directory's full path including directory name, relative to
815
+ # the workspace root.
511
816
  class MakeDirectoryRequest
512
817
  include ::Google::Protobuf::MessageExts
513
818
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -525,8 +830,8 @@ module Google
525
830
  # Required. The workspace's name.
526
831
  # @!attribute [rw] path
527
832
  # @return [::String]
528
- # Required. The directory's full path including directory name, relative to the
529
- # workspace root.
833
+ # Required. The directory's full path including directory name, relative to
834
+ # the workspace root.
530
835
  class RemoveDirectoryRequest
531
836
  include ::Google::Protobuf::MessageExts
532
837
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -538,12 +843,12 @@ module Google
538
843
  # Required. The workspace's name.
539
844
  # @!attribute [rw] path
540
845
  # @return [::String]
541
- # Required. The directory's full path including directory name, relative to the
542
- # workspace root.
846
+ # Required. The directory's full path including directory name, relative to
847
+ # the workspace root.
543
848
  # @!attribute [rw] new_path
544
849
  # @return [::String]
545
- # Required. The new path for the directory including directory name, rooted at
546
- # workspace root.
850
+ # Required. The new path for the directory including directory name, rooted
851
+ # at workspace root.
547
852
  class MoveDirectoryRequest
548
853
  include ::Google::Protobuf::MessageExts
549
854
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -561,7 +866,8 @@ module Google
561
866
  # Required. The workspace's name.
562
867
  # @!attribute [rw] path
563
868
  # @return [::String]
564
- # Required. The file's full path including filename, relative to the workspace root.
869
+ # Required. The file's full path including filename, relative to the
870
+ # workspace root.
565
871
  class ReadFileRequest
566
872
  include ::Google::Protobuf::MessageExts
567
873
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -582,7 +888,8 @@ module Google
582
888
  # Required. The workspace's name.
583
889
  # @!attribute [rw] path
584
890
  # @return [::String]
585
- # Required. The file's full path including filename, relative to the workspace root.
891
+ # Required. The file's full path including filename, relative to the
892
+ # workspace root.
586
893
  class RemoveFileRequest
587
894
  include ::Google::Protobuf::MessageExts
588
895
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -594,10 +901,12 @@ module Google
594
901
  # Required. The workspace's name.
595
902
  # @!attribute [rw] path
596
903
  # @return [::String]
597
- # Required. The file's full path including filename, relative to the workspace root.
904
+ # Required. The file's full path including filename, relative to the
905
+ # workspace root.
598
906
  # @!attribute [rw] new_path
599
907
  # @return [::String]
600
- # Required. The file's new path including filename, relative to the workspace root.
908
+ # Required. The file's new path including filename, relative to the workspace
909
+ # root.
601
910
  class MoveFileRequest
602
911
  include ::Google::Protobuf::MessageExts
603
912
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -645,15 +954,162 @@ module Google
645
954
  extend ::Google::Protobuf::MessageExts::ClassMethods
646
955
  end
647
956
 
957
+ # Represents a Dataform release configuration.
958
+ # @!attribute [r] name
959
+ # @return [::String]
960
+ # Output only. The release config's name.
961
+ # @!attribute [rw] git_commitish
962
+ # @return [::String]
963
+ # Required. Git commit/tag/branch name at which the repository should be
964
+ # compiled. Must exist in the remote repository. Examples:
965
+ # - a commit SHA: `12ade345`
966
+ # - a tag: `tag1`
967
+ # - a branch name: `branch1`
968
+ # @!attribute [rw] code_compilation_config
969
+ # @return [::Google::Cloud::Dataform::V1beta1::CodeCompilationConfig]
970
+ # Optional. If set, fields of `code_compilation_config` override the default
971
+ # compilation settings that are specified in dataform.json.
972
+ # @!attribute [rw] cron_schedule
973
+ # @return [::String]
974
+ # Optional. Optional schedule (in cron format) for automatic creation of
975
+ # compilation results.
976
+ # @!attribute [rw] time_zone
977
+ # @return [::String]
978
+ # Optional. Specifies the time zone to be used when interpreting
979
+ # cron_schedule. Must be a time zone name from the time zone database
980
+ # (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left
981
+ # unspecified, the default is UTC.
982
+ # @!attribute [r] recent_scheduled_release_records
983
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::ReleaseConfig::ScheduledReleaseRecord>]
984
+ # Output only. Records of the 10 most recent scheduled release attempts,
985
+ # ordered in in descending order of `release_time`. Updated whenever
986
+ # automatic creation of a compilation result is triggered by cron_schedule.
987
+ # @!attribute [rw] release_compilation_result
988
+ # @return [::String]
989
+ # Optional. The name of the currently released compilation result for this
990
+ # release config. This value is updated when a compilation result is created
991
+ # from this release config, or when this resource is updated by API call
992
+ # (perhaps to roll back to an earlier release). The compilation result must
993
+ # have been created using this release config. Must be in the format
994
+ # `projects/*/locations/*/repositories/*/compilationResults/*`.
995
+ class ReleaseConfig
996
+ include ::Google::Protobuf::MessageExts
997
+ extend ::Google::Protobuf::MessageExts::ClassMethods
998
+
999
+ # A record of an attempt to create a compilation result for this release
1000
+ # config.
1001
+ # @!attribute [rw] release_time
1002
+ # @return [::Google::Protobuf::Timestamp]
1003
+ # The timestamp of this release attempt.
1004
+ # @!attribute [rw] compilation_result
1005
+ # @return [::String]
1006
+ # The name of the created compilation result, if one was successfully
1007
+ # created. Must be in the format
1008
+ # `projects/*/locations/*/repositories/*/compilationResults/*`.
1009
+ # @!attribute [rw] error_status
1010
+ # @return [::Google::Rpc::Status]
1011
+ # The error status encountered upon this attempt to create the
1012
+ # compilation result, if the attempt was unsuccessful.
1013
+ class ScheduledReleaseRecord
1014
+ include ::Google::Protobuf::MessageExts
1015
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1016
+ end
1017
+ end
1018
+
1019
+ # `ListReleaseConfigs` request message.
1020
+ # @!attribute [rw] parent
1021
+ # @return [::String]
1022
+ # Required. The repository in which to list release configs. Must be in the
1023
+ # format `projects/*/locations/*/repositories/*`.
1024
+ # @!attribute [rw] page_size
1025
+ # @return [::Integer]
1026
+ # Optional. Maximum number of release configs to return. The server may
1027
+ # return fewer items than requested. If unspecified, the server will pick an
1028
+ # appropriate default.
1029
+ # @!attribute [rw] page_token
1030
+ # @return [::String]
1031
+ # Optional. Page token received from a previous `ListReleaseConfigs` call.
1032
+ # Provide this to retrieve the subsequent page.
1033
+ #
1034
+ # When paginating, all other parameters provided to `ListReleaseConfigs`
1035
+ # must match the call that provided the page token.
1036
+ class ListReleaseConfigsRequest
1037
+ include ::Google::Protobuf::MessageExts
1038
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1039
+ end
1040
+
1041
+ # `ListReleaseConfigs` response message.
1042
+ # @!attribute [rw] release_configs
1043
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::ReleaseConfig>]
1044
+ # List of release configs.
1045
+ # @!attribute [rw] next_page_token
1046
+ # @return [::String]
1047
+ # A token, which can be sent as `page_token` to retrieve the next page.
1048
+ # If this field is omitted, there are no subsequent pages.
1049
+ # @!attribute [rw] unreachable
1050
+ # @return [::Array<::String>]
1051
+ # Locations which could not be reached.
1052
+ class ListReleaseConfigsResponse
1053
+ include ::Google::Protobuf::MessageExts
1054
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1055
+ end
1056
+
1057
+ # `GetReleaseConfig` request message.
1058
+ # @!attribute [rw] name
1059
+ # @return [::String]
1060
+ # Required. The release config's name.
1061
+ class GetReleaseConfigRequest
1062
+ include ::Google::Protobuf::MessageExts
1063
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1064
+ end
1065
+
1066
+ # `CreateReleaseConfig` request message.
1067
+ # @!attribute [rw] parent
1068
+ # @return [::String]
1069
+ # Required. The repository in which to create the release config. Must be in
1070
+ # the format `projects/*/locations/*/repositories/*`.
1071
+ # @!attribute [rw] release_config
1072
+ # @return [::Google::Cloud::Dataform::V1beta1::ReleaseConfig]
1073
+ # Required. The release config to create.
1074
+ # @!attribute [rw] release_config_id
1075
+ # @return [::String]
1076
+ # Required. The ID to use for the release config, which will become the final
1077
+ # component of the release config's resource name.
1078
+ class CreateReleaseConfigRequest
1079
+ include ::Google::Protobuf::MessageExts
1080
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1081
+ end
1082
+
1083
+ # `UpdateReleaseConfig` request message.
1084
+ # @!attribute [rw] update_mask
1085
+ # @return [::Google::Protobuf::FieldMask]
1086
+ # Optional. Specifies the fields to be updated in the release config. If left
1087
+ # unset, all fields will be updated.
1088
+ # @!attribute [rw] release_config
1089
+ # @return [::Google::Cloud::Dataform::V1beta1::ReleaseConfig]
1090
+ # Required. The release config to update.
1091
+ class UpdateReleaseConfigRequest
1092
+ include ::Google::Protobuf::MessageExts
1093
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1094
+ end
1095
+
1096
+ # `DeleteReleaseConfig` request message.
1097
+ # @!attribute [rw] name
1098
+ # @return [::String]
1099
+ # Required. The release config's name.
1100
+ class DeleteReleaseConfigRequest
1101
+ include ::Google::Protobuf::MessageExts
1102
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1103
+ end
1104
+
648
1105
  # Represents the result of compiling a Dataform project.
649
1106
  # @!attribute [r] name
650
1107
  # @return [::String]
651
1108
  # Output only. The compilation result's name.
652
1109
  # @!attribute [rw] git_commitish
653
1110
  # @return [::String]
654
- # Immutable. Git commit/tag/branch name at which the repository should be compiled.
655
- # Must exist in the remote repository.
656
- # Examples:
1111
+ # Immutable. Git commit/tag/branch name at which the repository should be
1112
+ # compiled. Must exist in the remote repository. Examples:
657
1113
  # - a commit SHA: `12ade345`
658
1114
  # - a tag: `tag1`
659
1115
  # - a branch name: `branch1`
@@ -661,10 +1117,20 @@ module Google
661
1117
  # @return [::String]
662
1118
  # Immutable. The name of the workspace to compile. Must be in the format
663
1119
  # `projects/*/locations/*/repositories/*/workspaces/*`.
1120
+ # @!attribute [rw] release_config
1121
+ # @return [::String]
1122
+ # Immutable. The name of the release config to compile. The release
1123
+ # config's 'current_compilation_result' field will be updated to this
1124
+ # compilation result. Must be in the format
1125
+ # `projects/*/locations/*/repositories/*/releaseConfigs/*`.
664
1126
  # @!attribute [rw] code_compilation_config
665
- # @return [::Google::Cloud::Dataform::V1beta1::CompilationResult::CodeCompilationConfig]
666
- # Immutable. If set, fields of `code_compilation_overrides` override the default
1127
+ # @return [::Google::Cloud::Dataform::V1beta1::CodeCompilationConfig]
1128
+ # Immutable. If set, fields of `code_compilation_config` override the default
667
1129
  # compilation settings that are specified in dataform.json.
1130
+ # @!attribute [r] resolved_git_commit_sha
1131
+ # @return [::String]
1132
+ # Output only. The fully resolved Git commit SHA of the code that was
1133
+ # compiled. Not set for compilation results whose source is a workspace.
668
1134
  # @!attribute [r] dataform_core_version
669
1135
  # @return [::String]
670
1136
  # Output only. The version of `@dataform/core` that was used for compilation.
@@ -675,50 +1141,6 @@ module Google
675
1141
  include ::Google::Protobuf::MessageExts
676
1142
  extend ::Google::Protobuf::MessageExts::ClassMethods
677
1143
 
678
- # Configures various aspects of Dataform code compilation.
679
- # @!attribute [rw] default_database
680
- # @return [::String]
681
- # Optional. The default database (Google Cloud project ID).
682
- # @!attribute [rw] default_schema
683
- # @return [::String]
684
- # Optional. The default schema (BigQuery dataset ID).
685
- # @!attribute [rw] default_location
686
- # @return [::String]
687
- # Optional. The default BigQuery location to use. Defaults to "US".
688
- # See the BigQuery docs for a full list of locations:
689
- # https://cloud.google.com/bigquery/docs/locations.
690
- # @!attribute [rw] assertion_schema
691
- # @return [::String]
692
- # Optional. The default schema (BigQuery dataset ID) for assertions.
693
- # @!attribute [rw] vars
694
- # @return [::Google::Protobuf::Map{::String => ::String}]
695
- # Optional. User-defined variables that are made available to project code during
696
- # compilation.
697
- # @!attribute [rw] database_suffix
698
- # @return [::String]
699
- # Optional. The suffix that should be appended to all database (Google Cloud project
700
- # ID) names.
701
- # @!attribute [rw] schema_suffix
702
- # @return [::String]
703
- # Optional. The suffix that should be appended to all schema (BigQuery dataset ID)
704
- # names.
705
- # @!attribute [rw] table_prefix
706
- # @return [::String]
707
- # Optional. The prefix that should be prepended to all table names.
708
- class CodeCompilationConfig
709
- include ::Google::Protobuf::MessageExts
710
- extend ::Google::Protobuf::MessageExts::ClassMethods
711
-
712
- # @!attribute [rw] key
713
- # @return [::String]
714
- # @!attribute [rw] value
715
- # @return [::String]
716
- class VarsEntry
717
- include ::Google::Protobuf::MessageExts
718
- extend ::Google::Protobuf::MessageExts::ClassMethods
719
- end
720
- end
721
-
722
1144
  # An error encountered when attempting to compile a Dataform project.
723
1145
  # @!attribute [r] message
724
1146
  # @return [::String]
@@ -728,31 +1150,76 @@ module Google
728
1150
  # Output only. The error's full stack trace.
729
1151
  # @!attribute [r] path
730
1152
  # @return [::String]
731
- # Output only. The path of the file where this error occurred, if available, relative to
732
- # the project root.
1153
+ # Output only. The path of the file where this error occurred, if
1154
+ # available, relative to the project root.
733
1155
  # @!attribute [r] action_target
734
1156
  # @return [::Google::Cloud::Dataform::V1beta1::Target]
735
- # Output only. The identifier of the action where this error occurred, if available.
1157
+ # Output only. The identifier of the action where this error occurred, if
1158
+ # available.
736
1159
  class CompilationError
737
1160
  include ::Google::Protobuf::MessageExts
738
1161
  extend ::Google::Protobuf::MessageExts::ClassMethods
739
1162
  end
740
1163
  end
741
1164
 
1165
+ # Configures various aspects of Dataform code compilation.
1166
+ # @!attribute [rw] default_database
1167
+ # @return [::String]
1168
+ # Optional. The default database (Google Cloud project ID).
1169
+ # @!attribute [rw] default_schema
1170
+ # @return [::String]
1171
+ # Optional. The default schema (BigQuery dataset ID).
1172
+ # @!attribute [rw] default_location
1173
+ # @return [::String]
1174
+ # Optional. The default BigQuery location to use. Defaults to "US".
1175
+ # See the BigQuery docs for a full list of locations:
1176
+ # https://cloud.google.com/bigquery/docs/locations.
1177
+ # @!attribute [rw] assertion_schema
1178
+ # @return [::String]
1179
+ # Optional. The default schema (BigQuery dataset ID) for assertions.
1180
+ # @!attribute [rw] vars
1181
+ # @return [::Google::Protobuf::Map{::String => ::String}]
1182
+ # Optional. User-defined variables that are made available to project code
1183
+ # during compilation.
1184
+ # @!attribute [rw] database_suffix
1185
+ # @return [::String]
1186
+ # Optional. The suffix that should be appended to all database (Google Cloud
1187
+ # project ID) names.
1188
+ # @!attribute [rw] schema_suffix
1189
+ # @return [::String]
1190
+ # Optional. The suffix that should be appended to all schema (BigQuery
1191
+ # dataset ID) names.
1192
+ # @!attribute [rw] table_prefix
1193
+ # @return [::String]
1194
+ # Optional. The prefix that should be prepended to all table names.
1195
+ class CodeCompilationConfig
1196
+ include ::Google::Protobuf::MessageExts
1197
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1198
+
1199
+ # @!attribute [rw] key
1200
+ # @return [::String]
1201
+ # @!attribute [rw] value
1202
+ # @return [::String]
1203
+ class VarsEntry
1204
+ include ::Google::Protobuf::MessageExts
1205
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1206
+ end
1207
+ end
1208
+
742
1209
  # `ListCompilationResults` request message.
743
1210
  # @!attribute [rw] parent
744
1211
  # @return [::String]
745
- # Required. The repository in which to list compilation results. Must be in the
746
- # format `projects/*/locations/*/repositories/*`.
1212
+ # Required. The repository in which to list compilation results. Must be in
1213
+ # the format `projects/*/locations/*/repositories/*`.
747
1214
  # @!attribute [rw] page_size
748
1215
  # @return [::Integer]
749
- # Optional. Maximum number of compilation results to return. The server may return
750
- # fewer items than requested. If unspecified, the server will pick an
1216
+ # Optional. Maximum number of compilation results to return. The server may
1217
+ # return fewer items than requested. If unspecified, the server will pick an
751
1218
  # appropriate default.
752
1219
  # @!attribute [rw] page_token
753
1220
  # @return [::String]
754
- # Optional. Page token received from a previous `ListCompilationResults` call.
755
- # Provide this to retrieve the subsequent page.
1221
+ # Optional. Page token received from a previous `ListCompilationResults`
1222
+ # call. Provide this to retrieve the subsequent page.
756
1223
  #
757
1224
  # When paginating, all other parameters provided to `ListCompilationResults`
758
1225
  # must match the call that provided the page token.
@@ -789,8 +1256,8 @@ module Google
789
1256
  # `CreateCompilationResult` request message.
790
1257
  # @!attribute [rw] parent
791
1258
  # @return [::String]
792
- # Required. The repository in which to create the compilation result. Must be in the
793
- # format `projects/*/locations/*/repositories/*`.
1259
+ # Required. The repository in which to create the compilation result. Must be
1260
+ # in the format `projects/*/locations/*/repositories/*`.
794
1261
  # @!attribute [rw] compilation_result
795
1262
  # @return [::Google::Cloud::Dataform::V1beta1::CompilationResult]
796
1263
  # Required. The compilation result to create.
@@ -1067,21 +1534,22 @@ module Google
1067
1534
  # Required. The compilation result's name.
1068
1535
  # @!attribute [rw] page_size
1069
1536
  # @return [::Integer]
1070
- # Optional. Maximum number of compilation results to return. The server may return
1071
- # fewer items than requested. If unspecified, the server will pick an
1537
+ # Optional. Maximum number of compilation results to return. The server may
1538
+ # return fewer items than requested. If unspecified, the server will pick an
1072
1539
  # appropriate default.
1073
1540
  # @!attribute [rw] page_token
1074
1541
  # @return [::String]
1075
- # Optional. Page token received from a previous `QueryCompilationResultActions` call.
1076
- # Provide this to retrieve the subsequent page.
1542
+ # Optional. Page token received from a previous
1543
+ # `QueryCompilationResultActions` call. Provide this to retrieve the
1544
+ # subsequent page.
1077
1545
  #
1078
1546
  # When paginating, all other parameters provided to
1079
1547
  # `QueryCompilationResultActions` must match the call that provided the page
1080
1548
  # token.
1081
1549
  # @!attribute [rw] filter
1082
1550
  # @return [::String]
1083
- # Optional. Optional filter for the returned list. Filtering is only currently
1084
- # supported on the `file_path` field.
1551
+ # Optional. Optional filter for the returned list. Filtering is only
1552
+ # currently supported on the `file_path` field.
1085
1553
  class QueryCompilationResultActionsRequest
1086
1554
  include ::Google::Protobuf::MessageExts
1087
1555
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1100,16 +1568,186 @@ module Google
1100
1568
  extend ::Google::Protobuf::MessageExts::ClassMethods
1101
1569
  end
1102
1570
 
1571
+ # Represents a Dataform workflow configuration.
1572
+ # @!attribute [r] name
1573
+ # @return [::String]
1574
+ # Output only. The workflow config's name.
1575
+ # @!attribute [rw] release_config
1576
+ # @return [::String]
1577
+ # Required. The name of the release config whose release_compilation_result
1578
+ # should be executed. Must be in the format
1579
+ # `projects/*/locations/*/repositories/*/releaseConfigs/*`.
1580
+ # @!attribute [rw] invocation_config
1581
+ # @return [::Google::Cloud::Dataform::V1beta1::InvocationConfig]
1582
+ # Optional. If left unset, a default InvocationConfig will be used.
1583
+ # @!attribute [rw] cron_schedule
1584
+ # @return [::String]
1585
+ # Optional. Optional schedule (in cron format) for automatic execution of
1586
+ # this workflow config.
1587
+ # @!attribute [rw] time_zone
1588
+ # @return [::String]
1589
+ # Optional. Specifies the time zone to be used when interpreting
1590
+ # cron_schedule. Must be a time zone name from the time zone database
1591
+ # (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left
1592
+ # unspecified, the default is UTC.
1593
+ # @!attribute [r] recent_scheduled_execution_records
1594
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::WorkflowConfig::ScheduledExecutionRecord>]
1595
+ # Output only. Records of the 10 most recent scheduled execution attempts,
1596
+ # ordered in in descending order of `execution_time`. Updated whenever
1597
+ # automatic creation of a workflow invocation is triggered by cron_schedule.
1598
+ class WorkflowConfig
1599
+ include ::Google::Protobuf::MessageExts
1600
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1601
+
1602
+ # A record of an attempt to create a workflow invocation for this workflow
1603
+ # config.
1604
+ # @!attribute [rw] execution_time
1605
+ # @return [::Google::Protobuf::Timestamp]
1606
+ # The timestamp of this execution attempt.
1607
+ # @!attribute [rw] workflow_invocation
1608
+ # @return [::String]
1609
+ # The name of the created workflow invocation, if one was successfully
1610
+ # created. Must be in the format
1611
+ # `projects/*/locations/*/repositories/*/workflowInvocations/*`.
1612
+ # @!attribute [rw] error_status
1613
+ # @return [::Google::Rpc::Status]
1614
+ # The error status encountered upon this attempt to create the
1615
+ # workflow invocation, if the attempt was unsuccessful.
1616
+ class ScheduledExecutionRecord
1617
+ include ::Google::Protobuf::MessageExts
1618
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1619
+ end
1620
+ end
1621
+
1622
+ # Includes various configuration options for a workflow invocation.
1623
+ # If both `included_targets` and `included_tags` are unset, all actions
1624
+ # will be included.
1625
+ # @!attribute [rw] included_targets
1626
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::Target>]
1627
+ # Optional. The set of action identifiers to include.
1628
+ # @!attribute [rw] included_tags
1629
+ # @return [::Array<::String>]
1630
+ # Optional. The set of tags to include.
1631
+ # @!attribute [rw] transitive_dependencies_included
1632
+ # @return [::Boolean]
1633
+ # Optional. When set to true, transitive dependencies of included actions
1634
+ # will be executed.
1635
+ # @!attribute [rw] transitive_dependents_included
1636
+ # @return [::Boolean]
1637
+ # Optional. When set to true, transitive dependents of included actions will
1638
+ # be executed.
1639
+ # @!attribute [rw] fully_refresh_incremental_tables_enabled
1640
+ # @return [::Boolean]
1641
+ # Optional. When set to true, any incremental tables will be fully refreshed.
1642
+ # @!attribute [rw] service_account
1643
+ # @return [::String]
1644
+ # Optional. The service account to run workflow invocations under.
1645
+ class InvocationConfig
1646
+ include ::Google::Protobuf::MessageExts
1647
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1648
+ end
1649
+
1650
+ # `ListWorkflowConfigs` request message.
1651
+ # @!attribute [rw] parent
1652
+ # @return [::String]
1653
+ # Required. The repository in which to list workflow configs. Must be in the
1654
+ # format `projects/*/locations/*/repositories/*`.
1655
+ # @!attribute [rw] page_size
1656
+ # @return [::Integer]
1657
+ # Optional. Maximum number of workflow configs to return. The server may
1658
+ # return fewer items than requested. If unspecified, the server will pick an
1659
+ # appropriate default.
1660
+ # @!attribute [rw] page_token
1661
+ # @return [::String]
1662
+ # Optional. Page token received from a previous `ListWorkflowConfigs` call.
1663
+ # Provide this to retrieve the subsequent page.
1664
+ #
1665
+ # When paginating, all other parameters provided to `ListWorkflowConfigs`
1666
+ # must match the call that provided the page token.
1667
+ class ListWorkflowConfigsRequest
1668
+ include ::Google::Protobuf::MessageExts
1669
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1670
+ end
1671
+
1672
+ # `ListWorkflowConfigs` response message.
1673
+ # @!attribute [rw] workflow_configs
1674
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::WorkflowConfig>]
1675
+ # List of workflow configs.
1676
+ # @!attribute [rw] next_page_token
1677
+ # @return [::String]
1678
+ # A token, which can be sent as `page_token` to retrieve the next page.
1679
+ # If this field is omitted, there are no subsequent pages.
1680
+ # @!attribute [rw] unreachable
1681
+ # @return [::Array<::String>]
1682
+ # Locations which could not be reached.
1683
+ class ListWorkflowConfigsResponse
1684
+ include ::Google::Protobuf::MessageExts
1685
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1686
+ end
1687
+
1688
+ # `GetWorkflowConfig` request message.
1689
+ # @!attribute [rw] name
1690
+ # @return [::String]
1691
+ # Required. The workflow config's name.
1692
+ class GetWorkflowConfigRequest
1693
+ include ::Google::Protobuf::MessageExts
1694
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1695
+ end
1696
+
1697
+ # `CreateWorkflowConfig` request message.
1698
+ # @!attribute [rw] parent
1699
+ # @return [::String]
1700
+ # Required. The repository in which to create the workflow config. Must be in
1701
+ # the format `projects/*/locations/*/repositories/*`.
1702
+ # @!attribute [rw] workflow_config
1703
+ # @return [::Google::Cloud::Dataform::V1beta1::WorkflowConfig]
1704
+ # Required. The workflow config to create.
1705
+ # @!attribute [rw] workflow_config_id
1706
+ # @return [::String]
1707
+ # Required. The ID to use for the workflow config, which will become the
1708
+ # final component of the workflow config's resource name.
1709
+ class CreateWorkflowConfigRequest
1710
+ include ::Google::Protobuf::MessageExts
1711
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1712
+ end
1713
+
1714
+ # `UpdateWorkflowConfig` request message.
1715
+ # @!attribute [rw] update_mask
1716
+ # @return [::Google::Protobuf::FieldMask]
1717
+ # Optional. Specifies the fields to be updated in the workflow config. If
1718
+ # left unset, all fields will be updated.
1719
+ # @!attribute [rw] workflow_config
1720
+ # @return [::Google::Cloud::Dataform::V1beta1::WorkflowConfig]
1721
+ # Required. The workflow config to update.
1722
+ class UpdateWorkflowConfigRequest
1723
+ include ::Google::Protobuf::MessageExts
1724
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1725
+ end
1726
+
1727
+ # `DeleteWorkflowConfig` request message.
1728
+ # @!attribute [rw] name
1729
+ # @return [::String]
1730
+ # Required. The workflow config's name.
1731
+ class DeleteWorkflowConfigRequest
1732
+ include ::Google::Protobuf::MessageExts
1733
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1734
+ end
1735
+
1103
1736
  # Represents a single invocation of a compilation result.
1104
1737
  # @!attribute [r] name
1105
1738
  # @return [::String]
1106
1739
  # Output only. The workflow invocation's name.
1107
1740
  # @!attribute [rw] compilation_result
1108
1741
  # @return [::String]
1109
- # Immutable. The name of the compilation result to compile. Must be in the format
1742
+ # Immutable. The name of the compilation result to use for this invocation.
1743
+ # Must be in the format
1110
1744
  # `projects/*/locations/*/repositories/*/compilationResults/*`.
1745
+ # @!attribute [rw] workflow_config
1746
+ # @return [::String]
1747
+ # Immutable. The name of the workflow config to invoke. Must be in the
1748
+ # format `projects/*/locations/*/repositories/*/workflowConfigs/*`.
1111
1749
  # @!attribute [rw] invocation_config
1112
- # @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocation::InvocationConfig]
1750
+ # @return [::Google::Cloud::Dataform::V1beta1::InvocationConfig]
1113
1751
  # Immutable. If left unset, a default InvocationConfig will be used.
1114
1752
  # @!attribute [r] state
1115
1753
  # @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocation::State]
@@ -1121,31 +1759,6 @@ module Google
1121
1759
  include ::Google::Protobuf::MessageExts
1122
1760
  extend ::Google::Protobuf::MessageExts::ClassMethods
1123
1761
 
1124
- # Includes various configuration options for this workflow invocation.
1125
- # If both `included_targets` and `included_tags` are unset, all actions
1126
- # will be included.
1127
- # @!attribute [rw] included_targets
1128
- # @return [::Array<::Google::Cloud::Dataform::V1beta1::Target>]
1129
- # Immutable. The set of action identifiers to include.
1130
- # @!attribute [rw] included_tags
1131
- # @return [::Array<::String>]
1132
- # Immutable. The set of tags to include.
1133
- # @!attribute [rw] transitive_dependencies_included
1134
- # @return [::Boolean]
1135
- # Immutable. When set to true, transitive dependencies of included actions will be
1136
- # executed.
1137
- # @!attribute [rw] transitive_dependents_included
1138
- # @return [::Boolean]
1139
- # Immutable. When set to true, transitive dependents of included actions will be
1140
- # executed.
1141
- # @!attribute [rw] fully_refresh_incremental_tables_enabled
1142
- # @return [::Boolean]
1143
- # Immutable. When set to true, any incremental tables will be fully refreshed.
1144
- class InvocationConfig
1145
- include ::Google::Protobuf::MessageExts
1146
- extend ::Google::Protobuf::MessageExts::ClassMethods
1147
- end
1148
-
1149
1762
  # Represents the current state of a workflow invocation.
1150
1763
  module State
1151
1764
  # Default value. This value is unused.
@@ -1172,20 +1785,28 @@ module Google
1172
1785
  # `ListWorkflowInvocations` request message.
1173
1786
  # @!attribute [rw] parent
1174
1787
  # @return [::String]
1175
- # Required. The parent resource of the WorkflowInvocation type. Must be in the
1176
- # format `projects/*/locations/*/repositories/*`.
1788
+ # Required. The parent resource of the WorkflowInvocation type. Must be in
1789
+ # the format `projects/*/locations/*/repositories/*`.
1177
1790
  # @!attribute [rw] page_size
1178
1791
  # @return [::Integer]
1179
- # Optional. Maximum number of workflow invocations to return. The server may return
1180
- # fewer items than requested. If unspecified, the server will pick an
1792
+ # Optional. Maximum number of workflow invocations to return. The server may
1793
+ # return fewer items than requested. If unspecified, the server will pick an
1181
1794
  # appropriate default.
1182
1795
  # @!attribute [rw] page_token
1183
1796
  # @return [::String]
1184
- # Optional. Page token received from a previous `ListWorkflowInvocations` call.
1185
- # Provide this to retrieve the subsequent page.
1797
+ # Optional. Page token received from a previous `ListWorkflowInvocations`
1798
+ # call. Provide this to retrieve the subsequent page.
1186
1799
  #
1187
1800
  # When paginating, all other parameters provided to `ListWorkflowInvocations`
1188
1801
  # must match the call that provided the page token.
1802
+ # @!attribute [rw] order_by
1803
+ # @return [::String]
1804
+ # Optional. This field only supports ordering by `name`. If unspecified, the
1805
+ # server will choose the ordering. If specified, the default order is
1806
+ # ascending for the `name` field.
1807
+ # @!attribute [rw] filter
1808
+ # @return [::String]
1809
+ # Optional. Filter for the returned list.
1189
1810
  class ListWorkflowInvocationsRequest
1190
1811
  include ::Google::Protobuf::MessageExts
1191
1812
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1219,8 +1840,8 @@ module Google
1219
1840
  # `CreateWorkflowInvocation` request message.
1220
1841
  # @!attribute [rw] parent
1221
1842
  # @return [::String]
1222
- # Required. The repository in which to create the workflow invocation. Must be in the
1223
- # format `projects/*/locations/*/repositories/*`.
1843
+ # Required. The repository in which to create the workflow invocation. Must
1844
+ # be in the format `projects/*/locations/*/repositories/*`.
1224
1845
  # @!attribute [rw] workflow_invocation
1225
1846
  # @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocation]
1226
1847
  # Required. The workflow invocation resource to create.
@@ -1250,17 +1871,19 @@ module Google
1250
1871
  # Represents a single action in a workflow invocation.
1251
1872
  # @!attribute [r] target
1252
1873
  # @return [::Google::Cloud::Dataform::V1beta1::Target]
1253
- # Output only. This action's identifier. Unique within the workflow invocation.
1874
+ # Output only. This action's identifier. Unique within the workflow
1875
+ # invocation.
1254
1876
  # @!attribute [r] canonical_target
1255
1877
  # @return [::Google::Cloud::Dataform::V1beta1::Target]
1256
- # Output only. The action's identifier if the project had been compiled without any
1257
- # overrides configured. Unique within the compilation result.
1878
+ # Output only. The action's identifier if the project had been compiled
1879
+ # without any overrides configured. Unique within the compilation result.
1258
1880
  # @!attribute [r] state
1259
1881
  # @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::State]
1260
1882
  # Output only. This action's current state.
1261
1883
  # @!attribute [r] failure_reason
1262
1884
  # @return [::String]
1263
- # Output only. If and only if action's state is FAILED a failure reason is set.
1885
+ # Output only. If and only if action's state is FAILED a failure reason is
1886
+ # set.
1264
1887
  # @!attribute [r] invocation_timing
1265
1888
  # @return [::Google::Type::Interval]
1266
1889
  # Output only. This action's timing details.
@@ -1284,7 +1907,7 @@ module Google
1284
1907
  extend ::Google::Protobuf::MessageExts::ClassMethods
1285
1908
  end
1286
1909
 
1287
- # Represents the current state of an workflow invocation action.
1910
+ # Represents the current state of a workflow invocation action.
1288
1911
  module State
1289
1912
  # The action has not yet been considered for invocation.
1290
1913
  PENDING = 0
@@ -1317,13 +1940,14 @@ module Google
1317
1940
  # Required. The workflow invocation's name.
1318
1941
  # @!attribute [rw] page_size
1319
1942
  # @return [::Integer]
1320
- # Optional. Maximum number of workflow invocations to return. The server may return
1321
- # fewer items than requested. If unspecified, the server will pick an
1943
+ # Optional. Maximum number of workflow invocations to return. The server may
1944
+ # return fewer items than requested. If unspecified, the server will pick an
1322
1945
  # appropriate default.
1323
1946
  # @!attribute [rw] page_token
1324
1947
  # @return [::String]
1325
- # Optional. Page token received from a previous `QueryWorkflowInvocationActions` call.
1326
- # Provide this to retrieve the subsequent page.
1948
+ # Optional. Page token received from a previous
1949
+ # `QueryWorkflowInvocationActions` call. Provide this to retrieve the
1950
+ # subsequent page.
1327
1951
  #
1328
1952
  # When paginating, all other parameters provided to
1329
1953
  # `QueryWorkflowInvocationActions` must match the call that provided the page