google-cloud-dataform-v1beta1 0.10.0 → 0.11.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.
@@ -21,10 +21,23 @@ module Google
21
21
  module Cloud
22
22
  module Dataform
23
23
  module V1beta1
24
+ # Describes encryption state of a resource.
25
+ # @!attribute [rw] kms_key_version_name
26
+ # @return [::String]
27
+ # Required. The KMS key version name with which data of a resource is
28
+ # encrypted.
29
+ class DataEncryptionState
30
+ include ::Google::Protobuf::MessageExts
31
+ extend ::Google::Protobuf::MessageExts::ClassMethods
32
+ end
33
+
24
34
  # Represents a Dataform Git repository.
25
- # @!attribute [r] name
35
+ # @!attribute [rw] name
26
36
  # @return [::String]
27
- # Output only. The repository's name.
37
+ # Identifier. The repository's name.
38
+ # @!attribute [r] create_time
39
+ # @return [::Google::Protobuf::Timestamp]
40
+ # Output only. The timestamp of when the repository was created.
28
41
  # @!attribute [rw] display_name
29
42
  # @return [::String]
30
43
  # Optional. The repository's user-friendly name.
@@ -55,6 +68,22 @@ module Google
55
68
  # @!attribute [rw] service_account
56
69
  # @return [::String]
57
70
  # Optional. The service account to run workflow invocations under.
71
+ # @!attribute [rw] kms_key_name
72
+ # @return [::String]
73
+ # Optional. The reference to a KMS encryption key. If provided, it will be
74
+ # used to encrypt user data in the repository and all child resources. It is
75
+ # not possible to add or update the encryption key after the repository is
76
+ # created. Example:
77
+ # `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`
78
+ # @!attribute [r] data_encryption_state
79
+ # @return [::Google::Cloud::Dataform::V1beta1::DataEncryptionState]
80
+ # Output only. A data encryption state of a Git repository if this Repository
81
+ # is protected by a KMS key.
82
+ # @!attribute [r] internal_metadata
83
+ # @return [::String]
84
+ # Output only. All the metadata information that is used internally to serve
85
+ # the resource. For example: timestamps, flags, status fields, etc. The
86
+ # format of this field is a JSON string.
58
87
  class Repository
59
88
  include ::Google::Protobuf::MessageExts
60
89
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -99,6 +128,7 @@ module Google
99
128
  extend ::Google::Protobuf::MessageExts::ClassMethods
100
129
  end
101
130
 
131
+ # The status of the authentication token.
102
132
  module TokenStatus
103
133
  # Default value. This value is unused.
104
134
  TOKEN_STATUS_UNSPECIFIED = 0
@@ -115,13 +145,12 @@ module Google
115
145
  end
116
146
  end
117
147
 
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`
148
+ # Configures workspace compilation overrides for a repository. Primarily used
149
+ # by the UI (`console.cloud.google.com`). `schema_suffix` and `table_prefix`
150
+ # can have a special expression - `${workspaceName}`, which refers to the
151
+ # workspace name from which the compilation results will be created. API
152
+ # callers are expected to resolve the expression in these overrides and
153
+ # provide them explicitly in `code_compilation_config`
125
154
  # (https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.compilationResults#codecompilationconfig)
126
155
  # when creating workspace-scoped compilation results.
127
156
  # @!attribute [rw] default_database
@@ -164,8 +193,9 @@ module Google
164
193
  # Optional. Page token received from a previous `ListRepositories` call.
165
194
  # Provide this to retrieve the subsequent page.
166
195
  #
167
- # When paginating, all other parameters provided to `ListRepositories`
168
- # must match the call that provided the page token.
196
+ # When paginating, all other parameters provided to `ListRepositories`,
197
+ # with the exception of `page_size`, must match the call that provided the
198
+ # page token.
169
199
  # @!attribute [rw] order_by
170
200
  # @return [::String]
171
201
  # Optional. This field only supports ordering by `name`. If unspecified, the
@@ -240,9 +270,9 @@ module Google
240
270
  # Required. The repository's name.
241
271
  # @!attribute [rw] force
242
272
  # @return [::Boolean]
243
- # If set to true, any child resources of this repository will also be
244
- # deleted. (Otherwise, the request will only succeed if the repository has no
245
- # child resources.)
273
+ # Optional. If set to true, any child resources of this repository will also
274
+ # be deleted. (Otherwise, the request will only succeed if the repository has
275
+ # no child resources.)
246
276
  class DeleteRepositoryRequest
247
277
  include ::Google::Protobuf::MessageExts
248
278
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -262,8 +292,8 @@ module Google
262
292
  # validation on the current HEAD commit SHA is performed.
263
293
  # @!attribute [rw] file_operations
264
294
  # @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.
295
+ # Optional. A map to the path of the file to the operation. The path is the
296
+ # full file path including filename, from repository root.
267
297
  class CommitRepositoryChangesRequest
268
298
  include ::Google::Protobuf::MessageExts
269
299
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -309,6 +339,15 @@ module Google
309
339
  end
310
340
  end
311
341
 
342
+ # `CommitRepositoryChanges` response message.
343
+ # @!attribute [rw] commit_sha
344
+ # @return [::String]
345
+ # The commit SHA of the current commit.
346
+ class CommitRepositoryChangesResponse
347
+ include ::Google::Protobuf::MessageExts
348
+ extend ::Google::Protobuf::MessageExts::ClassMethods
349
+ end
350
+
312
351
  # `ReadRepositoryFile` request message.
313
352
  # @!attribute [rw] name
314
353
  # @return [::String]
@@ -358,8 +397,8 @@ module Google
358
397
  # subsequent page.
359
398
  #
360
399
  # When paginating, all other parameters provided to
361
- # `QueryRepositoryDirectoryContents` must match the call that provided the
362
- # page token.
400
+ # `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must
401
+ # match the call that provided the page token.
363
402
  class QueryRepositoryDirectoryContentsRequest
364
403
  include ::Google::Protobuf::MessageExts
365
404
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -392,8 +431,9 @@ module Google
392
431
  # Optional. Page token received from a previous `FetchRepositoryHistory`
393
432
  # call. Provide this to retrieve the subsequent page.
394
433
  #
395
- # When paginating, all other parameters provided to `FetchRepositoryHistory`
396
- # must match the call that provided the page token.
434
+ # When paginating, all other parameters provided to `FetchRepositoryHistory`,
435
+ # with the exception of `page_size`, must match the call that provided the
436
+ # page token.
397
437
  class FetchRepositoryHistoryRequest
398
438
  include ::Google::Protobuf::MessageExts
399
439
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -495,9 +535,21 @@ module Google
495
535
  end
496
536
 
497
537
  # Represents a Dataform Git workspace.
498
- # @!attribute [r] name
538
+ # @!attribute [rw] name
499
539
  # @return [::String]
500
- # Output only. The workspace's name.
540
+ # Identifier. The workspace's name.
541
+ # @!attribute [r] create_time
542
+ # @return [::Google::Protobuf::Timestamp]
543
+ # Output only. The timestamp of when the workspace was created.
544
+ # @!attribute [r] data_encryption_state
545
+ # @return [::Google::Cloud::Dataform::V1beta1::DataEncryptionState]
546
+ # Output only. A data encryption state of a Git repository if this Workspace
547
+ # is protected by a KMS key.
548
+ # @!attribute [r] internal_metadata
549
+ # @return [::String]
550
+ # Output only. All the metadata information that is used internally to serve
551
+ # the resource. For example: timestamps, flags, status fields, etc. The
552
+ # format of this field is a JSON string.
501
553
  class Workspace
502
554
  include ::Google::Protobuf::MessageExts
503
555
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -518,8 +570,9 @@ module Google
518
570
  # Optional. Page token received from a previous `ListWorkspaces` call.
519
571
  # Provide this to retrieve the subsequent page.
520
572
  #
521
- # When paginating, all other parameters provided to `ListWorkspaces`
522
- # must match the call that provided the page token.
573
+ # When paginating, all other parameters provided to `ListWorkspaces`, with
574
+ # the exception of `page_size`, must match the call that provided the page
575
+ # token.
523
576
  # @!attribute [rw] order_by
524
577
  # @return [::String]
525
578
  # Optional. This field only supports ordering by `name`. If unspecified, the
@@ -613,6 +666,12 @@ module Google
613
666
  extend ::Google::Protobuf::MessageExts::ClassMethods
614
667
  end
615
668
 
669
+ # `PullGitCommits` response message.
670
+ class PullGitCommitsResponse
671
+ include ::Google::Protobuf::MessageExts
672
+ extend ::Google::Protobuf::MessageExts::ClassMethods
673
+ end
674
+
616
675
  # `PushGitCommits` request message.
617
676
  # @!attribute [rw] name
618
677
  # @return [::String]
@@ -627,6 +686,12 @@ module Google
627
686
  extend ::Google::Protobuf::MessageExts::ClassMethods
628
687
  end
629
688
 
689
+ # `PushGitCommits` response message.
690
+ class PushGitCommitsResponse
691
+ include ::Google::Protobuf::MessageExts
692
+ extend ::Google::Protobuf::MessageExts::ClassMethods
693
+ end
694
+
630
695
  # `FetchFileGitStatuses` request message.
631
696
  # @!attribute [rw] name
632
697
  # @return [::String]
@@ -649,9 +714,9 @@ module Google
649
714
  # @!attribute [rw] path
650
715
  # @return [::String]
651
716
  # The file's full path including filename, relative to the workspace root.
652
- # @!attribute [rw] state
717
+ # @!attribute [r] state
653
718
  # @return [::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesResponse::UncommittedFileChange::State]
654
- # Indicates the status of the file.
719
+ # Output only. Indicates the status of the file.
655
720
  class UncommittedFileChange
656
721
  include ::Google::Protobuf::MessageExts
657
722
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -721,6 +786,12 @@ module Google
721
786
  extend ::Google::Protobuf::MessageExts::ClassMethods
722
787
  end
723
788
 
789
+ # `CommitWorkspaceChanges` response message.
790
+ class CommitWorkspaceChangesResponse
791
+ include ::Google::Protobuf::MessageExts
792
+ extend ::Google::Protobuf::MessageExts::ClassMethods
793
+ end
794
+
724
795
  # `ResetWorkspaceChanges` request message.
725
796
  # @!attribute [rw] name
726
797
  # @return [::String]
@@ -737,6 +808,12 @@ module Google
737
808
  extend ::Google::Protobuf::MessageExts::ClassMethods
738
809
  end
739
810
 
811
+ # `ResetWorkspaceChanges` response message.
812
+ class ResetWorkspaceChangesResponse
813
+ include ::Google::Protobuf::MessageExts
814
+ extend ::Google::Protobuf::MessageExts::ClassMethods
815
+ end
816
+
740
817
  # `FetchFileDiff` request message.
741
818
  # @!attribute [rw] workspace
742
819
  # @return [::String]
@@ -778,8 +855,8 @@ module Google
778
855
  # call. Provide this to retrieve the subsequent page.
779
856
  #
780
857
  # When paginating, all other parameters provided to
781
- # `QueryDirectoryContents` must match the call that provided the page
782
- # token.
858
+ # `QueryDirectoryContents`, with the exception of `page_size`, must match the
859
+ # call that provided the page token.
783
860
  class QueryDirectoryContentsRequest
784
861
  include ::Google::Protobuf::MessageExts
785
862
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -814,6 +891,80 @@ module Google
814
891
  extend ::Google::Protobuf::MessageExts::ClassMethods
815
892
  end
816
893
 
894
+ # Configuration containing file search request parameters.
895
+ # @!attribute [rw] workspace
896
+ # @return [::String]
897
+ # Required. The workspace's name.
898
+ # @!attribute [rw] page_size
899
+ # @return [::Integer]
900
+ # Optional. Maximum number of search results to return. The server may return
901
+ # fewer items than requested. If unspecified, the server will pick an
902
+ # appropriate default.
903
+ # @!attribute [rw] page_token
904
+ # @return [::String]
905
+ # Optional. Page token received from a previous `SearchFilesRequest`
906
+ # call. Provide this to retrieve the subsequent page.
907
+ #
908
+ # When paginating, all other parameters provided to `SearchFilesRequest`,
909
+ # with the exception of `page_size`, must match the call that provided the
910
+ # page token.
911
+ # @!attribute [rw] filter
912
+ # @return [::String]
913
+ # Optional. Optional filter for the returned list in filtering format.
914
+ # Filtering is only currently supported on the `path` field.
915
+ # See https://google.aip.dev/160 for details.
916
+ class SearchFilesRequest
917
+ include ::Google::Protobuf::MessageExts
918
+ extend ::Google::Protobuf::MessageExts::ClassMethods
919
+ end
920
+
921
+ # Client-facing representation of a file search response.
922
+ # @!attribute [rw] search_results
923
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::SearchResult>]
924
+ # List of matched results.
925
+ # @!attribute [rw] next_page_token
926
+ # @return [::String]
927
+ # Optional. A token, which can be sent as `page_token` to retrieve the next
928
+ # page. If this field is omitted, there are no subsequent pages.
929
+ class SearchFilesResponse
930
+ include ::Google::Protobuf::MessageExts
931
+ extend ::Google::Protobuf::MessageExts::ClassMethods
932
+ end
933
+
934
+ # Client-facing representation of a search result entry.
935
+ # @!attribute [rw] file
936
+ # @return [::Google::Cloud::Dataform::V1beta1::FileSearchResult]
937
+ # Details when search result is a file.
938
+ #
939
+ # Note: The following fields are mutually exclusive: `file`, `directory`. If a field in that set is populated, all other fields in the set will automatically be cleared.
940
+ # @!attribute [rw] directory
941
+ # @return [::Google::Cloud::Dataform::V1beta1::DirectorySearchResult]
942
+ # Details when search result is a directory.
943
+ #
944
+ # Note: The following fields are mutually exclusive: `directory`, `file`. If a field in that set is populated, all other fields in the set will automatically be cleared.
945
+ class SearchResult
946
+ include ::Google::Protobuf::MessageExts
947
+ extend ::Google::Protobuf::MessageExts::ClassMethods
948
+ end
949
+
950
+ # Client-facing representation of a file entry in search results.
951
+ # @!attribute [rw] path
952
+ # @return [::String]
953
+ # File system path relative to the workspace root.
954
+ class FileSearchResult
955
+ include ::Google::Protobuf::MessageExts
956
+ extend ::Google::Protobuf::MessageExts::ClassMethods
957
+ end
958
+
959
+ # Client-facing representation of a directory entry in search results.
960
+ # @!attribute [rw] path
961
+ # @return [::String]
962
+ # File system path relative to the workspace root.
963
+ class DirectorySearchResult
964
+ include ::Google::Protobuf::MessageExts
965
+ extend ::Google::Protobuf::MessageExts::ClassMethods
966
+ end
967
+
817
968
  # `MakeDirectory` request message.
818
969
  # @!attribute [rw] workspace
819
970
  # @return [::String]
@@ -846,6 +997,12 @@ module Google
846
997
  extend ::Google::Protobuf::MessageExts::ClassMethods
847
998
  end
848
999
 
1000
+ # `RemoveDirectory` response message.
1001
+ class RemoveDirectoryResponse
1002
+ include ::Google::Protobuf::MessageExts
1003
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1004
+ end
1005
+
849
1006
  # `MoveDirectory` request message.
850
1007
  # @!attribute [rw] workspace
851
1008
  # @return [::String]
@@ -877,6 +1034,10 @@ module Google
877
1034
  # @return [::String]
878
1035
  # Required. The file's full path including filename, relative to the
879
1036
  # workspace root.
1037
+ # @!attribute [rw] revision
1038
+ # @return [::String]
1039
+ # Optional. The Git revision of the file to return. If left empty, the
1040
+ # current contents of `path` will be returned.
880
1041
  class ReadFileRequest
881
1042
  include ::Google::Protobuf::MessageExts
882
1043
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -904,6 +1065,12 @@ module Google
904
1065
  extend ::Google::Protobuf::MessageExts::ClassMethods
905
1066
  end
906
1067
 
1068
+ # `RemoveFile` response message.
1069
+ class RemoveFileResponse
1070
+ include ::Google::Protobuf::MessageExts
1071
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1072
+ end
1073
+
907
1074
  # `MoveFile` request message.
908
1075
  # @!attribute [rw] workspace
909
1076
  # @return [::String]
@@ -964,9 +1131,9 @@ module Google
964
1131
  end
965
1132
 
966
1133
  # Represents a Dataform release configuration.
967
- # @!attribute [r] name
1134
+ # @!attribute [rw] name
968
1135
  # @return [::String]
969
- # Output only. The release config's name.
1136
+ # Identifier. The release config's name.
970
1137
  # @!attribute [rw] git_commitish
971
1138
  # @return [::String]
972
1139
  # Required. Git commit/tag/branch name at which the repository should be
@@ -991,25 +1158,31 @@ module Google
991
1158
  # @!attribute [r] recent_scheduled_release_records
992
1159
  # @return [::Array<::Google::Cloud::Dataform::V1beta1::ReleaseConfig::ScheduledReleaseRecord>]
993
1160
  # Output only. Records of the 10 most recent scheduled release attempts,
994
- # ordered in in descending order of `release_time`. Updated whenever
995
- # automatic creation of a compilation result is triggered by cron_schedule.
1161
+ # ordered in descending order of `release_time`. Updated whenever automatic
1162
+ # creation of a compilation result is triggered by cron_schedule.
996
1163
  # @!attribute [rw] release_compilation_result
997
1164
  # @return [::String]
998
1165
  # Optional. The name of the currently released compilation result for this
999
- # release config. This value is updated when a compilation result is created
1000
- # from this release config, or when this resource is updated by API call
1001
- # (perhaps to roll back to an earlier release). The compilation result must
1002
- # have been created using this release config. Must be in the format
1166
+ # release config. This value is updated when a compilation result is
1167
+ # automatically created from this release config (using cron_schedule), or
1168
+ # when this resource is updated by API call (perhaps to roll back to an
1169
+ # earlier release). The compilation result must have been created using this
1170
+ # release config. Must be in the format
1003
1171
  # `projects/*/locations/*/repositories/*/compilationResults/*`.
1172
+ # @!attribute [rw] disabled
1173
+ # @return [::Boolean]
1174
+ # Optional. Disables automatic creation of compilation results.
1175
+ # @!attribute [r] internal_metadata
1176
+ # @return [::String]
1177
+ # Output only. All the metadata information that is used internally to serve
1178
+ # the resource. For example: timestamps, flags, status fields, etc. The
1179
+ # format of this field is a JSON string.
1004
1180
  class ReleaseConfig
1005
1181
  include ::Google::Protobuf::MessageExts
1006
1182
  extend ::Google::Protobuf::MessageExts::ClassMethods
1007
1183
 
1008
1184
  # A record of an attempt to create a compilation result for this release
1009
1185
  # config.
1010
- # @!attribute [rw] release_time
1011
- # @return [::Google::Protobuf::Timestamp]
1012
- # The timestamp of this release attempt.
1013
1186
  # @!attribute [rw] compilation_result
1014
1187
  # @return [::String]
1015
1188
  # The name of the created compilation result, if one was successfully
@@ -1023,6 +1196,9 @@ module Google
1023
1196
  # compilation result, if the attempt was unsuccessful.
1024
1197
  #
1025
1198
  # Note: The following fields are mutually exclusive: `error_status`, `compilation_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1199
+ # @!attribute [r] release_time
1200
+ # @return [::Google::Protobuf::Timestamp]
1201
+ # Output only. The timestamp of this release attempt.
1026
1202
  class ScheduledReleaseRecord
1027
1203
  include ::Google::Protobuf::MessageExts
1028
1204
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1044,8 +1220,9 @@ module Google
1044
1220
  # Optional. Page token received from a previous `ListReleaseConfigs` call.
1045
1221
  # Provide this to retrieve the subsequent page.
1046
1222
  #
1047
- # When paginating, all other parameters provided to `ListReleaseConfigs`
1048
- # must match the call that provided the page token.
1223
+ # When paginating, all other parameters provided to `ListReleaseConfigs`,
1224
+ # with the exception of `page_size`, must match the call that provided the
1225
+ # page token.
1049
1226
  class ListReleaseConfigsRequest
1050
1227
  include ::Google::Protobuf::MessageExts
1051
1228
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1116,9 +1293,6 @@ module Google
1116
1293
  end
1117
1294
 
1118
1295
  # Represents the result of compiling a Dataform project.
1119
- # @!attribute [r] name
1120
- # @return [::String]
1121
- # Output only. The compilation result's name.
1122
1296
  # @!attribute [rw] git_commitish
1123
1297
  # @return [::String]
1124
1298
  # Immutable. Git commit/tag/branch name at which the repository should be
@@ -1136,12 +1310,13 @@ module Google
1136
1310
  # Note: The following fields are mutually exclusive: `workspace`, `git_commitish`, `release_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1137
1311
  # @!attribute [rw] release_config
1138
1312
  # @return [::String]
1139
- # Immutable. The name of the release config to compile. The release
1140
- # config's 'current_compilation_result' field will be updated to this
1141
- # compilation result. Must be in the format
1142
- # `projects/*/locations/*/repositories/*/releaseConfigs/*`.
1313
+ # Immutable. The name of the release config to compile. Must be in the
1314
+ # format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
1143
1315
  #
1144
1316
  # Note: The following fields are mutually exclusive: `release_config`, `git_commitish`, `workspace`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1317
+ # @!attribute [r] name
1318
+ # @return [::String]
1319
+ # Output only. The compilation result's name.
1145
1320
  # @!attribute [rw] code_compilation_config
1146
1321
  # @return [::Google::Cloud::Dataform::V1beta1::CodeCompilationConfig]
1147
1322
  # Immutable. If set, fields of `code_compilation_config` override the default
@@ -1156,6 +1331,17 @@ module Google
1156
1331
  # @!attribute [r] compilation_errors
1157
1332
  # @return [::Array<::Google::Cloud::Dataform::V1beta1::CompilationResult::CompilationError>]
1158
1333
  # Output only. Errors encountered during project compilation.
1334
+ # @!attribute [r] data_encryption_state
1335
+ # @return [::Google::Cloud::Dataform::V1beta1::DataEncryptionState]
1336
+ # Output only. Only set if the repository has a KMS Key.
1337
+ # @!attribute [r] create_time
1338
+ # @return [::Google::Protobuf::Timestamp]
1339
+ # Output only. The timestamp of when the compilation result was created.
1340
+ # @!attribute [r] internal_metadata
1341
+ # @return [::String]
1342
+ # Output only. All the metadata information that is used internally to serve
1343
+ # the resource. For example: timestamps, flags, status fields, etc. The
1344
+ # format of this field is a JSON string.
1159
1345
  class CompilationResult
1160
1346
  include ::Google::Protobuf::MessageExts
1161
1347
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1211,6 +1397,9 @@ module Google
1211
1397
  # @!attribute [rw] table_prefix
1212
1398
  # @return [::String]
1213
1399
  # Optional. The prefix that should be prepended to all table names.
1400
+ # @!attribute [rw] default_notebook_runtime_options
1401
+ # @return [::Google::Cloud::Dataform::V1beta1::NotebookRuntimeOptions]
1402
+ # Optional. The default notebook runtime options.
1214
1403
  class CodeCompilationConfig
1215
1404
  include ::Google::Protobuf::MessageExts
1216
1405
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1225,6 +1414,16 @@ module Google
1225
1414
  end
1226
1415
  end
1227
1416
 
1417
+ # Configures various aspects of Dataform notebook runtime.
1418
+ # @!attribute [rw] gcs_output_bucket
1419
+ # @return [::String]
1420
+ # Optional. The Google Cloud Storage location to upload the result to.
1421
+ # Format: `gs://bucket-name`.
1422
+ class NotebookRuntimeOptions
1423
+ include ::Google::Protobuf::MessageExts
1424
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1425
+ end
1426
+
1228
1427
  # `ListCompilationResults` request message.
1229
1428
  # @!attribute [rw] parent
1230
1429
  # @return [::String]
@@ -1240,8 +1439,17 @@ module Google
1240
1439
  # Optional. Page token received from a previous `ListCompilationResults`
1241
1440
  # call. Provide this to retrieve the subsequent page.
1242
1441
  #
1243
- # When paginating, all other parameters provided to `ListCompilationResults`
1244
- # must match the call that provided the page token.
1442
+ # When paginating, all other parameters provided to `ListCompilationResults`,
1443
+ # with the exception of `page_size`, must match the call that provided the
1444
+ # page token.
1445
+ # @!attribute [rw] order_by
1446
+ # @return [::String]
1447
+ # Optional. This field only supports ordering by `name` and `create_time`.
1448
+ # If unspecified, the server will choose the ordering.
1449
+ # If specified, the default order is ascending for the `name` field.
1450
+ # @!attribute [rw] filter
1451
+ # @return [::String]
1452
+ # Optional. Filter for the returned list.
1245
1453
  class ListCompilationResultsRequest
1246
1454
  include ::Google::Protobuf::MessageExts
1247
1455
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1289,13 +1497,13 @@ module Google
1289
1497
  # will be written to the referenced database object.
1290
1498
  # @!attribute [rw] database
1291
1499
  # @return [::String]
1292
- # The action's database (Google Cloud project ID) .
1500
+ # Optional. The action's database (Google Cloud project ID) .
1293
1501
  # @!attribute [rw] schema
1294
1502
  # @return [::String]
1295
- # The action's schema (BigQuery dataset ID), within `database`.
1503
+ # Optional. The action's schema (BigQuery dataset ID), within `database`.
1296
1504
  # @!attribute [rw] name
1297
1505
  # @return [::String]
1298
- # The action's name, within `database` and `schema`.
1506
+ # Optional. The action's name, within `database` and `schema`.
1299
1507
  class Target
1300
1508
  include ::Google::Protobuf::MessageExts
1301
1509
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1342,37 +1550,47 @@ module Google
1342
1550
  end
1343
1551
 
1344
1552
  # Represents a single Dataform action in a compilation result.
1345
- # @!attribute [rw] target
1346
- # @return [::Google::Cloud::Dataform::V1beta1::Target]
1347
- # This action's identifier. Unique within the compilation result.
1348
- # @!attribute [rw] canonical_target
1349
- # @return [::Google::Cloud::Dataform::V1beta1::Target]
1350
- # The action's identifier if the project had been compiled without any
1351
- # overrides configured. Unique within the compilation result.
1352
- # @!attribute [rw] file_path
1353
- # @return [::String]
1354
- # The full path including filename in which this action is located, relative
1355
- # to the workspace root.
1356
1553
  # @!attribute [rw] relation
1357
1554
  # @return [::Google::Cloud::Dataform::V1beta1::CompilationResultAction::Relation]
1358
1555
  # The database relation created/updated by this action.
1359
1556
  #
1360
- # Note: The following fields are mutually exclusive: `relation`, `operations`, `assertion`, `declaration`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1557
+ # Note: The following fields are mutually exclusive: `relation`, `operations`, `assertion`, `declaration`, `notebook`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1361
1558
  # @!attribute [rw] operations
1362
1559
  # @return [::Google::Cloud::Dataform::V1beta1::CompilationResultAction::Operations]
1363
1560
  # The database operations executed by this action.
1364
1561
  #
1365
- # Note: The following fields are mutually exclusive: `operations`, `relation`, `assertion`, `declaration`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1562
+ # Note: The following fields are mutually exclusive: `operations`, `relation`, `assertion`, `declaration`, `notebook`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1366
1563
  # @!attribute [rw] assertion
1367
1564
  # @return [::Google::Cloud::Dataform::V1beta1::CompilationResultAction::Assertion]
1368
1565
  # The assertion executed by this action.
1369
1566
  #
1370
- # Note: The following fields are mutually exclusive: `assertion`, `relation`, `operations`, `declaration`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1567
+ # Note: The following fields are mutually exclusive: `assertion`, `relation`, `operations`, `declaration`, `notebook`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1371
1568
  # @!attribute [rw] declaration
1372
1569
  # @return [::Google::Cloud::Dataform::V1beta1::CompilationResultAction::Declaration]
1373
1570
  # The declaration declared by this action.
1374
1571
  #
1375
- # Note: The following fields are mutually exclusive: `declaration`, `relation`, `operations`, `assertion`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1572
+ # Note: The following fields are mutually exclusive: `declaration`, `relation`, `operations`, `assertion`, `notebook`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1573
+ # @!attribute [rw] notebook
1574
+ # @return [::Google::Cloud::Dataform::V1beta1::CompilationResultAction::Notebook]
1575
+ # The notebook executed by this action.
1576
+ #
1577
+ # Note: The following fields are mutually exclusive: `notebook`, `relation`, `operations`, `assertion`, `declaration`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1578
+ # @!attribute [rw] target
1579
+ # @return [::Google::Cloud::Dataform::V1beta1::Target]
1580
+ # This action's identifier. Unique within the compilation result.
1581
+ # @!attribute [rw] canonical_target
1582
+ # @return [::Google::Cloud::Dataform::V1beta1::Target]
1583
+ # The action's identifier if the project had been compiled without any
1584
+ # overrides configured. Unique within the compilation result.
1585
+ # @!attribute [rw] file_path
1586
+ # @return [::String]
1587
+ # The full path including filename in which this action is located, relative
1588
+ # to the workspace root.
1589
+ # @!attribute [r] internal_metadata
1590
+ # @return [::String]
1591
+ # Output only. All the metadata information that is used internally to serve
1592
+ # the resource. For example: timestamps, flags, status fields, etc. The
1593
+ # format of this field is a JSON string.
1376
1594
  class CompilationResultAction
1377
1595
  include ::Google::Protobuf::MessageExts
1378
1596
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1553,6 +1771,24 @@ module Google
1553
1771
  include ::Google::Protobuf::MessageExts
1554
1772
  extend ::Google::Protobuf::MessageExts::ClassMethods
1555
1773
  end
1774
+
1775
+ # Represents a notebook.
1776
+ # @!attribute [rw] dependency_targets
1777
+ # @return [::Array<::Google::Cloud::Dataform::V1beta1::Target>]
1778
+ # A list of actions that this action depends on.
1779
+ # @!attribute [rw] disabled
1780
+ # @return [::Boolean]
1781
+ # Whether this action is disabled (i.e. should not be run).
1782
+ # @!attribute [rw] contents
1783
+ # @return [::String]
1784
+ # The contents of the notebook.
1785
+ # @!attribute [rw] tags
1786
+ # @return [::Array<::String>]
1787
+ # Arbitrary, user-defined tags on this action.
1788
+ class Notebook
1789
+ include ::Google::Protobuf::MessageExts
1790
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1791
+ end
1556
1792
  end
1557
1793
 
1558
1794
  # `QueryCompilationResultActions` request message.
@@ -1571,8 +1807,8 @@ module Google
1571
1807
  # subsequent page.
1572
1808
  #
1573
1809
  # When paginating, all other parameters provided to
1574
- # `QueryCompilationResultActions` must match the call that provided the page
1575
- # token.
1810
+ # `QueryCompilationResultActions`, with the exception of `page_size`, must
1811
+ # match the call that provided the page token.
1576
1812
  # @!attribute [rw] filter
1577
1813
  # @return [::String]
1578
1814
  # Optional. Optional filter for the returned list. Filtering is only
@@ -1596,9 +1832,9 @@ module Google
1596
1832
  end
1597
1833
 
1598
1834
  # Represents a Dataform workflow configuration.
1599
- # @!attribute [r] name
1835
+ # @!attribute [rw] name
1600
1836
  # @return [::String]
1601
- # Output only. The workflow config's name.
1837
+ # Identifier. The workflow config's name.
1602
1838
  # @!attribute [rw] release_config
1603
1839
  # @return [::String]
1604
1840
  # Required. The name of the release config whose release_compilation_result
@@ -1620,17 +1856,25 @@ module Google
1620
1856
  # @!attribute [r] recent_scheduled_execution_records
1621
1857
  # @return [::Array<::Google::Cloud::Dataform::V1beta1::WorkflowConfig::ScheduledExecutionRecord>]
1622
1858
  # Output only. Records of the 10 most recent scheduled execution attempts,
1623
- # ordered in in descending order of `execution_time`. Updated whenever
1624
- # automatic creation of a workflow invocation is triggered by cron_schedule.
1859
+ # ordered in descending order of `execution_time`. Updated whenever automatic
1860
+ # creation of a workflow invocation is triggered by cron_schedule.
1861
+ # @!attribute [r] create_time
1862
+ # @return [::Google::Protobuf::Timestamp]
1863
+ # Output only. The timestamp of when the WorkflowConfig was created.
1864
+ # @!attribute [r] update_time
1865
+ # @return [::Google::Protobuf::Timestamp]
1866
+ # Output only. The timestamp of when the WorkflowConfig was last updated.
1867
+ # @!attribute [r] internal_metadata
1868
+ # @return [::String]
1869
+ # Output only. All the metadata information that is used internally to serve
1870
+ # the resource. For example: timestamps, flags, status fields, etc. The
1871
+ # format of this field is a JSON string.
1625
1872
  class WorkflowConfig
1626
1873
  include ::Google::Protobuf::MessageExts
1627
1874
  extend ::Google::Protobuf::MessageExts::ClassMethods
1628
1875
 
1629
1876
  # A record of an attempt to create a workflow invocation for this workflow
1630
1877
  # config.
1631
- # @!attribute [rw] execution_time
1632
- # @return [::Google::Protobuf::Timestamp]
1633
- # The timestamp of this execution attempt.
1634
1878
  # @!attribute [rw] workflow_invocation
1635
1879
  # @return [::String]
1636
1880
  # The name of the created workflow invocation, if one was successfully
@@ -1644,6 +1888,9 @@ module Google
1644
1888
  # workflow invocation, if the attempt was unsuccessful.
1645
1889
  #
1646
1890
  # Note: The following fields are mutually exclusive: `error_status`, `workflow_invocation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1891
+ # @!attribute [r] execution_time
1892
+ # @return [::Google::Protobuf::Timestamp]
1893
+ # Output only. The timestamp of this execution attempt.
1647
1894
  class ScheduledExecutionRecord
1648
1895
  include ::Google::Protobuf::MessageExts
1649
1896
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1693,8 +1940,9 @@ module Google
1693
1940
  # Optional. Page token received from a previous `ListWorkflowConfigs` call.
1694
1941
  # Provide this to retrieve the subsequent page.
1695
1942
  #
1696
- # When paginating, all other parameters provided to `ListWorkflowConfigs`
1697
- # must match the call that provided the page token.
1943
+ # When paginating, all other parameters provided to `ListWorkflowConfigs`,
1944
+ # with the exception of `page_size`, must match the call that provided the
1945
+ # page token.
1698
1946
  class ListWorkflowConfigsRequest
1699
1947
  include ::Google::Protobuf::MessageExts
1700
1948
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1765,9 +2013,6 @@ module Google
1765
2013
  end
1766
2014
 
1767
2015
  # Represents a single invocation of a compilation result.
1768
- # @!attribute [r] name
1769
- # @return [::String]
1770
- # Output only. The workflow invocation's name.
1771
2016
  # @!attribute [rw] compilation_result
1772
2017
  # @return [::String]
1773
2018
  # Immutable. The name of the compilation result to use for this invocation.
@@ -1781,6 +2026,9 @@ module Google
1781
2026
  # format `projects/*/locations/*/repositories/*/workflowConfigs/*`.
1782
2027
  #
1783
2028
  # Note: The following fields are mutually exclusive: `workflow_config`, `compilation_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2029
+ # @!attribute [r] name
2030
+ # @return [::String]
2031
+ # Output only. The workflow invocation's name.
1784
2032
  # @!attribute [rw] invocation_config
1785
2033
  # @return [::Google::Cloud::Dataform::V1beta1::InvocationConfig]
1786
2034
  # Immutable. If left unset, a default InvocationConfig will be used.
@@ -1790,6 +2038,19 @@ module Google
1790
2038
  # @!attribute [r] invocation_timing
1791
2039
  # @return [::Google::Type::Interval]
1792
2040
  # Output only. This workflow invocation's timing details.
2041
+ # @!attribute [r] resolved_compilation_result
2042
+ # @return [::String]
2043
+ # Output only. The resolved compilation result that was used to create this
2044
+ # invocation. Will be in the format
2045
+ # `projects/*/locations/*/repositories/*/compilationResults/*`.
2046
+ # @!attribute [r] data_encryption_state
2047
+ # @return [::Google::Cloud::Dataform::V1beta1::DataEncryptionState]
2048
+ # Output only. Only set if the repository has a KMS Key.
2049
+ # @!attribute [r] internal_metadata
2050
+ # @return [::String]
2051
+ # Output only. All the metadata information that is used internally to serve
2052
+ # the resource. For example: timestamps, flags, status fields, etc. The
2053
+ # format of this field is a JSON string.
1793
2054
  class WorkflowInvocation
1794
2055
  include ::Google::Protobuf::MessageExts
1795
2056
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1832,8 +2093,9 @@ module Google
1832
2093
  # Optional. Page token received from a previous `ListWorkflowInvocations`
1833
2094
  # call. Provide this to retrieve the subsequent page.
1834
2095
  #
1835
- # When paginating, all other parameters provided to `ListWorkflowInvocations`
1836
- # must match the call that provided the page token.
2096
+ # When paginating, all other parameters provided to
2097
+ # `ListWorkflowInvocations`, with the exception of `page_size`, must match
2098
+ # the call that provided the page token.
1837
2099
  # @!attribute [rw] order_by
1838
2100
  # @return [::String]
1839
2101
  # Optional. This field only supports ordering by `name`. If unspecified, the
@@ -1903,7 +2165,23 @@ module Google
1903
2165
  extend ::Google::Protobuf::MessageExts::ClassMethods
1904
2166
  end
1905
2167
 
2168
+ # `CancelWorkflowInvocation` response message.
2169
+ class CancelWorkflowInvocationResponse
2170
+ include ::Google::Protobuf::MessageExts
2171
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2172
+ end
2173
+
1906
2174
  # Represents a single action in a workflow invocation.
2175
+ # @!attribute [r] bigquery_action
2176
+ # @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::BigQueryAction]
2177
+ # Output only. The workflow action's bigquery action details.
2178
+ #
2179
+ # Note: The following fields are mutually exclusive: `bigquery_action`, `notebook_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2180
+ # @!attribute [r] notebook_action
2181
+ # @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::NotebookAction]
2182
+ # Output only. The workflow action's notebook action details.
2183
+ #
2184
+ # Note: The following fields are mutually exclusive: `notebook_action`, `bigquery_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1907
2185
  # @!attribute [r] target
1908
2186
  # @return [::Google::Cloud::Dataform::V1beta1::Target]
1909
2187
  # Output only. This action's identifier. Unique within the workflow
@@ -1926,9 +2204,11 @@ module Google
1926
2204
  # CANCELLED, FAILED] state.
1927
2205
  # `end_time` will be set if the action is in [SUCCEEDED, CANCELLED, FAILED]
1928
2206
  # state.
1929
- # @!attribute [r] bigquery_action
1930
- # @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction::BigQueryAction]
1931
- # Output only. The workflow action's bigquery action details.
2207
+ # @!attribute [r] internal_metadata
2208
+ # @return [::String]
2209
+ # Output only. All the metadata information that is used internally to serve
2210
+ # the resource. For example: timestamps, flags, status fields, etc. The
2211
+ # format of this field is a JSON string.
1932
2212
  class WorkflowInvocationAction
1933
2213
  include ::Google::Protobuf::MessageExts
1934
2214
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1937,11 +2217,29 @@ module Google
1937
2217
  # @!attribute [r] sql_script
1938
2218
  # @return [::String]
1939
2219
  # Output only. The generated BigQuery SQL script that will be executed.
2220
+ # @!attribute [r] job_id
2221
+ # @return [::String]
2222
+ # Output only. The ID of the BigQuery job that executed the SQL in
2223
+ # sql_script. Only set once the job has started to run.
1940
2224
  class BigQueryAction
1941
2225
  include ::Google::Protobuf::MessageExts
1942
2226
  extend ::Google::Protobuf::MessageExts::ClassMethods
1943
2227
  end
1944
2228
 
2229
+ # Represents a workflow action that will run against a Notebook runtime.
2230
+ # @!attribute [r] contents
2231
+ # @return [::String]
2232
+ # Output only. The code contents of a Notebook to be run.
2233
+ # @!attribute [r] job_id
2234
+ # @return [::String]
2235
+ # Output only. The ID of the Vertex job that executed the notebook in
2236
+ # contents and also the ID used for the outputs created in Google Cloud
2237
+ # Storage buckets. Only set once the job has started to run.
2238
+ class NotebookAction
2239
+ include ::Google::Protobuf::MessageExts
2240
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2241
+ end
2242
+
1945
2243
  # Represents the current state of a workflow invocation action.
1946
2244
  module State
1947
2245
  # The action has not yet been considered for invocation.
@@ -1985,8 +2283,8 @@ module Google
1985
2283
  # subsequent page.
1986
2284
  #
1987
2285
  # When paginating, all other parameters provided to
1988
- # `QueryWorkflowInvocationActions` must match the call that provided the page
1989
- # token.
2286
+ # `QueryWorkflowInvocationActions`, with the exception of `page_size`, must
2287
+ # match the call that provided the page token.
1990
2288
  class QueryWorkflowInvocationActionsRequest
1991
2289
  include ::Google::Protobuf::MessageExts
1992
2290
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -2004,6 +2302,40 @@ module Google
2004
2302
  include ::Google::Protobuf::MessageExts
2005
2303
  extend ::Google::Protobuf::MessageExts::ClassMethods
2006
2304
  end
2305
+
2306
+ # Config for all repositories in a given project and location.
2307
+ # @!attribute [rw] name
2308
+ # @return [::String]
2309
+ # Identifier. The config name.
2310
+ # @!attribute [rw] default_kms_key_name
2311
+ # @return [::String]
2312
+ # Optional. The default KMS key that is used if no encryption key is provided
2313
+ # when a repository is created.
2314
+ class Config
2315
+ include ::Google::Protobuf::MessageExts
2316
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2317
+ end
2318
+
2319
+ # `GetConfig` request message.
2320
+ # @!attribute [rw] name
2321
+ # @return [::String]
2322
+ # Required. The config name.
2323
+ class GetConfigRequest
2324
+ include ::Google::Protobuf::MessageExts
2325
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2326
+ end
2327
+
2328
+ # `UpdateConfig` request message.
2329
+ # @!attribute [rw] config
2330
+ # @return [::Google::Cloud::Dataform::V1beta1::Config]
2331
+ # Required. The config to update.
2332
+ # @!attribute [rw] update_mask
2333
+ # @return [::Google::Protobuf::FieldMask]
2334
+ # Optional. Specifies the fields to be updated in the config.
2335
+ class UpdateConfigRequest
2336
+ include ::Google::Protobuf::MessageExts
2337
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2338
+ end
2007
2339
  end
2008
2340
  end
2009
2341
  end