google-cloud-dataproc 0.10.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +3 -2
  3. data/AUTHENTICATION.md +51 -59
  4. data/LICENSE.md +203 -0
  5. data/MIGRATING.md +310 -0
  6. data/README.md +33 -44
  7. data/lib/{google/cloud/dataproc/v1/doc/google/protobuf/empty.rb → google-cloud-dataproc.rb} +4 -14
  8. data/lib/google/cloud/dataproc.rb +167 -305
  9. data/lib/google/cloud/dataproc/version.rb +6 -2
  10. metadata +97 -100
  11. data/LICENSE +0 -201
  12. data/lib/google/cloud/dataproc/v1.rb +0 -371
  13. data/lib/google/cloud/dataproc/v1/autoscaling_policies_pb.rb +0 -80
  14. data/lib/google/cloud/dataproc/v1/autoscaling_policies_services_pb.rb +0 -59
  15. data/lib/google/cloud/dataproc/v1/autoscaling_policy_service_client.rb +0 -494
  16. data/lib/google/cloud/dataproc/v1/autoscaling_policy_service_client_config.json +0 -51
  17. data/lib/google/cloud/dataproc/v1/cluster_controller_client.rb +0 -824
  18. data/lib/google/cloud/dataproc/v1/cluster_controller_client_config.json +0 -59
  19. data/lib/google/cloud/dataproc/v1/clusters_pb.rb +0 -234
  20. data/lib/google/cloud/dataproc/v1/clusters_services_pb.rb +0 -69
  21. data/lib/google/cloud/dataproc/v1/credentials.rb +0 -41
  22. data/lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/autoscaling_policies.rb +0 -238
  23. data/lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb +0 -819
  24. data/lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/jobs.rb +0 -759
  25. data/lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/workflow_templates.rb +0 -566
  26. data/lib/google/cloud/dataproc/v1/doc/google/longrunning/operations.rb +0 -51
  27. data/lib/google/cloud/dataproc/v1/doc/google/protobuf/any.rb +0 -131
  28. data/lib/google/cloud/dataproc/v1/doc/google/protobuf/duration.rb +0 -91
  29. data/lib/google/cloud/dataproc/v1/doc/google/protobuf/field_mask.rb +0 -222
  30. data/lib/google/cloud/dataproc/v1/doc/google/protobuf/timestamp.rb +0 -113
  31. data/lib/google/cloud/dataproc/v1/doc/google/rpc/status.rb +0 -39
  32. data/lib/google/cloud/dataproc/v1/job_controller_client.rb +0 -592
  33. data/lib/google/cloud/dataproc/v1/job_controller_client_config.json +0 -59
  34. data/lib/google/cloud/dataproc/v1/jobs_pb.rb +0 -273
  35. data/lib/google/cloud/dataproc/v1/jobs_services_pb.rb +0 -61
  36. data/lib/google/cloud/dataproc/v1/operations_pb.rb +0 -45
  37. data/lib/google/cloud/dataproc/v1/shared_pb.rb +0 -26
  38. data/lib/google/cloud/dataproc/v1/workflow_template_service_client.rb +0 -770
  39. data/lib/google/cloud/dataproc/v1/workflow_template_service_client_config.json +0 -64
  40. data/lib/google/cloud/dataproc/v1/workflow_templates_pb.rb +0 -184
  41. data/lib/google/cloud/dataproc/v1/workflow_templates_services_pb.rb +0 -105
  42. data/lib/google/cloud/dataproc/v1beta2.rb +0 -371
  43. data/lib/google/cloud/dataproc/v1beta2/autoscaling_policies_pb.rb +0 -80
  44. data/lib/google/cloud/dataproc/v1beta2/autoscaling_policies_services_pb.rb +0 -59
  45. data/lib/google/cloud/dataproc/v1beta2/autoscaling_policy_service_client.rb +0 -494
  46. data/lib/google/cloud/dataproc/v1beta2/autoscaling_policy_service_client_config.json +0 -51
  47. data/lib/google/cloud/dataproc/v1beta2/cluster_controller_client.rb +0 -833
  48. data/lib/google/cloud/dataproc/v1beta2/cluster_controller_client_config.json +0 -59
  49. data/lib/google/cloud/dataproc/v1beta2/clusters_pb.rb +0 -241
  50. data/lib/google/cloud/dataproc/v1beta2/clusters_services_pb.rb +0 -69
  51. data/lib/google/cloud/dataproc/v1beta2/credentials.rb +0 -41
  52. data/lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/autoscaling_policies.rb +0 -238
  53. data/lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/clusters.rb +0 -841
  54. data/lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/jobs.rb +0 -728
  55. data/lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/workflow_templates.rb +0 -579
  56. data/lib/google/cloud/dataproc/v1beta2/doc/google/longrunning/operations.rb +0 -51
  57. data/lib/google/cloud/dataproc/v1beta2/doc/google/protobuf/any.rb +0 -131
  58. data/lib/google/cloud/dataproc/v1beta2/doc/google/protobuf/duration.rb +0 -91
  59. data/lib/google/cloud/dataproc/v1beta2/doc/google/protobuf/empty.rb +0 -29
  60. data/lib/google/cloud/dataproc/v1beta2/doc/google/protobuf/field_mask.rb +0 -222
  61. data/lib/google/cloud/dataproc/v1beta2/doc/google/protobuf/timestamp.rb +0 -113
  62. data/lib/google/cloud/dataproc/v1beta2/doc/google/rpc/status.rb +0 -39
  63. data/lib/google/cloud/dataproc/v1beta2/job_controller_client.rb +0 -592
  64. data/lib/google/cloud/dataproc/v1beta2/job_controller_client_config.json +0 -59
  65. data/lib/google/cloud/dataproc/v1beta2/jobs_pb.rb +0 -261
  66. data/lib/google/cloud/dataproc/v1beta2/jobs_services_pb.rb +0 -61
  67. data/lib/google/cloud/dataproc/v1beta2/operations_pb.rb +0 -44
  68. data/lib/google/cloud/dataproc/v1beta2/shared_pb.rb +0 -30
  69. data/lib/google/cloud/dataproc/v1beta2/workflow_template_service_client.rb +0 -778
  70. data/lib/google/cloud/dataproc/v1beta2/workflow_template_service_client_config.json +0 -64
  71. data/lib/google/cloud/dataproc/v1beta2/workflow_templates_pb.rb +0 -186
  72. data/lib/google/cloud/dataproc/v1beta2/workflow_templates_services_pb.rb +0 -105
@@ -1,579 +0,0 @@
1
- # Copyright 2020 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Cloud
18
- module Dataproc
19
- module V1beta2
20
- # A Dataproc workflow template resource.
21
- # @!attribute [rw] id
22
- # @return [String]
23
- # Required. The template id.
24
- #
25
- # The id must contain only letters (a-z, A-Z), numbers (0-9),
26
- # underscores (_), and hyphens (-). Cannot begin or end with underscore
27
- # or hyphen. Must consist of between 3 and 50 characters.
28
- #
29
- # .
30
- # @!attribute [rw] name
31
- # @return [String]
32
- # Output only. The resource name of the workflow template, as described
33
- # in https://cloud.google.com/apis/design/resource_names.
34
- #
35
- # * For `projects.regions.workflowTemplates`, the resource name of the
36
- # template has the following format:
37
- # `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
38
- #
39
- # * For `projects.locations.workflowTemplates`, the resource name of the
40
- # template has the following format:
41
- # `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
42
- # @!attribute [rw] version
43
- # @return [Integer]
44
- # Optional. Used to perform a consistent read-modify-write.
45
- #
46
- # This field should be left blank for a `CreateWorkflowTemplate` request. It
47
- # is required for an `UpdateWorkflowTemplate` request, and must match the
48
- # current server version. A typical update template flow would fetch the
49
- # current template with a `GetWorkflowTemplate` request, which will return
50
- # the current template with the `version` field filled in with the
51
- # current server version. The user updates other fields in the template,
52
- # then returns it as part of the `UpdateWorkflowTemplate` request.
53
- # @!attribute [rw] create_time
54
- # @return [Google::Protobuf::Timestamp]
55
- # Output only. The time template was created.
56
- # @!attribute [rw] update_time
57
- # @return [Google::Protobuf::Timestamp]
58
- # Output only. The time template was last updated.
59
- # @!attribute [rw] labels
60
- # @return [Hash{String => String}]
61
- # Optional. The labels to associate with this template. These labels
62
- # will be propagated to all jobs and clusters created by the workflow
63
- # instance.
64
- #
65
- # Label **keys** must contain 1 to 63 characters, and must conform to
66
- # [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
67
- #
68
- # Label **values** may be empty, but, if present, must contain 1 to 63
69
- # characters, and must conform to
70
- # [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
71
- #
72
- # No more than 32 labels can be associated with a template.
73
- # @!attribute [rw] placement
74
- # @return [Google::Cloud::Dataproc::V1beta2::WorkflowTemplatePlacement]
75
- # Required. WorkflowTemplate scheduling information.
76
- # @!attribute [rw] jobs
77
- # @return [Array<Google::Cloud::Dataproc::V1beta2::OrderedJob>]
78
- # Required. The Directed Acyclic Graph of Jobs to submit.
79
- # @!attribute [rw] parameters
80
- # @return [Array<Google::Cloud::Dataproc::V1beta2::TemplateParameter>]
81
- # Optional. Template parameters whose values are substituted into the
82
- # template. Values for parameters must be provided when the template is
83
- # instantiated.
84
- class WorkflowTemplate; end
85
-
86
- # Specifies workflow execution target.
87
- #
88
- # Either `managed_cluster` or `cluster_selector` is required.
89
- # @!attribute [rw] managed_cluster
90
- # @return [Google::Cloud::Dataproc::V1beta2::ManagedCluster]
91
- # Optional. A cluster that is managed by the workflow.
92
- # @!attribute [rw] cluster_selector
93
- # @return [Google::Cloud::Dataproc::V1beta2::ClusterSelector]
94
- # Optional. A selector that chooses target cluster for jobs based
95
- # on metadata.
96
- #
97
- # The selector is evaluated at the time each job is submitted.
98
- class WorkflowTemplatePlacement; end
99
-
100
- # Cluster that is managed by the workflow.
101
- # @!attribute [rw] cluster_name
102
- # @return [String]
103
- # Required. The cluster name prefix. A unique cluster name will be formed by
104
- # appending a random suffix.
105
- #
106
- # The name must contain only lower-case letters (a-z), numbers (0-9),
107
- # and hyphens (-). Must begin with a letter. Cannot begin or end with
108
- # hyphen. Must consist of between 2 and 35 characters.
109
- # @!attribute [rw] config
110
- # @return [Google::Cloud::Dataproc::V1beta2::ClusterConfig]
111
- # Required. The cluster configuration.
112
- # @!attribute [rw] labels
113
- # @return [Hash{String => String}]
114
- # Optional. The labels to associate with this cluster.
115
- #
116
- # Label keys must be between 1 and 63 characters long, and must conform to
117
- # the following PCRE regular expression:
118
- # [\p\\{Ll}\p\\{Lo}][\p\\{Ll}\p\\{Lo}\p\\{N}_-]\\{0,62}
119
- #
120
- # Label values must be between 1 and 63 characters long, and must conform to
121
- # the following PCRE regular expression: [\p\\{Ll}\p\\{Lo}\p\\{N}_-]\\{0,63}
122
- #
123
- # No more than 32 labels can be associated with a given cluster.
124
- class ManagedCluster; end
125
-
126
- # A selector that chooses target cluster for jobs based on metadata.
127
- # @!attribute [rw] zone
128
- # @return [String]
129
- # Optional. The zone where workflow process executes. This parameter does not
130
- # affect the selection of the cluster.
131
- #
132
- # If unspecified, the zone of the first cluster matching the selector
133
- # is used.
134
- # @!attribute [rw] cluster_labels
135
- # @return [Hash{String => String}]
136
- # Required. The cluster labels. Cluster must have all labels
137
- # to match.
138
- class ClusterSelector; end
139
-
140
- # A job executed by the workflow.
141
- # @!attribute [rw] step_id
142
- # @return [String]
143
- # Required. The step id. The id must be unique among all jobs
144
- # within the template.
145
- #
146
- # The step id is used as prefix for job id, as job
147
- # `goog-dataproc-workflow-step-id` label, and in
148
- # {Google::Cloud::Dataproc::V1beta2::OrderedJob#prerequisite_step_ids prerequisiteStepIds} field from other
149
- # steps.
150
- #
151
- # The id must contain only letters (a-z, A-Z), numbers (0-9),
152
- # underscores (_), and hyphens (-). Cannot begin or end with underscore
153
- # or hyphen. Must consist of between 3 and 50 characters.
154
- # @!attribute [rw] hadoop_job
155
- # @return [Google::Cloud::Dataproc::V1beta2::HadoopJob]
156
- # @!attribute [rw] spark_job
157
- # @return [Google::Cloud::Dataproc::V1beta2::SparkJob]
158
- # @!attribute [rw] pyspark_job
159
- # @return [Google::Cloud::Dataproc::V1beta2::PySparkJob]
160
- # @!attribute [rw] hive_job
161
- # @return [Google::Cloud::Dataproc::V1beta2::HiveJob]
162
- # @!attribute [rw] pig_job
163
- # @return [Google::Cloud::Dataproc::V1beta2::PigJob]
164
- # @!attribute [rw] spark_sql_job
165
- # @return [Google::Cloud::Dataproc::V1beta2::SparkSqlJob]
166
- # @!attribute [rw] labels
167
- # @return [Hash{String => String}]
168
- # Optional. The labels to associate with this job.
169
- #
170
- # Label keys must be between 1 and 63 characters long, and must conform to
171
- # the following regular expression:
172
- # [\p\\{Ll}\p\\{Lo}][\p\\{Ll}\p\\{Lo}\p\\{N}_-]\\{0,62}
173
- #
174
- # Label values must be between 1 and 63 characters long, and must conform to
175
- # the following regular expression: [\p\\{Ll}\p\\{Lo}\p\\{N}_-]\\{0,63}
176
- #
177
- # No more than 32 labels can be associated with a given job.
178
- # @!attribute [rw] scheduling
179
- # @return [Google::Cloud::Dataproc::V1beta2::JobScheduling]
180
- # Optional. Job scheduling configuration.
181
- # @!attribute [rw] prerequisite_step_ids
182
- # @return [Array<String>]
183
- # Optional. The optional list of prerequisite job step_ids.
184
- # If not specified, the job will start at the beginning of workflow.
185
- class OrderedJob; end
186
-
187
- # A configurable parameter that replaces one or more fields in the template.
188
- # Parameterizable fields:
189
- # * Labels
190
- # * File uris
191
- # * Job properties
192
- # * Job arguments
193
- # * Script variables
194
- # * Main class (in HadoopJob and SparkJob)
195
- # * Zone (in ClusterSelector)
196
- # @!attribute [rw] name
197
- # @return [String]
198
- # Required. Parameter name.
199
- # The parameter name is used as the key, and paired with the
200
- # parameter value, which are passed to the template when the template
201
- # is instantiated.
202
- # The name must contain only capital letters (A-Z), numbers (0-9), and
203
- # underscores (_), and must not start with a number. The maximum length is
204
- # 40 characters.
205
- # @!attribute [rw] fields
206
- # @return [Array<String>]
207
- # Required. Paths to all fields that the parameter replaces.
208
- # A field is allowed to appear in at most one parameter's list of field
209
- # paths.
210
- #
211
- # A field path is similar in syntax to a {Google::Protobuf::FieldMask}.
212
- # For example, a field path that references the zone field of a workflow
213
- # template's cluster selector would be specified as
214
- # `placement.clusterSelector.zone`.
215
- #
216
- # Also, field paths can reference fields using the following syntax:
217
- #
218
- # * Values in maps can be referenced by key:
219
- # * labels['key']
220
- # * placement.clusterSelector.clusterLabels['key']
221
- # * placement.managedCluster.labels['key']
222
- # * placement.clusterSelector.clusterLabels['key']
223
- # * jobs['step-id'].labels['key']
224
- #
225
- # * Jobs in the jobs list can be referenced by step-id:
226
- # * jobs['step-id'].hadoopJob.mainJarFileUri
227
- # * jobs['step-id'].hiveJob.queryFileUri
228
- # * jobs['step-id'].pySparkJob.mainPythonFileUri
229
- # * jobs['step-id'].hadoopJob.jarFileUris[0]
230
- # * jobs['step-id'].hadoopJob.archiveUris[0]
231
- # * jobs['step-id'].hadoopJob.fileUris[0]
232
- # * jobs['step-id'].pySparkJob.pythonFileUris[0]
233
- #
234
- # * Items in repeated fields can be referenced by a zero-based index:
235
- # * jobs['step-id'].sparkJob.args[0]
236
- #
237
- # * Other examples:
238
- # * jobs['step-id'].hadoopJob.properties['key']
239
- # * jobs['step-id'].hadoopJob.args[0]
240
- # * jobs['step-id'].hiveJob.scriptVariables['key']
241
- # * jobs['step-id'].hadoopJob.mainJarFileUri
242
- # * placement.clusterSelector.zone
243
- #
244
- # It may not be possible to parameterize maps and repeated fields in their
245
- # entirety since only individual map values and individual items in repeated
246
- # fields can be referenced. For example, the following field paths are
247
- # invalid:
248
- #
249
- # * placement.clusterSelector.clusterLabels
250
- # * jobs['step-id'].sparkJob.args
251
- # @!attribute [rw] description
252
- # @return [String]
253
- # Optional. Brief description of the parameter.
254
- # Must not exceed 1024 characters.
255
- # @!attribute [rw] validation
256
- # @return [Google::Cloud::Dataproc::V1beta2::ParameterValidation]
257
- # Optional. Validation rules to be applied to this parameter's value.
258
- class TemplateParameter; end
259
-
260
- # Configuration for parameter validation.
261
- # @!attribute [rw] regex
262
- # @return [Google::Cloud::Dataproc::V1beta2::RegexValidation]
263
- # Validation based on regular expressions.
264
- # @!attribute [rw] values
265
- # @return [Google::Cloud::Dataproc::V1beta2::ValueValidation]
266
- # Validation based on a list of allowed values.
267
- class ParameterValidation; end
268
-
269
- # Validation based on regular expressions.
270
- # @!attribute [rw] regexes
271
- # @return [Array<String>]
272
- # Required. RE2 regular expressions used to validate the parameter's value.
273
- # The value must match the regex in its entirety (substring
274
- # matches are not sufficient).
275
- class RegexValidation; end
276
-
277
- # Validation based on a list of allowed values.
278
- # @!attribute [rw] values
279
- # @return [Array<String>]
280
- # Required. List of allowed values for the parameter.
281
- class ValueValidation; end
282
-
283
- # A Dataproc workflow template resource.
284
- # @!attribute [rw] template
285
- # @return [String]
286
- # Output only. The resource name of the workflow template as described
287
- # in https://cloud.google.com/apis/design/resource_names.
288
- #
289
- # * For `projects.regions.workflowTemplates`, the resource name of the
290
- # template has the following format:
291
- # `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
292
- #
293
- # * For `projects.locations.workflowTemplates`, the resource name of the
294
- # template has the following format:
295
- # `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
296
- # @!attribute [rw] version
297
- # @return [Integer]
298
- # Output only. The version of template at the time of
299
- # workflow instantiation.
300
- # @!attribute [rw] create_cluster
301
- # @return [Google::Cloud::Dataproc::V1beta2::ClusterOperation]
302
- # Output only. The create cluster operation metadata.
303
- # @!attribute [rw] graph
304
- # @return [Google::Cloud::Dataproc::V1beta2::WorkflowGraph]
305
- # Output only. The workflow graph.
306
- # @!attribute [rw] delete_cluster
307
- # @return [Google::Cloud::Dataproc::V1beta2::ClusterOperation]
308
- # Output only. The delete cluster operation metadata.
309
- # @!attribute [rw] state
310
- # @return [Google::Cloud::Dataproc::V1beta2::WorkflowMetadata::State]
311
- # Output only. The workflow state.
312
- # @!attribute [rw] cluster_name
313
- # @return [String]
314
- # Output only. The name of the target cluster.
315
- # @!attribute [rw] parameters
316
- # @return [Hash{String => String}]
317
- # Map from parameter names to values that were used for those parameters.
318
- # @!attribute [rw] start_time
319
- # @return [Google::Protobuf::Timestamp]
320
- # Output only. Workflow start time.
321
- # @!attribute [rw] end_time
322
- # @return [Google::Protobuf::Timestamp]
323
- # Output only. Workflow end time.
324
- # @!attribute [rw] cluster_uuid
325
- # @return [String]
326
- # Output only. The UUID of target cluster.
327
- class WorkflowMetadata
328
- # The operation state.
329
- module State
330
- # Unused.
331
- UNKNOWN = 0
332
-
333
- # The operation has been created.
334
- PENDING = 1
335
-
336
- # The operation is running.
337
- RUNNING = 2
338
-
339
- # The operation is done; either cancelled or completed.
340
- DONE = 3
341
- end
342
- end
343
-
344
- # The cluster operation triggered by a workflow.
345
- # @!attribute [rw] operation_id
346
- # @return [String]
347
- # Output only. The id of the cluster operation.
348
- # @!attribute [rw] error
349
- # @return [String]
350
- # Output only. Error, if operation failed.
351
- # @!attribute [rw] done
352
- # @return [true, false]
353
- # Output only. Indicates the operation is done.
354
- class ClusterOperation; end
355
-
356
- # The workflow graph.
357
- # @!attribute [rw] nodes
358
- # @return [Array<Google::Cloud::Dataproc::V1beta2::WorkflowNode>]
359
- # Output only. The workflow nodes.
360
- class WorkflowGraph; end
361
-
362
- # The workflow node.
363
- # @!attribute [rw] step_id
364
- # @return [String]
365
- # Output only. The name of the node.
366
- # @!attribute [rw] prerequisite_step_ids
367
- # @return [Array<String>]
368
- # Output only. Node's prerequisite nodes.
369
- # @!attribute [rw] job_id
370
- # @return [String]
371
- # Output only. The job id; populated after the node enters RUNNING state.
372
- # @!attribute [rw] state
373
- # @return [Google::Cloud::Dataproc::V1beta2::WorkflowNode::NodeState]
374
- # Output only. The node state.
375
- # @!attribute [rw] error
376
- # @return [String]
377
- # Output only. The error detail.
378
- class WorkflowNode
379
- # The workflow node state.
380
- module NodeState
381
- # State is unspecified.
382
- NODE_STATUS_UNSPECIFIED = 0
383
-
384
- # The node is awaiting prerequisite node to finish.
385
- BLOCKED = 1
386
-
387
- # The node is runnable but not running.
388
- RUNNABLE = 2
389
-
390
- # The node is running.
391
- RUNNING = 3
392
-
393
- # The node completed successfully.
394
- COMPLETED = 4
395
-
396
- # The node failed. A node can be marked FAILED because
397
- # its ancestor or peer failed.
398
- FAILED = 5
399
- end
400
- end
401
-
402
- # A request to create a workflow template.
403
- # @!attribute [rw] parent
404
- # @return [String]
405
- # Required. The resource name of the region or location, as described
406
- # in https://cloud.google.com/apis/design/resource_names.
407
- #
408
- # * For `projects.regions.workflowTemplates,create`, the resource name of the
409
- # region has the following format:
410
- # `projects/{project_id}/regions/{region}`
411
- #
412
- # * For `projects.locations.workflowTemplates.create`, the resource name of
413
- # the location has the following format:
414
- # `projects/{project_id}/locations/{location}`
415
- # @!attribute [rw] template
416
- # @return [Google::Cloud::Dataproc::V1beta2::WorkflowTemplate]
417
- # Required. The Dataproc workflow template to create.
418
- class CreateWorkflowTemplateRequest; end
419
-
420
- # A request to fetch a workflow template.
421
- # @!attribute [rw] name
422
- # @return [String]
423
- # Required. The resource name of the workflow template, as described
424
- # in https://cloud.google.com/apis/design/resource_names.
425
- #
426
- # * For `projects.regions.workflowTemplates.get`, the resource name of the
427
- # template has the following format:
428
- # `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
429
- #
430
- # * For `projects.locations.workflowTemplates.get`, the resource name of the
431
- # template has the following format:
432
- # `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
433
- # @!attribute [rw] version
434
- # @return [Integer]
435
- # Optional. The version of workflow template to retrieve. Only previously
436
- # instantiated versions can be retrieved.
437
- #
438
- # If unspecified, retrieves the current version.
439
- class GetWorkflowTemplateRequest; end
440
-
441
- # A request to instantiate a workflow template.
442
- # @!attribute [rw] name
443
- # @return [String]
444
- # Required. The resource name of the workflow template, as described
445
- # in https://cloud.google.com/apis/design/resource_names.
446
- #
447
- # * For `projects.regions.workflowTemplates.instantiate`, the resource name
448
- # of the template has the following format:
449
- # `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
450
- #
451
- # * For `projects.locations.workflowTemplates.instantiate`, the resource name
452
- # of the template has the following format:
453
- # `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
454
- # @!attribute [rw] version
455
- # @return [Integer]
456
- # Optional. The version of workflow template to instantiate. If specified,
457
- # the workflow will be instantiated only if the current version of
458
- # the workflow template has the supplied version.
459
- #
460
- # This option cannot be used to instantiate a previous version of
461
- # workflow template.
462
- # @!attribute [rw] instance_id
463
- # @return [String]
464
- # Deprecated. Please use `request_id` field instead.
465
- # @!attribute [rw] request_id
466
- # @return [String]
467
- # Optional. A tag that prevents multiple concurrent workflow
468
- # instances with the same tag from running. This mitigates risk of
469
- # concurrent instances started due to retries.
470
- #
471
- # It is recommended to always set this value to a
472
- # [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
473
- #
474
- # The tag must contain only letters (a-z, A-Z), numbers (0-9),
475
- # underscores (_), and hyphens (-). The maximum length is 40 characters.
476
- # @!attribute [rw] parameters
477
- # @return [Hash{String => String}]
478
- # Optional. Map from parameter names to values that should be used for those
479
- # parameters. Values may not exceed 100 characters.
480
- class InstantiateWorkflowTemplateRequest; end
481
-
482
- # A request to instantiate an inline workflow template.
483
- # @!attribute [rw] parent
484
- # @return [String]
485
- # Required. The resource name of the region or location, as described
486
- # in https://cloud.google.com/apis/design/resource_names.
487
- #
488
- # * For `projects.regions.workflowTemplates,instantiateinline`, the resource
489
- # name of the region has the following format:
490
- # `projects/{project_id}/regions/{region}`
491
- #
492
- # * For `projects.locations.workflowTemplates.instantiateinline`, the
493
- # resource name of the location has the following format:
494
- # `projects/{project_id}/locations/{location}`
495
- # @!attribute [rw] template
496
- # @return [Google::Cloud::Dataproc::V1beta2::WorkflowTemplate]
497
- # Required. The workflow template to instantiate.
498
- # @!attribute [rw] instance_id
499
- # @return [String]
500
- # Deprecated. Please use `request_id` field instead.
501
- # @!attribute [rw] request_id
502
- # @return [String]
503
- # Optional. A tag that prevents multiple concurrent workflow
504
- # instances with the same tag from running. This mitigates risk of
505
- # concurrent instances started due to retries.
506
- #
507
- # It is recommended to always set this value to a
508
- # [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
509
- #
510
- # The tag must contain only letters (a-z, A-Z), numbers (0-9),
511
- # underscores (_), and hyphens (-). The maximum length is 40 characters.
512
- class InstantiateInlineWorkflowTemplateRequest; end
513
-
514
- # A request to update a workflow template.
515
- # @!attribute [rw] template
516
- # @return [Google::Cloud::Dataproc::V1beta2::WorkflowTemplate]
517
- # Required. The updated workflow template.
518
- #
519
- # The `template.version` field must match the current version.
520
- class UpdateWorkflowTemplateRequest; end
521
-
522
- # A request to list workflow templates in a project.
523
- # @!attribute [rw] parent
524
- # @return [String]
525
- # Required. The resource name of the region or location, as described
526
- # in https://cloud.google.com/apis/design/resource_names.
527
- #
528
- # * For `projects.regions.workflowTemplates,list`, the resource
529
- # name of the region has the following format:
530
- # `projects/{project_id}/regions/{region}`
531
- #
532
- # * For `projects.locations.workflowTemplates.list`, the
533
- # resource name of the location has the following format:
534
- # `projects/{project_id}/locations/{location}`
535
- # @!attribute [rw] page_size
536
- # @return [Integer]
537
- # Optional. The maximum number of results to return in each response.
538
- # @!attribute [rw] page_token
539
- # @return [String]
540
- # Optional. The page token, returned by a previous call, to request the
541
- # next page of results.
542
- class ListWorkflowTemplatesRequest; end
543
-
544
- # A response to a request to list workflow templates in a project.
545
- # @!attribute [rw] templates
546
- # @return [Array<Google::Cloud::Dataproc::V1beta2::WorkflowTemplate>]
547
- # Output only. WorkflowTemplates list.
548
- # @!attribute [rw] next_page_token
549
- # @return [String]
550
- # Output only. This token is included in the response if there are more
551
- # results to fetch. To fetch additional results, provide this value as the
552
- # page_token in a subsequent <code>ListWorkflowTemplatesRequest</code>.
553
- class ListWorkflowTemplatesResponse; end
554
-
555
- # A request to delete a workflow template.
556
- #
557
- # Currently started workflows will remain running.
558
- # @!attribute [rw] name
559
- # @return [String]
560
- # Required. The resource name of the workflow template, as described
561
- # in https://cloud.google.com/apis/design/resource_names.
562
- #
563
- # * For `projects.regions.workflowTemplates.delete`, the resource name
564
- # of the template has the following format:
565
- # `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
566
- #
567
- # * For `projects.locations.workflowTemplates.instantiate`, the resource name
568
- # of the template has the following format:
569
- # `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
570
- # @!attribute [rw] version
571
- # @return [Integer]
572
- # Optional. The version of workflow template to delete. If specified,
573
- # will only delete the template if the current server version matches
574
- # specified version.
575
- class DeleteWorkflowTemplateRequest; end
576
- end
577
- end
578
- end
579
- end