google-cloud-gke_hub-v1 0.1.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 (35) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +169 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +139 -0
  6. data/lib/google/cloud/gke_hub/v1/gke_hub/client.rb +1388 -0
  7. data/lib/google/cloud/gke_hub/v1/gke_hub/credentials.rb +51 -0
  8. data/lib/google/cloud/gke_hub/v1/gke_hub/operations.rb +664 -0
  9. data/lib/google/cloud/gke_hub/v1/gke_hub/paths.rb +88 -0
  10. data/lib/google/cloud/gke_hub/v1/gke_hub.rb +63 -0
  11. data/lib/google/cloud/gke_hub/v1/version.rb +28 -0
  12. data/lib/google/cloud/gke_hub/v1.rb +38 -0
  13. data/lib/google/cloud/gkehub/v1/configmanagement/configmanagement_pb.rb +179 -0
  14. data/lib/google/cloud/gkehub/v1/feature_pb.rb +86 -0
  15. data/lib/google/cloud/gkehub/v1/membership_pb.rb +77 -0
  16. data/lib/google/cloud/gkehub/v1/multiclusteringress/multiclusteringress_pb.rb +25 -0
  17. data/lib/google/cloud/gkehub/v1/service_pb.rb +135 -0
  18. data/lib/google/cloud/gkehub/v1/service_services_pb.rb +89 -0
  19. data/lib/google-cloud-gke_hub-v1.rb +21 -0
  20. data/proto_docs/README.md +4 -0
  21. data/proto_docs/google/api/field_behavior.rb +71 -0
  22. data/proto_docs/google/api/resource.rb +283 -0
  23. data/proto_docs/google/cloud/gkehub/v1/configmanagement/configmanagement.rb +446 -0
  24. data/proto_docs/google/cloud/gkehub/v1/feature.rb +230 -0
  25. data/proto_docs/google/cloud/gkehub/v1/membership.rb +229 -0
  26. data/proto_docs/google/cloud/gkehub/v1/multiclusteringress/multiclusteringress.rb +39 -0
  27. data/proto_docs/google/cloud/gkehub/v1/service.rb +473 -0
  28. data/proto_docs/google/longrunning/operations.rb +164 -0
  29. data/proto_docs/google/protobuf/any.rb +141 -0
  30. data/proto_docs/google/protobuf/duration.rb +98 -0
  31. data/proto_docs/google/protobuf/empty.rb +36 -0
  32. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  33. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  34. data/proto_docs/google/rpc/status.rb +46 -0
  35. metadata +225 -0
@@ -0,0 +1,473 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 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 GkeHub
23
+ module V1
24
+ # Request message for `GkeHub.ListMemberships` method.
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. The parent (project and location) where the Memberships will be listed.
28
+ # Specified in the format `projects/*/locations/*`.
29
+ # @!attribute [rw] page_size
30
+ # @return [::Integer]
31
+ # Optional. When requesting a 'page' of resources, `page_size` specifies number of
32
+ # resources to return. If unspecified or set to 0, all resources will
33
+ # be returned.
34
+ # @!attribute [rw] page_token
35
+ # @return [::String]
36
+ # Optional. Token returned by previous call to `ListMemberships` which
37
+ # specifies the position in the list from where to continue listing the
38
+ # resources.
39
+ # @!attribute [rw] filter
40
+ # @return [::String]
41
+ # Optional. Lists Memberships that match the filter expression, following the syntax
42
+ # outlined in https://google.aip.dev/160.
43
+ #
44
+ # Examples:
45
+ #
46
+ # - Name is `bar` in project `foo-proj` and location `global`:
47
+ #
48
+ # name = "projects/foo-proj/locations/global/membership/bar"
49
+ #
50
+ # - Memberships that have a label called `foo`:
51
+ #
52
+ # labels.foo:*
53
+ #
54
+ # - Memberships that have a label called `foo` whose value is `bar`:
55
+ #
56
+ # labels.foo = bar
57
+ #
58
+ # - Memberships in the CREATING state:
59
+ #
60
+ # state = CREATING
61
+ # @!attribute [rw] order_by
62
+ # @return [::String]
63
+ # Optional. One or more fields to compare and use to sort the output.
64
+ # See https://google.aip.dev/132#ordering.
65
+ class ListMembershipsRequest
66
+ include ::Google::Protobuf::MessageExts
67
+ extend ::Google::Protobuf::MessageExts::ClassMethods
68
+ end
69
+
70
+ # Response message for the `GkeHub.ListMemberships` method.
71
+ # @!attribute [rw] resources
72
+ # @return [::Array<::Google::Cloud::GkeHub::V1::Membership>]
73
+ # The list of matching Memberships.
74
+ # @!attribute [rw] next_page_token
75
+ # @return [::String]
76
+ # A token to request the next page of resources from the
77
+ # `ListMemberships` method. The value of an empty string means that
78
+ # there are no more resources to return.
79
+ # @!attribute [rw] unreachable
80
+ # @return [::Array<::String>]
81
+ # List of locations that could not be reached while fetching this list.
82
+ class ListMembershipsResponse
83
+ include ::Google::Protobuf::MessageExts
84
+ extend ::Google::Protobuf::MessageExts::ClassMethods
85
+ end
86
+
87
+ # Request message for `GkeHub.GetMembership` method.
88
+ # @!attribute [rw] name
89
+ # @return [::String]
90
+ # Required. The Membership resource name in the format
91
+ # `projects/*/locations/*/memberships/*`.
92
+ class GetMembershipRequest
93
+ include ::Google::Protobuf::MessageExts
94
+ extend ::Google::Protobuf::MessageExts::ClassMethods
95
+ end
96
+
97
+ # Request message for the `GkeHub.CreateMembership` method.
98
+ # @!attribute [rw] parent
99
+ # @return [::String]
100
+ # Required. The parent (project and location) where the Memberships will be created.
101
+ # Specified in the format `projects/*/locations/*`.
102
+ # @!attribute [rw] membership_id
103
+ # @return [::String]
104
+ # Required. Client chosen ID for the membership. `membership_id` must be a valid RFC
105
+ # 1123 compliant DNS label:
106
+ #
107
+ # 1. At most 63 characters in length
108
+ # 2. It must consist of lower case alphanumeric characters or `-`
109
+ # 3. It must start and end with an alphanumeric character
110
+ #
111
+ # Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`,
112
+ # with a maximum length of 63 characters.
113
+ # @!attribute [rw] resource
114
+ # @return [::Google::Cloud::GkeHub::V1::Membership]
115
+ # Required. The membership to create.
116
+ # @!attribute [rw] request_id
117
+ # @return [::String]
118
+ # Optional. A request ID to identify requests. Specify a unique request ID
119
+ # so that if you must retry your request, the server will know to ignore
120
+ # the request if it has already been completed. The server will guarantee
121
+ # that for at least 60 minutes after the first request.
122
+ #
123
+ # For example, consider a situation where you make an initial request and
124
+ # the request times out. If you make the request again with the same request
125
+ # ID, the server can check if original operation with the same request ID
126
+ # was received, and if so, will ignore the second request. This prevents
127
+ # clients from accidentally creating duplicate commitments.
128
+ #
129
+ # The request ID must be a valid UUID with the exception that zero UUID is
130
+ # not supported (00000000-0000-0000-0000-000000000000).
131
+ class CreateMembershipRequest
132
+ include ::Google::Protobuf::MessageExts
133
+ extend ::Google::Protobuf::MessageExts::ClassMethods
134
+ end
135
+
136
+ # Request message for `GkeHub.DeleteMembership` method.
137
+ # @!attribute [rw] name
138
+ # @return [::String]
139
+ # Required. The Membership resource name in the format
140
+ # `projects/*/locations/*/memberships/*`.
141
+ # @!attribute [rw] request_id
142
+ # @return [::String]
143
+ # Optional. A request ID to identify requests. Specify a unique request ID
144
+ # so that if you must retry your request, the server will know to ignore
145
+ # the request if it has already been completed. The server will guarantee
146
+ # that for at least 60 minutes after the first request.
147
+ #
148
+ # For example, consider a situation where you make an initial request and
149
+ # the request times out. If you make the request again with the same request
150
+ # ID, the server can check if original operation with the same request ID
151
+ # was received, and if so, will ignore the second request. This prevents
152
+ # clients from accidentally creating duplicate commitments.
153
+ #
154
+ # The request ID must be a valid UUID with the exception that zero UUID is
155
+ # not supported (00000000-0000-0000-0000-000000000000).
156
+ class DeleteMembershipRequest
157
+ include ::Google::Protobuf::MessageExts
158
+ extend ::Google::Protobuf::MessageExts::ClassMethods
159
+ end
160
+
161
+ # Request message for `GkeHub.UpdateMembership` method.
162
+ # @!attribute [rw] name
163
+ # @return [::String]
164
+ # Required. The Membership resource name in the format
165
+ # `projects/*/locations/*/memberships/*`.
166
+ # @!attribute [rw] update_mask
167
+ # @return [::Google::Protobuf::FieldMask]
168
+ # Required. Mask of fields to update.
169
+ # @!attribute [rw] resource
170
+ # @return [::Google::Cloud::GkeHub::V1::Membership]
171
+ # Required. Only fields specified in update_mask are updated.
172
+ # If you specify a field in the update_mask but don't specify its value here
173
+ # that field will be deleted.
174
+ # If you are updating a map field, set the value of a key to null or empty
175
+ # string to delete the key from the map. It's not possible to update a key's
176
+ # value to the empty string.
177
+ # If you specify the update_mask to be a special path "*", fully replaces all
178
+ # user-modifiable fields to match `resource`.
179
+ # @!attribute [rw] request_id
180
+ # @return [::String]
181
+ # Optional. A request ID to identify requests. Specify a unique request ID
182
+ # so that if you must retry your request, the server will know to ignore
183
+ # the request if it has already been completed. The server will guarantee
184
+ # that for at least 60 minutes after the first request.
185
+ #
186
+ # For example, consider a situation where you make an initial request and
187
+ # the request times out. If you make the request again with the same request
188
+ # ID, the server can check if original operation with the same request ID
189
+ # was received, and if so, will ignore the second request. This prevents
190
+ # clients from accidentally creating duplicate commitments.
191
+ #
192
+ # The request ID must be a valid UUID with the exception that zero UUID is
193
+ # not supported (00000000-0000-0000-0000-000000000000).
194
+ class UpdateMembershipRequest
195
+ include ::Google::Protobuf::MessageExts
196
+ extend ::Google::Protobuf::MessageExts::ClassMethods
197
+ end
198
+
199
+ # Request message for `GkeHub.GenerateConnectManifest`
200
+ # method.
201
+ # .
202
+ # @!attribute [rw] name
203
+ # @return [::String]
204
+ # Required. The Membership resource name the Agent will associate with, in the format
205
+ # `projects/*/locations/*/memberships/*`.
206
+ # @!attribute [rw] namespace
207
+ # @return [::String]
208
+ # Optional. Namespace for GKE Connect agent resources. Defaults to `gke-connect`.
209
+ #
210
+ # The Connect Agent is authorized automatically when run in the default
211
+ # namespace. Otherwise, explicit authorization must be granted with an
212
+ # additional IAM binding.
213
+ # @!attribute [rw] proxy
214
+ # @return [::String]
215
+ # Optional. URI of a proxy if connectivity from the agent to gkeconnect.googleapis.com
216
+ # requires the use of a proxy. Format must be in the form
217
+ # `http(s)://{proxy_address}`, depending on the HTTP/HTTPS protocol
218
+ # supported by the proxy. This will direct the connect agent's outbound
219
+ # traffic through a HTTP(S) proxy.
220
+ # @!attribute [rw] version
221
+ # @return [::String]
222
+ # Optional. The Connect agent version to use. Defaults to the most current version.
223
+ # @!attribute [rw] is_upgrade
224
+ # @return [::Boolean]
225
+ # Optional. If true, generate the resources for upgrade only. Some resources
226
+ # generated only for installation (e.g. secrets) will be excluded.
227
+ # @!attribute [rw] registry
228
+ # @return [::String]
229
+ # Optional. The registry to fetch the connect agent image from. Defaults to
230
+ # gcr.io/gkeconnect.
231
+ # @!attribute [rw] image_pull_secret_content
232
+ # @return [::String]
233
+ # Optional. The image pull secret content for the registry, if not public.
234
+ class GenerateConnectManifestRequest
235
+ include ::Google::Protobuf::MessageExts
236
+ extend ::Google::Protobuf::MessageExts::ClassMethods
237
+ end
238
+
239
+ # GenerateConnectManifestResponse contains manifest information for
240
+ # installing/upgrading a Connect agent.
241
+ # @!attribute [rw] manifest
242
+ # @return [::Array<::Google::Cloud::GkeHub::V1::ConnectAgentResource>]
243
+ # The ordered list of Kubernetes resources that need to be applied to the
244
+ # cluster for GKE Connect agent installation/upgrade.
245
+ class GenerateConnectManifestResponse
246
+ include ::Google::Protobuf::MessageExts
247
+ extend ::Google::Protobuf::MessageExts::ClassMethods
248
+ end
249
+
250
+ # ConnectAgentResource represents a Kubernetes resource manifest for Connect
251
+ # Agent deployment.
252
+ # @!attribute [rw] type
253
+ # @return [::Google::Cloud::GkeHub::V1::TypeMeta]
254
+ # Kubernetes type of the resource.
255
+ # @!attribute [rw] manifest
256
+ # @return [::String]
257
+ # YAML manifest of the resource.
258
+ class ConnectAgentResource
259
+ include ::Google::Protobuf::MessageExts
260
+ extend ::Google::Protobuf::MessageExts::ClassMethods
261
+ end
262
+
263
+ # TypeMeta is the type information needed for content unmarshalling of
264
+ # Kubernetes resources in the manifest.
265
+ # @!attribute [rw] kind
266
+ # @return [::String]
267
+ # Kind of the resource (e.g. Deployment).
268
+ # @!attribute [rw] api_version
269
+ # @return [::String]
270
+ # APIVersion of the resource (e.g. v1).
271
+ class TypeMeta
272
+ include ::Google::Protobuf::MessageExts
273
+ extend ::Google::Protobuf::MessageExts::ClassMethods
274
+ end
275
+
276
+ # Request message for `GkeHub.ListFeatures` method.
277
+ # @!attribute [rw] parent
278
+ # @return [::String]
279
+ # The parent (project and location) where the Features will be listed.
280
+ # Specified in the format `projects/*/locations/*`.
281
+ # @!attribute [rw] page_size
282
+ # @return [::Integer]
283
+ # When requesting a 'page' of resources, `page_size` specifies number of
284
+ # resources to return. If unspecified or set to 0, all resources will
285
+ # be returned.
286
+ # @!attribute [rw] page_token
287
+ # @return [::String]
288
+ # Token returned by previous call to `ListFeatures` which
289
+ # specifies the position in the list from where to continue listing the
290
+ # resources.
291
+ # @!attribute [rw] filter
292
+ # @return [::String]
293
+ # Lists Features that match the filter expression, following the syntax
294
+ # outlined in https://google.aip.dev/160.
295
+ #
296
+ # Examples:
297
+ #
298
+ # - Feature with the name "servicemesh" in project "foo-proj":
299
+ #
300
+ # name = "projects/foo-proj/locations/global/features/servicemesh"
301
+ #
302
+ # - Features that have a label called `foo`:
303
+ #
304
+ # labels.foo:*
305
+ #
306
+ # - Features that have a label called `foo` whose value is `bar`:
307
+ #
308
+ # labels.foo = bar
309
+ # @!attribute [rw] order_by
310
+ # @return [::String]
311
+ # One or more fields to compare and use to sort the output.
312
+ # See https://google.aip.dev/132#ordering.
313
+ class ListFeaturesRequest
314
+ include ::Google::Protobuf::MessageExts
315
+ extend ::Google::Protobuf::MessageExts::ClassMethods
316
+ end
317
+
318
+ # Response message for the `GkeHub.ListFeatures` method.
319
+ # @!attribute [rw] resources
320
+ # @return [::Array<::Google::Cloud::GkeHub::V1::Feature>]
321
+ # The list of matching Features
322
+ # @!attribute [rw] next_page_token
323
+ # @return [::String]
324
+ # A token to request the next page of resources from the
325
+ # `ListFeatures` method. The value of an empty string means
326
+ # that there are no more resources to return.
327
+ class ListFeaturesResponse
328
+ include ::Google::Protobuf::MessageExts
329
+ extend ::Google::Protobuf::MessageExts::ClassMethods
330
+ end
331
+
332
+ # Request message for `GkeHub.GetFeature` method.
333
+ # @!attribute [rw] name
334
+ # @return [::String]
335
+ # The Feature resource name in the format
336
+ # `projects/*/locations/*/features/*`
337
+ class GetFeatureRequest
338
+ include ::Google::Protobuf::MessageExts
339
+ extend ::Google::Protobuf::MessageExts::ClassMethods
340
+ end
341
+
342
+ # Request message for the `GkeHub.CreateFeature` method.
343
+ # @!attribute [rw] parent
344
+ # @return [::String]
345
+ # The parent (project and location) where the Feature will be created.
346
+ # Specified in the format `projects/*/locations/*`.
347
+ # @!attribute [rw] feature_id
348
+ # @return [::String]
349
+ # The ID of the feature to create.
350
+ # @!attribute [rw] resource
351
+ # @return [::Google::Cloud::GkeHub::V1::Feature]
352
+ # The Feature resource to create.
353
+ # @!attribute [rw] request_id
354
+ # @return [::String]
355
+ # Optional. A request ID to identify requests. Specify a unique request ID
356
+ # so that if you must retry your request, the server will know to ignore
357
+ # the request if it has already been completed. The server will guarantee
358
+ # that for at least 60 minutes after the first request.
359
+ #
360
+ # For example, consider a situation where you make an initial request and
361
+ # the request times out. If you make the request again with the same request
362
+ # ID, the server can check if original operation with the same request ID
363
+ # was received, and if so, will ignore the second request. This prevents
364
+ # clients from accidentally creating duplicate commitments.
365
+ #
366
+ # The request ID must be a valid UUID with the exception that zero UUID is
367
+ # not supported (00000000-0000-0000-0000-000000000000).
368
+ class CreateFeatureRequest
369
+ include ::Google::Protobuf::MessageExts
370
+ extend ::Google::Protobuf::MessageExts::ClassMethods
371
+ end
372
+
373
+ # Request message for `GkeHub.DeleteFeature` method.
374
+ # @!attribute [rw] name
375
+ # @return [::String]
376
+ # The Feature resource name in the format
377
+ # `projects/*/locations/*/features/*`.
378
+ # @!attribute [rw] force
379
+ # @return [::Boolean]
380
+ # If set to true, the delete will ignore any outstanding resources for
381
+ # this Feature (that is, `FeatureState.has_resources` is set to true). These
382
+ # resources will NOT be cleaned up or modified in any way.
383
+ # @!attribute [rw] request_id
384
+ # @return [::String]
385
+ # Optional. A request ID to identify requests. Specify a unique request ID
386
+ # so that if you must retry your request, the server will know to ignore
387
+ # the request if it has already been completed. The server will guarantee
388
+ # that for at least 60 minutes after the first request.
389
+ #
390
+ # For example, consider a situation where you make an initial request and
391
+ # the request times out. If you make the request again with the same request
392
+ # ID, the server can check if original operation with the same request ID
393
+ # was received, and if so, will ignore the second request. This prevents
394
+ # clients from accidentally creating duplicate commitments.
395
+ #
396
+ # The request ID must be a valid UUID with the exception that zero UUID is
397
+ # not supported (00000000-0000-0000-0000-000000000000).
398
+ class DeleteFeatureRequest
399
+ include ::Google::Protobuf::MessageExts
400
+ extend ::Google::Protobuf::MessageExts::ClassMethods
401
+ end
402
+
403
+ # Request message for `GkeHub.UpdateFeature` method.
404
+ # @!attribute [rw] name
405
+ # @return [::String]
406
+ # The Feature resource name in the format
407
+ # `projects/*/locations/*/features/*`.
408
+ # @!attribute [rw] update_mask
409
+ # @return [::Google::Protobuf::FieldMask]
410
+ # Mask of fields to update.
411
+ # @!attribute [rw] resource
412
+ # @return [::Google::Cloud::GkeHub::V1::Feature]
413
+ # Only fields specified in update_mask are updated.
414
+ # If you specify a field in the update_mask but don't specify its value here
415
+ # that field will be deleted.
416
+ # If you are updating a map field, set the value of a key to null or empty
417
+ # string to delete the key from the map. It's not possible to update a key's
418
+ # value to the empty string.
419
+ # If you specify the update_mask to be a special path "*", fully replaces all
420
+ # user-modifiable fields to match `resource`.
421
+ # @!attribute [rw] request_id
422
+ # @return [::String]
423
+ # Optional. A request ID to identify requests. Specify a unique request ID
424
+ # so that if you must retry your request, the server will know to ignore
425
+ # the request if it has already been completed. The server will guarantee
426
+ # that for at least 60 minutes after the first request.
427
+ #
428
+ # For example, consider a situation where you make an initial request and
429
+ # the request times out. If you make the request again with the same request
430
+ # ID, the server can check if original operation with the same request ID
431
+ # was received, and if so, will ignore the second request. This prevents
432
+ # clients from accidentally creating duplicate commitments.
433
+ #
434
+ # The request ID must be a valid UUID with the exception that zero UUID is
435
+ # not supported (00000000-0000-0000-0000-000000000000).
436
+ class UpdateFeatureRequest
437
+ include ::Google::Protobuf::MessageExts
438
+ extend ::Google::Protobuf::MessageExts::ClassMethods
439
+ end
440
+
441
+ # Represents the metadata of the long-running operation.
442
+ # @!attribute [r] create_time
443
+ # @return [::Google::Protobuf::Timestamp]
444
+ # Output only. The time the operation was created.
445
+ # @!attribute [r] end_time
446
+ # @return [::Google::Protobuf::Timestamp]
447
+ # Output only. The time the operation finished running.
448
+ # @!attribute [r] target
449
+ # @return [::String]
450
+ # Output only. Server-defined resource path for the target of the operation.
451
+ # @!attribute [r] verb
452
+ # @return [::String]
453
+ # Output only. Name of the verb executed by the operation.
454
+ # @!attribute [r] status_detail
455
+ # @return [::String]
456
+ # Output only. Human-readable status of the operation, if any.
457
+ # @!attribute [r] cancel_requested
458
+ # @return [::Boolean]
459
+ # Output only. Identifies whether the user has requested cancellation
460
+ # of the operation. Operations that have successfully been cancelled
461
+ # have [Operation.error][] value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
462
+ # corresponding to `Code.CANCELLED`.
463
+ # @!attribute [r] api_version
464
+ # @return [::String]
465
+ # Output only. API version used to start the operation.
466
+ class OperationMetadata
467
+ include ::Google::Protobuf::MessageExts
468
+ extend ::Google::Protobuf::MessageExts::ClassMethods
469
+ end
470
+ end
471
+ end
472
+ end
473
+ end
@@ -0,0 +1,164 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 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