google-cloud-beyond_corp-app_gateways-v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (28) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +149 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +144 -0
  6. data/lib/google/cloud/beyond_corp/app_gateways/v1/app_gateways_service/client.rb +804 -0
  7. data/lib/google/cloud/beyond_corp/app_gateways/v1/app_gateways_service/credentials.rb +49 -0
  8. data/lib/google/cloud/beyond_corp/app_gateways/v1/app_gateways_service/operations.rb +772 -0
  9. data/lib/google/cloud/beyond_corp/app_gateways/v1/app_gateways_service/paths.rb +71 -0
  10. data/lib/google/cloud/beyond_corp/app_gateways/v1/app_gateways_service.rb +65 -0
  11. data/lib/google/cloud/beyond_corp/app_gateways/v1/version.rb +30 -0
  12. data/lib/google/cloud/beyond_corp/app_gateways/v1.rb +42 -0
  13. data/lib/google/cloud/beyondcorp/appgateways/v1/app_gateways_service_pb.rb +107 -0
  14. data/lib/google/cloud/beyondcorp/appgateways/v1/app_gateways_service_services_pb.rb +66 -0
  15. data/lib/google-cloud-beyond_corp-app_gateways-v1.rb +21 -0
  16. data/proto_docs/README.md +4 -0
  17. data/proto_docs/google/api/field_behavior.rb +71 -0
  18. data/proto_docs/google/api/resource.rb +222 -0
  19. data/proto_docs/google/cloud/beyondcorp/appgateways/v1/app_gateways_service.rb +291 -0
  20. data/proto_docs/google/longrunning/operations.rb +164 -0
  21. data/proto_docs/google/protobuf/any.rb +141 -0
  22. data/proto_docs/google/protobuf/duration.rb +98 -0
  23. data/proto_docs/google/protobuf/empty.rb +34 -0
  24. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  25. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  26. data/proto_docs/google/rpc/status.rb +46 -0
  27. data/proto_docs/google/type/expr.rb +75 -0
  28. metadata +260 -0
@@ -0,0 +1,222 @@
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 Api
22
+ # A simple descriptor of a resource type.
23
+ #
24
+ # ResourceDescriptor annotates a resource message (either by means of a
25
+ # protobuf annotation or use in the service config), and associates the
26
+ # resource's schema, the resource type, and the pattern of the resource name.
27
+ #
28
+ # Example:
29
+ #
30
+ # message Topic {
31
+ # // Indicates this message defines a resource schema.
32
+ # // Declares the resource type in the format of {service}/{kind}.
33
+ # // For Kubernetes resources, the format is {api group}/{kind}.
34
+ # option (google.api.resource) = {
35
+ # type: "pubsub.googleapis.com/Topic"
36
+ # pattern: "projects/{project}/topics/{topic}"
37
+ # };
38
+ # }
39
+ #
40
+ # The ResourceDescriptor Yaml config will look like:
41
+ #
42
+ # resources:
43
+ # - type: "pubsub.googleapis.com/Topic"
44
+ # pattern: "projects/{project}/topics/{topic}"
45
+ #
46
+ # Sometimes, resources have multiple patterns, typically because they can
47
+ # live under multiple parents.
48
+ #
49
+ # Example:
50
+ #
51
+ # message LogEntry {
52
+ # option (google.api.resource) = {
53
+ # type: "logging.googleapis.com/LogEntry"
54
+ # pattern: "projects/{project}/logs/{log}"
55
+ # pattern: "folders/{folder}/logs/{log}"
56
+ # pattern: "organizations/{organization}/logs/{log}"
57
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
58
+ # };
59
+ # }
60
+ #
61
+ # The ResourceDescriptor Yaml config will look like:
62
+ #
63
+ # resources:
64
+ # - type: 'logging.googleapis.com/LogEntry'
65
+ # pattern: "projects/{project}/logs/{log}"
66
+ # pattern: "folders/{folder}/logs/{log}"
67
+ # pattern: "organizations/{organization}/logs/{log}"
68
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
69
+ # @!attribute [rw] type
70
+ # @return [::String]
71
+ # The resource type. It must be in the format of
72
+ # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
73
+ # singular and must not include version numbers.
74
+ #
75
+ # Example: `storage.googleapis.com/Bucket`
76
+ #
77
+ # The value of the resource_type_kind must follow the regular expression
78
+ # /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
79
+ # should use PascalCase (UpperCamelCase). The maximum number of
80
+ # characters allowed for the `resource_type_kind` is 100.
81
+ # @!attribute [rw] pattern
82
+ # @return [::Array<::String>]
83
+ # Optional. The relative resource name pattern associated with this resource
84
+ # type. The DNS prefix of the full resource name shouldn't be specified here.
85
+ #
86
+ # The path pattern must follow the syntax, which aligns with HTTP binding
87
+ # syntax:
88
+ #
89
+ # Template = Segment { "/" Segment } ;
90
+ # Segment = LITERAL | Variable ;
91
+ # Variable = "{" LITERAL "}" ;
92
+ #
93
+ # Examples:
94
+ #
95
+ # - "projects/\\{project}/topics/\\{topic}"
96
+ # - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
97
+ #
98
+ # The components in braces correspond to the IDs for each resource in the
99
+ # hierarchy. It is expected that, if multiple patterns are provided,
100
+ # the same component name (e.g. "project") refers to IDs of the same
101
+ # type of resource.
102
+ # @!attribute [rw] name_field
103
+ # @return [::String]
104
+ # Optional. The field on the resource that designates the resource name
105
+ # field. If omitted, this is assumed to be "name".
106
+ # @!attribute [rw] history
107
+ # @return [::Google::Api::ResourceDescriptor::History]
108
+ # Optional. The historical or future-looking state of the resource pattern.
109
+ #
110
+ # Example:
111
+ #
112
+ # // The InspectTemplate message originally only supported resource
113
+ # // names with organization, and project was added later.
114
+ # message InspectTemplate {
115
+ # option (google.api.resource) = {
116
+ # type: "dlp.googleapis.com/InspectTemplate"
117
+ # pattern:
118
+ # "organizations/{organization}/inspectTemplates/{inspect_template}"
119
+ # pattern: "projects/{project}/inspectTemplates/{inspect_template}"
120
+ # history: ORIGINALLY_SINGLE_PATTERN
121
+ # };
122
+ # }
123
+ # @!attribute [rw] plural
124
+ # @return [::String]
125
+ # The plural name used in the resource name and permission names, such as
126
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
127
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
128
+ # concept of the `plural` field in k8s CRD spec
129
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
130
+ #
131
+ # Note: The plural form is required even for singleton resources. See
132
+ # https://aip.dev/156
133
+ # @!attribute [rw] singular
134
+ # @return [::String]
135
+ # The same concept of the `singular` field in k8s CRD spec
136
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
137
+ # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
138
+ # @!attribute [rw] style
139
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
140
+ # Style flag(s) for this resource.
141
+ # These indicate that a resource is expected to conform to a given
142
+ # style. See the specific style flags for additional information.
143
+ class ResourceDescriptor
144
+ include ::Google::Protobuf::MessageExts
145
+ extend ::Google::Protobuf::MessageExts::ClassMethods
146
+
147
+ # A description of the historical or future-looking state of the
148
+ # resource pattern.
149
+ module History
150
+ # The "unset" value.
151
+ HISTORY_UNSPECIFIED = 0
152
+
153
+ # The resource originally had one pattern and launched as such, and
154
+ # additional patterns were added later.
155
+ ORIGINALLY_SINGLE_PATTERN = 1
156
+
157
+ # The resource has one pattern, but the API owner expects to add more
158
+ # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
159
+ # that from being necessary once there are multiple patterns.)
160
+ FUTURE_MULTI_PATTERN = 2
161
+ end
162
+
163
+ # A flag representing a specific style that a resource claims to conform to.
164
+ module Style
165
+ # The unspecified value. Do not use.
166
+ STYLE_UNSPECIFIED = 0
167
+
168
+ # This resource is intended to be "declarative-friendly".
169
+ #
170
+ # Declarative-friendly resources must be more strictly consistent, and
171
+ # setting this to true communicates to tools that this resource should
172
+ # adhere to declarative-friendly expectations.
173
+ #
174
+ # Note: This is used by the API linter (linter.aip.dev) to enable
175
+ # additional checks.
176
+ DECLARATIVE_FRIENDLY = 1
177
+ end
178
+ end
179
+
180
+ # Defines a proto annotation that describes a string field that refers to
181
+ # an API resource.
182
+ # @!attribute [rw] type
183
+ # @return [::String]
184
+ # The resource type that the annotated field references.
185
+ #
186
+ # Example:
187
+ #
188
+ # message Subscription {
189
+ # string topic = 2 [(google.api.resource_reference) = {
190
+ # type: "pubsub.googleapis.com/Topic"
191
+ # }];
192
+ # }
193
+ #
194
+ # Occasionally, a field may reference an arbitrary resource. In this case,
195
+ # APIs use the special value * in their resource reference.
196
+ #
197
+ # Example:
198
+ #
199
+ # message GetIamPolicyRequest {
200
+ # string resource = 2 [(google.api.resource_reference) = {
201
+ # type: "*"
202
+ # }];
203
+ # }
204
+ # @!attribute [rw] child_type
205
+ # @return [::String]
206
+ # The resource type of a child collection that the annotated field
207
+ # references. This is useful for annotating the `parent` field that
208
+ # doesn't have a fixed resource type.
209
+ #
210
+ # Example:
211
+ #
212
+ # message ListLogEntriesRequest {
213
+ # string parent = 1 [(google.api.resource_reference) = {
214
+ # child_type: "logging.googleapis.com/LogEntry"
215
+ # };
216
+ # }
217
+ class ResourceReference
218
+ include ::Google::Protobuf::MessageExts
219
+ extend ::Google::Protobuf::MessageExts::ClassMethods
220
+ end
221
+ end
222
+ end
@@ -0,0 +1,291 @@
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 BeyondCorp
23
+ module AppGateways
24
+ module V1
25
+ # Request message for BeyondCorp.ListAppGateways.
26
+ # @!attribute [rw] parent
27
+ # @return [::String]
28
+ # Required. The resource name of the AppGateway location using the form:
29
+ # `projects/{project_id}/locations/{location_id}`
30
+ # @!attribute [rw] page_size
31
+ # @return [::Integer]
32
+ # Optional. The maximum number of items to return.
33
+ # If not specified, a default value of 50 will be used by the service.
34
+ # Regardless of the page_size value, the response may include a partial list
35
+ # and a caller should only rely on response's
36
+ # [next_page_token][BeyondCorp.ListAppGatewaysResponse.next_page_token] to
37
+ # determine if there are more instances left to be queried.
38
+ # @!attribute [rw] page_token
39
+ # @return [::String]
40
+ # Optional. The next_page_token value returned from a previous
41
+ # ListAppGatewaysRequest, if any.
42
+ # @!attribute [rw] filter
43
+ # @return [::String]
44
+ # Optional. A filter specifying constraints of a list operation.
45
+ # @!attribute [rw] order_by
46
+ # @return [::String]
47
+ # Optional. Specifies the ordering of results. See
48
+ # [Sorting
49
+ # order](https://cloud.google.com/apis/design/design_patterns#sorting_order)
50
+ # for more information.
51
+ class ListAppGatewaysRequest
52
+ include ::Google::Protobuf::MessageExts
53
+ extend ::Google::Protobuf::MessageExts::ClassMethods
54
+ end
55
+
56
+ # Response message for BeyondCorp.ListAppGateways.
57
+ # @!attribute [rw] app_gateways
58
+ # @return [::Array<::Google::Cloud::BeyondCorp::AppGateways::V1::AppGateway>]
59
+ # A list of BeyondCorp AppGateways in the project.
60
+ # @!attribute [rw] next_page_token
61
+ # @return [::String]
62
+ # A token to retrieve the next page of results, or empty if there are no more
63
+ # results in the list.
64
+ # @!attribute [rw] unreachable
65
+ # @return [::Array<::String>]
66
+ # A list of locations that could not be reached.
67
+ class ListAppGatewaysResponse
68
+ include ::Google::Protobuf::MessageExts
69
+ extend ::Google::Protobuf::MessageExts::ClassMethods
70
+ end
71
+
72
+ # Request message for BeyondCorp.GetAppGateway.
73
+ # @!attribute [rw] name
74
+ # @return [::String]
75
+ # Required. BeyondCorp AppGateway name using the form:
76
+ # `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`
77
+ class GetAppGatewayRequest
78
+ include ::Google::Protobuf::MessageExts
79
+ extend ::Google::Protobuf::MessageExts::ClassMethods
80
+ end
81
+
82
+ # Request message for BeyondCorp.CreateAppGateway.
83
+ # @!attribute [rw] parent
84
+ # @return [::String]
85
+ # Required. The resource project name of the AppGateway location using the
86
+ # form: `projects/{project_id}/locations/{location_id}`
87
+ # @!attribute [rw] app_gateway_id
88
+ # @return [::String]
89
+ # Optional. User-settable AppGateway resource ID.
90
+ # * Must start with a letter.
91
+ # * Must contain between 4-63 characters from `/[a-z][0-9]-/`.
92
+ # * Must end with a number or a letter.
93
+ # @!attribute [rw] app_gateway
94
+ # @return [::Google::Cloud::BeyondCorp::AppGateways::V1::AppGateway]
95
+ # Required. A BeyondCorp AppGateway resource.
96
+ # @!attribute [rw] request_id
97
+ # @return [::String]
98
+ # Optional. An optional request ID to identify requests. Specify a unique
99
+ # request ID so that if you must retry your request, the server will know to
100
+ # ignore the request if it has already been completed. The server will
101
+ # guarantee that for at least 60 minutes since the first request.
102
+ #
103
+ # For example, consider a situation where you make an initial request and t
104
+ # he request times out. If you make the request again with the same request
105
+ # ID, the server can check if original operation with the same request ID
106
+ # was received, and if so, will ignore the second request. This prevents
107
+ # clients from accidentally creating duplicate commitments.
108
+ #
109
+ # The request ID must be a valid UUID with the exception that zero UUID is
110
+ # not supported (00000000-0000-0000-0000-000000000000).
111
+ # @!attribute [rw] validate_only
112
+ # @return [::Boolean]
113
+ # Optional. If set, validates request by executing a dry-run which would not
114
+ # alter the resource in any way.
115
+ class CreateAppGatewayRequest
116
+ include ::Google::Protobuf::MessageExts
117
+ extend ::Google::Protobuf::MessageExts::ClassMethods
118
+ end
119
+
120
+ # Request message for BeyondCorp.DeleteAppGateway.
121
+ # @!attribute [rw] name
122
+ # @return [::String]
123
+ # Required. BeyondCorp AppGateway name using the form:
124
+ # `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`
125
+ # @!attribute [rw] request_id
126
+ # @return [::String]
127
+ # Optional. An optional request ID to identify requests. Specify a unique
128
+ # request ID so that if you must retry your request, the server will know to
129
+ # ignore the request if it has already been completed. The server will
130
+ # guarantee that for at least 60 minutes after the first request.
131
+ #
132
+ # For example, consider a situation where you make an initial request and t
133
+ # he request times out. If you make the request again with the same request
134
+ # ID, the server can check if original operation with the same request ID
135
+ # was received, and if so, will ignore the second request. This prevents
136
+ # clients from accidentally creating duplicate commitments.
137
+ #
138
+ # The request ID must be a valid UUID with the exception that zero UUID is
139
+ # not supported (00000000-0000-0000-0000-000000000000).
140
+ # @!attribute [rw] validate_only
141
+ # @return [::Boolean]
142
+ # Optional. If set, validates request by executing a dry-run which would not
143
+ # alter the resource in any way.
144
+ class DeleteAppGatewayRequest
145
+ include ::Google::Protobuf::MessageExts
146
+ extend ::Google::Protobuf::MessageExts::ClassMethods
147
+ end
148
+
149
+ # A BeyondCorp AppGateway resource represents a BeyondCorp protected AppGateway
150
+ # to a remote application. It creates all the necessary GCP components needed
151
+ # for creating a BeyondCorp protected AppGateway. Multiple connectors can be
152
+ # authorised for a single AppGateway.
153
+ # @!attribute [rw] name
154
+ # @return [::String]
155
+ # Required. Unique resource name of the AppGateway.
156
+ # The name is ignored when creating an AppGateway.
157
+ # @!attribute [r] create_time
158
+ # @return [::Google::Protobuf::Timestamp]
159
+ # Output only. Timestamp when the resource was created.
160
+ # @!attribute [r] update_time
161
+ # @return [::Google::Protobuf::Timestamp]
162
+ # Output only. Timestamp when the resource was last modified.
163
+ # @!attribute [rw] labels
164
+ # @return [::Google::Protobuf::Map{::String => ::String}]
165
+ # Optional. Resource labels to represent user provided metadata.
166
+ # @!attribute [rw] display_name
167
+ # @return [::String]
168
+ # Optional. An arbitrary user-provided name for the AppGateway. Cannot exceed
169
+ # 64 characters.
170
+ # @!attribute [r] uid
171
+ # @return [::String]
172
+ # Output only. A unique identifier for the instance generated by the
173
+ # system.
174
+ # @!attribute [rw] type
175
+ # @return [::Google::Cloud::BeyondCorp::AppGateways::V1::AppGateway::Type]
176
+ # Required. The type of network connectivity used by the AppGateway.
177
+ # @!attribute [r] state
178
+ # @return [::Google::Cloud::BeyondCorp::AppGateways::V1::AppGateway::State]
179
+ # Output only. The current state of the AppGateway.
180
+ # @!attribute [r] uri
181
+ # @return [::String]
182
+ # Output only. Server-defined URI for this resource.
183
+ # @!attribute [r] allocated_connections
184
+ # @return [::Array<::Google::Cloud::BeyondCorp::AppGateways::V1::AppGateway::AllocatedConnection>]
185
+ # Output only. A list of connections allocated for the Gateway
186
+ # @!attribute [rw] host_type
187
+ # @return [::Google::Cloud::BeyondCorp::AppGateways::V1::AppGateway::HostType]
188
+ # Required. The type of hosting used by the AppGateway.
189
+ class AppGateway
190
+ include ::Google::Protobuf::MessageExts
191
+ extend ::Google::Protobuf::MessageExts::ClassMethods
192
+
193
+ # Allocated connection of the AppGateway.
194
+ # @!attribute [rw] psc_uri
195
+ # @return [::String]
196
+ # Required. The PSC uri of an allocated connection
197
+ # @!attribute [rw] ingress_port
198
+ # @return [::Integer]
199
+ # Required. The ingress port of an allocated connection
200
+ class AllocatedConnection
201
+ include ::Google::Protobuf::MessageExts
202
+ extend ::Google::Protobuf::MessageExts::ClassMethods
203
+ end
204
+
205
+ # @!attribute [rw] key
206
+ # @return [::String]
207
+ # @!attribute [rw] value
208
+ # @return [::String]
209
+ class LabelsEntry
210
+ include ::Google::Protobuf::MessageExts
211
+ extend ::Google::Protobuf::MessageExts::ClassMethods
212
+ end
213
+
214
+ # Enum containing list of all possible network connectivity options
215
+ # supported by BeyondCorp AppGateway.
216
+ module Type
217
+ # Default value. This value is unused.
218
+ TYPE_UNSPECIFIED = 0
219
+
220
+ # TCP Proxy based BeyondCorp Connection. API will default to this if unset.
221
+ TCP_PROXY = 1
222
+ end
223
+
224
+ # Represents the different states of an AppGateway.
225
+ module State
226
+ # Default value. This value is unused.
227
+ STATE_UNSPECIFIED = 0
228
+
229
+ # AppGateway is being created.
230
+ CREATING = 1
231
+
232
+ # AppGateway has been created.
233
+ CREATED = 2
234
+
235
+ # AppGateway's configuration is being updated.
236
+ UPDATING = 3
237
+
238
+ # AppGateway is being deleted.
239
+ DELETING = 4
240
+
241
+ # AppGateway is down and may be restored in the future.
242
+ # This happens when CCFE sends ProjectState = OFF.
243
+ DOWN = 5
244
+ end
245
+
246
+ # Enum containing list of all possible host types supported by BeyondCorp
247
+ # Connection.
248
+ module HostType
249
+ # Default value. This value is unused.
250
+ HOST_TYPE_UNSPECIFIED = 0
251
+
252
+ # AppGateway hosted in a GCP regional managed instance group.
253
+ GCP_REGIONAL_MIG = 1
254
+ end
255
+ end
256
+
257
+ # Represents the metadata of the long-running operation.
258
+ # @!attribute [r] create_time
259
+ # @return [::Google::Protobuf::Timestamp]
260
+ # Output only. The time the operation was created.
261
+ # @!attribute [r] end_time
262
+ # @return [::Google::Protobuf::Timestamp]
263
+ # Output only. The time the operation finished running.
264
+ # @!attribute [r] target
265
+ # @return [::String]
266
+ # Output only. Server-defined resource path for the target of the operation.
267
+ # @!attribute [r] verb
268
+ # @return [::String]
269
+ # Output only. Name of the verb executed by the operation.
270
+ # @!attribute [r] status_message
271
+ # @return [::String]
272
+ # Output only. Human-readable status of the operation, if any.
273
+ # @!attribute [r] requested_cancellation
274
+ # @return [::Boolean]
275
+ # Output only. Identifies whether the user has requested cancellation
276
+ # of the operation. Operations that have successfully been cancelled
277
+ # have [Operation.error][] value with a
278
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to
279
+ # `Code.CANCELLED`.
280
+ # @!attribute [r] api_version
281
+ # @return [::String]
282
+ # Output only. API version used to start the operation.
283
+ class AppGatewayOperationMetadata
284
+ include ::Google::Protobuf::MessageExts
285
+ extend ::Google::Protobuf::MessageExts::ClassMethods
286
+ end
287
+ end
288
+ end
289
+ end
290
+ end
291
+ 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