google-apis-apigateway_v1beta 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1174 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module ApigatewayV1beta
23
+ # API Gateway API
24
+ #
25
+ #
26
+ #
27
+ # @example
28
+ # require 'google/apis/apigateway_v1beta'
29
+ #
30
+ # Apigateway = Google::Apis::ApigatewayV1beta # Alias the module
31
+ # service = Apigateway::ApigatewayService.new
32
+ #
33
+ # @see https://cloud.google.com/api-gateway/docs
34
+ class ApigatewayService < Google::Apis::Core::BaseService
35
+ # @return [String]
36
+ # API key. Your API key identifies your project and provides you with API access,
37
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
38
+ attr_accessor :key
39
+
40
+ # @return [String]
41
+ # Available to use for quota purposes for server-side applications. Can be any
42
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
43
+ attr_accessor :quota_user
44
+
45
+ def initialize
46
+ super('https://apigateway.googleapis.com/', '',
47
+ client_name: 'google-apis-apigateway_v1beta',
48
+ client_version: Google::Apis::ApigatewayV1beta::GEM_VERSION)
49
+ @batch_path = 'batch'
50
+ end
51
+
52
+ # Gets information about a location.
53
+ # @param [String] name
54
+ # Resource name for the location.
55
+ # @param [String] fields
56
+ # Selector specifying which fields to include in a partial response.
57
+ # @param [String] quota_user
58
+ # Available to use for quota purposes for server-side applications. Can be any
59
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
60
+ # @param [Google::Apis::RequestOptions] options
61
+ # Request-specific options
62
+ #
63
+ # @yield [result, err] Result & error if block supplied
64
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayLocation] parsed result object
65
+ # @yieldparam err [StandardError] error object if request failed
66
+ #
67
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayLocation]
68
+ #
69
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
70
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
71
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
72
+ def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
73
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
74
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayLocation::Representation
75
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayLocation
76
+ command.params['name'] = name unless name.nil?
77
+ command.query['fields'] = fields unless fields.nil?
78
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
79
+ execute_or_queue_command(command, &block)
80
+ end
81
+
82
+ # Lists information about the supported locations for this service.
83
+ # @param [String] name
84
+ # The resource that owns the locations collection, if applicable.
85
+ # @param [String] filter
86
+ # The standard list filter.
87
+ # @param [Fixnum] page_size
88
+ # The standard list page size.
89
+ # @param [String] page_token
90
+ # The standard list page token.
91
+ # @param [String] fields
92
+ # Selector specifying which fields to include in a partial response.
93
+ # @param [String] quota_user
94
+ # Available to use for quota purposes for server-side applications. Can be any
95
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
96
+ # @param [Google::Apis::RequestOptions] options
97
+ # Request-specific options
98
+ #
99
+ # @yield [result, err] Result & error if block supplied
100
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayListLocationsResponse] parsed result object
101
+ # @yieldparam err [StandardError] error object if request failed
102
+ #
103
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayListLocationsResponse]
104
+ #
105
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
106
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
107
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
108
+ def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
109
+ command = make_simple_command(:get, 'v1beta/{+name}/locations', options)
110
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayListLocationsResponse::Representation
111
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayListLocationsResponse
112
+ command.params['name'] = name unless name.nil?
113
+ command.query['filter'] = filter unless filter.nil?
114
+ command.query['pageSize'] = page_size unless page_size.nil?
115
+ command.query['pageToken'] = page_token unless page_token.nil?
116
+ command.query['fields'] = fields unless fields.nil?
117
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
118
+ execute_or_queue_command(command, &block)
119
+ end
120
+
121
+ # Creates a new Api in a given project and location.
122
+ # @param [String] parent
123
+ # Required. Parent resource of the API, of the form: `projects/*/locations/
124
+ # global`
125
+ # @param [Google::Apis::ApigatewayV1beta::ApigatewayApi] apigateway_api_object
126
+ # @param [String] api_id
127
+ # Required. Identifier to assign to the API. Must be unique within scope of the
128
+ # parent resource.
129
+ # @param [String] fields
130
+ # Selector specifying which fields to include in a partial response.
131
+ # @param [String] quota_user
132
+ # Available to use for quota purposes for server-side applications. Can be any
133
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
134
+ # @param [Google::Apis::RequestOptions] options
135
+ # Request-specific options
136
+ #
137
+ # @yield [result, err] Result & error if block supplied
138
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object
139
+ # @yieldparam err [StandardError] error object if request failed
140
+ #
141
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation]
142
+ #
143
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
144
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
145
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
146
+ def create_project_location_api(parent, apigateway_api_object = nil, api_id: nil, fields: nil, quota_user: nil, options: nil, &block)
147
+ command = make_simple_command(:post, 'v1beta/{+parent}/apis', options)
148
+ command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayApi::Representation
149
+ command.request_object = apigateway_api_object
150
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation
151
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation
152
+ command.params['parent'] = parent unless parent.nil?
153
+ command.query['apiId'] = api_id unless api_id.nil?
154
+ command.query['fields'] = fields unless fields.nil?
155
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
156
+ execute_or_queue_command(command, &block)
157
+ end
158
+
159
+ # Deletes a single Api.
160
+ # @param [String] name
161
+ # Required. Resource name of the form: `projects/*/locations/global/apis/*`
162
+ # @param [String] fields
163
+ # Selector specifying which fields to include in a partial response.
164
+ # @param [String] quota_user
165
+ # Available to use for quota purposes for server-side applications. Can be any
166
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
167
+ # @param [Google::Apis::RequestOptions] options
168
+ # Request-specific options
169
+ #
170
+ # @yield [result, err] Result & error if block supplied
171
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object
172
+ # @yieldparam err [StandardError] error object if request failed
173
+ #
174
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation]
175
+ #
176
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
177
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
178
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
179
+ def delete_project_location_api(name, fields: nil, quota_user: nil, options: nil, &block)
180
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
181
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation
182
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation
183
+ command.params['name'] = name unless name.nil?
184
+ command.query['fields'] = fields unless fields.nil?
185
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
186
+ execute_or_queue_command(command, &block)
187
+ end
188
+
189
+ # Gets details of a single Api.
190
+ # @param [String] name
191
+ # Required. Resource name of the form: `projects/*/locations/global/apis/*`
192
+ # @param [String] fields
193
+ # Selector specifying which fields to include in a partial response.
194
+ # @param [String] quota_user
195
+ # Available to use for quota purposes for server-side applications. Can be any
196
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
197
+ # @param [Google::Apis::RequestOptions] options
198
+ # Request-specific options
199
+ #
200
+ # @yield [result, err] Result & error if block supplied
201
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayApi] parsed result object
202
+ # @yieldparam err [StandardError] error object if request failed
203
+ #
204
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayApi]
205
+ #
206
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
207
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
208
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
209
+ def get_project_location_api(name, fields: nil, quota_user: nil, options: nil, &block)
210
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
211
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayApi::Representation
212
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayApi
213
+ command.params['name'] = name unless name.nil?
214
+ command.query['fields'] = fields unless fields.nil?
215
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
216
+ execute_or_queue_command(command, &block)
217
+ end
218
+
219
+ # Gets the access control policy for a resource. Returns an empty policy if the
220
+ # resource exists and does not have a policy set.
221
+ # @param [String] resource
222
+ # REQUIRED: The resource for which the policy is being requested. See the
223
+ # operation documentation for the appropriate value for this field.
224
+ # @param [Fixnum] options_requested_policy_version
225
+ # Optional. The policy format version to be returned. Valid values are 0, 1, and
226
+ # 3. Requests specifying an invalid value will be rejected. Requests for
227
+ # policies with any conditional bindings must specify version 3. Policies
228
+ # without any conditional bindings may specify any valid value or leave the
229
+ # field unset. To learn which resources support conditions in their IAM policies,
230
+ # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
231
+ # resource-policies).
232
+ # @param [String] fields
233
+ # Selector specifying which fields to include in a partial response.
234
+ # @param [String] quota_user
235
+ # Available to use for quota purposes for server-side applications. Can be any
236
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
237
+ # @param [Google::Apis::RequestOptions] options
238
+ # Request-specific options
239
+ #
240
+ # @yield [result, err] Result & error if block supplied
241
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] parsed result object
242
+ # @yieldparam err [StandardError] error object if request failed
243
+ #
244
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayPolicy]
245
+ #
246
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
247
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
248
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
249
+ def get_project_location_api_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
250
+ command = make_simple_command(:get, 'v1beta/{+resource}:getIamPolicy', options)
251
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayPolicy::Representation
252
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayPolicy
253
+ command.params['resource'] = resource unless resource.nil?
254
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
255
+ command.query['fields'] = fields unless fields.nil?
256
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
257
+ execute_or_queue_command(command, &block)
258
+ end
259
+
260
+ # Lists Apis in a given project and location.
261
+ # @param [String] parent
262
+ # Required. Parent resource of the API, of the form: `projects/*/locations/
263
+ # global`
264
+ # @param [String] filter
265
+ # Filter.
266
+ # @param [String] order_by
267
+ # Order by parameters.
268
+ # @param [Fixnum] page_size
269
+ # Page size.
270
+ # @param [String] page_token
271
+ # Page token.
272
+ # @param [String] fields
273
+ # Selector specifying which fields to include in a partial response.
274
+ # @param [String] quota_user
275
+ # Available to use for quota purposes for server-side applications. Can be any
276
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
277
+ # @param [Google::Apis::RequestOptions] options
278
+ # Request-specific options
279
+ #
280
+ # @yield [result, err] Result & error if block supplied
281
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayListApisResponse] parsed result object
282
+ # @yieldparam err [StandardError] error object if request failed
283
+ #
284
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayListApisResponse]
285
+ #
286
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
287
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
288
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
289
+ def list_project_location_apis(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
290
+ command = make_simple_command(:get, 'v1beta/{+parent}/apis', options)
291
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayListApisResponse::Representation
292
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayListApisResponse
293
+ command.params['parent'] = parent unless parent.nil?
294
+ command.query['filter'] = filter unless filter.nil?
295
+ command.query['orderBy'] = order_by unless order_by.nil?
296
+ command.query['pageSize'] = page_size unless page_size.nil?
297
+ command.query['pageToken'] = page_token unless page_token.nil?
298
+ command.query['fields'] = fields unless fields.nil?
299
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
300
+ execute_or_queue_command(command, &block)
301
+ end
302
+
303
+ # Updates the parameters of a single Api.
304
+ # @param [String] name
305
+ # Output only. Resource name of the API. Format: projects/`project`/locations/
306
+ # global/apis/`api`
307
+ # @param [Google::Apis::ApigatewayV1beta::ApigatewayApi] apigateway_api_object
308
+ # @param [String] update_mask
309
+ # Field mask is used to specify the fields to be overwritten in the Api resource
310
+ # by the update. The fields specified in the update_mask are relative to the
311
+ # resource, not the full request. A field will be overwritten if it is in the
312
+ # mask. If the user does not provide a mask then all fields will be overwritten.
313
+ # @param [String] fields
314
+ # Selector specifying which fields to include in a partial response.
315
+ # @param [String] quota_user
316
+ # Available to use for quota purposes for server-side applications. Can be any
317
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
318
+ # @param [Google::Apis::RequestOptions] options
319
+ # Request-specific options
320
+ #
321
+ # @yield [result, err] Result & error if block supplied
322
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object
323
+ # @yieldparam err [StandardError] error object if request failed
324
+ #
325
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation]
326
+ #
327
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
328
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
329
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
330
+ def patch_project_location_api(name, apigateway_api_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
331
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
332
+ command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayApi::Representation
333
+ command.request_object = apigateway_api_object
334
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation
335
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation
336
+ command.params['name'] = name unless name.nil?
337
+ command.query['updateMask'] = update_mask unless update_mask.nil?
338
+ command.query['fields'] = fields unless fields.nil?
339
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
340
+ execute_or_queue_command(command, &block)
341
+ end
342
+
343
+ # Sets the access control policy on the specified resource. Replaces any
344
+ # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
345
+ # PERMISSION_DENIED` errors.
346
+ # @param [String] resource
347
+ # REQUIRED: The resource for which the policy is being specified. See the
348
+ # operation documentation for the appropriate value for this field.
349
+ # @param [Google::Apis::ApigatewayV1beta::ApigatewaySetIamPolicyRequest] apigateway_set_iam_policy_request_object
350
+ # @param [String] fields
351
+ # Selector specifying which fields to include in a partial response.
352
+ # @param [String] quota_user
353
+ # Available to use for quota purposes for server-side applications. Can be any
354
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
355
+ # @param [Google::Apis::RequestOptions] options
356
+ # Request-specific options
357
+ #
358
+ # @yield [result, err] Result & error if block supplied
359
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] parsed result object
360
+ # @yieldparam err [StandardError] error object if request failed
361
+ #
362
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayPolicy]
363
+ #
364
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
365
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
366
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
367
+ def set_project_location_api_iam_policy(resource, apigateway_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
368
+ command = make_simple_command(:post, 'v1beta/{+resource}:setIamPolicy', options)
369
+ command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewaySetIamPolicyRequest::Representation
370
+ command.request_object = apigateway_set_iam_policy_request_object
371
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayPolicy::Representation
372
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayPolicy
373
+ command.params['resource'] = resource unless resource.nil?
374
+ command.query['fields'] = fields unless fields.nil?
375
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
376
+ execute_or_queue_command(command, &block)
377
+ end
378
+
379
+ # Returns permissions that a caller has on the specified resource. If the
380
+ # resource does not exist, this will return an empty set of permissions, not a `
381
+ # NOT_FOUND` error. Note: This operation is designed to be used for building
382
+ # permission-aware UIs and command-line tools, not for authorization checking.
383
+ # This operation may "fail open" without warning.
384
+ # @param [String] resource
385
+ # REQUIRED: The resource for which the policy detail is being requested. See the
386
+ # operation documentation for the appropriate value for this field.
387
+ # @param [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsRequest] apigateway_test_iam_permissions_request_object
388
+ # @param [String] fields
389
+ # Selector specifying which fields to include in a partial response.
390
+ # @param [String] quota_user
391
+ # Available to use for quota purposes for server-side applications. Can be any
392
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
393
+ # @param [Google::Apis::RequestOptions] options
394
+ # Request-specific options
395
+ #
396
+ # @yield [result, err] Result & error if block supplied
397
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse] parsed result object
398
+ # @yieldparam err [StandardError] error object if request failed
399
+ #
400
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse]
401
+ #
402
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
403
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
404
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
405
+ def test_project_location_api_iam_permissions(resource, apigateway_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
406
+ command = make_simple_command(:post, 'v1beta/{+resource}:testIamPermissions', options)
407
+ command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsRequest::Representation
408
+ command.request_object = apigateway_test_iam_permissions_request_object
409
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse::Representation
410
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse
411
+ command.params['resource'] = resource unless resource.nil?
412
+ command.query['fields'] = fields unless fields.nil?
413
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
414
+ execute_or_queue_command(command, &block)
415
+ end
416
+
417
+ # Creates a new ApiConfig in a given project and location.
418
+ # @param [String] parent
419
+ # Required. Parent resource of the API Config, of the form: `projects/*/
420
+ # locations/global/apis/*`
421
+ # @param [Google::Apis::ApigatewayV1beta::ApigatewayApiConfig] apigateway_api_config_object
422
+ # @param [String] api_config_id
423
+ # Required. Identifier to assign to the API Config. Must be unique within scope
424
+ # of the parent resource.
425
+ # @param [String] fields
426
+ # Selector specifying which fields to include in a partial response.
427
+ # @param [String] quota_user
428
+ # Available to use for quota purposes for server-side applications. Can be any
429
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
430
+ # @param [Google::Apis::RequestOptions] options
431
+ # Request-specific options
432
+ #
433
+ # @yield [result, err] Result & error if block supplied
434
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object
435
+ # @yieldparam err [StandardError] error object if request failed
436
+ #
437
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation]
438
+ #
439
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
440
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
441
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
442
+ def create_project_location_api_config(parent, apigateway_api_config_object = nil, api_config_id: nil, fields: nil, quota_user: nil, options: nil, &block)
443
+ command = make_simple_command(:post, 'v1beta/{+parent}/configs', options)
444
+ command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayApiConfig::Representation
445
+ command.request_object = apigateway_api_config_object
446
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation
447
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation
448
+ command.params['parent'] = parent unless parent.nil?
449
+ command.query['apiConfigId'] = api_config_id unless api_config_id.nil?
450
+ command.query['fields'] = fields unless fields.nil?
451
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
452
+ execute_or_queue_command(command, &block)
453
+ end
454
+
455
+ # Deletes a single ApiConfig.
456
+ # @param [String] name
457
+ # Required. Resource name of the form: `projects/*/locations/global/apis/*/
458
+ # configs/*`
459
+ # @param [String] fields
460
+ # Selector specifying which fields to include in a partial response.
461
+ # @param [String] quota_user
462
+ # Available to use for quota purposes for server-side applications. Can be any
463
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
464
+ # @param [Google::Apis::RequestOptions] options
465
+ # Request-specific options
466
+ #
467
+ # @yield [result, err] Result & error if block supplied
468
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object
469
+ # @yieldparam err [StandardError] error object if request failed
470
+ #
471
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation]
472
+ #
473
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
474
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
475
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
476
+ def delete_project_location_api_config(name, fields: nil, quota_user: nil, options: nil, &block)
477
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
478
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation
479
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation
480
+ command.params['name'] = name unless name.nil?
481
+ command.query['fields'] = fields unless fields.nil?
482
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
483
+ execute_or_queue_command(command, &block)
484
+ end
485
+
486
+ # Gets details of a single ApiConfig.
487
+ # @param [String] name
488
+ # Required. Resource name of the form: `projects/*/locations/global/apis/*/
489
+ # configs/*`
490
+ # @param [String] view
491
+ # Specifies which fields of the API Config are returned in the response.
492
+ # Defaults to `BASIC` view.
493
+ # @param [String] fields
494
+ # Selector specifying which fields to include in a partial response.
495
+ # @param [String] quota_user
496
+ # Available to use for quota purposes for server-side applications. Can be any
497
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
498
+ # @param [Google::Apis::RequestOptions] options
499
+ # Request-specific options
500
+ #
501
+ # @yield [result, err] Result & error if block supplied
502
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayApiConfig] parsed result object
503
+ # @yieldparam err [StandardError] error object if request failed
504
+ #
505
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayApiConfig]
506
+ #
507
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
508
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
509
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
510
+ def get_project_location_api_config(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
511
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
512
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayApiConfig::Representation
513
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayApiConfig
514
+ command.params['name'] = name unless name.nil?
515
+ command.query['view'] = view unless view.nil?
516
+ command.query['fields'] = fields unless fields.nil?
517
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
518
+ execute_or_queue_command(command, &block)
519
+ end
520
+
521
+ # Gets the access control policy for a resource. Returns an empty policy if the
522
+ # resource exists and does not have a policy set.
523
+ # @param [String] resource
524
+ # REQUIRED: The resource for which the policy is being requested. See the
525
+ # operation documentation for the appropriate value for this field.
526
+ # @param [Fixnum] options_requested_policy_version
527
+ # Optional. The policy format version to be returned. Valid values are 0, 1, and
528
+ # 3. Requests specifying an invalid value will be rejected. Requests for
529
+ # policies with any conditional bindings must specify version 3. Policies
530
+ # without any conditional bindings may specify any valid value or leave the
531
+ # field unset. To learn which resources support conditions in their IAM policies,
532
+ # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
533
+ # resource-policies).
534
+ # @param [String] fields
535
+ # Selector specifying which fields to include in a partial response.
536
+ # @param [String] quota_user
537
+ # Available to use for quota purposes for server-side applications. Can be any
538
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
539
+ # @param [Google::Apis::RequestOptions] options
540
+ # Request-specific options
541
+ #
542
+ # @yield [result, err] Result & error if block supplied
543
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] parsed result object
544
+ # @yieldparam err [StandardError] error object if request failed
545
+ #
546
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayPolicy]
547
+ #
548
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
549
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
550
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
551
+ def get_project_location_api_config_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
552
+ command = make_simple_command(:get, 'v1beta/{+resource}:getIamPolicy', options)
553
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayPolicy::Representation
554
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayPolicy
555
+ command.params['resource'] = resource unless resource.nil?
556
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
557
+ command.query['fields'] = fields unless fields.nil?
558
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
559
+ execute_or_queue_command(command, &block)
560
+ end
561
+
562
+ # Lists ApiConfigs in a given project and location.
563
+ # @param [String] parent
564
+ # Required. Parent resource of the API Config, of the form: `projects/*/
565
+ # locations/global/apis/*`
566
+ # @param [String] filter
567
+ # Filter.
568
+ # @param [String] order_by
569
+ # Order by parameters.
570
+ # @param [Fixnum] page_size
571
+ # Page size.
572
+ # @param [String] page_token
573
+ # Page token.
574
+ # @param [String] fields
575
+ # Selector specifying which fields to include in a partial response.
576
+ # @param [String] quota_user
577
+ # Available to use for quota purposes for server-side applications. Can be any
578
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
579
+ # @param [Google::Apis::RequestOptions] options
580
+ # Request-specific options
581
+ #
582
+ # @yield [result, err] Result & error if block supplied
583
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayListApiConfigsResponse] parsed result object
584
+ # @yieldparam err [StandardError] error object if request failed
585
+ #
586
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayListApiConfigsResponse]
587
+ #
588
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
589
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
590
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
591
+ def list_project_location_api_configs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
592
+ command = make_simple_command(:get, 'v1beta/{+parent}/configs', options)
593
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayListApiConfigsResponse::Representation
594
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayListApiConfigsResponse
595
+ command.params['parent'] = parent unless parent.nil?
596
+ command.query['filter'] = filter unless filter.nil?
597
+ command.query['orderBy'] = order_by unless order_by.nil?
598
+ command.query['pageSize'] = page_size unless page_size.nil?
599
+ command.query['pageToken'] = page_token unless page_token.nil?
600
+ command.query['fields'] = fields unless fields.nil?
601
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
602
+ execute_or_queue_command(command, &block)
603
+ end
604
+
605
+ # Updates the parameters of a single ApiConfig.
606
+ # @param [String] name
607
+ # Output only. Resource name of the API Config. Format: projects/`project`/
608
+ # locations/global/apis/`api`/configs/`api_config`
609
+ # @param [Google::Apis::ApigatewayV1beta::ApigatewayApiConfig] apigateway_api_config_object
610
+ # @param [String] update_mask
611
+ # Field mask is used to specify the fields to be overwritten in the ApiConfig
612
+ # resource by the update. The fields specified in the update_mask are relative
613
+ # to the resource, not the full request. A field will be overwritten if it is in
614
+ # the mask. If the user does not provide a mask then all fields will be
615
+ # overwritten.
616
+ # @param [String] fields
617
+ # Selector specifying which fields to include in a partial response.
618
+ # @param [String] quota_user
619
+ # Available to use for quota purposes for server-side applications. Can be any
620
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
621
+ # @param [Google::Apis::RequestOptions] options
622
+ # Request-specific options
623
+ #
624
+ # @yield [result, err] Result & error if block supplied
625
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object
626
+ # @yieldparam err [StandardError] error object if request failed
627
+ #
628
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation]
629
+ #
630
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
631
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
632
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
633
+ def patch_project_location_api_config(name, apigateway_api_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
634
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
635
+ command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayApiConfig::Representation
636
+ command.request_object = apigateway_api_config_object
637
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation
638
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation
639
+ command.params['name'] = name unless name.nil?
640
+ command.query['updateMask'] = update_mask unless update_mask.nil?
641
+ command.query['fields'] = fields unless fields.nil?
642
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
643
+ execute_or_queue_command(command, &block)
644
+ end
645
+
646
+ # Sets the access control policy on the specified resource. Replaces any
647
+ # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
648
+ # PERMISSION_DENIED` errors.
649
+ # @param [String] resource
650
+ # REQUIRED: The resource for which the policy is being specified. See the
651
+ # operation documentation for the appropriate value for this field.
652
+ # @param [Google::Apis::ApigatewayV1beta::ApigatewaySetIamPolicyRequest] apigateway_set_iam_policy_request_object
653
+ # @param [String] fields
654
+ # Selector specifying which fields to include in a partial response.
655
+ # @param [String] quota_user
656
+ # Available to use for quota purposes for server-side applications. Can be any
657
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
658
+ # @param [Google::Apis::RequestOptions] options
659
+ # Request-specific options
660
+ #
661
+ # @yield [result, err] Result & error if block supplied
662
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] parsed result object
663
+ # @yieldparam err [StandardError] error object if request failed
664
+ #
665
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayPolicy]
666
+ #
667
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
668
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
669
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
670
+ def set_project_location_api_config_iam_policy(resource, apigateway_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
671
+ command = make_simple_command(:post, 'v1beta/{+resource}:setIamPolicy', options)
672
+ command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewaySetIamPolicyRequest::Representation
673
+ command.request_object = apigateway_set_iam_policy_request_object
674
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayPolicy::Representation
675
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayPolicy
676
+ command.params['resource'] = resource unless resource.nil?
677
+ command.query['fields'] = fields unless fields.nil?
678
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
679
+ execute_or_queue_command(command, &block)
680
+ end
681
+
682
+ # Returns permissions that a caller has on the specified resource. If the
683
+ # resource does not exist, this will return an empty set of permissions, not a `
684
+ # NOT_FOUND` error. Note: This operation is designed to be used for building
685
+ # permission-aware UIs and command-line tools, not for authorization checking.
686
+ # This operation may "fail open" without warning.
687
+ # @param [String] resource
688
+ # REQUIRED: The resource for which the policy detail is being requested. See the
689
+ # operation documentation for the appropriate value for this field.
690
+ # @param [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsRequest] apigateway_test_iam_permissions_request_object
691
+ # @param [String] fields
692
+ # Selector specifying which fields to include in a partial response.
693
+ # @param [String] quota_user
694
+ # Available to use for quota purposes for server-side applications. Can be any
695
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
696
+ # @param [Google::Apis::RequestOptions] options
697
+ # Request-specific options
698
+ #
699
+ # @yield [result, err] Result & error if block supplied
700
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse] parsed result object
701
+ # @yieldparam err [StandardError] error object if request failed
702
+ #
703
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse]
704
+ #
705
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
706
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
707
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
708
+ def test_project_location_api_config_iam_permissions(resource, apigateway_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
709
+ command = make_simple_command(:post, 'v1beta/{+resource}:testIamPermissions', options)
710
+ command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsRequest::Representation
711
+ command.request_object = apigateway_test_iam_permissions_request_object
712
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse::Representation
713
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse
714
+ command.params['resource'] = resource unless resource.nil?
715
+ command.query['fields'] = fields unless fields.nil?
716
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
717
+ execute_or_queue_command(command, &block)
718
+ end
719
+
720
+ # Creates a new Gateway in a given project and location.
721
+ # @param [String] parent
722
+ # Required. Parent resource of the Gateway, of the form: `projects/*/locations/*`
723
+ # @param [Google::Apis::ApigatewayV1beta::ApigatewayGateway] apigateway_gateway_object
724
+ # @param [String] gateway_id
725
+ # Required. Identifier to assign to the Gateway. Must be unique within scope of
726
+ # the parent resource.
727
+ # @param [String] fields
728
+ # Selector specifying which fields to include in a partial response.
729
+ # @param [String] quota_user
730
+ # Available to use for quota purposes for server-side applications. Can be any
731
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
732
+ # @param [Google::Apis::RequestOptions] options
733
+ # Request-specific options
734
+ #
735
+ # @yield [result, err] Result & error if block supplied
736
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object
737
+ # @yieldparam err [StandardError] error object if request failed
738
+ #
739
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation]
740
+ #
741
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
742
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
743
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
744
+ def create_project_location_gateway(parent, apigateway_gateway_object = nil, gateway_id: nil, fields: nil, quota_user: nil, options: nil, &block)
745
+ command = make_simple_command(:post, 'v1beta/{+parent}/gateways', options)
746
+ command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayGateway::Representation
747
+ command.request_object = apigateway_gateway_object
748
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation
749
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation
750
+ command.params['parent'] = parent unless parent.nil?
751
+ command.query['gatewayId'] = gateway_id unless gateway_id.nil?
752
+ command.query['fields'] = fields unless fields.nil?
753
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
754
+ execute_or_queue_command(command, &block)
755
+ end
756
+
757
+ # Deletes a single Gateway.
758
+ # @param [String] name
759
+ # Required. Resource name of the form: `projects/*/locations/*/gateways/*`
760
+ # @param [String] fields
761
+ # Selector specifying which fields to include in a partial response.
762
+ # @param [String] quota_user
763
+ # Available to use for quota purposes for server-side applications. Can be any
764
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
765
+ # @param [Google::Apis::RequestOptions] options
766
+ # Request-specific options
767
+ #
768
+ # @yield [result, err] Result & error if block supplied
769
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object
770
+ # @yieldparam err [StandardError] error object if request failed
771
+ #
772
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation]
773
+ #
774
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
775
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
776
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
777
+ def delete_project_location_gateway(name, fields: nil, quota_user: nil, options: nil, &block)
778
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
779
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation
780
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation
781
+ command.params['name'] = name unless name.nil?
782
+ command.query['fields'] = fields unless fields.nil?
783
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
784
+ execute_or_queue_command(command, &block)
785
+ end
786
+
787
+ # Gets details of a single Gateway.
788
+ # @param [String] name
789
+ # Required. Resource name of the form: `projects/*/locations/*/gateways/*`
790
+ # @param [String] fields
791
+ # Selector specifying which fields to include in a partial response.
792
+ # @param [String] quota_user
793
+ # Available to use for quota purposes for server-side applications. Can be any
794
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
795
+ # @param [Google::Apis::RequestOptions] options
796
+ # Request-specific options
797
+ #
798
+ # @yield [result, err] Result & error if block supplied
799
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayGateway] parsed result object
800
+ # @yieldparam err [StandardError] error object if request failed
801
+ #
802
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayGateway]
803
+ #
804
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
805
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
806
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
807
+ def get_project_location_gateway(name, fields: nil, quota_user: nil, options: nil, &block)
808
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
809
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayGateway::Representation
810
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayGateway
811
+ command.params['name'] = name unless name.nil?
812
+ command.query['fields'] = fields unless fields.nil?
813
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
814
+ execute_or_queue_command(command, &block)
815
+ end
816
+
817
+ # Gets the access control policy for a resource. Returns an empty policy if the
818
+ # resource exists and does not have a policy set.
819
+ # @param [String] resource
820
+ # REQUIRED: The resource for which the policy is being requested. See the
821
+ # operation documentation for the appropriate value for this field.
822
+ # @param [Fixnum] options_requested_policy_version
823
+ # Optional. The policy format version to be returned. Valid values are 0, 1, and
824
+ # 3. Requests specifying an invalid value will be rejected. Requests for
825
+ # policies with any conditional bindings must specify version 3. Policies
826
+ # without any conditional bindings may specify any valid value or leave the
827
+ # field unset. To learn which resources support conditions in their IAM policies,
828
+ # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
829
+ # resource-policies).
830
+ # @param [String] fields
831
+ # Selector specifying which fields to include in a partial response.
832
+ # @param [String] quota_user
833
+ # Available to use for quota purposes for server-side applications. Can be any
834
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
835
+ # @param [Google::Apis::RequestOptions] options
836
+ # Request-specific options
837
+ #
838
+ # @yield [result, err] Result & error if block supplied
839
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] parsed result object
840
+ # @yieldparam err [StandardError] error object if request failed
841
+ #
842
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayPolicy]
843
+ #
844
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
845
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
846
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
847
+ def get_project_location_gateway_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
848
+ command = make_simple_command(:get, 'v1beta/{+resource}:getIamPolicy', options)
849
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayPolicy::Representation
850
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayPolicy
851
+ command.params['resource'] = resource unless resource.nil?
852
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
853
+ command.query['fields'] = fields unless fields.nil?
854
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
855
+ execute_or_queue_command(command, &block)
856
+ end
857
+
858
+ # Lists Gateways in a given project and location.
859
+ # @param [String] parent
860
+ # Required. Parent resource of the Gateway, of the form: `projects/*/locations/*`
861
+ # @param [String] filter
862
+ # Filter.
863
+ # @param [String] order_by
864
+ # Order by parameters.
865
+ # @param [Fixnum] page_size
866
+ # Page size.
867
+ # @param [String] page_token
868
+ # Page token.
869
+ # @param [String] fields
870
+ # Selector specifying which fields to include in a partial response.
871
+ # @param [String] quota_user
872
+ # Available to use for quota purposes for server-side applications. Can be any
873
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
874
+ # @param [Google::Apis::RequestOptions] options
875
+ # Request-specific options
876
+ #
877
+ # @yield [result, err] Result & error if block supplied
878
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayListGatewaysResponse] parsed result object
879
+ # @yieldparam err [StandardError] error object if request failed
880
+ #
881
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayListGatewaysResponse]
882
+ #
883
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
884
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
885
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
886
+ def list_project_location_gateways(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
887
+ command = make_simple_command(:get, 'v1beta/{+parent}/gateways', options)
888
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayListGatewaysResponse::Representation
889
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayListGatewaysResponse
890
+ command.params['parent'] = parent unless parent.nil?
891
+ command.query['filter'] = filter unless filter.nil?
892
+ command.query['orderBy'] = order_by unless order_by.nil?
893
+ command.query['pageSize'] = page_size unless page_size.nil?
894
+ command.query['pageToken'] = page_token unless page_token.nil?
895
+ command.query['fields'] = fields unless fields.nil?
896
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
897
+ execute_or_queue_command(command, &block)
898
+ end
899
+
900
+ # Updates the parameters of a single Gateway.
901
+ # @param [String] name
902
+ # Output only. Resource name of the Gateway. Format: projects/`project`/
903
+ # locations/`location`/gateways/`gateway`
904
+ # @param [Google::Apis::ApigatewayV1beta::ApigatewayGateway] apigateway_gateway_object
905
+ # @param [String] update_mask
906
+ # Field mask is used to specify the fields to be overwritten in the Gateway
907
+ # resource by the update. The fields specified in the update_mask are relative
908
+ # to the resource, not the full request. A field will be overwritten if it is in
909
+ # the mask. If the user does not provide a mask then all fields will be
910
+ # overwritten.
911
+ # @param [String] fields
912
+ # Selector specifying which fields to include in a partial response.
913
+ # @param [String] quota_user
914
+ # Available to use for quota purposes for server-side applications. Can be any
915
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
916
+ # @param [Google::Apis::RequestOptions] options
917
+ # Request-specific options
918
+ #
919
+ # @yield [result, err] Result & error if block supplied
920
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object
921
+ # @yieldparam err [StandardError] error object if request failed
922
+ #
923
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation]
924
+ #
925
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
926
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
927
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
928
+ def patch_project_location_gateway(name, apigateway_gateway_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
929
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
930
+ command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayGateway::Representation
931
+ command.request_object = apigateway_gateway_object
932
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation
933
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation
934
+ command.params['name'] = name unless name.nil?
935
+ command.query['updateMask'] = update_mask unless update_mask.nil?
936
+ command.query['fields'] = fields unless fields.nil?
937
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
938
+ execute_or_queue_command(command, &block)
939
+ end
940
+
941
+ # Sets the access control policy on the specified resource. Replaces any
942
+ # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
943
+ # PERMISSION_DENIED` errors.
944
+ # @param [String] resource
945
+ # REQUIRED: The resource for which the policy is being specified. See the
946
+ # operation documentation for the appropriate value for this field.
947
+ # @param [Google::Apis::ApigatewayV1beta::ApigatewaySetIamPolicyRequest] apigateway_set_iam_policy_request_object
948
+ # @param [String] fields
949
+ # Selector specifying which fields to include in a partial response.
950
+ # @param [String] quota_user
951
+ # Available to use for quota purposes for server-side applications. Can be any
952
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
953
+ # @param [Google::Apis::RequestOptions] options
954
+ # Request-specific options
955
+ #
956
+ # @yield [result, err] Result & error if block supplied
957
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayPolicy] parsed result object
958
+ # @yieldparam err [StandardError] error object if request failed
959
+ #
960
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayPolicy]
961
+ #
962
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
963
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
964
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
965
+ def set_project_location_gateway_iam_policy(resource, apigateway_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
966
+ command = make_simple_command(:post, 'v1beta/{+resource}:setIamPolicy', options)
967
+ command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewaySetIamPolicyRequest::Representation
968
+ command.request_object = apigateway_set_iam_policy_request_object
969
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayPolicy::Representation
970
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayPolicy
971
+ command.params['resource'] = resource unless resource.nil?
972
+ command.query['fields'] = fields unless fields.nil?
973
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
974
+ execute_or_queue_command(command, &block)
975
+ end
976
+
977
+ # Returns permissions that a caller has on the specified resource. If the
978
+ # resource does not exist, this will return an empty set of permissions, not a `
979
+ # NOT_FOUND` error. Note: This operation is designed to be used for building
980
+ # permission-aware UIs and command-line tools, not for authorization checking.
981
+ # This operation may "fail open" without warning.
982
+ # @param [String] resource
983
+ # REQUIRED: The resource for which the policy detail is being requested. See the
984
+ # operation documentation for the appropriate value for this field.
985
+ # @param [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsRequest] apigateway_test_iam_permissions_request_object
986
+ # @param [String] fields
987
+ # Selector specifying which fields to include in a partial response.
988
+ # @param [String] quota_user
989
+ # Available to use for quota purposes for server-side applications. Can be any
990
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
991
+ # @param [Google::Apis::RequestOptions] options
992
+ # Request-specific options
993
+ #
994
+ # @yield [result, err] Result & error if block supplied
995
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse] parsed result object
996
+ # @yieldparam err [StandardError] error object if request failed
997
+ #
998
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse]
999
+ #
1000
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1001
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1002
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1003
+ def test_project_location_gateway_iam_permissions(resource, apigateway_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1004
+ command = make_simple_command(:post, 'v1beta/{+resource}:testIamPermissions', options)
1005
+ command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsRequest::Representation
1006
+ command.request_object = apigateway_test_iam_permissions_request_object
1007
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse::Representation
1008
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayTestIamPermissionsResponse
1009
+ command.params['resource'] = resource unless resource.nil?
1010
+ command.query['fields'] = fields unless fields.nil?
1011
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1012
+ execute_or_queue_command(command, &block)
1013
+ end
1014
+
1015
+ # Starts asynchronous cancellation on a long-running operation. The server makes
1016
+ # a best effort to cancel the operation, but success is not guaranteed. If the
1017
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
1018
+ # Clients can use Operations.GetOperation or other methods to check whether the
1019
+ # cancellation succeeded or whether the operation completed despite cancellation.
1020
+ # On successful cancellation, the operation is not deleted; instead, it becomes
1021
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
1022
+ # corresponding to `Code.CANCELLED`.
1023
+ # @param [String] name
1024
+ # The name of the operation resource to be cancelled.
1025
+ # @param [Google::Apis::ApigatewayV1beta::ApigatewayCancelOperationRequest] apigateway_cancel_operation_request_object
1026
+ # @param [String] fields
1027
+ # Selector specifying which fields to include in a partial response.
1028
+ # @param [String] quota_user
1029
+ # Available to use for quota purposes for server-side applications. Can be any
1030
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1031
+ # @param [Google::Apis::RequestOptions] options
1032
+ # Request-specific options
1033
+ #
1034
+ # @yield [result, err] Result & error if block supplied
1035
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::Empty] parsed result object
1036
+ # @yieldparam err [StandardError] error object if request failed
1037
+ #
1038
+ # @return [Google::Apis::ApigatewayV1beta::Empty]
1039
+ #
1040
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1041
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1042
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1043
+ def cancel_project_location_operation(name, apigateway_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1044
+ command = make_simple_command(:post, 'v1beta/{+name}:cancel', options)
1045
+ command.request_representation = Google::Apis::ApigatewayV1beta::ApigatewayCancelOperationRequest::Representation
1046
+ command.request_object = apigateway_cancel_operation_request_object
1047
+ command.response_representation = Google::Apis::ApigatewayV1beta::Empty::Representation
1048
+ command.response_class = Google::Apis::ApigatewayV1beta::Empty
1049
+ command.params['name'] = name unless name.nil?
1050
+ command.query['fields'] = fields unless fields.nil?
1051
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1052
+ execute_or_queue_command(command, &block)
1053
+ end
1054
+
1055
+ # Deletes a long-running operation. This method indicates that the client is no
1056
+ # longer interested in the operation result. It does not cancel the operation.
1057
+ # If the server doesn't support this method, it returns `google.rpc.Code.
1058
+ # UNIMPLEMENTED`.
1059
+ # @param [String] name
1060
+ # The name of the operation resource to be deleted.
1061
+ # @param [String] fields
1062
+ # Selector specifying which fields to include in a partial response.
1063
+ # @param [String] quota_user
1064
+ # Available to use for quota purposes for server-side applications. Can be any
1065
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1066
+ # @param [Google::Apis::RequestOptions] options
1067
+ # Request-specific options
1068
+ #
1069
+ # @yield [result, err] Result & error if block supplied
1070
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::Empty] parsed result object
1071
+ # @yieldparam err [StandardError] error object if request failed
1072
+ #
1073
+ # @return [Google::Apis::ApigatewayV1beta::Empty]
1074
+ #
1075
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1076
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1077
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1078
+ def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1079
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
1080
+ command.response_representation = Google::Apis::ApigatewayV1beta::Empty::Representation
1081
+ command.response_class = Google::Apis::ApigatewayV1beta::Empty
1082
+ command.params['name'] = name unless name.nil?
1083
+ command.query['fields'] = fields unless fields.nil?
1084
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1085
+ execute_or_queue_command(command, &block)
1086
+ end
1087
+
1088
+ # Gets the latest state of a long-running operation. Clients can use this method
1089
+ # to poll the operation result at intervals as recommended by the API service.
1090
+ # @param [String] name
1091
+ # The name of the operation resource.
1092
+ # @param [String] fields
1093
+ # Selector specifying which fields to include in a partial response.
1094
+ # @param [String] quota_user
1095
+ # Available to use for quota purposes for server-side applications. Can be any
1096
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1097
+ # @param [Google::Apis::RequestOptions] options
1098
+ # Request-specific options
1099
+ #
1100
+ # @yield [result, err] Result & error if block supplied
1101
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayOperation] parsed result object
1102
+ # @yieldparam err [StandardError] error object if request failed
1103
+ #
1104
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayOperation]
1105
+ #
1106
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1107
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1108
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1109
+ def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1110
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
1111
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayOperation::Representation
1112
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayOperation
1113
+ command.params['name'] = name unless name.nil?
1114
+ command.query['fields'] = fields unless fields.nil?
1115
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1116
+ execute_or_queue_command(command, &block)
1117
+ end
1118
+
1119
+ # Lists operations that match the specified filter in the request. If the server
1120
+ # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
1121
+ # binding allows API services to override the binding to use different resource
1122
+ # name schemes, such as `users/*/operations`. To override the binding, API
1123
+ # services can add a binding such as `"/v1/`name=users/*`/operations"` to their
1124
+ # service configuration. For backwards compatibility, the default name includes
1125
+ # the operations collection id, however overriding users must ensure the name
1126
+ # binding is the parent resource, without the operations collection id.
1127
+ # @param [String] name
1128
+ # The name of the operation's parent resource.
1129
+ # @param [String] filter
1130
+ # The standard list filter.
1131
+ # @param [Fixnum] page_size
1132
+ # The standard list page size.
1133
+ # @param [String] page_token
1134
+ # The standard list page token.
1135
+ # @param [String] fields
1136
+ # Selector specifying which fields to include in a partial response.
1137
+ # @param [String] quota_user
1138
+ # Available to use for quota purposes for server-side applications. Can be any
1139
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1140
+ # @param [Google::Apis::RequestOptions] options
1141
+ # Request-specific options
1142
+ #
1143
+ # @yield [result, err] Result & error if block supplied
1144
+ # @yieldparam result [Google::Apis::ApigatewayV1beta::ApigatewayListOperationsResponse] parsed result object
1145
+ # @yieldparam err [StandardError] error object if request failed
1146
+ #
1147
+ # @return [Google::Apis::ApigatewayV1beta::ApigatewayListOperationsResponse]
1148
+ #
1149
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1150
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1151
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1152
+ def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1153
+ command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
1154
+ command.response_representation = Google::Apis::ApigatewayV1beta::ApigatewayListOperationsResponse::Representation
1155
+ command.response_class = Google::Apis::ApigatewayV1beta::ApigatewayListOperationsResponse
1156
+ command.params['name'] = name unless name.nil?
1157
+ command.query['filter'] = filter unless filter.nil?
1158
+ command.query['pageSize'] = page_size unless page_size.nil?
1159
+ command.query['pageToken'] = page_token unless page_token.nil?
1160
+ command.query['fields'] = fields unless fields.nil?
1161
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1162
+ execute_or_queue_command(command, &block)
1163
+ end
1164
+
1165
+ protected
1166
+
1167
+ def apply_command_defaults(command)
1168
+ command.query['key'] = key unless key.nil?
1169
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1170
+ end
1171
+ end
1172
+ end
1173
+ end
1174
+ end