google-cloud-dataplex-v1 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +149 -0
- data/LICENSE.md +201 -0
- data/README.md +139 -0
- data/lib/google/cloud/dataplex/v1/dataplex_service/client.rb +3133 -0
- data/lib/google/cloud/dataplex/v1/dataplex_service/credentials.rb +47 -0
- data/lib/google/cloud/dataplex/v1/dataplex_service/operations.rb +767 -0
- data/lib/google/cloud/dataplex/v1/dataplex_service/paths.rb +157 -0
- data/lib/google/cloud/dataplex/v1/dataplex_service.rb +54 -0
- data/lib/google/cloud/dataplex/v1/logs_pb.rb +135 -0
- data/lib/google/cloud/dataplex/v1/metadata_pb.rb +214 -0
- data/lib/google/cloud/dataplex/v1/metadata_service/client.rb +729 -0
- data/lib/google/cloud/dataplex/v1/metadata_service/credentials.rb +47 -0
- data/lib/google/cloud/dataplex/v1/metadata_service/paths.rb +102 -0
- data/lib/google/cloud/dataplex/v1/metadata_service.rb +50 -0
- data/lib/google/cloud/dataplex/v1/metadata_services_pb.rb +52 -0
- data/lib/google/cloud/dataplex/v1/resources_pb.rb +298 -0
- data/lib/google/cloud/dataplex/v1/service_pb.rb +218 -0
- data/lib/google/cloud/dataplex/v1/service_services_pb.rb +102 -0
- data/lib/google/cloud/dataplex/v1/tasks_pb.rb +133 -0
- data/lib/google/cloud/dataplex/v1/version.rb +28 -0
- data/lib/google/cloud/dataplex/v1.rb +39 -0
- data/lib/google-cloud-dataplex-v1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +71 -0
- data/proto_docs/google/api/resource.rb +222 -0
- data/proto_docs/google/cloud/dataplex/v1/logs.rb +308 -0
- data/proto_docs/google/cloud/dataplex/v1/metadata.rb +533 -0
- data/proto_docs/google/cloud/dataplex/v1/resources.rb +821 -0
- data/proto_docs/google/cloud/dataplex/v1/service.rb +601 -0
- data/proto_docs/google/cloud/dataplex/v1/tasks.rb +349 -0
- data/proto_docs/google/longrunning/operations.rb +164 -0
- data/proto_docs/google/protobuf/any.rb +141 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +129 -0
- data/proto_docs/google/rpc/status.rb +46 -0
- metadata +231 -0
@@ -0,0 +1,349 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Dataplex
|
23
|
+
module V1
|
24
|
+
# A task represents a user-visible job.
|
25
|
+
# @!attribute [r] name
|
26
|
+
# @return [::String]
|
27
|
+
# Output only. The relative resource name of the task, of the form:
|
28
|
+
# projects/\\{project_number}/locations/\\{location_id}/lakes/\\{lake_id}/
|
29
|
+
# tasks/\\{task_id}.
|
30
|
+
# @!attribute [r] uid
|
31
|
+
# @return [::String]
|
32
|
+
# Output only. System generated globally unique ID for the task. This ID will be
|
33
|
+
# different if the task is deleted and re-created with the same name.
|
34
|
+
# @!attribute [r] create_time
|
35
|
+
# @return [::Google::Protobuf::Timestamp]
|
36
|
+
# Output only. The time when the task was created.
|
37
|
+
# @!attribute [r] update_time
|
38
|
+
# @return [::Google::Protobuf::Timestamp]
|
39
|
+
# Output only. The time when the task was last updated.
|
40
|
+
# @!attribute [rw] description
|
41
|
+
# @return [::String]
|
42
|
+
# Optional. Description of the task.
|
43
|
+
# @!attribute [rw] display_name
|
44
|
+
# @return [::String]
|
45
|
+
# Optional. User friendly display name.
|
46
|
+
# @!attribute [r] state
|
47
|
+
# @return [::Google::Cloud::Dataplex::V1::State]
|
48
|
+
# Output only. Current state of the task.
|
49
|
+
# @!attribute [rw] labels
|
50
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
51
|
+
# Optional. User-defined labels for the task.
|
52
|
+
# @!attribute [rw] trigger_spec
|
53
|
+
# @return [::Google::Cloud::Dataplex::V1::Task::TriggerSpec]
|
54
|
+
# Required. Spec related to how often and when a task should be triggered.
|
55
|
+
# @!attribute [rw] execution_spec
|
56
|
+
# @return [::Google::Cloud::Dataplex::V1::Task::ExecutionSpec]
|
57
|
+
# Required. Spec related to how a task is executed.
|
58
|
+
# @!attribute [rw] spark
|
59
|
+
# @return [::Google::Cloud::Dataplex::V1::Task::SparkTaskConfig]
|
60
|
+
# Config related to running custom Spark tasks.
|
61
|
+
class Task
|
62
|
+
include ::Google::Protobuf::MessageExts
|
63
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
64
|
+
|
65
|
+
# Configuration for the underlying infrastructure used to run workloads.
|
66
|
+
# @!attribute [rw] batch
|
67
|
+
# @return [::Google::Cloud::Dataplex::V1::Task::InfrastructureSpec::BatchComputeResources]
|
68
|
+
# Compute resources needed for a Task when using Dataproc Serverless.
|
69
|
+
# @!attribute [rw] container_image
|
70
|
+
# @return [::Google::Cloud::Dataplex::V1::Task::InfrastructureSpec::ContainerImageRuntime]
|
71
|
+
# Container Image Runtime Configuration.
|
72
|
+
# @!attribute [rw] vpc_network
|
73
|
+
# @return [::Google::Cloud::Dataplex::V1::Task::InfrastructureSpec::VpcNetwork]
|
74
|
+
# Vpc network.
|
75
|
+
class InfrastructureSpec
|
76
|
+
include ::Google::Protobuf::MessageExts
|
77
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
78
|
+
|
79
|
+
# Batch compute resources associated with the task.
|
80
|
+
# @!attribute [rw] executors_count
|
81
|
+
# @return [::Integer]
|
82
|
+
# Optional. Total number of job executors.
|
83
|
+
# @!attribute [rw] max_executors_count
|
84
|
+
# @return [::Integer]
|
85
|
+
# Optional. Max configurable executors.
|
86
|
+
# If max_executors_count > executors_count, then auto-scaling is enabled.
|
87
|
+
class BatchComputeResources
|
88
|
+
include ::Google::Protobuf::MessageExts
|
89
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
90
|
+
end
|
91
|
+
|
92
|
+
# Container Image Runtime Configuration used with Batch execution.
|
93
|
+
# @!attribute [rw] java_jars
|
94
|
+
# @return [::Array<::String>]
|
95
|
+
# Optional. A list of Java JARS to add to the classpath.
|
96
|
+
# Valid input includes Cloud Storage URIs to Jar binaries.
|
97
|
+
# For example, `gs://bucket-name/my/path/to/file.jar`.
|
98
|
+
# @!attribute [rw] python_packages
|
99
|
+
# @return [::Array<::String>]
|
100
|
+
# Optional. A list of python packages to be installed.
|
101
|
+
# Valid formats include Cloud Storage URI to a PIP installable library.
|
102
|
+
# For example, `gs://bucket-name/my/path/to/lib.tar.gz`.
|
103
|
+
# @!attribute [rw] properties
|
104
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
105
|
+
# Optional. Override to common configuration of open source components installed on
|
106
|
+
# the Dataproc cluster.
|
107
|
+
# The properties to set on daemon config files.
|
108
|
+
# Property keys are specified in `prefix:property` format, for example
|
109
|
+
# `core:hadoop.tmp.dir`.
|
110
|
+
# For more information, see [Cluster
|
111
|
+
# properties](https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
|
112
|
+
class ContainerImageRuntime
|
113
|
+
include ::Google::Protobuf::MessageExts
|
114
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
115
|
+
|
116
|
+
# @!attribute [rw] key
|
117
|
+
# @return [::String]
|
118
|
+
# @!attribute [rw] value
|
119
|
+
# @return [::String]
|
120
|
+
class PropertiesEntry
|
121
|
+
include ::Google::Protobuf::MessageExts
|
122
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
123
|
+
end
|
124
|
+
end
|
125
|
+
|
126
|
+
# Cloud VPC Network used to run the infrastructure.
|
127
|
+
# @!attribute [rw] network
|
128
|
+
# @return [::String]
|
129
|
+
# Optional. The Cloud VPC network in which the job is run. By default, the Cloud
|
130
|
+
# VPC network named Default within the project is used.
|
131
|
+
# @!attribute [rw] sub_network
|
132
|
+
# @return [::String]
|
133
|
+
# Optional. The Cloud VPC sub-network in which the job is run.
|
134
|
+
# @!attribute [rw] network_tags
|
135
|
+
# @return [::Array<::String>]
|
136
|
+
# Optional. List of network tags to apply to the job.
|
137
|
+
class VpcNetwork
|
138
|
+
include ::Google::Protobuf::MessageExts
|
139
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
140
|
+
end
|
141
|
+
end
|
142
|
+
|
143
|
+
# Task scheduling and trigger settings.
|
144
|
+
# @!attribute [rw] type
|
145
|
+
# @return [::Google::Cloud::Dataplex::V1::Task::TriggerSpec::Type]
|
146
|
+
# Required. Immutable. Trigger type of the user-specified Task.
|
147
|
+
# @!attribute [rw] start_time
|
148
|
+
# @return [::Google::Protobuf::Timestamp]
|
149
|
+
# Optional. The first run of the task will be after this time.
|
150
|
+
# If not specified, the task will run shortly after being submitted if
|
151
|
+
# ON_DEMAND and based on the schedule if RECURRING.
|
152
|
+
# @!attribute [rw] disabled
|
153
|
+
# @return [::Boolean]
|
154
|
+
# Optional. Prevent the task from executing.
|
155
|
+
# This does not cancel already running tasks. It is intended to temporarily
|
156
|
+
# disable RECURRING tasks.
|
157
|
+
# @!attribute [rw] max_retries
|
158
|
+
# @return [::Integer]
|
159
|
+
# Optional. Number of retry attempts before aborting.
|
160
|
+
# Set to zero to never attempt to retry a failed task.
|
161
|
+
# @!attribute [rw] schedule
|
162
|
+
# @return [::String]
|
163
|
+
# Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running
|
164
|
+
# tasks periodically.
|
165
|
+
# To explicitly set a timezone to the cron tab, apply a prefix in the
|
166
|
+
# cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or "TZ=$\\{IANA_TIME_ZONE}".
|
167
|
+
# The $\\{IANA_TIME_ZONE} may only be a valid string from IANA time zone
|
168
|
+
# database. For example, "CRON_TZ=America/New_York 1 * * * *", or
|
169
|
+
# "TZ=America/New_York 1 * * * *".
|
170
|
+
# This field is required for RECURRING tasks.
|
171
|
+
class TriggerSpec
|
172
|
+
include ::Google::Protobuf::MessageExts
|
173
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
174
|
+
|
175
|
+
# Determines how often and when the job will run.
|
176
|
+
module Type
|
177
|
+
# Unspecified trigger type.
|
178
|
+
TYPE_UNSPECIFIED = 0
|
179
|
+
|
180
|
+
# The task runs one-time shortly after Task Creation.
|
181
|
+
ON_DEMAND = 1
|
182
|
+
|
183
|
+
# The task is scheduled to run periodically.
|
184
|
+
RECURRING = 2
|
185
|
+
end
|
186
|
+
end
|
187
|
+
|
188
|
+
# Execution related settings, like retry and service_account.
|
189
|
+
# @!attribute [rw] args
|
190
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
191
|
+
# Optional. The arguments to pass to the task.
|
192
|
+
# The args can use placeholders of the format $\\{placeholder} as
|
193
|
+
# part of key/value string. These will be interpolated before passing the
|
194
|
+
# args to the driver. Currently supported placeholders:
|
195
|
+
# - $\\{task_id}
|
196
|
+
# - $\\{job_time}
|
197
|
+
# To pass positional args, set the key as TASK_ARGS. The value should be a
|
198
|
+
# comma-separated string of all the positional arguments. To use a
|
199
|
+
# delimiter other than comma, refer to
|
200
|
+
# https://cloud.google.com/sdk/gcloud/reference/topic/escaping. In case of
|
201
|
+
# other keys being present in the args, then TASK_ARGS will be passed as
|
202
|
+
# the last argument.
|
203
|
+
# @!attribute [rw] service_account
|
204
|
+
# @return [::String]
|
205
|
+
# Required. Service account to use to execute a task.
|
206
|
+
# If not provided, the default Compute service account for the project is
|
207
|
+
# used.
|
208
|
+
# @!attribute [rw] max_job_execution_lifetime
|
209
|
+
# @return [::Google::Protobuf::Duration]
|
210
|
+
# Optional. The maximum duration after which the job execution is expired.
|
211
|
+
class ExecutionSpec
|
212
|
+
include ::Google::Protobuf::MessageExts
|
213
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
214
|
+
|
215
|
+
# @!attribute [rw] key
|
216
|
+
# @return [::String]
|
217
|
+
# @!attribute [rw] value
|
218
|
+
# @return [::String]
|
219
|
+
class ArgsEntry
|
220
|
+
include ::Google::Protobuf::MessageExts
|
221
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
222
|
+
end
|
223
|
+
end
|
224
|
+
|
225
|
+
# User-specified config for running a Spark task.
|
226
|
+
# @!attribute [rw] main_jar_file_uri
|
227
|
+
# @return [::String]
|
228
|
+
# The Cloud Storage URI of the jar file that contains the main class.
|
229
|
+
# The execution args are passed in as a sequence of named process
|
230
|
+
# arguments (`--key=value`).
|
231
|
+
# @!attribute [rw] main_class
|
232
|
+
# @return [::String]
|
233
|
+
# The name of the driver's main class. The jar file that contains the
|
234
|
+
# class must be in the default CLASSPATH or specified in
|
235
|
+
# `jar_file_uris`.
|
236
|
+
# The execution args are passed in as a sequence of named process
|
237
|
+
# arguments (`--key=value`).
|
238
|
+
# @!attribute [rw] python_script_file
|
239
|
+
# @return [::String]
|
240
|
+
# The Gcloud Storage URI of the main Python file to use as the driver.
|
241
|
+
# Must be a .py file. The execution args are passed in as a sequence of
|
242
|
+
# named process arguments (`--key=value`).
|
243
|
+
# @!attribute [rw] sql_script_file
|
244
|
+
# @return [::String]
|
245
|
+
# A reference to a query file. This can be the Cloud Storage URI of the
|
246
|
+
# query file or it can the path to a SqlScript Content. The execution
|
247
|
+
# args are used to declare a set of script variables
|
248
|
+
# (`set key="value";`).
|
249
|
+
# @!attribute [rw] sql_script
|
250
|
+
# @return [::String]
|
251
|
+
# The query text.
|
252
|
+
# The execution args are used to declare a set of script variables
|
253
|
+
# (`set key="value";`).
|
254
|
+
# @!attribute [rw] file_uris
|
255
|
+
# @return [::Array<::String>]
|
256
|
+
# Optional. Cloud Storage URIs of files to be placed in the working directory of each
|
257
|
+
# executor.
|
258
|
+
# @!attribute [rw] archive_uris
|
259
|
+
# @return [::Array<::String>]
|
260
|
+
# Optional. Cloud Storage URIs of archives to be extracted into the working directory
|
261
|
+
# of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and
|
262
|
+
# .zip.
|
263
|
+
# @!attribute [rw] infrastructure_spec
|
264
|
+
# @return [::Google::Cloud::Dataplex::V1::Task::InfrastructureSpec]
|
265
|
+
# Optional. Infrastructure specification for the execution.
|
266
|
+
class SparkTaskConfig
|
267
|
+
include ::Google::Protobuf::MessageExts
|
268
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
269
|
+
end
|
270
|
+
|
271
|
+
# @!attribute [rw] key
|
272
|
+
# @return [::String]
|
273
|
+
# @!attribute [rw] value
|
274
|
+
# @return [::String]
|
275
|
+
class LabelsEntry
|
276
|
+
include ::Google::Protobuf::MessageExts
|
277
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
278
|
+
end
|
279
|
+
end
|
280
|
+
|
281
|
+
# A job represents an instance of a task.
|
282
|
+
# @!attribute [r] name
|
283
|
+
# @return [::String]
|
284
|
+
# Output only. The relative resource name of the job, of the form:
|
285
|
+
# `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}`.
|
286
|
+
# @!attribute [r] uid
|
287
|
+
# @return [::String]
|
288
|
+
# Output only. System generated globally unique ID for the job.
|
289
|
+
# @!attribute [r] start_time
|
290
|
+
# @return [::Google::Protobuf::Timestamp]
|
291
|
+
# Output only. The time when the job was started.
|
292
|
+
# @!attribute [r] end_time
|
293
|
+
# @return [::Google::Protobuf::Timestamp]
|
294
|
+
# Output only. The time when the job ended.
|
295
|
+
# @!attribute [r] state
|
296
|
+
# @return [::Google::Cloud::Dataplex::V1::Job::State]
|
297
|
+
# Output only. Execution state for the job.
|
298
|
+
# @!attribute [r] retry_count
|
299
|
+
# @return [::Integer]
|
300
|
+
# Output only. The number of times the job has been retried (excluding the
|
301
|
+
# initial attempt).
|
302
|
+
# @!attribute [r] service
|
303
|
+
# @return [::Google::Cloud::Dataplex::V1::Job::Service]
|
304
|
+
# Output only. The underlying service running a job.
|
305
|
+
# @!attribute [r] service_job
|
306
|
+
# @return [::String]
|
307
|
+
# Output only. The full resource name for the job run under a particular service.
|
308
|
+
# @!attribute [r] message
|
309
|
+
# @return [::String]
|
310
|
+
# Output only. Additional information about the current state.
|
311
|
+
class Job
|
312
|
+
include ::Google::Protobuf::MessageExts
|
313
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
314
|
+
|
315
|
+
module Service
|
316
|
+
# Service used to run the job is unspecified.
|
317
|
+
SERVICE_UNSPECIFIED = 0
|
318
|
+
|
319
|
+
# Dataproc service is used to run this job.
|
320
|
+
DATAPROC = 1
|
321
|
+
end
|
322
|
+
|
323
|
+
module State
|
324
|
+
# The job state is unknown.
|
325
|
+
STATE_UNSPECIFIED = 0
|
326
|
+
|
327
|
+
# The job is running.
|
328
|
+
RUNNING = 1
|
329
|
+
|
330
|
+
# The job is cancelling.
|
331
|
+
CANCELLING = 2
|
332
|
+
|
333
|
+
# The job cancellation was successful.
|
334
|
+
CANCELLED = 3
|
335
|
+
|
336
|
+
# The job completed successfully.
|
337
|
+
SUCCEEDED = 4
|
338
|
+
|
339
|
+
# The job is no longer running due to an error.
|
340
|
+
FAILED = 5
|
341
|
+
|
342
|
+
# The job was cancelled outside of Dataplex.
|
343
|
+
ABORTED = 6
|
344
|
+
end
|
345
|
+
end
|
346
|
+
end
|
347
|
+
end
|
348
|
+
end
|
349
|
+
end
|
@@ -0,0 +1,164 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Longrunning
|
22
|
+
# This resource represents a long-running operation that is the result of a
|
23
|
+
# network API call.
|
24
|
+
# @!attribute [rw] name
|
25
|
+
# @return [::String]
|
26
|
+
# The server-assigned name, which is only unique within the same service that
|
27
|
+
# originally returns it. If you use the default HTTP mapping, the
|
28
|
+
# `name` should be a resource name ending with `operations/{unique_id}`.
|
29
|
+
# @!attribute [rw] metadata
|
30
|
+
# @return [::Google::Protobuf::Any]
|
31
|
+
# Service-specific metadata associated with the operation. It typically
|
32
|
+
# contains progress information and common metadata such as create time.
|
33
|
+
# Some services might not provide such metadata. Any method that returns a
|
34
|
+
# long-running operation should document the metadata type, if any.
|
35
|
+
# @!attribute [rw] done
|
36
|
+
# @return [::Boolean]
|
37
|
+
# If the value is `false`, it means the operation is still in progress.
|
38
|
+
# If `true`, the operation is completed, and either `error` or `response` is
|
39
|
+
# available.
|
40
|
+
# @!attribute [rw] error
|
41
|
+
# @return [::Google::Rpc::Status]
|
42
|
+
# The error result of the operation in case of failure or cancellation.
|
43
|
+
# @!attribute [rw] response
|
44
|
+
# @return [::Google::Protobuf::Any]
|
45
|
+
# The normal response of the operation in case of success. If the original
|
46
|
+
# method returns no data on success, such as `Delete`, the response is
|
47
|
+
# `google.protobuf.Empty`. If the original method is standard
|
48
|
+
# `Get`/`Create`/`Update`, the response should be the resource. For other
|
49
|
+
# methods, the response should have the type `XxxResponse`, where `Xxx`
|
50
|
+
# is the original method name. For example, if the original method name
|
51
|
+
# is `TakeSnapshot()`, the inferred response type is
|
52
|
+
# `TakeSnapshotResponse`.
|
53
|
+
class Operation
|
54
|
+
include ::Google::Protobuf::MessageExts
|
55
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
56
|
+
end
|
57
|
+
|
58
|
+
# The request message for Operations.GetOperation.
|
59
|
+
# @!attribute [rw] name
|
60
|
+
# @return [::String]
|
61
|
+
# The name of the operation resource.
|
62
|
+
class GetOperationRequest
|
63
|
+
include ::Google::Protobuf::MessageExts
|
64
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
65
|
+
end
|
66
|
+
|
67
|
+
# The request message for Operations.ListOperations.
|
68
|
+
# @!attribute [rw] name
|
69
|
+
# @return [::String]
|
70
|
+
# The name of the operation's parent resource.
|
71
|
+
# @!attribute [rw] filter
|
72
|
+
# @return [::String]
|
73
|
+
# The standard list filter.
|
74
|
+
# @!attribute [rw] page_size
|
75
|
+
# @return [::Integer]
|
76
|
+
# The standard list page size.
|
77
|
+
# @!attribute [rw] page_token
|
78
|
+
# @return [::String]
|
79
|
+
# The standard list page token.
|
80
|
+
class ListOperationsRequest
|
81
|
+
include ::Google::Protobuf::MessageExts
|
82
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
83
|
+
end
|
84
|
+
|
85
|
+
# The response message for Operations.ListOperations.
|
86
|
+
# @!attribute [rw] operations
|
87
|
+
# @return [::Array<::Google::Longrunning::Operation>]
|
88
|
+
# A list of operations that matches the specified filter in the request.
|
89
|
+
# @!attribute [rw] next_page_token
|
90
|
+
# @return [::String]
|
91
|
+
# The standard List next-page token.
|
92
|
+
class ListOperationsResponse
|
93
|
+
include ::Google::Protobuf::MessageExts
|
94
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
95
|
+
end
|
96
|
+
|
97
|
+
# The request message for Operations.CancelOperation.
|
98
|
+
# @!attribute [rw] name
|
99
|
+
# @return [::String]
|
100
|
+
# The name of the operation resource to be cancelled.
|
101
|
+
class CancelOperationRequest
|
102
|
+
include ::Google::Protobuf::MessageExts
|
103
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
104
|
+
end
|
105
|
+
|
106
|
+
# The request message for Operations.DeleteOperation.
|
107
|
+
# @!attribute [rw] name
|
108
|
+
# @return [::String]
|
109
|
+
# The name of the operation resource to be deleted.
|
110
|
+
class DeleteOperationRequest
|
111
|
+
include ::Google::Protobuf::MessageExts
|
112
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
113
|
+
end
|
114
|
+
|
115
|
+
# The request message for Operations.WaitOperation.
|
116
|
+
# @!attribute [rw] name
|
117
|
+
# @return [::String]
|
118
|
+
# The name of the operation resource to wait on.
|
119
|
+
# @!attribute [rw] timeout
|
120
|
+
# @return [::Google::Protobuf::Duration]
|
121
|
+
# The maximum duration to wait before timing out. If left blank, the wait
|
122
|
+
# will be at most the time permitted by the underlying HTTP/RPC protocol.
|
123
|
+
# If RPC context deadline is also specified, the shorter one will be used.
|
124
|
+
class WaitOperationRequest
|
125
|
+
include ::Google::Protobuf::MessageExts
|
126
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
127
|
+
end
|
128
|
+
|
129
|
+
# A message representing the message types used by a long-running operation.
|
130
|
+
#
|
131
|
+
# Example:
|
132
|
+
#
|
133
|
+
# rpc LongRunningRecognize(LongRunningRecognizeRequest)
|
134
|
+
# returns (google.longrunning.Operation) {
|
135
|
+
# option (google.longrunning.operation_info) = {
|
136
|
+
# response_type: "LongRunningRecognizeResponse"
|
137
|
+
# metadata_type: "LongRunningRecognizeMetadata"
|
138
|
+
# };
|
139
|
+
# }
|
140
|
+
# @!attribute [rw] response_type
|
141
|
+
# @return [::String]
|
142
|
+
# Required. The message name of the primary return type for this
|
143
|
+
# long-running operation.
|
144
|
+
# This type will be used to deserialize the LRO's response.
|
145
|
+
#
|
146
|
+
# If the response is in a different package from the rpc, a fully-qualified
|
147
|
+
# message name must be used (e.g. `google.protobuf.Struct`).
|
148
|
+
#
|
149
|
+
# Note: Altering this value constitutes a breaking change.
|
150
|
+
# @!attribute [rw] metadata_type
|
151
|
+
# @return [::String]
|
152
|
+
# Required. The message name of the metadata type for this long-running
|
153
|
+
# operation.
|
154
|
+
#
|
155
|
+
# If the response is in a different package from the rpc, a fully-qualified
|
156
|
+
# message name must be used (e.g. `google.protobuf.Struct`).
|
157
|
+
#
|
158
|
+
# Note: Altering this value constitutes a breaking change.
|
159
|
+
class OperationInfo
|
160
|
+
include ::Google::Protobuf::MessageExts
|
161
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
162
|
+
end
|
163
|
+
end
|
164
|
+
end
|
@@ -0,0 +1,141 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Protobuf
|
22
|
+
# `Any` contains an arbitrary serialized protocol buffer message along with a
|
23
|
+
# URL that describes the type of the serialized message.
|
24
|
+
#
|
25
|
+
# Protobuf library provides support to pack/unpack Any values in the form
|
26
|
+
# of utility functions or additional generated methods of the Any type.
|
27
|
+
#
|
28
|
+
# Example 1: Pack and unpack a message in C++.
|
29
|
+
#
|
30
|
+
# Foo foo = ...;
|
31
|
+
# Any any;
|
32
|
+
# any.PackFrom(foo);
|
33
|
+
# ...
|
34
|
+
# if (any.UnpackTo(&foo)) {
|
35
|
+
# ...
|
36
|
+
# }
|
37
|
+
#
|
38
|
+
# Example 2: Pack and unpack a message in Java.
|
39
|
+
#
|
40
|
+
# Foo foo = ...;
|
41
|
+
# Any any = Any.pack(foo);
|
42
|
+
# ...
|
43
|
+
# if (any.is(Foo.class)) {
|
44
|
+
# foo = any.unpack(Foo.class);
|
45
|
+
# }
|
46
|
+
#
|
47
|
+
# Example 3: Pack and unpack a message in Python.
|
48
|
+
#
|
49
|
+
# foo = Foo(...)
|
50
|
+
# any = Any()
|
51
|
+
# any.Pack(foo)
|
52
|
+
# ...
|
53
|
+
# if any.Is(Foo.DESCRIPTOR):
|
54
|
+
# any.Unpack(foo)
|
55
|
+
# ...
|
56
|
+
#
|
57
|
+
# Example 4: Pack and unpack a message in Go
|
58
|
+
#
|
59
|
+
# foo := &pb.Foo{...}
|
60
|
+
# any, err := anypb.New(foo)
|
61
|
+
# if err != nil {
|
62
|
+
# ...
|
63
|
+
# }
|
64
|
+
# ...
|
65
|
+
# foo := &pb.Foo{}
|
66
|
+
# if err := any.UnmarshalTo(foo); err != nil {
|
67
|
+
# ...
|
68
|
+
# }
|
69
|
+
#
|
70
|
+
# The pack methods provided by protobuf library will by default use
|
71
|
+
# 'type.googleapis.com/full.type.name' as the type URL and the unpack
|
72
|
+
# methods only use the fully qualified type name after the last '/'
|
73
|
+
# in the type URL, for example "foo.bar.com/x/y.z" will yield type
|
74
|
+
# name "y.z".
|
75
|
+
#
|
76
|
+
#
|
77
|
+
# JSON
|
78
|
+
# ====
|
79
|
+
# The JSON representation of an `Any` value uses the regular
|
80
|
+
# representation of the deserialized, embedded message, with an
|
81
|
+
# additional field `@type` which contains the type URL. Example:
|
82
|
+
#
|
83
|
+
# package google.profile;
|
84
|
+
# message Person {
|
85
|
+
# string first_name = 1;
|
86
|
+
# string last_name = 2;
|
87
|
+
# }
|
88
|
+
#
|
89
|
+
# {
|
90
|
+
# "@type": "type.googleapis.com/google.profile.Person",
|
91
|
+
# "firstName": <string>,
|
92
|
+
# "lastName": <string>
|
93
|
+
# }
|
94
|
+
#
|
95
|
+
# If the embedded message type is well-known and has a custom JSON
|
96
|
+
# representation, that representation will be embedded adding a field
|
97
|
+
# `value` which holds the custom JSON in addition to the `@type`
|
98
|
+
# field. Example (for message [google.protobuf.Duration][]):
|
99
|
+
#
|
100
|
+
# {
|
101
|
+
# "@type": "type.googleapis.com/google.protobuf.Duration",
|
102
|
+
# "value": "1.212s"
|
103
|
+
# }
|
104
|
+
# @!attribute [rw] type_url
|
105
|
+
# @return [::String]
|
106
|
+
# A URL/resource name that uniquely identifies the type of the serialized
|
107
|
+
# protocol buffer message. This string must contain at least
|
108
|
+
# one "/" character. The last segment of the URL's path must represent
|
109
|
+
# the fully qualified name of the type (as in
|
110
|
+
# `path/google.protobuf.Duration`). The name should be in a canonical form
|
111
|
+
# (e.g., leading "." is not accepted).
|
112
|
+
#
|
113
|
+
# In practice, teams usually precompile into the binary all types that they
|
114
|
+
# expect it to use in the context of Any. However, for URLs which use the
|
115
|
+
# scheme `http`, `https`, or no scheme, one can optionally set up a type
|
116
|
+
# server that maps type URLs to message definitions as follows:
|
117
|
+
#
|
118
|
+
# * If no scheme is provided, `https` is assumed.
|
119
|
+
# * An HTTP GET on the URL must yield a [google.protobuf.Type][]
|
120
|
+
# value in binary format, or produce an error.
|
121
|
+
# * Applications are allowed to cache lookup results based on the
|
122
|
+
# URL, or have them precompiled into a binary to avoid any
|
123
|
+
# lookup. Therefore, binary compatibility needs to be preserved
|
124
|
+
# on changes to types. (Use versioned type names to manage
|
125
|
+
# breaking changes.)
|
126
|
+
#
|
127
|
+
# Note: this functionality is not currently available in the official
|
128
|
+
# protobuf release, and it is not used for type URLs beginning with
|
129
|
+
# type.googleapis.com.
|
130
|
+
#
|
131
|
+
# Schemes other than `http`, `https` (or the empty scheme) might be
|
132
|
+
# used with implementation specific semantics.
|
133
|
+
# @!attribute [rw] value
|
134
|
+
# @return [::String]
|
135
|
+
# Must be a valid serialized protocol buffer of the above specified type.
|
136
|
+
class Any
|
137
|
+
include ::Google::Protobuf::MessageExts
|
138
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
139
|
+
end
|
140
|
+
end
|
141
|
+
end
|