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