google-cloud-edge_container-v1 0.a → 0.1.1

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 (36) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +144 -8
  5. data/lib/google/cloud/edge_container/v1/bindings_override.rb +102 -0
  6. data/lib/google/cloud/edge_container/v1/edge_container/client.rb +2486 -0
  7. data/lib/google/cloud/edge_container/v1/edge_container/credentials.rb +47 -0
  8. data/lib/google/cloud/edge_container/v1/edge_container/operations.rb +809 -0
  9. data/lib/google/cloud/edge_container/v1/edge_container/paths.rb +172 -0
  10. data/lib/google/cloud/edge_container/v1/edge_container/rest/client.rb +2324 -0
  11. data/lib/google/cloud/edge_container/v1/edge_container/rest/operations.rb +902 -0
  12. data/lib/google/cloud/edge_container/v1/edge_container/rest/service_stub.rb +1255 -0
  13. data/lib/google/cloud/edge_container/v1/edge_container/rest.rb +55 -0
  14. data/lib/google/cloud/edge_container/v1/edge_container.rb +57 -0
  15. data/lib/google/cloud/edge_container/v1/rest.rb +38 -0
  16. data/lib/google/cloud/edge_container/v1/version.rb +7 -2
  17. data/lib/google/cloud/edge_container/v1.rb +45 -0
  18. data/lib/google/cloud/edgecontainer/v1/resources_pb.rb +92 -0
  19. data/lib/google/cloud/edgecontainer/v1/service_pb.rb +81 -0
  20. data/lib/google/cloud/edgecontainer/v1/service_services_pb.rb +84 -0
  21. data/lib/google-cloud-edge_container-v1.rb +21 -0
  22. data/proto_docs/README.md +4 -0
  23. data/proto_docs/google/api/client.rb +420 -0
  24. data/proto_docs/google/api/field_behavior.rb +85 -0
  25. data/proto_docs/google/api/launch_stage.rb +71 -0
  26. data/proto_docs/google/api/resource.rb +227 -0
  27. data/proto_docs/google/cloud/edgecontainer/v1/resources.rb +881 -0
  28. data/proto_docs/google/cloud/edgecontainer/v1/service.rb +475 -0
  29. data/proto_docs/google/longrunning/operations.rb +164 -0
  30. data/proto_docs/google/protobuf/any.rb +145 -0
  31. data/proto_docs/google/protobuf/duration.rb +98 -0
  32. data/proto_docs/google/protobuf/empty.rb +34 -0
  33. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  34. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  35. data/proto_docs/google/rpc/status.rb +48 -0
  36. metadata +96 -10
@@ -0,0 +1,475 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 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 EdgeContainer
23
+ module V1
24
+ # Long-running operation metadata for Edge Container API methods.
25
+ # @!attribute [rw] create_time
26
+ # @return [::Google::Protobuf::Timestamp]
27
+ # The time the operation was created.
28
+ # @!attribute [rw] end_time
29
+ # @return [::Google::Protobuf::Timestamp]
30
+ # The time the operation finished running.
31
+ # @!attribute [rw] target
32
+ # @return [::String]
33
+ # Server-defined resource path for the target of the operation.
34
+ # @!attribute [rw] verb
35
+ # @return [::String]
36
+ # The verb executed by the operation.
37
+ # @!attribute [rw] status_message
38
+ # @return [::String]
39
+ # Human-readable status of the operation, if any.
40
+ # @!attribute [rw] requested_cancellation
41
+ # @return [::Boolean]
42
+ # Identifies whether the user has requested cancellation of the operation.
43
+ # Operations that have successfully been cancelled have [Operation.error][]
44
+ # value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
45
+ # corresponding to `Code.CANCELLED`.
46
+ # @!attribute [rw] api_version
47
+ # @return [::String]
48
+ # API version used to start the operation.
49
+ # @!attribute [rw] warnings
50
+ # @return [::Array<::String>]
51
+ # Warnings that do not block the operation, but still hold relevant
52
+ # information for the end user to receive.
53
+ class OperationMetadata
54
+ include ::Google::Protobuf::MessageExts
55
+ extend ::Google::Protobuf::MessageExts::ClassMethods
56
+ end
57
+
58
+ # Lists clusters in a location.
59
+ # @!attribute [rw] parent
60
+ # @return [::String]
61
+ # Required. The parent location, which owns this collection of clusters.
62
+ # @!attribute [rw] page_size
63
+ # @return [::Integer]
64
+ # The maximum number of resources to list.
65
+ # @!attribute [rw] page_token
66
+ # @return [::String]
67
+ # A page token received from previous list request.
68
+ # A page token received from previous list request.
69
+ # @!attribute [rw] filter
70
+ # @return [::String]
71
+ # Only resources matching this filter will be listed.
72
+ # @!attribute [rw] order_by
73
+ # @return [::String]
74
+ # Specifies the order in which resources will be listed.
75
+ class ListClustersRequest
76
+ include ::Google::Protobuf::MessageExts
77
+ extend ::Google::Protobuf::MessageExts::ClassMethods
78
+ end
79
+
80
+ # List of clusters in a location.
81
+ # @!attribute [rw] clusters
82
+ # @return [::Array<::Google::Cloud::EdgeContainer::V1::Cluster>]
83
+ # Clusters in the location.
84
+ # @!attribute [rw] next_page_token
85
+ # @return [::String]
86
+ # A token to retrieve next page of results.
87
+ # @!attribute [rw] unreachable
88
+ # @return [::Array<::String>]
89
+ # Locations that could not be reached.
90
+ class ListClustersResponse
91
+ include ::Google::Protobuf::MessageExts
92
+ extend ::Google::Protobuf::MessageExts::ClassMethods
93
+ end
94
+
95
+ # Gets a cluster.
96
+ # @!attribute [rw] name
97
+ # @return [::String]
98
+ # Required. The resource name of the cluster.
99
+ class GetClusterRequest
100
+ include ::Google::Protobuf::MessageExts
101
+ extend ::Google::Protobuf::MessageExts::ClassMethods
102
+ end
103
+
104
+ # Creates a cluster.
105
+ # @!attribute [rw] parent
106
+ # @return [::String]
107
+ # Required. The parent location where this cluster will be created.
108
+ # @!attribute [rw] cluster_id
109
+ # @return [::String]
110
+ # Required. A client-specified unique identifier for the cluster.
111
+ # @!attribute [rw] cluster
112
+ # @return [::Google::Cloud::EdgeContainer::V1::Cluster]
113
+ # Required. The cluster to create.
114
+ # @!attribute [rw] request_id
115
+ # @return [::String]
116
+ # A unique identifier for this request. Restricted to 36 ASCII characters. A
117
+ # random UUID is recommended. This request is only idempotent if
118
+ # `request_id` is provided.
119
+ class CreateClusterRequest
120
+ include ::Google::Protobuf::MessageExts
121
+ extend ::Google::Protobuf::MessageExts::ClassMethods
122
+ end
123
+
124
+ # Updates a cluster.
125
+ # @!attribute [rw] update_mask
126
+ # @return [::Google::Protobuf::FieldMask]
127
+ # Field mask is used to specify the fields to be overwritten in the
128
+ # Cluster resource by the update.
129
+ # The fields specified in the update_mask are relative to the resource, not
130
+ # the full request. A field will be overwritten if it is in the mask. If the
131
+ # user does not provide a mask then all fields will be overwritten.
132
+ # @!attribute [rw] cluster
133
+ # @return [::Google::Cloud::EdgeContainer::V1::Cluster]
134
+ # The updated cluster.
135
+ # @!attribute [rw] request_id
136
+ # @return [::String]
137
+ # A unique identifier for this request. Restricted to 36 ASCII characters.
138
+ # A random UUID is recommended.
139
+ # This request is only idempotent if `request_id` is provided.
140
+ class UpdateClusterRequest
141
+ include ::Google::Protobuf::MessageExts
142
+ extend ::Google::Protobuf::MessageExts::ClassMethods
143
+ end
144
+
145
+ # Upgrades a cluster.
146
+ # @!attribute [rw] name
147
+ # @return [::String]
148
+ # Required. The resource name of the cluster.
149
+ # @!attribute [rw] target_version
150
+ # @return [::String]
151
+ # Required. The version the cluster is going to be upgraded to.
152
+ # @!attribute [rw] schedule
153
+ # @return [::Google::Cloud::EdgeContainer::V1::UpgradeClusterRequest::Schedule]
154
+ # The schedule for the upgrade.
155
+ # @!attribute [rw] request_id
156
+ # @return [::String]
157
+ # A unique identifier for this request. Restricted to 36 ASCII characters. A
158
+ # random UUID is recommended. This request is only idempotent if
159
+ # `request_id` is provided.
160
+ class UpgradeClusterRequest
161
+ include ::Google::Protobuf::MessageExts
162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
163
+
164
+ # Represents the schedule about when the cluster is going to be upgraded.
165
+ module Schedule
166
+ # Unspecified. The default is to upgrade the cluster immediately which is
167
+ # the only option today.
168
+ SCHEDULE_UNSPECIFIED = 0
169
+
170
+ # The cluster is going to be upgraded immediately after receiving the
171
+ # request.
172
+ IMMEDIATELY = 1
173
+ end
174
+ end
175
+
176
+ # Deletes a cluster.
177
+ # @!attribute [rw] name
178
+ # @return [::String]
179
+ # Required. The resource name of the cluster.
180
+ # @!attribute [rw] request_id
181
+ # @return [::String]
182
+ # A unique identifier for this request. Restricted to 36 ASCII characters. A
183
+ # random UUID is recommended. This request is only idempotent if
184
+ # `request_id` is provided.
185
+ class DeleteClusterRequest
186
+ include ::Google::Protobuf::MessageExts
187
+ extend ::Google::Protobuf::MessageExts::ClassMethods
188
+ end
189
+
190
+ # Generates an access token for a cluster.
191
+ # @!attribute [rw] cluster
192
+ # @return [::String]
193
+ # Required. The resource name of the cluster.
194
+ class GenerateAccessTokenRequest
195
+ include ::Google::Protobuf::MessageExts
196
+ extend ::Google::Protobuf::MessageExts::ClassMethods
197
+ end
198
+
199
+ # An access token for a cluster.
200
+ # @!attribute [r] access_token
201
+ # @return [::String]
202
+ # Output only. Access token to authenticate to k8s api-server.
203
+ # @!attribute [r] expire_time
204
+ # @return [::Google::Protobuf::Timestamp]
205
+ # Output only. Timestamp at which the token will expire.
206
+ class GenerateAccessTokenResponse
207
+ include ::Google::Protobuf::MessageExts
208
+ extend ::Google::Protobuf::MessageExts::ClassMethods
209
+ end
210
+
211
+ # Generates an offline credential(offline) for a cluster.
212
+ # @!attribute [rw] cluster
213
+ # @return [::String]
214
+ # Required. The resource name of the cluster.
215
+ class GenerateOfflineCredentialRequest
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
+ end
219
+
220
+ # An offline credential for a cluster.
221
+ # @!attribute [r] client_certificate
222
+ # @return [::String]
223
+ # Output only. Client certificate to authenticate to k8s api-server.
224
+ # @!attribute [r] client_key
225
+ # @return [::String]
226
+ # Output only. Client private key to authenticate to k8s api-server.
227
+ # @!attribute [r] user_id
228
+ # @return [::String]
229
+ # Output only. Client's identity.
230
+ # @!attribute [r] expire_time
231
+ # @return [::Google::Protobuf::Timestamp]
232
+ # Output only. Timestamp at which this credential will expire.
233
+ class GenerateOfflineCredentialResponse
234
+ include ::Google::Protobuf::MessageExts
235
+ extend ::Google::Protobuf::MessageExts::ClassMethods
236
+ end
237
+
238
+ # Lists node pools in a cluster.
239
+ # @!attribute [rw] parent
240
+ # @return [::String]
241
+ # Required. The parent cluster, which owns this collection of node pools.
242
+ # @!attribute [rw] page_size
243
+ # @return [::Integer]
244
+ # The maximum number of resources to list.
245
+ # @!attribute [rw] page_token
246
+ # @return [::String]
247
+ # A page token received from previous list request.
248
+ # @!attribute [rw] filter
249
+ # @return [::String]
250
+ # Only resources matching this filter will be listed.
251
+ # @!attribute [rw] order_by
252
+ # @return [::String]
253
+ # Specifies the order in which resources will be listed.
254
+ class ListNodePoolsRequest
255
+ include ::Google::Protobuf::MessageExts
256
+ extend ::Google::Protobuf::MessageExts::ClassMethods
257
+ end
258
+
259
+ # List of node pools in a cluster.
260
+ # @!attribute [rw] node_pools
261
+ # @return [::Array<::Google::Cloud::EdgeContainer::V1::NodePool>]
262
+ # Node pools in the cluster.
263
+ # @!attribute [rw] next_page_token
264
+ # @return [::String]
265
+ # A token to retrieve next page of results.
266
+ # @!attribute [rw] unreachable
267
+ # @return [::Array<::String>]
268
+ # Locations that could not be reached.
269
+ class ListNodePoolsResponse
270
+ include ::Google::Protobuf::MessageExts
271
+ extend ::Google::Protobuf::MessageExts::ClassMethods
272
+ end
273
+
274
+ # Gets a node pool.
275
+ # @!attribute [rw] name
276
+ # @return [::String]
277
+ # Required. The resource name of the node pool.
278
+ class GetNodePoolRequest
279
+ include ::Google::Protobuf::MessageExts
280
+ extend ::Google::Protobuf::MessageExts::ClassMethods
281
+ end
282
+
283
+ # Creates a node pool.
284
+ # @!attribute [rw] parent
285
+ # @return [::String]
286
+ # Required. The parent cluster where this node pool will be created.
287
+ # @!attribute [rw] node_pool_id
288
+ # @return [::String]
289
+ # Required. A client-specified unique identifier for the node pool.
290
+ # @!attribute [rw] node_pool
291
+ # @return [::Google::Cloud::EdgeContainer::V1::NodePool]
292
+ # Required. The node pool to create.
293
+ # @!attribute [rw] request_id
294
+ # @return [::String]
295
+ # A unique identifier for this request. Restricted to 36 ASCII characters. A
296
+ # random UUID is recommended. This request is only idempotent if
297
+ # `request_id` is provided.
298
+ class CreateNodePoolRequest
299
+ include ::Google::Protobuf::MessageExts
300
+ extend ::Google::Protobuf::MessageExts::ClassMethods
301
+ end
302
+
303
+ # Updates a node pool.
304
+ # @!attribute [rw] update_mask
305
+ # @return [::Google::Protobuf::FieldMask]
306
+ # Field mask is used to specify the fields to be overwritten in the
307
+ # NodePool resource by the update.
308
+ # The fields specified in the update_mask are relative to the resource, not
309
+ # the full request. A field will be overwritten if it is in the mask. If the
310
+ # user does not provide a mask then all fields will be overwritten.
311
+ # @!attribute [rw] node_pool
312
+ # @return [::Google::Cloud::EdgeContainer::V1::NodePool]
313
+ # The updated node pool.
314
+ # @!attribute [rw] request_id
315
+ # @return [::String]
316
+ # A unique identifier for this request. Restricted to 36 ASCII characters. A
317
+ # random UUID is recommended. This request is only idempotent if
318
+ # `request_id` is provided.
319
+ class UpdateNodePoolRequest
320
+ include ::Google::Protobuf::MessageExts
321
+ extend ::Google::Protobuf::MessageExts::ClassMethods
322
+ end
323
+
324
+ # Deletes a node pool.
325
+ # @!attribute [rw] name
326
+ # @return [::String]
327
+ # Required. The resource name of the node pool.
328
+ # @!attribute [rw] request_id
329
+ # @return [::String]
330
+ # A unique identifier for this request. Restricted to 36 ASCII characters. A
331
+ # random UUID is recommended. This request is only idempotent if
332
+ # `request_id` is provided.
333
+ class DeleteNodePoolRequest
334
+ include ::Google::Protobuf::MessageExts
335
+ extend ::Google::Protobuf::MessageExts::ClassMethods
336
+ end
337
+
338
+ # Lists machines in a site.
339
+ # @!attribute [rw] parent
340
+ # @return [::String]
341
+ # Required. The parent site, which owns this collection of machines.
342
+ # @!attribute [rw] page_size
343
+ # @return [::Integer]
344
+ # The maximum number of resources to list.
345
+ # @!attribute [rw] page_token
346
+ # @return [::String]
347
+ # A page token received from previous list request.
348
+ # @!attribute [rw] filter
349
+ # @return [::String]
350
+ # Only resources matching this filter will be listed.
351
+ # @!attribute [rw] order_by
352
+ # @return [::String]
353
+ # Specifies the order in which resources will be listed.
354
+ class ListMachinesRequest
355
+ include ::Google::Protobuf::MessageExts
356
+ extend ::Google::Protobuf::MessageExts::ClassMethods
357
+ end
358
+
359
+ # List of machines in a site.
360
+ # @!attribute [rw] machines
361
+ # @return [::Array<::Google::Cloud::EdgeContainer::V1::Machine>]
362
+ # Machines in the site.
363
+ # @!attribute [rw] next_page_token
364
+ # @return [::String]
365
+ # A token to retrieve next page of results.
366
+ # @!attribute [rw] unreachable
367
+ # @return [::Array<::String>]
368
+ # Locations that could not be reached.
369
+ class ListMachinesResponse
370
+ include ::Google::Protobuf::MessageExts
371
+ extend ::Google::Protobuf::MessageExts::ClassMethods
372
+ end
373
+
374
+ # Gets a machine.
375
+ # @!attribute [rw] name
376
+ # @return [::String]
377
+ # Required. The resource name of the machine.
378
+ class GetMachineRequest
379
+ include ::Google::Protobuf::MessageExts
380
+ extend ::Google::Protobuf::MessageExts::ClassMethods
381
+ end
382
+
383
+ # Lists VPN connections.
384
+ # @!attribute [rw] parent
385
+ # @return [::String]
386
+ # Required. The parent location, which owns this collection of VPN
387
+ # connections.
388
+ # @!attribute [rw] page_size
389
+ # @return [::Integer]
390
+ # The maximum number of resources to list.
391
+ # @!attribute [rw] page_token
392
+ # @return [::String]
393
+ # A page token received from previous list request.
394
+ # @!attribute [rw] filter
395
+ # @return [::String]
396
+ # Only resources matching this filter will be listed.
397
+ # @!attribute [rw] order_by
398
+ # @return [::String]
399
+ # Specifies the order in which resources will be listed.
400
+ class ListVpnConnectionsRequest
401
+ include ::Google::Protobuf::MessageExts
402
+ extend ::Google::Protobuf::MessageExts::ClassMethods
403
+ end
404
+
405
+ # List of VPN connections in a location.
406
+ # @!attribute [rw] vpn_connections
407
+ # @return [::Array<::Google::Cloud::EdgeContainer::V1::VpnConnection>]
408
+ # VpnConnections in the location.
409
+ # @!attribute [rw] next_page_token
410
+ # @return [::String]
411
+ # A token to retrieve next page of results.
412
+ # @!attribute [rw] unreachable
413
+ # @return [::Array<::String>]
414
+ # Locations that could not be reached.
415
+ class ListVpnConnectionsResponse
416
+ include ::Google::Protobuf::MessageExts
417
+ extend ::Google::Protobuf::MessageExts::ClassMethods
418
+ end
419
+
420
+ # Gets a VPN connection.
421
+ # @!attribute [rw] name
422
+ # @return [::String]
423
+ # Required. The resource name of the vpn connection.
424
+ class GetVpnConnectionRequest
425
+ include ::Google::Protobuf::MessageExts
426
+ extend ::Google::Protobuf::MessageExts::ClassMethods
427
+ end
428
+
429
+ # Creates a VPN connection.
430
+ # @!attribute [rw] parent
431
+ # @return [::String]
432
+ # Required. The parent location where this vpn connection will be created.
433
+ # @!attribute [rw] vpn_connection_id
434
+ # @return [::String]
435
+ # Required. The VPN connection identifier.
436
+ # @!attribute [rw] vpn_connection
437
+ # @return [::Google::Cloud::EdgeContainer::V1::VpnConnection]
438
+ # Required. The VPN connection to create.
439
+ # @!attribute [rw] request_id
440
+ # @return [::String]
441
+ # A unique identifier for this request. Restricted to 36 ASCII characters. A
442
+ # random UUID is recommended. This request is only idempotent if
443
+ # `request_id` is provided.
444
+ class CreateVpnConnectionRequest
445
+ include ::Google::Protobuf::MessageExts
446
+ extend ::Google::Protobuf::MessageExts::ClassMethods
447
+ end
448
+
449
+ # Deletes a vpn connection.
450
+ # @!attribute [rw] name
451
+ # @return [::String]
452
+ # Required. The resource name of the vpn connection.
453
+ # @!attribute [rw] request_id
454
+ # @return [::String]
455
+ # A unique identifier for this request. Restricted to 36 ASCII characters. A
456
+ # random UUID is recommended. This request is only idempotent if
457
+ # `request_id` is provided.
458
+ class DeleteVpnConnectionRequest
459
+ include ::Google::Protobuf::MessageExts
460
+ extend ::Google::Protobuf::MessageExts::ClassMethods
461
+ end
462
+
463
+ # Gets the server config.
464
+ # @!attribute [rw] name
465
+ # @return [::String]
466
+ # Required. The name (project and location) of the server config to get,
467
+ # specified in the format `projects/*/locations/*`.
468
+ class GetServerConfigRequest
469
+ include ::Google::Protobuf::MessageExts
470
+ extend ::Google::Protobuf::MessageExts::ClassMethods
471
+ end
472
+ end
473
+ end
474
+ end
475
+ end
@@ -0,0 +1,164 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 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