google-cloud-dataform-v1beta1 0.a → 0.2.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 (32) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +149 -0
  4. data/README.md +144 -8
  5. data/lib/google/cloud/dataform/v1beta1/bindings_override.rb +102 -0
  6. data/lib/google/cloud/dataform/v1beta1/dataform/client.rb +3843 -0
  7. data/lib/google/cloud/dataform/v1beta1/dataform/credentials.rb +47 -0
  8. data/lib/google/cloud/dataform/v1beta1/dataform/paths.rb +151 -0
  9. data/lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb +2971 -0
  10. data/lib/google/cloud/dataform/v1beta1/dataform/rest/service_stub.rb +2189 -0
  11. data/lib/google/cloud/dataform/v1beta1/dataform/rest.rb +54 -0
  12. data/lib/google/cloud/dataform/v1beta1/dataform.rb +56 -0
  13. data/lib/google/cloud/dataform/v1beta1/dataform_pb.rb +504 -0
  14. data/lib/google/cloud/dataform/v1beta1/dataform_services_pb.rb +117 -0
  15. data/lib/google/cloud/dataform/v1beta1/rest.rb +38 -0
  16. data/lib/google/cloud/dataform/v1beta1/version.rb +7 -2
  17. data/lib/google/cloud/dataform/v1beta1.rb +45 -0
  18. data/lib/google-cloud-dataform-v1beta1.rb +21 -0
  19. data/proto_docs/README.md +4 -0
  20. data/proto_docs/google/api/client.rb +318 -0
  21. data/proto_docs/google/api/field_behavior.rb +71 -0
  22. data/proto_docs/google/api/launch_stage.rb +71 -0
  23. data/proto_docs/google/api/resource.rb +222 -0
  24. data/proto_docs/google/cloud/dataform/v1beta1/dataform.rb +1351 -0
  25. data/proto_docs/google/protobuf/any.rb +141 -0
  26. data/proto_docs/google/protobuf/duration.rb +98 -0
  27. data/proto_docs/google/protobuf/empty.rb +34 -0
  28. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  29. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  30. data/proto_docs/google/type/expr.rb +75 -0
  31. data/proto_docs/google/type/interval.rb +45 -0
  32. metadata +227 -13
@@ -0,0 +1,1351 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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 V1beta1
24
+ # Represents a Dataform Git repository.
25
+ # @!attribute [r] name
26
+ # @return [::String]
27
+ # Output only. The repository's name.
28
+ # @!attribute [rw] git_remote_settings
29
+ # @return [::Google::Cloud::Dataform::V1beta1::Repository::GitRemoteSettings]
30
+ # Optional. If set, configures this repository to be linked to a Git remote.
31
+ class Repository
32
+ include ::Google::Protobuf::MessageExts
33
+ extend ::Google::Protobuf::MessageExts::ClassMethods
34
+
35
+ # Controls Git remote configuration for a repository.
36
+ # @!attribute [rw] url
37
+ # @return [::String]
38
+ # Required. The Git remote's URL.
39
+ # @!attribute [rw] default_branch
40
+ # @return [::String]
41
+ # Required. The Git remote's default branch name.
42
+ # @!attribute [rw] authentication_token_secret_version
43
+ # @return [::String]
44
+ # Required. The name of the Secret Manager secret version to use as an
45
+ # authentication token for Git operations. Must be in the format
46
+ # `projects/*/secrets/*/versions/*`.
47
+ # @!attribute [r] token_status
48
+ # @return [::Google::Cloud::Dataform::V1beta1::Repository::GitRemoteSettings::TokenStatus]
49
+ # Output only. Indicates the status of the Git access token.
50
+ class GitRemoteSettings
51
+ include ::Google::Protobuf::MessageExts
52
+ extend ::Google::Protobuf::MessageExts::ClassMethods
53
+
54
+ # Indicates the status of a Git authentication token.
55
+ module TokenStatus
56
+ # Default value. This value is unused.
57
+ TOKEN_STATUS_UNSPECIFIED = 0
58
+
59
+ # The token could not be found in Secret Manager (or the Dataform
60
+ # Service Account did not have permission to access it).
61
+ NOT_FOUND = 1
62
+
63
+ # The token could not be used to authenticate against the Git remote.
64
+ INVALID = 2
65
+
66
+ # The token was used successfully to authenticate against the Git remote.
67
+ VALID = 3
68
+ end
69
+ end
70
+ end
71
+
72
+ # `ListRepositories` request message.
73
+ # @!attribute [rw] parent
74
+ # @return [::String]
75
+ # Required. The location in which to list repositories. Must be in the format
76
+ # `projects/*/locations/*`.
77
+ # @!attribute [rw] page_size
78
+ # @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.
82
+ # @!attribute [rw] page_token
83
+ # @return [::String]
84
+ # Optional. Page token received from a previous `ListRepositories` call.
85
+ # Provide this to retrieve the subsequent page.
86
+ #
87
+ # When paginating, all other parameters provided to `ListRepositories`
88
+ # must match the call that provided the page token.
89
+ # @!attribute [rw] order_by
90
+ # @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.
94
+ # @!attribute [rw] filter
95
+ # @return [::String]
96
+ # Optional. Filter for the returned list.
97
+ class ListRepositoriesRequest
98
+ include ::Google::Protobuf::MessageExts
99
+ extend ::Google::Protobuf::MessageExts::ClassMethods
100
+ end
101
+
102
+ # `ListRepositories` response message.
103
+ # @!attribute [rw] repositories
104
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::Repository>]
105
+ # List of repositories.
106
+ # @!attribute [rw] next_page_token
107
+ # @return [::String]
108
+ # A token which can be sent as `page_token` to retrieve the next page.
109
+ # If this field is omitted, there are no subsequent pages.
110
+ # @!attribute [rw] unreachable
111
+ # @return [::Array<::String>]
112
+ # Locations which could not be reached.
113
+ class ListRepositoriesResponse
114
+ include ::Google::Protobuf::MessageExts
115
+ extend ::Google::Protobuf::MessageExts::ClassMethods
116
+ end
117
+
118
+ # `GetRepository` request message.
119
+ # @!attribute [rw] name
120
+ # @return [::String]
121
+ # Required. The repository's name.
122
+ class GetRepositoryRequest
123
+ include ::Google::Protobuf::MessageExts
124
+ extend ::Google::Protobuf::MessageExts::ClassMethods
125
+ end
126
+
127
+ # `CreateRepository` request message.
128
+ # @!attribute [rw] parent
129
+ # @return [::String]
130
+ # Required. The location in which to create the repository. Must be in the format
131
+ # `projects/*/locations/*`.
132
+ # @!attribute [rw] repository
133
+ # @return [::Google::Cloud::Dataform::V1beta1::Repository]
134
+ # Required. The repository to create.
135
+ # @!attribute [rw] repository_id
136
+ # @return [::String]
137
+ # Required. The ID to use for the repository, which will become the final component of
138
+ # the repository's resource name.
139
+ class CreateRepositoryRequest
140
+ include ::Google::Protobuf::MessageExts
141
+ extend ::Google::Protobuf::MessageExts::ClassMethods
142
+ end
143
+
144
+ # `UpdateRepository` request message.
145
+ # @!attribute [rw] update_mask
146
+ # @return [::Google::Protobuf::FieldMask]
147
+ # Optional. Specifies the fields to be updated in the repository. If left unset,
148
+ # all fields will be updated.
149
+ # @!attribute [rw] repository
150
+ # @return [::Google::Cloud::Dataform::V1beta1::Repository]
151
+ # Required. The repository to update.
152
+ class UpdateRepositoryRequest
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+ end
156
+
157
+ # `DeleteRepository` request message.
158
+ # @!attribute [rw] name
159
+ # @return [::String]
160
+ # Required. The repository's name.
161
+ # @!attribute [rw] force
162
+ # @return [::Boolean]
163
+ # If set to true, any child resources of this repository will also be
164
+ # deleted. (Otherwise, the request will only succeed if the repository has no
165
+ # child resources.)
166
+ class DeleteRepositoryRequest
167
+ include ::Google::Protobuf::MessageExts
168
+ extend ::Google::Protobuf::MessageExts::ClassMethods
169
+ end
170
+
171
+ # `FetchRemoteBranches` request message.
172
+ # @!attribute [rw] name
173
+ # @return [::String]
174
+ # Required. The repository's name.
175
+ class FetchRemoteBranchesRequest
176
+ include ::Google::Protobuf::MessageExts
177
+ extend ::Google::Protobuf::MessageExts::ClassMethods
178
+ end
179
+
180
+ # `FetchRemoteBranches` response message.
181
+ # @!attribute [rw] branches
182
+ # @return [::Array<::String>]
183
+ # The remote repository's branch names.
184
+ class FetchRemoteBranchesResponse
185
+ include ::Google::Protobuf::MessageExts
186
+ extend ::Google::Protobuf::MessageExts::ClassMethods
187
+ end
188
+
189
+ # Represents a Dataform Git workspace.
190
+ # @!attribute [r] name
191
+ # @return [::String]
192
+ # Output only. The workspace's name.
193
+ class Workspace
194
+ include ::Google::Protobuf::MessageExts
195
+ extend ::Google::Protobuf::MessageExts::ClassMethods
196
+ end
197
+
198
+ # `ListWorkspaces` request message.
199
+ # @!attribute [rw] parent
200
+ # @return [::String]
201
+ # Required. The repository in which to list workspaces. Must be in the
202
+ # format `projects/*/locations/*/repositories/*`.
203
+ # @!attribute [rw] page_size
204
+ # @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.
208
+ # @!attribute [rw] page_token
209
+ # @return [::String]
210
+ # Optional. Page token received from a previous `ListWorkspaces` call.
211
+ # Provide this to retrieve the subsequent page.
212
+ #
213
+ # When paginating, all other parameters provided to `ListWorkspaces`
214
+ # must match the call that provided the page token.
215
+ # @!attribute [rw] order_by
216
+ # @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.
220
+ # @!attribute [rw] filter
221
+ # @return [::String]
222
+ # Optional. Filter for the returned list.
223
+ class ListWorkspacesRequest
224
+ include ::Google::Protobuf::MessageExts
225
+ extend ::Google::Protobuf::MessageExts::ClassMethods
226
+ end
227
+
228
+ # `ListWorkspaces` response message.
229
+ # @!attribute [rw] workspaces
230
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::Workspace>]
231
+ # List of workspaces.
232
+ # @!attribute [rw] next_page_token
233
+ # @return [::String]
234
+ # A token, which can be sent as `page_token` to retrieve the next page.
235
+ # If this field is omitted, there are no subsequent pages.
236
+ # @!attribute [rw] unreachable
237
+ # @return [::Array<::String>]
238
+ # Locations which could not be reached.
239
+ class ListWorkspacesResponse
240
+ include ::Google::Protobuf::MessageExts
241
+ extend ::Google::Protobuf::MessageExts::ClassMethods
242
+ end
243
+
244
+ # `GetWorkspace` request message.
245
+ # @!attribute [rw] name
246
+ # @return [::String]
247
+ # Required. The workspace's name.
248
+ class GetWorkspaceRequest
249
+ include ::Google::Protobuf::MessageExts
250
+ extend ::Google::Protobuf::MessageExts::ClassMethods
251
+ end
252
+
253
+ # `CreateWorkspace` request message.
254
+ # @!attribute [rw] parent
255
+ # @return [::String]
256
+ # Required. The repository in which to create the workspace. Must be in the format
257
+ # `projects/*/locations/*/repositories/*`.
258
+ # @!attribute [rw] workspace
259
+ # @return [::Google::Cloud::Dataform::V1beta1::Workspace]
260
+ # Required. The workspace to create.
261
+ # @!attribute [rw] workspace_id
262
+ # @return [::String]
263
+ # Required. The ID to use for the workspace, which will become the final component of
264
+ # the workspace's resource name.
265
+ class CreateWorkspaceRequest
266
+ include ::Google::Protobuf::MessageExts
267
+ extend ::Google::Protobuf::MessageExts::ClassMethods
268
+ end
269
+
270
+ # `DeleteWorkspace` request message.
271
+ # @!attribute [rw] name
272
+ # @return [::String]
273
+ # Required. The workspace resource's name.
274
+ class DeleteWorkspaceRequest
275
+ include ::Google::Protobuf::MessageExts
276
+ extend ::Google::Protobuf::MessageExts::ClassMethods
277
+ end
278
+
279
+ # Represents the author of a Git commit.
280
+ # @!attribute [rw] name
281
+ # @return [::String]
282
+ # Required. The commit author's name.
283
+ # @!attribute [rw] email_address
284
+ # @return [::String]
285
+ # Required. The commit author's email address.
286
+ class CommitAuthor
287
+ include ::Google::Protobuf::MessageExts
288
+ extend ::Google::Protobuf::MessageExts::ClassMethods
289
+ end
290
+
291
+ # `PullGitCommits` request message.
292
+ # @!attribute [rw] name
293
+ # @return [::String]
294
+ # Required. The workspace's name.
295
+ # @!attribute [rw] remote_branch
296
+ # @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.
299
+ # @!attribute [rw] author
300
+ # @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.
303
+ class PullGitCommitsRequest
304
+ include ::Google::Protobuf::MessageExts
305
+ extend ::Google::Protobuf::MessageExts::ClassMethods
306
+ end
307
+
308
+ # `PushGitCommits` request message.
309
+ # @!attribute [rw] name
310
+ # @return [::String]
311
+ # Required. The workspace's name.
312
+ # @!attribute [rw] remote_branch
313
+ # @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.
316
+ class PushGitCommitsRequest
317
+ include ::Google::Protobuf::MessageExts
318
+ extend ::Google::Protobuf::MessageExts::ClassMethods
319
+ end
320
+
321
+ # `FetchFileGitStatuses` request message.
322
+ # @!attribute [rw] name
323
+ # @return [::String]
324
+ # Required. The workspace's name.
325
+ class FetchFileGitStatusesRequest
326
+ include ::Google::Protobuf::MessageExts
327
+ extend ::Google::Protobuf::MessageExts::ClassMethods
328
+ end
329
+
330
+ # `FetchFileGitStatuses` response message.
331
+ # @!attribute [rw] uncommitted_file_changes
332
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesResponse::UncommittedFileChange>]
333
+ # A list of all files which have uncommitted Git changes. There will only be
334
+ # a single entry for any given file.
335
+ class FetchFileGitStatusesResponse
336
+ include ::Google::Protobuf::MessageExts
337
+ extend ::Google::Protobuf::MessageExts::ClassMethods
338
+
339
+ # Represents the Git state of a file with uncommitted changes.
340
+ # @!attribute [rw] path
341
+ # @return [::String]
342
+ # The file's full path including filename, relative to the workspace root.
343
+ # @!attribute [rw] state
344
+ # @return [::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesResponse::UncommittedFileChange::State]
345
+ # Indicates the status of the file.
346
+ class UncommittedFileChange
347
+ include ::Google::Protobuf::MessageExts
348
+ extend ::Google::Protobuf::MessageExts::ClassMethods
349
+
350
+ # Indicates the status of an uncommitted file change.
351
+ module State
352
+ # Default value. This value is unused.
353
+ STATE_UNSPECIFIED = 0
354
+
355
+ # The file has been newly added.
356
+ ADDED = 1
357
+
358
+ # The file has been deleted.
359
+ DELETED = 2
360
+
361
+ # The file has been modified.
362
+ MODIFIED = 3
363
+
364
+ # The file contains merge conflicts.
365
+ HAS_CONFLICTS = 4
366
+ end
367
+ end
368
+ end
369
+
370
+ # `FetchGitAheadBehind` request message.
371
+ # @!attribute [rw] name
372
+ # @return [::String]
373
+ # Required. The workspace's name.
374
+ # @!attribute [rw] remote_branch
375
+ # @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.
379
+ class FetchGitAheadBehindRequest
380
+ include ::Google::Protobuf::MessageExts
381
+ extend ::Google::Protobuf::MessageExts::ClassMethods
382
+ end
383
+
384
+ # `FetchGitAheadBehind` response message.
385
+ # @!attribute [rw] commits_ahead
386
+ # @return [::Integer]
387
+ # The number of commits in the remote branch that are not in the workspace.
388
+ # @!attribute [rw] commits_behind
389
+ # @return [::Integer]
390
+ # The number of commits in the workspace that are not in the remote branch.
391
+ class FetchGitAheadBehindResponse
392
+ include ::Google::Protobuf::MessageExts
393
+ extend ::Google::Protobuf::MessageExts::ClassMethods
394
+ end
395
+
396
+ # `CommitWorkspaceChanges` request message.
397
+ # @!attribute [rw] name
398
+ # @return [::String]
399
+ # Required. The workspace's name.
400
+ # @!attribute [rw] author
401
+ # @return [::Google::Cloud::Dataform::V1beta1::CommitAuthor]
402
+ # Required. The commit's author.
403
+ # @!attribute [rw] commit_message
404
+ # @return [::String]
405
+ # Optional. The commit's message.
406
+ # @!attribute [rw] paths
407
+ # @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.
410
+ class CommitWorkspaceChangesRequest
411
+ include ::Google::Protobuf::MessageExts
412
+ extend ::Google::Protobuf::MessageExts::ClassMethods
413
+ end
414
+
415
+ # `ResetWorkspaceChanges` request message.
416
+ # @!attribute [rw] name
417
+ # @return [::String]
418
+ # Required. The workspace's name.
419
+ # @!attribute [rw] paths
420
+ # @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.
423
+ # @!attribute [rw] clean
424
+ # @return [::Boolean]
425
+ # Optional. If set to true, untracked files will be deleted.
426
+ class ResetWorkspaceChangesRequest
427
+ include ::Google::Protobuf::MessageExts
428
+ extend ::Google::Protobuf::MessageExts::ClassMethods
429
+ end
430
+
431
+ # `FetchFileDiff` request message.
432
+ # @!attribute [rw] workspace
433
+ # @return [::String]
434
+ # Required. The workspace's name.
435
+ # @!attribute [rw] path
436
+ # @return [::String]
437
+ # Required. The file's full path including filename, relative to the workspace root.
438
+ class FetchFileDiffRequest
439
+ include ::Google::Protobuf::MessageExts
440
+ extend ::Google::Protobuf::MessageExts::ClassMethods
441
+ end
442
+
443
+ # `FetchFileDiff` response message.
444
+ # @!attribute [rw] formatted_diff
445
+ # @return [::String]
446
+ # The raw formatted Git diff for the file.
447
+ class FetchFileDiffResponse
448
+ include ::Google::Protobuf::MessageExts
449
+ extend ::Google::Protobuf::MessageExts::ClassMethods
450
+ end
451
+
452
+ # `QueryDirectoryContents` request message.
453
+ # @!attribute [rw] workspace
454
+ # @return [::String]
455
+ # Required. The workspace's name.
456
+ # @!attribute [rw] path
457
+ # @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.
460
+ # @!attribute [rw] page_size
461
+ # @return [::Integer]
462
+ # Optional. Maximum number of paths to return. The server may return fewer
463
+ # items than requested. If unspecified, the server will pick an appropriate
464
+ # default.
465
+ # @!attribute [rw] page_token
466
+ # @return [::String]
467
+ # Optional. Page token received from a previous `QueryDirectoryContents` call.
468
+ # Provide this to retrieve the subsequent page.
469
+ #
470
+ # When paginating, all other parameters provided to
471
+ # `QueryDirectoryContents` must match the call that provided the page
472
+ # token.
473
+ class QueryDirectoryContentsRequest
474
+ include ::Google::Protobuf::MessageExts
475
+ extend ::Google::Protobuf::MessageExts::ClassMethods
476
+ end
477
+
478
+ # `QueryDirectoryContents` response message.
479
+ # @!attribute [rw] directory_entries
480
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::QueryDirectoryContentsResponse::DirectoryEntry>]
481
+ # List of entries in the directory.
482
+ # @!attribute [rw] next_page_token
483
+ # @return [::String]
484
+ # A token, which can be sent as `page_token` to retrieve the next page.
485
+ # If this field is omitted, there are no subsequent pages.
486
+ class QueryDirectoryContentsResponse
487
+ include ::Google::Protobuf::MessageExts
488
+ extend ::Google::Protobuf::MessageExts::ClassMethods
489
+
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
501
+ end
502
+
503
+ # `MakeDirectory` request message.
504
+ # @!attribute [rw] workspace
505
+ # @return [::String]
506
+ # Required. The workspace's name.
507
+ # @!attribute [rw] path
508
+ # @return [::String]
509
+ # Required. The directory's full path including directory name, relative to the
510
+ # workspace root.
511
+ class MakeDirectoryRequest
512
+ include ::Google::Protobuf::MessageExts
513
+ extend ::Google::Protobuf::MessageExts::ClassMethods
514
+ end
515
+
516
+ # `MakeDirectory` response message.
517
+ class MakeDirectoryResponse
518
+ include ::Google::Protobuf::MessageExts
519
+ extend ::Google::Protobuf::MessageExts::ClassMethods
520
+ end
521
+
522
+ # `RemoveDirectory` request message.
523
+ # @!attribute [rw] workspace
524
+ # @return [::String]
525
+ # Required. The workspace's name.
526
+ # @!attribute [rw] path
527
+ # @return [::String]
528
+ # Required. The directory's full path including directory name, relative to the
529
+ # workspace root.
530
+ class RemoveDirectoryRequest
531
+ include ::Google::Protobuf::MessageExts
532
+ extend ::Google::Protobuf::MessageExts::ClassMethods
533
+ end
534
+
535
+ # `MoveDirectory` request message.
536
+ # @!attribute [rw] workspace
537
+ # @return [::String]
538
+ # Required. The workspace's name.
539
+ # @!attribute [rw] path
540
+ # @return [::String]
541
+ # Required. The directory's full path including directory name, relative to the
542
+ # workspace root.
543
+ # @!attribute [rw] new_path
544
+ # @return [::String]
545
+ # Required. The new path for the directory including directory name, rooted at
546
+ # workspace root.
547
+ class MoveDirectoryRequest
548
+ include ::Google::Protobuf::MessageExts
549
+ extend ::Google::Protobuf::MessageExts::ClassMethods
550
+ end
551
+
552
+ # `MoveDirectory` response message.
553
+ class MoveDirectoryResponse
554
+ include ::Google::Protobuf::MessageExts
555
+ extend ::Google::Protobuf::MessageExts::ClassMethods
556
+ end
557
+
558
+ # `ReadFile` request message.
559
+ # @!attribute [rw] workspace
560
+ # @return [::String]
561
+ # Required. The workspace's name.
562
+ # @!attribute [rw] path
563
+ # @return [::String]
564
+ # Required. The file's full path including filename, relative to the workspace root.
565
+ class ReadFileRequest
566
+ include ::Google::Protobuf::MessageExts
567
+ extend ::Google::Protobuf::MessageExts::ClassMethods
568
+ end
569
+
570
+ # `ReadFile` response message.
571
+ # @!attribute [rw] file_contents
572
+ # @return [::String]
573
+ # The file's contents.
574
+ class ReadFileResponse
575
+ include ::Google::Protobuf::MessageExts
576
+ extend ::Google::Protobuf::MessageExts::ClassMethods
577
+ end
578
+
579
+ # `RemoveFile` request message.
580
+ # @!attribute [rw] workspace
581
+ # @return [::String]
582
+ # Required. The workspace's name.
583
+ # @!attribute [rw] path
584
+ # @return [::String]
585
+ # Required. The file's full path including filename, relative to the workspace root.
586
+ class RemoveFileRequest
587
+ include ::Google::Protobuf::MessageExts
588
+ extend ::Google::Protobuf::MessageExts::ClassMethods
589
+ end
590
+
591
+ # `MoveFile` request message.
592
+ # @!attribute [rw] workspace
593
+ # @return [::String]
594
+ # Required. The workspace's name.
595
+ # @!attribute [rw] path
596
+ # @return [::String]
597
+ # Required. The file's full path including filename, relative to the workspace root.
598
+ # @!attribute [rw] new_path
599
+ # @return [::String]
600
+ # Required. The file's new path including filename, relative to the workspace root.
601
+ class MoveFileRequest
602
+ include ::Google::Protobuf::MessageExts
603
+ extend ::Google::Protobuf::MessageExts::ClassMethods
604
+ end
605
+
606
+ # `MoveFile` response message.
607
+ class MoveFileResponse
608
+ include ::Google::Protobuf::MessageExts
609
+ extend ::Google::Protobuf::MessageExts::ClassMethods
610
+ end
611
+
612
+ # `WriteFile` request message.
613
+ # @!attribute [rw] workspace
614
+ # @return [::String]
615
+ # Required. The workspace's name.
616
+ # @!attribute [rw] path
617
+ # @return [::String]
618
+ # Required. The file.
619
+ # @!attribute [rw] contents
620
+ # @return [::String]
621
+ # Required. The file's contents.
622
+ class WriteFileRequest
623
+ include ::Google::Protobuf::MessageExts
624
+ extend ::Google::Protobuf::MessageExts::ClassMethods
625
+ end
626
+
627
+ # `WriteFile` response message.
628
+ class WriteFileResponse
629
+ include ::Google::Protobuf::MessageExts
630
+ extend ::Google::Protobuf::MessageExts::ClassMethods
631
+ end
632
+
633
+ # `InstallNpmPackages` request message.
634
+ # @!attribute [rw] workspace
635
+ # @return [::String]
636
+ # Required. The workspace's name.
637
+ class InstallNpmPackagesRequest
638
+ include ::Google::Protobuf::MessageExts
639
+ extend ::Google::Protobuf::MessageExts::ClassMethods
640
+ end
641
+
642
+ # `InstallNpmPackages` response message.
643
+ class InstallNpmPackagesResponse
644
+ include ::Google::Protobuf::MessageExts
645
+ extend ::Google::Protobuf::MessageExts::ClassMethods
646
+ end
647
+
648
+ # Represents the result of compiling a Dataform project.
649
+ # @!attribute [r] name
650
+ # @return [::String]
651
+ # Output only. The compilation result's name.
652
+ # @!attribute [rw] git_commitish
653
+ # @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:
657
+ # - a commit SHA: `12ade345`
658
+ # - a tag: `tag1`
659
+ # - a branch name: `branch1`
660
+ # @!attribute [rw] workspace
661
+ # @return [::String]
662
+ # Immutable. The name of the workspace to compile. Must be in the format
663
+ # `projects/*/locations/*/repositories/*/workspaces/*`.
664
+ # @!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
667
+ # compilation settings that are specified in dataform.json.
668
+ # @!attribute [r] dataform_core_version
669
+ # @return [::String]
670
+ # Output only. The version of `@dataform/core` that was used for compilation.
671
+ # @!attribute [r] compilation_errors
672
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::CompilationResult::CompilationError>]
673
+ # Output only. Errors encountered during project compilation.
674
+ class CompilationResult
675
+ include ::Google::Protobuf::MessageExts
676
+ extend ::Google::Protobuf::MessageExts::ClassMethods
677
+
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
+ # An error encountered when attempting to compile a Dataform project.
723
+ # @!attribute [r] message
724
+ # @return [::String]
725
+ # Output only. The error's top level message.
726
+ # @!attribute [r] stack
727
+ # @return [::String]
728
+ # Output only. The error's full stack trace.
729
+ # @!attribute [r] path
730
+ # @return [::String]
731
+ # Output only. The path of the file where this error occurred, if available, relative to
732
+ # the project root.
733
+ # @!attribute [r] action_target
734
+ # @return [::Google::Cloud::Dataform::V1beta1::Target]
735
+ # Output only. The identifier of the action where this error occurred, if available.
736
+ class CompilationError
737
+ include ::Google::Protobuf::MessageExts
738
+ extend ::Google::Protobuf::MessageExts::ClassMethods
739
+ end
740
+ end
741
+
742
+ # `ListCompilationResults` request message.
743
+ # @!attribute [rw] parent
744
+ # @return [::String]
745
+ # Required. The repository in which to list compilation results. Must be in the
746
+ # format `projects/*/locations/*/repositories/*`.
747
+ # @!attribute [rw] page_size
748
+ # @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
751
+ # appropriate default.
752
+ # @!attribute [rw] page_token
753
+ # @return [::String]
754
+ # Optional. Page token received from a previous `ListCompilationResults` call.
755
+ # Provide this to retrieve the subsequent page.
756
+ #
757
+ # When paginating, all other parameters provided to `ListCompilationResults`
758
+ # must match the call that provided the page token.
759
+ class ListCompilationResultsRequest
760
+ include ::Google::Protobuf::MessageExts
761
+ extend ::Google::Protobuf::MessageExts::ClassMethods
762
+ end
763
+
764
+ # `ListCompilationResults` response message.
765
+ # @!attribute [rw] compilation_results
766
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::CompilationResult>]
767
+ # List of compilation results.
768
+ # @!attribute [rw] next_page_token
769
+ # @return [::String]
770
+ # A token, which can be sent as `page_token` to retrieve the next page.
771
+ # If this field is omitted, there are no subsequent pages.
772
+ # @!attribute [rw] unreachable
773
+ # @return [::Array<::String>]
774
+ # Locations which could not be reached.
775
+ class ListCompilationResultsResponse
776
+ include ::Google::Protobuf::MessageExts
777
+ extend ::Google::Protobuf::MessageExts::ClassMethods
778
+ end
779
+
780
+ # `GetCompilationResult` request message.
781
+ # @!attribute [rw] name
782
+ # @return [::String]
783
+ # Required. The compilation result's name.
784
+ class GetCompilationResultRequest
785
+ include ::Google::Protobuf::MessageExts
786
+ extend ::Google::Protobuf::MessageExts::ClassMethods
787
+ end
788
+
789
+ # `CreateCompilationResult` request message.
790
+ # @!attribute [rw] parent
791
+ # @return [::String]
792
+ # Required. The repository in which to create the compilation result. Must be in the
793
+ # format `projects/*/locations/*/repositories/*`.
794
+ # @!attribute [rw] compilation_result
795
+ # @return [::Google::Cloud::Dataform::V1beta1::CompilationResult]
796
+ # Required. The compilation result to create.
797
+ class CreateCompilationResultRequest
798
+ include ::Google::Protobuf::MessageExts
799
+ extend ::Google::Protobuf::MessageExts::ClassMethods
800
+ end
801
+
802
+ # Represents an action identifier. If the action writes output, the output
803
+ # will be written to the referenced database object.
804
+ # @!attribute [rw] database
805
+ # @return [::String]
806
+ # The action's database (Google Cloud project ID) .
807
+ # @!attribute [rw] schema
808
+ # @return [::String]
809
+ # The action's schema (BigQuery dataset ID), within `database`.
810
+ # @!attribute [rw] name
811
+ # @return [::String]
812
+ # The action's name, within `database` and `schema`.
813
+ class Target
814
+ include ::Google::Protobuf::MessageExts
815
+ extend ::Google::Protobuf::MessageExts::ClassMethods
816
+ end
817
+
818
+ # Describes a relation and its columns.
819
+ # @!attribute [rw] description
820
+ # @return [::String]
821
+ # A text description of the relation.
822
+ # @!attribute [rw] columns
823
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::RelationDescriptor::ColumnDescriptor>]
824
+ # A list of descriptions of columns within the relation.
825
+ # @!attribute [rw] bigquery_labels
826
+ # @return [::Google::Protobuf::Map{::String => ::String}]
827
+ # A set of BigQuery labels that should be applied to the relation.
828
+ class RelationDescriptor
829
+ include ::Google::Protobuf::MessageExts
830
+ extend ::Google::Protobuf::MessageExts::ClassMethods
831
+
832
+ # Describes a column.
833
+ # @!attribute [rw] path
834
+ # @return [::Array<::String>]
835
+ # The identifier for the column. Each entry in `path` represents one level
836
+ # of nesting.
837
+ # @!attribute [rw] description
838
+ # @return [::String]
839
+ # A textual description of the column.
840
+ # @!attribute [rw] bigquery_policy_tags
841
+ # @return [::Array<::String>]
842
+ # A list of BigQuery policy tags that will be applied to the column.
843
+ class ColumnDescriptor
844
+ include ::Google::Protobuf::MessageExts
845
+ extend ::Google::Protobuf::MessageExts::ClassMethods
846
+ end
847
+
848
+ # @!attribute [rw] key
849
+ # @return [::String]
850
+ # @!attribute [rw] value
851
+ # @return [::String]
852
+ class BigqueryLabelsEntry
853
+ include ::Google::Protobuf::MessageExts
854
+ extend ::Google::Protobuf::MessageExts::ClassMethods
855
+ end
856
+ end
857
+
858
+ # Represents a single Dataform action in a compilation result.
859
+ # @!attribute [rw] target
860
+ # @return [::Google::Cloud::Dataform::V1beta1::Target]
861
+ # This action's identifier. Unique within the compilation result.
862
+ # @!attribute [rw] canonical_target
863
+ # @return [::Google::Cloud::Dataform::V1beta1::Target]
864
+ # The action's identifier if the project had been compiled without any
865
+ # overrides configured. Unique within the compilation result.
866
+ # @!attribute [rw] file_path
867
+ # @return [::String]
868
+ # The full path including filename in which this action is located, relative
869
+ # to the workspace root.
870
+ # @!attribute [rw] relation
871
+ # @return [::Google::Cloud::Dataform::V1beta1::CompilationResultAction::Relation]
872
+ # The database relation created/updated by this action.
873
+ # @!attribute [rw] operations
874
+ # @return [::Google::Cloud::Dataform::V1beta1::CompilationResultAction::Operations]
875
+ # The database operations executed by this action.
876
+ # @!attribute [rw] assertion
877
+ # @return [::Google::Cloud::Dataform::V1beta1::CompilationResultAction::Assertion]
878
+ # The assertion executed by this action.
879
+ # @!attribute [rw] declaration
880
+ # @return [::Google::Cloud::Dataform::V1beta1::CompilationResultAction::Declaration]
881
+ # The declaration declared by this action.
882
+ class CompilationResultAction
883
+ include ::Google::Protobuf::MessageExts
884
+ extend ::Google::Protobuf::MessageExts::ClassMethods
885
+
886
+ # Represents a database relation.
887
+ # @!attribute [rw] dependency_targets
888
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::Target>]
889
+ # A list of actions that this action depends on.
890
+ # @!attribute [rw] disabled
891
+ # @return [::Boolean]
892
+ # Whether this action is disabled (i.e. should not be run).
893
+ # @!attribute [rw] tags
894
+ # @return [::Array<::String>]
895
+ # Arbitrary, user-defined tags on this action.
896
+ # @!attribute [rw] relation_descriptor
897
+ # @return [::Google::Cloud::Dataform::V1beta1::RelationDescriptor]
898
+ # Descriptor for the relation and its columns.
899
+ # @!attribute [rw] relation_type
900
+ # @return [::Google::Cloud::Dataform::V1beta1::CompilationResultAction::Relation::RelationType]
901
+ # The type of this relation.
902
+ # @!attribute [rw] select_query
903
+ # @return [::String]
904
+ # The SELECT query which returns rows which this relation should contain.
905
+ # @!attribute [rw] pre_operations
906
+ # @return [::Array<::String>]
907
+ # SQL statements to be executed before creating the relation.
908
+ # @!attribute [rw] post_operations
909
+ # @return [::Array<::String>]
910
+ # SQL statements to be executed after creating the relation.
911
+ # @!attribute [rw] incremental_table_config
912
+ # @return [::Google::Cloud::Dataform::V1beta1::CompilationResultAction::Relation::IncrementalTableConfig]
913
+ # Configures `INCREMENTAL_TABLE` settings for this relation. Only set if
914
+ # `relation_type` is `INCREMENTAL_TABLE`.
915
+ # @!attribute [rw] partition_expression
916
+ # @return [::String]
917
+ # The SQL expression used to partition the relation.
918
+ # @!attribute [rw] cluster_expressions
919
+ # @return [::Array<::String>]
920
+ # A list of columns or SQL expressions used to cluster the table.
921
+ # @!attribute [rw] partition_expiration_days
922
+ # @return [::Integer]
923
+ # Sets the partition expiration in days.
924
+ # @!attribute [rw] require_partition_filter
925
+ # @return [::Boolean]
926
+ # Specifies whether queries on this table must include a predicate filter
927
+ # that filters on the partitioning column.
928
+ # @!attribute [rw] additional_options
929
+ # @return [::Google::Protobuf::Map{::String => ::String}]
930
+ # Additional options that will be provided as key/value pairs into the
931
+ # options clause of a create table/view statement. See
932
+ # https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language
933
+ # for more information on which options are supported.
934
+ class Relation
935
+ include ::Google::Protobuf::MessageExts
936
+ extend ::Google::Protobuf::MessageExts::ClassMethods
937
+
938
+ # Contains settings for relations of type `INCREMENTAL_TABLE`.
939
+ # @!attribute [rw] incremental_select_query
940
+ # @return [::String]
941
+ # The SELECT query which returns rows which should be inserted into the
942
+ # relation if it already exists and is not being refreshed.
943
+ # @!attribute [rw] refresh_disabled
944
+ # @return [::Boolean]
945
+ # Whether this table should be protected from being refreshed.
946
+ # @!attribute [rw] unique_key_parts
947
+ # @return [::Array<::String>]
948
+ # A set of columns or SQL expressions used to define row uniqueness.
949
+ # If any duplicates are discovered (as defined by `unique_key_parts`),
950
+ # only the newly selected rows (as defined by `incremental_select_query`)
951
+ # will be included in the relation.
952
+ # @!attribute [rw] update_partition_filter
953
+ # @return [::String]
954
+ # A SQL expression conditional used to limit the set of existing rows
955
+ # considered for a merge operation (see `unique_key_parts` for more
956
+ # information).
957
+ # @!attribute [rw] incremental_pre_operations
958
+ # @return [::Array<::String>]
959
+ # SQL statements to be executed before inserting new rows into the
960
+ # relation.
961
+ # @!attribute [rw] incremental_post_operations
962
+ # @return [::Array<::String>]
963
+ # SQL statements to be executed after inserting new rows into the
964
+ # relation.
965
+ class IncrementalTableConfig
966
+ include ::Google::Protobuf::MessageExts
967
+ extend ::Google::Protobuf::MessageExts::ClassMethods
968
+ end
969
+
970
+ # @!attribute [rw] key
971
+ # @return [::String]
972
+ # @!attribute [rw] value
973
+ # @return [::String]
974
+ class AdditionalOptionsEntry
975
+ include ::Google::Protobuf::MessageExts
976
+ extend ::Google::Protobuf::MessageExts::ClassMethods
977
+ end
978
+
979
+ # Indicates the type of this relation.
980
+ module RelationType
981
+ # Default value. This value is unused.
982
+ RELATION_TYPE_UNSPECIFIED = 0
983
+
984
+ # The relation is a table.
985
+ TABLE = 1
986
+
987
+ # The relation is a view.
988
+ VIEW = 2
989
+
990
+ # The relation is an incrementalized table.
991
+ INCREMENTAL_TABLE = 3
992
+
993
+ # The relation is a materialized view.
994
+ MATERIALIZED_VIEW = 4
995
+ end
996
+ end
997
+
998
+ # Represents a list of arbitrary database operations.
999
+ # @!attribute [rw] dependency_targets
1000
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::Target>]
1001
+ # A list of actions that this action depends on.
1002
+ # @!attribute [rw] disabled
1003
+ # @return [::Boolean]
1004
+ # Whether this action is disabled (i.e. should not be run).
1005
+ # @!attribute [rw] tags
1006
+ # @return [::Array<::String>]
1007
+ # Arbitrary, user-defined tags on this action.
1008
+ # @!attribute [rw] relation_descriptor
1009
+ # @return [::Google::Cloud::Dataform::V1beta1::RelationDescriptor]
1010
+ # Descriptor for any output relation and its columns. Only set if
1011
+ # `has_output` is true.
1012
+ # @!attribute [rw] queries
1013
+ # @return [::Array<::String>]
1014
+ # A list of arbitrary SQL statements that will be executed without
1015
+ # alteration.
1016
+ # @!attribute [rw] has_output
1017
+ # @return [::Boolean]
1018
+ # Whether these operations produce an output relation.
1019
+ class Operations
1020
+ include ::Google::Protobuf::MessageExts
1021
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1022
+ end
1023
+
1024
+ # Represents an assertion upon a SQL query which is required return zero
1025
+ # rows.
1026
+ # @!attribute [rw] dependency_targets
1027
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::Target>]
1028
+ # A list of actions that this action depends on.
1029
+ # @!attribute [rw] parent_action
1030
+ # @return [::Google::Cloud::Dataform::V1beta1::Target]
1031
+ # The parent action of this assertion. Only set if this assertion was
1032
+ # automatically generated.
1033
+ # @!attribute [rw] disabled
1034
+ # @return [::Boolean]
1035
+ # Whether this action is disabled (i.e. should not be run).
1036
+ # @!attribute [rw] tags
1037
+ # @return [::Array<::String>]
1038
+ # Arbitrary, user-defined tags on this action.
1039
+ # @!attribute [rw] select_query
1040
+ # @return [::String]
1041
+ # The SELECT query which must return zero rows in order for this assertion
1042
+ # to succeed.
1043
+ # @!attribute [rw] relation_descriptor
1044
+ # @return [::Google::Cloud::Dataform::V1beta1::RelationDescriptor]
1045
+ # Descriptor for the assertion's automatically-generated view and its
1046
+ # columns.
1047
+ class Assertion
1048
+ include ::Google::Protobuf::MessageExts
1049
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1050
+ end
1051
+
1052
+ # Represents a relation which is not managed by Dataform but which may be
1053
+ # referenced by Dataform actions.
1054
+ # @!attribute [rw] relation_descriptor
1055
+ # @return [::Google::Cloud::Dataform::V1beta1::RelationDescriptor]
1056
+ # Descriptor for the relation and its columns. Used as documentation only,
1057
+ # i.e. values here will result in no changes to the relation's metadata.
1058
+ class Declaration
1059
+ include ::Google::Protobuf::MessageExts
1060
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1061
+ end
1062
+ end
1063
+
1064
+ # `QueryCompilationResultActions` request message.
1065
+ # @!attribute [rw] name
1066
+ # @return [::String]
1067
+ # Required. The compilation result's name.
1068
+ # @!attribute [rw] page_size
1069
+ # @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
1072
+ # appropriate default.
1073
+ # @!attribute [rw] page_token
1074
+ # @return [::String]
1075
+ # Optional. Page token received from a previous `QueryCompilationResultActions` call.
1076
+ # Provide this to retrieve the subsequent page.
1077
+ #
1078
+ # When paginating, all other parameters provided to
1079
+ # `QueryCompilationResultActions` must match the call that provided the page
1080
+ # token.
1081
+ # @!attribute [rw] filter
1082
+ # @return [::String]
1083
+ # Optional. Optional filter for the returned list. Filtering is only currently
1084
+ # supported on the `file_path` field.
1085
+ class QueryCompilationResultActionsRequest
1086
+ include ::Google::Protobuf::MessageExts
1087
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1088
+ end
1089
+
1090
+ # `QueryCompilationResultActions` response message.
1091
+ # @!attribute [rw] compilation_result_actions
1092
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::CompilationResultAction>]
1093
+ # List of compilation result actions.
1094
+ # @!attribute [rw] next_page_token
1095
+ # @return [::String]
1096
+ # A token, which can be sent as `page_token` to retrieve the next page.
1097
+ # If this field is omitted, there are no subsequent pages.
1098
+ class QueryCompilationResultActionsResponse
1099
+ include ::Google::Protobuf::MessageExts
1100
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1101
+ end
1102
+
1103
+ # Represents a single invocation of a compilation result.
1104
+ # @!attribute [r] name
1105
+ # @return [::String]
1106
+ # Output only. The workflow invocation's name.
1107
+ # @!attribute [rw] compilation_result
1108
+ # @return [::String]
1109
+ # Immutable. The name of the compilation result to compile. Must be in the format
1110
+ # `projects/*/locations/*/repositories/*/compilationResults/*`.
1111
+ # @!attribute [rw] invocation_config
1112
+ # @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocation::InvocationConfig]
1113
+ # Immutable. If left unset, a default InvocationConfig will be used.
1114
+ # @!attribute [r] state
1115
+ # @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocation::State]
1116
+ # Output only. This workflow invocation's current state.
1117
+ # @!attribute [r] invocation_timing
1118
+ # @return [::Google::Type::Interval]
1119
+ # Output only. This workflow invocation's timing details.
1120
+ class WorkflowInvocation
1121
+ include ::Google::Protobuf::MessageExts
1122
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1123
+
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
+ # Represents the current state of a workflow invocation.
1150
+ module State
1151
+ # Default value. This value is unused.
1152
+ STATE_UNSPECIFIED = 0
1153
+
1154
+ # The workflow invocation is currently running.
1155
+ RUNNING = 1
1156
+
1157
+ # The workflow invocation succeeded. A terminal state.
1158
+ SUCCEEDED = 2
1159
+
1160
+ # The workflow invocation was cancelled. A terminal state.
1161
+ CANCELLED = 3
1162
+
1163
+ # The workflow invocation failed. A terminal state.
1164
+ FAILED = 4
1165
+
1166
+ # The workflow invocation is being cancelled, but some actions are still
1167
+ # running.
1168
+ CANCELING = 5
1169
+ end
1170
+ end
1171
+
1172
+ # `ListWorkflowInvocations` request message.
1173
+ # @!attribute [rw] parent
1174
+ # @return [::String]
1175
+ # Required. The parent resource of the WorkflowInvocation type. Must be in the
1176
+ # format `projects/*/locations/*/repositories/*`.
1177
+ # @!attribute [rw] page_size
1178
+ # @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
1181
+ # appropriate default.
1182
+ # @!attribute [rw] page_token
1183
+ # @return [::String]
1184
+ # Optional. Page token received from a previous `ListWorkflowInvocations` call.
1185
+ # Provide this to retrieve the subsequent page.
1186
+ #
1187
+ # When paginating, all other parameters provided to `ListWorkflowInvocations`
1188
+ # must match the call that provided the page token.
1189
+ class ListWorkflowInvocationsRequest
1190
+ include ::Google::Protobuf::MessageExts
1191
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1192
+ end
1193
+
1194
+ # `ListWorkflowInvocations` response message.
1195
+ # @!attribute [rw] workflow_invocations
1196
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::WorkflowInvocation>]
1197
+ # List of workflow invocations.
1198
+ # @!attribute [rw] next_page_token
1199
+ # @return [::String]
1200
+ # A token, which can be sent as `page_token` to retrieve the next page.
1201
+ # If this field is omitted, there are no subsequent pages.
1202
+ # @!attribute [rw] unreachable
1203
+ # @return [::Array<::String>]
1204
+ # Locations which could not be reached.
1205
+ class ListWorkflowInvocationsResponse
1206
+ include ::Google::Protobuf::MessageExts
1207
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1208
+ end
1209
+
1210
+ # `GetWorkflowInvocation` request message.
1211
+ # @!attribute [rw] name
1212
+ # @return [::String]
1213
+ # Required. The workflow invocation resource's name.
1214
+ class GetWorkflowInvocationRequest
1215
+ include ::Google::Protobuf::MessageExts
1216
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1217
+ end
1218
+
1219
+ # `CreateWorkflowInvocation` request message.
1220
+ # @!attribute [rw] parent
1221
+ # @return [::String]
1222
+ # Required. The repository in which to create the workflow invocation. Must be in the
1223
+ # format `projects/*/locations/*/repositories/*`.
1224
+ # @!attribute [rw] workflow_invocation
1225
+ # @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocation]
1226
+ # Required. The workflow invocation resource to create.
1227
+ class CreateWorkflowInvocationRequest
1228
+ include ::Google::Protobuf::MessageExts
1229
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1230
+ end
1231
+
1232
+ # `DeleteWorkflowInvocation` request message.
1233
+ # @!attribute [rw] name
1234
+ # @return [::String]
1235
+ # Required. The workflow invocation resource's name.
1236
+ class DeleteWorkflowInvocationRequest
1237
+ include ::Google::Protobuf::MessageExts
1238
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1239
+ end
1240
+
1241
+ # `CancelWorkflowInvocation` request message.
1242
+ # @!attribute [rw] name
1243
+ # @return [::String]
1244
+ # Required. The workflow invocation resource's name.
1245
+ class CancelWorkflowInvocationRequest
1246
+ include ::Google::Protobuf::MessageExts
1247
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1248
+ end
1249
+
1250
+ # Represents a single action in a workflow invocation.
1251
+ # @!attribute [r] target
1252
+ # @return [::Google::Cloud::Dataform::V1beta1::Target]
1253
+ # Output only. This action's identifier. Unique within the workflow invocation.
1254
+ # @!attribute [r] canonical_target
1255
+ # @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.
1258
+ # @!attribute [r] state
1259
+ # @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::State]
1260
+ # Output only. This action's current state.
1261
+ # @!attribute [r] failure_reason
1262
+ # @return [::String]
1263
+ # Output only. If and only if action's state is FAILED a failure reason is set.
1264
+ # @!attribute [r] invocation_timing
1265
+ # @return [::Google::Type::Interval]
1266
+ # Output only. This action's timing details.
1267
+ # `start_time` will be set if the action is in [RUNNING, SUCCEEDED,
1268
+ # CANCELLED, FAILED] state.
1269
+ # `end_time` will be set if the action is in [SUCCEEDED, CANCELLED, FAILED]
1270
+ # state.
1271
+ # @!attribute [r] bigquery_action
1272
+ # @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::BigQueryAction]
1273
+ # Output only. The workflow action's bigquery action details.
1274
+ class WorkflowInvocationAction
1275
+ include ::Google::Protobuf::MessageExts
1276
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1277
+
1278
+ # Represents a workflow action that will run against BigQuery.
1279
+ # @!attribute [r] sql_script
1280
+ # @return [::String]
1281
+ # Output only. The generated BigQuery SQL script that will be executed.
1282
+ class BigQueryAction
1283
+ include ::Google::Protobuf::MessageExts
1284
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1285
+ end
1286
+
1287
+ # Represents the current state of an workflow invocation action.
1288
+ module State
1289
+ # The action has not yet been considered for invocation.
1290
+ PENDING = 0
1291
+
1292
+ # The action is currently running.
1293
+ RUNNING = 1
1294
+
1295
+ # Execution of the action was skipped because upstream dependencies did not
1296
+ # all complete successfully. A terminal state.
1297
+ SKIPPED = 2
1298
+
1299
+ # Execution of the action was disabled as per the configuration of the
1300
+ # corresponding compilation result action. A terminal state.
1301
+ DISABLED = 3
1302
+
1303
+ # The action succeeded. A terminal state.
1304
+ SUCCEEDED = 4
1305
+
1306
+ # The action was cancelled. A terminal state.
1307
+ CANCELLED = 5
1308
+
1309
+ # The action failed. A terminal state.
1310
+ FAILED = 6
1311
+ end
1312
+ end
1313
+
1314
+ # `QueryWorkflowInvocationActions` request message.
1315
+ # @!attribute [rw] name
1316
+ # @return [::String]
1317
+ # Required. The workflow invocation's name.
1318
+ # @!attribute [rw] page_size
1319
+ # @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
1322
+ # appropriate default.
1323
+ # @!attribute [rw] page_token
1324
+ # @return [::String]
1325
+ # Optional. Page token received from a previous `QueryWorkflowInvocationActions` call.
1326
+ # Provide this to retrieve the subsequent page.
1327
+ #
1328
+ # When paginating, all other parameters provided to
1329
+ # `QueryWorkflowInvocationActions` must match the call that provided the page
1330
+ # token.
1331
+ class QueryWorkflowInvocationActionsRequest
1332
+ include ::Google::Protobuf::MessageExts
1333
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1334
+ end
1335
+
1336
+ # `QueryWorkflowInvocationActions` response message.
1337
+ # @!attribute [rw] workflow_invocation_actions
1338
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>]
1339
+ # List of workflow invocation actions.
1340
+ # @!attribute [rw] next_page_token
1341
+ # @return [::String]
1342
+ # A token, which can be sent as `page_token` to retrieve the next page.
1343
+ # If this field is omitted, there are no subsequent pages.
1344
+ class QueryWorkflowInvocationActionsResponse
1345
+ include ::Google::Protobuf::MessageExts
1346
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1347
+ end
1348
+ end
1349
+ end
1350
+ end
1351
+ end