1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
# frozen_string_literal: true
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
module Google
module Longrunning
# This resource represents a long-running operation that is the result of a
# network API call.
# @!attribute [rw] name
# @return [::String]
# The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
# @!attribute [rw] metadata
# @return [::Google::Protobuf::Any]
# Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
# @!attribute [rw] done
# @return [::Boolean]
# If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
# @!attribute [rw] error
# @return [::Google::Rpc::Status]
# The error result of the operation in case of failure or cancellation.
#
# Note: The following fields are mutually exclusive: `error`, `response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
# @!attribute [rw] response
# @return [::Google::Protobuf::Any]
# The normal, successful response of the operation. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
# methods, the response should have the type `XxxResponse`, where `Xxx`
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
#
# Note: The following fields are mutually exclusive: `response`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.
class Operation
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# The request message for
# Operations.GetOperation.
# @!attribute [rw] name
# @return [::String]
# The name of the operation resource.
class GetOperationRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# The request message for
# Operations.ListOperations.
# @!attribute [rw] name
# @return [::String]
# The name of the operation's parent resource.
# @!attribute [rw] filter
# @return [::String]
# The standard list filter.
# @!attribute [rw] page_size
# @return [::Integer]
# The standard list page size.
# @!attribute [rw] page_token
# @return [::String]
# The standard list page token.
# @!attribute [rw] return_partial_success
# @return [::Boolean]
# When set to `true`, operations that are reachable are returned as normal,
# and those that are unreachable are returned in the
# [ListOperationsResponse.unreachable] field.
#
# This can only be `true` when reading across collections e.g. when `parent`
# is set to `"projects/example/locations/-"`.
#
# This field is not by default supported and will result in an
# `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
# service or product specific documentation.
class ListOperationsRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# The response message for
# Operations.ListOperations.
# @!attribute [rw] operations
# @return [::Array<::Google::Longrunning::Operation>]
# A list of operations that matches the specified filter in the request.
# @!attribute [rw] next_page_token
# @return [::String]
# The standard List next-page token.
# @!attribute [rw] unreachable
# @return [::Array<::String>]
# Unordered list. Unreachable resources. Populated when the request sets
# `ListOperationsRequest.return_partial_success` and reads across
# collections e.g. when attempting to list all resources across all supported
# locations.
class ListOperationsResponse
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# The request message for
# Operations.CancelOperation.
# @!attribute [rw] name
# @return [::String]
# The name of the operation resource to be cancelled.
class CancelOperationRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# The request message for
# Operations.DeleteOperation.
# @!attribute [rw] name
# @return [::String]
# The name of the operation resource to be deleted.
class DeleteOperationRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# The request message for
# Operations.WaitOperation.
# @!attribute [rw] name
# @return [::String]
# The name of the operation resource to wait on.
# @!attribute [rw] timeout
# @return [::Google::Protobuf::Duration]
# The maximum duration to wait before timing out. If left blank, the wait
# will be at most the time permitted by the underlying HTTP/RPC protocol.
# If RPC context deadline is also specified, the shorter one will be used.
class WaitOperationRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# A message representing the message types used by a long-running operation.
#
# Example:
#
# rpc Export(ExportRequest) returns (google.longrunning.Operation) {
# option (google.longrunning.operation_info) = {
# response_type: "ExportResponse"
# metadata_type: "ExportMetadata"
# };
# }
# @!attribute [rw] response_type
# @return [::String]
# Required. The message name of the primary return type for this
# long-running operation.
# This type will be used to deserialize the LRO's response.
#
# If the response is in a different package from the rpc, a fully-qualified
# message name must be used (e.g. `google.protobuf.Struct`).
#
# Note: Altering this value constitutes a breaking change.
# @!attribute [rw] metadata_type
# @return [::String]
# Required. The message name of the metadata type for this long-running
# operation.
#
# If the response is in a different package from the rpc, a fully-qualified
# message name must be used (e.g. `google.protobuf.Struct`).
#
# Note: Altering this value constitutes a breaking change.
class OperationInfo
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
end
end
|
