google-apis-cloudnumberregistry_v1alpha 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1526 @@
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 CloudnumberregistryV1alpha
23
+ # Cloud Number Registry API
24
+ #
25
+ #
26
+ #
27
+ # @example
28
+ # require 'google/apis/cloudnumberregistry_v1alpha'
29
+ #
30
+ # Cloudnumberregistry = Google::Apis::CloudnumberregistryV1alpha # Alias the module
31
+ # service = Cloudnumberregistry::CloudNumberRegistryService.new
32
+ #
33
+ # @see https://docs.cloud.google.com/number-registry/reference/rest
34
+ class CloudNumberRegistryService < Google::Apis::Core::BaseService
35
+ DEFAULT_ENDPOINT_TEMPLATE = "https://cloudnumberregistry.$UNIVERSE_DOMAIN$/"
36
+
37
+ # @return [String]
38
+ # API key. Your API key identifies your project and provides you with API access,
39
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
40
+ attr_accessor :key
41
+
42
+ # @return [String]
43
+ # Available to use for quota purposes for server-side applications. Can be any
44
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
45
+ attr_accessor :quota_user
46
+
47
+ def initialize
48
+ super(DEFAULT_ENDPOINT_TEMPLATE, '',
49
+ client_name: 'google-apis-cloudnumberregistry_v1alpha',
50
+ client_version: Google::Apis::CloudnumberregistryV1alpha::GEM_VERSION)
51
+ @batch_path = 'batch'
52
+ end
53
+
54
+ # Gets information about a location.
55
+ # @param [String] name
56
+ # Resource name for the location.
57
+ # @param [String] fields
58
+ # Selector specifying which fields to include in a partial response.
59
+ # @param [String] quota_user
60
+ # Available to use for quota purposes for server-side applications. Can be any
61
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
62
+ # @param [Google::Apis::RequestOptions] options
63
+ # Request-specific options
64
+ #
65
+ # @yield [result, err] Result & error if block supplied
66
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Location] parsed result object
67
+ # @yieldparam err [StandardError] error object if request failed
68
+ #
69
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Location]
70
+ #
71
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
72
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
73
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
74
+ def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
75
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
76
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Location::Representation
77
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Location
78
+ command.params['name'] = name unless name.nil?
79
+ command.query['fields'] = fields unless fields.nil?
80
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
81
+ execute_or_queue_command(command, &block)
82
+ end
83
+
84
+ # Lists information about the supported locations for this service. This method
85
+ # lists locations based on the resource scope provided in the
86
+ # ListLocationsRequest.name field: * **Global locations**: If `name` is empty,
87
+ # the method lists the public locations available to all projects. * **Project-
88
+ # specific locations**: If `name` follows the format `projects/`project``, the
89
+ # method lists locations visible to that specific project. This includes public,
90
+ # private, or other project-specific locations enabled for the project. For gRPC
91
+ # and client library implementations, the resource name is passed as the `name`
92
+ # field. For direct service calls, the resource name is incorporated into the
93
+ # request path based on the specific service implementation and version.
94
+ # @param [String] name
95
+ # The resource that owns the locations collection, if applicable.
96
+ # @param [Array<String>, String] extra_location_types
97
+ # Optional. Do not use this field unless explicitly documented otherwise. This
98
+ # is primarily for internal usage.
99
+ # @param [String] filter
100
+ # A filter to narrow down results to a preferred subset. The filtering language
101
+ # accepts strings like `"displayName=tokyo"`, and is documented in more detail
102
+ # in [AIP-160](https://google.aip.dev/160).
103
+ # @param [Fixnum] page_size
104
+ # The maximum number of results to return. If not set, the service selects a
105
+ # default.
106
+ # @param [String] page_token
107
+ # A page token received from the `next_page_token` field in the response. Send
108
+ # that page token to receive the subsequent page.
109
+ # @param [String] fields
110
+ # Selector specifying which fields to include in a partial response.
111
+ # @param [String] quota_user
112
+ # Available to use for quota purposes for server-side applications. Can be any
113
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
114
+ # @param [Google::Apis::RequestOptions] options
115
+ # Request-specific options
116
+ #
117
+ # @yield [result, err] Result & error if block supplied
118
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::ListLocationsResponse] parsed result object
119
+ # @yieldparam err [StandardError] error object if request failed
120
+ #
121
+ # @return [Google::Apis::CloudnumberregistryV1alpha::ListLocationsResponse]
122
+ #
123
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
124
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
125
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
126
+ def list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
127
+ command = make_simple_command(:get, 'v1alpha/{+name}/locations', options)
128
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::ListLocationsResponse::Representation
129
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::ListLocationsResponse
130
+ command.params['name'] = name unless name.nil?
131
+ command.query['extraLocationTypes'] = extra_location_types unless extra_location_types.nil?
132
+ command.query['filter'] = filter unless filter.nil?
133
+ command.query['pageSize'] = page_size unless page_size.nil?
134
+ command.query['pageToken'] = page_token unless page_token.nil?
135
+ command.query['fields'] = fields unless fields.nil?
136
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
137
+ execute_or_queue_command(command, &block)
138
+ end
139
+
140
+ # Creates a new CustomRange in a given project and location.
141
+ # @param [String] parent
142
+ # Required. Value for parent.
143
+ # @param [Google::Apis::CloudnumberregistryV1alpha::CustomRange] custom_range_object
144
+ # @param [String] custom_range_id
145
+ # Required. Id of the requesting object.
146
+ # @param [String] request_id
147
+ # Optional. An optional request ID to identify requests. Specify a unique
148
+ # request ID so that if you must retry your request, the server will know to
149
+ # ignore the request if it has already been completed. The server will guarantee
150
+ # that for at least 60 minutes since the first request. For example, consider a
151
+ # situation where you make an initial request and the request times out. If you
152
+ # make the request again with the same request ID, the server can check if
153
+ # original operation with the same request ID was received, and if so, will
154
+ # ignore the second request. This prevents clients from accidentally creating
155
+ # duplicate commitments. The request ID must be a valid UUID with the exception
156
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
157
+ # @param [String] fields
158
+ # Selector specifying which fields to include in a partial response.
159
+ # @param [String] quota_user
160
+ # Available to use for quota purposes for server-side applications. Can be any
161
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
162
+ # @param [Google::Apis::RequestOptions] options
163
+ # Request-specific options
164
+ #
165
+ # @yield [result, err] Result & error if block supplied
166
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Operation] parsed result object
167
+ # @yieldparam err [StandardError] error object if request failed
168
+ #
169
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Operation]
170
+ #
171
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
172
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
173
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
174
+ def create_project_location_custom_range(parent, custom_range_object = nil, custom_range_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
175
+ command = make_simple_command(:post, 'v1alpha/{+parent}/customRanges', options)
176
+ command.request_representation = Google::Apis::CloudnumberregistryV1alpha::CustomRange::Representation
177
+ command.request_object = custom_range_object
178
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Operation::Representation
179
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Operation
180
+ command.params['parent'] = parent unless parent.nil?
181
+ command.query['customRangeId'] = custom_range_id unless custom_range_id.nil?
182
+ command.query['requestId'] = request_id unless request_id.nil?
183
+ command.query['fields'] = fields unless fields.nil?
184
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
185
+ execute_or_queue_command(command, &block)
186
+ end
187
+
188
+ # Deletes a single CustomRange.
189
+ # @param [String] name
190
+ # Required. Name of the resource
191
+ # @param [Boolean] force
192
+ # Optional. If set to true, all associated resources will be deleted.
193
+ # @param [String] request_id
194
+ # Optional. An optional request ID to identify requests. Specify a unique
195
+ # request ID so that if you must retry your request, the server will know to
196
+ # ignore the request if it has already been completed. The server will guarantee
197
+ # that for at least 60 minutes after the first request. For example, consider a
198
+ # situation where you make an initial request and the request times out. If you
199
+ # make the request again with the same request ID, the server can check if
200
+ # original operation with the same request ID was received, and if so, will
201
+ # ignore the second request. This prevents clients from accidentally creating
202
+ # duplicate commitments. The request ID must be a valid UUID with the exception
203
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
204
+ # @param [String] fields
205
+ # Selector specifying which fields to include in a partial response.
206
+ # @param [String] quota_user
207
+ # Available to use for quota purposes for server-side applications. Can be any
208
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
209
+ # @param [Google::Apis::RequestOptions] options
210
+ # Request-specific options
211
+ #
212
+ # @yield [result, err] Result & error if block supplied
213
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Operation] parsed result object
214
+ # @yieldparam err [StandardError] error object if request failed
215
+ #
216
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Operation]
217
+ #
218
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
219
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
220
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
221
+ def delete_project_location_custom_range(name, force: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
222
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
223
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Operation::Representation
224
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Operation
225
+ command.params['name'] = name unless name.nil?
226
+ command.query['force'] = force unless force.nil?
227
+ command.query['requestId'] = request_id unless request_id.nil?
228
+ command.query['fields'] = fields unless fields.nil?
229
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
230
+ execute_or_queue_command(command, &block)
231
+ end
232
+
233
+ # Finds free IP ranges in a single CustomRange.
234
+ # @param [String] name
235
+ # Required. Name of the CustomRange.
236
+ # @param [Fixnum] cidr_prefix_length
237
+ # Required. The prefix length of the free IP ranges to find.
238
+ # @param [Fixnum] range_count
239
+ # Optional. The number of free IP ranges to find.
240
+ # @param [String] request_id
241
+ # Optional. An optional request ID to identify requests. Specify a unique
242
+ # request ID so that if you must retry your request, the server will know to
243
+ # ignore the request if it has already been completed. The server will guarantee
244
+ # that for at least 60 minutes since the first request. For example, consider a
245
+ # situation where you make an initial request and the request times out. If you
246
+ # make the request again with the same request ID, the server can check if
247
+ # original operation with the same request ID was received, and if so, will
248
+ # ignore the second request. This prevents clients from accidentally creating
249
+ # duplicate commitments. The request ID must be a valid UUID with the exception
250
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
251
+ # @param [String] fields
252
+ # Selector specifying which fields to include in a partial response.
253
+ # @param [String] quota_user
254
+ # Available to use for quota purposes for server-side applications. Can be any
255
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
256
+ # @param [Google::Apis::RequestOptions] options
257
+ # Request-specific options
258
+ #
259
+ # @yield [result, err] Result & error if block supplied
260
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::FindCustomRangeFreeIpRangesResponse] parsed result object
261
+ # @yieldparam err [StandardError] error object if request failed
262
+ #
263
+ # @return [Google::Apis::CloudnumberregistryV1alpha::FindCustomRangeFreeIpRangesResponse]
264
+ #
265
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
266
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
267
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
268
+ def find_project_location_custom_range_free_ip_ranges(name, cidr_prefix_length: nil, range_count: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
269
+ command = make_simple_command(:get, 'v1alpha/{+name}:findFreeIpRanges', options)
270
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::FindCustomRangeFreeIpRangesResponse::Representation
271
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::FindCustomRangeFreeIpRangesResponse
272
+ command.params['name'] = name unless name.nil?
273
+ command.query['cidrPrefixLength'] = cidr_prefix_length unless cidr_prefix_length.nil?
274
+ command.query['rangeCount'] = range_count unless range_count.nil?
275
+ command.query['requestId'] = request_id unless request_id.nil?
276
+ command.query['fields'] = fields unless fields.nil?
277
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
278
+ execute_or_queue_command(command, &block)
279
+ end
280
+
281
+ # Gets details of a single CustomRange.
282
+ # @param [String] name
283
+ # Required. Name of the resource
284
+ # @param [String] fields
285
+ # Selector specifying which fields to include in a partial response.
286
+ # @param [String] quota_user
287
+ # Available to use for quota purposes for server-side applications. Can be any
288
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
289
+ # @param [Google::Apis::RequestOptions] options
290
+ # Request-specific options
291
+ #
292
+ # @yield [result, err] Result & error if block supplied
293
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::CustomRange] parsed result object
294
+ # @yieldparam err [StandardError] error object if request failed
295
+ #
296
+ # @return [Google::Apis::CloudnumberregistryV1alpha::CustomRange]
297
+ #
298
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
299
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
300
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
301
+ def get_project_location_custom_range(name, fields: nil, quota_user: nil, options: nil, &block)
302
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
303
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::CustomRange::Representation
304
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::CustomRange
305
+ command.params['name'] = name unless name.nil?
306
+ command.query['fields'] = fields unless fields.nil?
307
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
308
+ execute_or_queue_command(command, &block)
309
+ end
310
+
311
+ # Lists CustomRanges in a given project and location.
312
+ # @param [String] parent
313
+ # Required. Parent value for ListCustomRangesRequest
314
+ # @param [String] filter
315
+ # Optional. Filtering results.
316
+ # @param [String] order_by
317
+ # Optional. Hint for how to order the results.
318
+ # @param [Fixnum] page_size
319
+ # Optional. Requested page size. Server may return fewer items than requested.
320
+ # If unspecified, server will pick an appropriate default.
321
+ # @param [String] page_token
322
+ # Optional. A token identifying a page of results the server should return.
323
+ # @param [String] fields
324
+ # Selector specifying which fields to include in a partial response.
325
+ # @param [String] quota_user
326
+ # Available to use for quota purposes for server-side applications. Can be any
327
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
328
+ # @param [Google::Apis::RequestOptions] options
329
+ # Request-specific options
330
+ #
331
+ # @yield [result, err] Result & error if block supplied
332
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::ListCustomRangesResponse] parsed result object
333
+ # @yieldparam err [StandardError] error object if request failed
334
+ #
335
+ # @return [Google::Apis::CloudnumberregistryV1alpha::ListCustomRangesResponse]
336
+ #
337
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
338
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
339
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
340
+ def list_project_location_custom_ranges(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
341
+ command = make_simple_command(:get, 'v1alpha/{+parent}/customRanges', options)
342
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::ListCustomRangesResponse::Representation
343
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::ListCustomRangesResponse
344
+ command.params['parent'] = parent unless parent.nil?
345
+ command.query['filter'] = filter unless filter.nil?
346
+ command.query['orderBy'] = order_by unless order_by.nil?
347
+ command.query['pageSize'] = page_size unless page_size.nil?
348
+ command.query['pageToken'] = page_token unless page_token.nil?
349
+ command.query['fields'] = fields unless fields.nil?
350
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
351
+ execute_or_queue_command(command, &block)
352
+ end
353
+
354
+ # Updates the parameters of a single CustomRange.
355
+ # @param [String] name
356
+ # Required. Identifier. name of resource
357
+ # @param [Google::Apis::CloudnumberregistryV1alpha::CustomRange] custom_range_object
358
+ # @param [String] request_id
359
+ # Optional. An optional request ID to identify requests. Specify a unique
360
+ # request ID so that if you must retry your request, the server will know to
361
+ # ignore the request if it has already been completed. The server will guarantee
362
+ # that for at least 60 minutes since the first request. For example, consider a
363
+ # situation where you make an initial request and the request times out. If you
364
+ # make the request again with the same request ID, the server can check if
365
+ # original operation with the same request ID was received, and if so, will
366
+ # ignore the second request. This prevents clients from accidentally creating
367
+ # duplicate commitments. The request ID must be a valid UUID with the exception
368
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
369
+ # @param [String] update_mask
370
+ # Optional. Field mask is used to specify the fields to be overwritten in the
371
+ # CustomRange resource by the update. The fields specified in the update_mask
372
+ # are relative to the resource, not the full request. A field will be
373
+ # overwritten if it is in the mask. If the user does not provide a mask then all
374
+ # fields will be overwritten.
375
+ # @param [String] fields
376
+ # Selector specifying which fields to include in a partial response.
377
+ # @param [String] quota_user
378
+ # Available to use for quota purposes for server-side applications. Can be any
379
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
380
+ # @param [Google::Apis::RequestOptions] options
381
+ # Request-specific options
382
+ #
383
+ # @yield [result, err] Result & error if block supplied
384
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Operation] parsed result object
385
+ # @yieldparam err [StandardError] error object if request failed
386
+ #
387
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Operation]
388
+ #
389
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
390
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
391
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
392
+ def patch_project_location_custom_range(name, custom_range_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
393
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
394
+ command.request_representation = Google::Apis::CloudnumberregistryV1alpha::CustomRange::Representation
395
+ command.request_object = custom_range_object
396
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Operation::Representation
397
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Operation
398
+ command.params['name'] = name unless name.nil?
399
+ command.query['requestId'] = request_id unless request_id.nil?
400
+ command.query['updateMask'] = update_mask unless update_mask.nil?
401
+ command.query['fields'] = fields unless fields.nil?
402
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
403
+ execute_or_queue_command(command, &block)
404
+ end
405
+
406
+ # Gets the details of a single CustomRange and its utilization.
407
+ # @param [String] name
408
+ # Required. Name of the resource
409
+ # @param [String] fields
410
+ # Selector specifying which fields to include in a partial response.
411
+ # @param [String] quota_user
412
+ # Available to use for quota purposes for server-side applications. Can be any
413
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
414
+ # @param [Google::Apis::RequestOptions] options
415
+ # Request-specific options
416
+ #
417
+ # @yield [result, err] Result & error if block supplied
418
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::ShowCustomRangeUtilizationResponse] parsed result object
419
+ # @yieldparam err [StandardError] error object if request failed
420
+ #
421
+ # @return [Google::Apis::CloudnumberregistryV1alpha::ShowCustomRangeUtilizationResponse]
422
+ #
423
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
424
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
425
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
426
+ def show_project_location_custom_range_utilization(name, fields: nil, quota_user: nil, options: nil, &block)
427
+ command = make_simple_command(:get, 'v1alpha/{+name}:showUtilization', options)
428
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::ShowCustomRangeUtilizationResponse::Representation
429
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::ShowCustomRangeUtilizationResponse
430
+ command.params['name'] = name unless name.nil?
431
+ command.query['fields'] = fields unless fields.nil?
432
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
433
+ execute_or_queue_command(command, &block)
434
+ end
435
+
436
+ # Finds free IP ranges in a single DiscoveredRange.
437
+ # @param [String] name
438
+ # Required. Name of the DiscoveredRange.
439
+ # @param [Fixnum] cidr_prefix_length
440
+ # Required. The prefix length of the free IP ranges to find.
441
+ # @param [Fixnum] range_count
442
+ # Optional. The number of free IP ranges to find.
443
+ # @param [String] request_id
444
+ # Optional. An optional request ID to identify requests. Specify a unique
445
+ # request ID so that if you must retry your request, the server will know to
446
+ # ignore the request if it has already been completed. The server will guarantee
447
+ # that for at least 60 minutes since the first request. For example, consider a
448
+ # situation where you make an initial request and the request times out. If you
449
+ # make the request again with the same request ID, the server can check if
450
+ # original operation with the same request ID was received, and if so, will
451
+ # ignore the second request. This prevents clients from accidentally creating
452
+ # duplicate commitments. The request ID must be a valid UUID with the exception
453
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
454
+ # @param [String] fields
455
+ # Selector specifying which fields to include in a partial response.
456
+ # @param [String] quota_user
457
+ # Available to use for quota purposes for server-side applications. Can be any
458
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
459
+ # @param [Google::Apis::RequestOptions] options
460
+ # Request-specific options
461
+ #
462
+ # @yield [result, err] Result & error if block supplied
463
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::FindDiscoveredRangeFreeIpRangesResponse] parsed result object
464
+ # @yieldparam err [StandardError] error object if request failed
465
+ #
466
+ # @return [Google::Apis::CloudnumberregistryV1alpha::FindDiscoveredRangeFreeIpRangesResponse]
467
+ #
468
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
469
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
470
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
471
+ def find_project_location_discovered_range_free_ip_ranges(name, cidr_prefix_length: nil, range_count: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
472
+ command = make_simple_command(:get, 'v1alpha/{+name}:findFreeIpRanges', options)
473
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::FindDiscoveredRangeFreeIpRangesResponse::Representation
474
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::FindDiscoveredRangeFreeIpRangesResponse
475
+ command.params['name'] = name unless name.nil?
476
+ command.query['cidrPrefixLength'] = cidr_prefix_length unless cidr_prefix_length.nil?
477
+ command.query['rangeCount'] = range_count unless range_count.nil?
478
+ command.query['requestId'] = request_id unless request_id.nil?
479
+ command.query['fields'] = fields unless fields.nil?
480
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
481
+ execute_or_queue_command(command, &block)
482
+ end
483
+
484
+ # Gets details of a single DiscoveredRange.
485
+ # @param [String] name
486
+ # Required. Name of the resource
487
+ # @param [String] fields
488
+ # Selector specifying which fields to include in a partial response.
489
+ # @param [String] quota_user
490
+ # Available to use for quota purposes for server-side applications. Can be any
491
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
492
+ # @param [Google::Apis::RequestOptions] options
493
+ # Request-specific options
494
+ #
495
+ # @yield [result, err] Result & error if block supplied
496
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::DiscoveredRange] parsed result object
497
+ # @yieldparam err [StandardError] error object if request failed
498
+ #
499
+ # @return [Google::Apis::CloudnumberregistryV1alpha::DiscoveredRange]
500
+ #
501
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
502
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
503
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
504
+ def get_project_location_discovered_range(name, fields: nil, quota_user: nil, options: nil, &block)
505
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
506
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::DiscoveredRange::Representation
507
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::DiscoveredRange
508
+ command.params['name'] = name unless name.nil?
509
+ command.query['fields'] = fields unless fields.nil?
510
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
511
+ execute_or_queue_command(command, &block)
512
+ end
513
+
514
+ # Lists DiscoveredRanges in a given project and location.
515
+ # @param [String] parent
516
+ # Required. Parent value for ListDiscoveredRangesRequest
517
+ # @param [String] filter
518
+ # Optional. Filtering results.
519
+ # @param [String] order_by
520
+ # Optional. Hint for how to order the results.
521
+ # @param [Fixnum] page_size
522
+ # Optional. Requested page size. Server may return fewer items than requested.
523
+ # If unspecified, server will pick an appropriate default.
524
+ # @param [String] page_token
525
+ # Optional. A token identifying a page of results the server should return.
526
+ # @param [String] fields
527
+ # Selector specifying which fields to include in a partial response.
528
+ # @param [String] quota_user
529
+ # Available to use for quota purposes for server-side applications. Can be any
530
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
531
+ # @param [Google::Apis::RequestOptions] options
532
+ # Request-specific options
533
+ #
534
+ # @yield [result, err] Result & error if block supplied
535
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::ListDiscoveredRangesResponse] parsed result object
536
+ # @yieldparam err [StandardError] error object if request failed
537
+ #
538
+ # @return [Google::Apis::CloudnumberregistryV1alpha::ListDiscoveredRangesResponse]
539
+ #
540
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
541
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
542
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
543
+ def list_project_location_discovered_ranges(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
544
+ command = make_simple_command(:get, 'v1alpha/{+parent}/discoveredRanges', options)
545
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::ListDiscoveredRangesResponse::Representation
546
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::ListDiscoveredRangesResponse
547
+ command.params['parent'] = parent unless parent.nil?
548
+ command.query['filter'] = filter unless filter.nil?
549
+ command.query['orderBy'] = order_by unless order_by.nil?
550
+ command.query['pageSize'] = page_size unless page_size.nil?
551
+ command.query['pageToken'] = page_token unless page_token.nil?
552
+ command.query['fields'] = fields unless fields.nil?
553
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
554
+ execute_or_queue_command(command, &block)
555
+ end
556
+
557
+ # Gets the details of a single DiscoveredRange and its utilization.
558
+ # @param [String] name
559
+ # Required. Name of the resource
560
+ # @param [String] fields
561
+ # Selector specifying which fields to include in a partial response.
562
+ # @param [String] quota_user
563
+ # Available to use for quota purposes for server-side applications. Can be any
564
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
565
+ # @param [Google::Apis::RequestOptions] options
566
+ # Request-specific options
567
+ #
568
+ # @yield [result, err] Result & error if block supplied
569
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::ShowDiscoveredRangeUtilizationResponse] parsed result object
570
+ # @yieldparam err [StandardError] error object if request failed
571
+ #
572
+ # @return [Google::Apis::CloudnumberregistryV1alpha::ShowDiscoveredRangeUtilizationResponse]
573
+ #
574
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
575
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
576
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
577
+ def show_project_location_discovered_range_utilization(name, fields: nil, quota_user: nil, options: nil, &block)
578
+ command = make_simple_command(:get, 'v1alpha/{+name}:showUtilization', options)
579
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::ShowDiscoveredRangeUtilizationResponse::Representation
580
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::ShowDiscoveredRangeUtilizationResponse
581
+ command.params['name'] = name unless name.nil?
582
+ command.query['fields'] = fields unless fields.nil?
583
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
584
+ execute_or_queue_command(command, &block)
585
+ end
586
+
587
+ # Checks the availability of IPAM admin scopes in a given project and location.
588
+ # @param [String] parent
589
+ # Required. Parent value for the IpamAdminScopes.
590
+ # @param [Array<String>, String] scopes
591
+ # Required. The scopes of the IpamAdminScopes to look for.
592
+ # @param [String] fields
593
+ # Selector specifying which fields to include in a partial response.
594
+ # @param [String] quota_user
595
+ # Available to use for quota purposes for server-side applications. Can be any
596
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
597
+ # @param [Google::Apis::RequestOptions] options
598
+ # Request-specific options
599
+ #
600
+ # @yield [result, err] Result & error if block supplied
601
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::CheckAvailabilityIpamAdminScopesResponse] parsed result object
602
+ # @yieldparam err [StandardError] error object if request failed
603
+ #
604
+ # @return [Google::Apis::CloudnumberregistryV1alpha::CheckAvailabilityIpamAdminScopesResponse]
605
+ #
606
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
607
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
608
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
609
+ def check_project_location_ipam_admin_scope_availability(parent, scopes: nil, fields: nil, quota_user: nil, options: nil, &block)
610
+ command = make_simple_command(:get, 'v1alpha/{+parent}/ipamAdminScopes:checkAvailability', options)
611
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::CheckAvailabilityIpamAdminScopesResponse::Representation
612
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::CheckAvailabilityIpamAdminScopesResponse
613
+ command.params['parent'] = parent unless parent.nil?
614
+ command.query['scopes'] = scopes unless scopes.nil?
615
+ command.query['fields'] = fields unless fields.nil?
616
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
617
+ execute_or_queue_command(command, &block)
618
+ end
619
+
620
+ # Cleans up a single IpamAdminScope.
621
+ # @param [String] name
622
+ # Required. Name of the resource
623
+ # @param [Google::Apis::CloudnumberregistryV1alpha::CleanupIpamAdminScopeRequest] cleanup_ipam_admin_scope_request_object
624
+ # @param [String] fields
625
+ # Selector specifying which fields to include in a partial response.
626
+ # @param [String] quota_user
627
+ # Available to use for quota purposes for server-side applications. Can be any
628
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
629
+ # @param [Google::Apis::RequestOptions] options
630
+ # Request-specific options
631
+ #
632
+ # @yield [result, err] Result & error if block supplied
633
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Operation] parsed result object
634
+ # @yieldparam err [StandardError] error object if request failed
635
+ #
636
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Operation]
637
+ #
638
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
639
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
640
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
641
+ def cleanup_ipam_admin_scope(name, cleanup_ipam_admin_scope_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
642
+ command = make_simple_command(:post, 'v1alpha/{+name}:cleanup', options)
643
+ command.request_representation = Google::Apis::CloudnumberregistryV1alpha::CleanupIpamAdminScopeRequest::Representation
644
+ command.request_object = cleanup_ipam_admin_scope_request_object
645
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Operation::Representation
646
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Operation
647
+ command.params['name'] = name unless name.nil?
648
+ command.query['fields'] = fields unless fields.nil?
649
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
650
+ execute_or_queue_command(command, &block)
651
+ end
652
+
653
+ # Creates a new IpamAdminScope in a given project and location.
654
+ # @param [String] parent
655
+ # Required. Value for parent.
656
+ # @param [Google::Apis::CloudnumberregistryV1alpha::IpamAdminScope] ipam_admin_scope_object
657
+ # @param [String] ipam_admin_scope_id
658
+ # Required. Id of the requesting object.
659
+ # @param [String] request_id
660
+ # Optional. An optional request ID to identify requests. Specify a unique
661
+ # request ID so that if you must retry your request, the server will know to
662
+ # ignore the request if it has already been completed. The server will guarantee
663
+ # that for at least 60 minutes since the first request. For example, consider a
664
+ # situation where you make an initial request and the request times out. If you
665
+ # make the request again with the same request ID, the server can check if
666
+ # original operation with the same request ID was received, and if so, will
667
+ # ignore the second request. This prevents clients from accidentally creating
668
+ # duplicate commitments. The request ID must be a valid UUID with the exception
669
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
670
+ # @param [String] fields
671
+ # Selector specifying which fields to include in a partial response.
672
+ # @param [String] quota_user
673
+ # Available to use for quota purposes for server-side applications. Can be any
674
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
675
+ # @param [Google::Apis::RequestOptions] options
676
+ # Request-specific options
677
+ #
678
+ # @yield [result, err] Result & error if block supplied
679
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Operation] parsed result object
680
+ # @yieldparam err [StandardError] error object if request failed
681
+ #
682
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Operation]
683
+ #
684
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
685
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
686
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
687
+ def create_project_location_ipam_admin_scope(parent, ipam_admin_scope_object = nil, ipam_admin_scope_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
688
+ command = make_simple_command(:post, 'v1alpha/{+parent}/ipamAdminScopes', options)
689
+ command.request_representation = Google::Apis::CloudnumberregistryV1alpha::IpamAdminScope::Representation
690
+ command.request_object = ipam_admin_scope_object
691
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Operation::Representation
692
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Operation
693
+ command.params['parent'] = parent unless parent.nil?
694
+ command.query['ipamAdminScopeId'] = ipam_admin_scope_id unless ipam_admin_scope_id.nil?
695
+ command.query['requestId'] = request_id unless request_id.nil?
696
+ command.query['fields'] = fields unless fields.nil?
697
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
698
+ execute_or_queue_command(command, &block)
699
+ end
700
+
701
+ # Deletes a single IpamAdminScope.
702
+ # @param [String] name
703
+ # Required. Name of the resource
704
+ # @param [Boolean] force
705
+ # Optional. If set to true, all associated resources will be deleted.
706
+ # @param [String] request_id
707
+ # Optional. An optional request ID to identify requests. Specify a unique
708
+ # request ID so that if you must retry your request, the server will know to
709
+ # ignore the request if it has already been completed. The server will guarantee
710
+ # that for at least 60 minutes after the first request. For example, consider a
711
+ # situation where you make an initial request and the request times out. If you
712
+ # make the request again with the same request ID, the server can check if
713
+ # original operation with the same request ID was received, and if so, will
714
+ # ignore the second request. This prevents clients from accidentally creating
715
+ # duplicate commitments. The request ID must be a valid UUID with the exception
716
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
717
+ # @param [String] fields
718
+ # Selector specifying which fields to include in a partial response.
719
+ # @param [String] quota_user
720
+ # Available to use for quota purposes for server-side applications. Can be any
721
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
722
+ # @param [Google::Apis::RequestOptions] options
723
+ # Request-specific options
724
+ #
725
+ # @yield [result, err] Result & error if block supplied
726
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Operation] parsed result object
727
+ # @yieldparam err [StandardError] error object if request failed
728
+ #
729
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Operation]
730
+ #
731
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
732
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
733
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
734
+ def delete_project_location_ipam_admin_scope(name, force: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
735
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
736
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Operation::Representation
737
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Operation
738
+ command.params['name'] = name unless name.nil?
739
+ command.query['force'] = force unless force.nil?
740
+ command.query['requestId'] = request_id unless request_id.nil?
741
+ command.query['fields'] = fields unless fields.nil?
742
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
743
+ execute_or_queue_command(command, &block)
744
+ end
745
+
746
+ # Disables a single IpamAdminScope.
747
+ # @param [String] name
748
+ # Required. Name of the resource
749
+ # @param [Google::Apis::CloudnumberregistryV1alpha::DisableIpamAdminScopeRequest] disable_ipam_admin_scope_request_object
750
+ # @param [String] fields
751
+ # Selector specifying which fields to include in a partial response.
752
+ # @param [String] quota_user
753
+ # Available to use for quota purposes for server-side applications. Can be any
754
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
755
+ # @param [Google::Apis::RequestOptions] options
756
+ # Request-specific options
757
+ #
758
+ # @yield [result, err] Result & error if block supplied
759
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Operation] parsed result object
760
+ # @yieldparam err [StandardError] error object if request failed
761
+ #
762
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Operation]
763
+ #
764
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
765
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
766
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
767
+ def disable_ipam_admin_scope(name, disable_ipam_admin_scope_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
768
+ command = make_simple_command(:post, 'v1alpha/{+name}:disable', options)
769
+ command.request_representation = Google::Apis::CloudnumberregistryV1alpha::DisableIpamAdminScopeRequest::Representation
770
+ command.request_object = disable_ipam_admin_scope_request_object
771
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Operation::Representation
772
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Operation
773
+ command.params['name'] = name unless name.nil?
774
+ command.query['fields'] = fields unless fields.nil?
775
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
776
+ execute_or_queue_command(command, &block)
777
+ end
778
+
779
+ # Gets details of a single IpamAdminScope.
780
+ # @param [String] name
781
+ # Required. Name of the resource
782
+ # @param [String] fields
783
+ # Selector specifying which fields to include in a partial response.
784
+ # @param [String] quota_user
785
+ # Available to use for quota purposes for server-side applications. Can be any
786
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
787
+ # @param [Google::Apis::RequestOptions] options
788
+ # Request-specific options
789
+ #
790
+ # @yield [result, err] Result & error if block supplied
791
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::IpamAdminScope] parsed result object
792
+ # @yieldparam err [StandardError] error object if request failed
793
+ #
794
+ # @return [Google::Apis::CloudnumberregistryV1alpha::IpamAdminScope]
795
+ #
796
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
797
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
798
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
799
+ def get_project_location_ipam_admin_scope(name, fields: nil, quota_user: nil, options: nil, &block)
800
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
801
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::IpamAdminScope::Representation
802
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::IpamAdminScope
803
+ command.params['name'] = name unless name.nil?
804
+ command.query['fields'] = fields unless fields.nil?
805
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
806
+ execute_or_queue_command(command, &block)
807
+ end
808
+
809
+ # List all IPAM admin scopes in a given project and location.
810
+ # @param [String] parent
811
+ # Required. Parent value for ListIpamAdminScopesRequest
812
+ # @param [String] filter
813
+ # Optional. Filtering results
814
+ # @param [String] order_by
815
+ # Optional. Hint for how to order the results
816
+ # @param [Fixnum] page_size
817
+ # Optional. Requested page size. Server may return fewer items than requested.
818
+ # If unspecified, server will pick an appropriate default.
819
+ # @param [String] page_token
820
+ # Optional. A token identifying a page of results the server should return.
821
+ # @param [String] fields
822
+ # Selector specifying which fields to include in a partial response.
823
+ # @param [String] quota_user
824
+ # Available to use for quota purposes for server-side applications. Can be any
825
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
826
+ # @param [Google::Apis::RequestOptions] options
827
+ # Request-specific options
828
+ #
829
+ # @yield [result, err] Result & error if block supplied
830
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::ListIpamAdminScopesResponse] parsed result object
831
+ # @yieldparam err [StandardError] error object if request failed
832
+ #
833
+ # @return [Google::Apis::CloudnumberregistryV1alpha::ListIpamAdminScopesResponse]
834
+ #
835
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
836
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
837
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
838
+ def list_project_location_ipam_admin_scopes(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
839
+ command = make_simple_command(:get, 'v1alpha/{+parent}/ipamAdminScopes', options)
840
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::ListIpamAdminScopesResponse::Representation
841
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::ListIpamAdminScopesResponse
842
+ command.params['parent'] = parent unless parent.nil?
843
+ command.query['filter'] = filter unless filter.nil?
844
+ command.query['orderBy'] = order_by unless order_by.nil?
845
+ command.query['pageSize'] = page_size unless page_size.nil?
846
+ command.query['pageToken'] = page_token unless page_token.nil?
847
+ command.query['fields'] = fields unless fields.nil?
848
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
849
+ execute_or_queue_command(command, &block)
850
+ end
851
+
852
+ # Updates the parameters of a single IpamAdminScope.
853
+ # @param [String] name
854
+ # Required. Identifier. name of resource
855
+ # @param [Google::Apis::CloudnumberregistryV1alpha::IpamAdminScope] ipam_admin_scope_object
856
+ # @param [String] request_id
857
+ # Optional. An optional request ID to identify requests. Specify a unique
858
+ # request ID so that if you must retry your request, the server will know to
859
+ # ignore the request if it has already been completed. The server will guarantee
860
+ # that for at least 60 minutes since the first request. For example, consider a
861
+ # situation where you make an initial request and the request times out. If you
862
+ # make the request again with the same request ID, the server can check if
863
+ # original operation with the same request ID was received, and if so, will
864
+ # ignore the second request. This prevents clients from accidentally creating
865
+ # duplicate commitments. The request ID must be a valid UUID with the exception
866
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
867
+ # @param [String] update_mask
868
+ # Optional. Field mask is used to specify the fields to be overwritten in the
869
+ # IpamAdminScope resource by the update. The fields specified in the update_mask
870
+ # are relative to the resource, not the full request. A field will be
871
+ # overwritten if it is in the mask. If the user does not provide a mask then all
872
+ # fields will be overwritten.
873
+ # @param [String] fields
874
+ # Selector specifying which fields to include in a partial response.
875
+ # @param [String] quota_user
876
+ # Available to use for quota purposes for server-side applications. Can be any
877
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
878
+ # @param [Google::Apis::RequestOptions] options
879
+ # Request-specific options
880
+ #
881
+ # @yield [result, err] Result & error if block supplied
882
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Operation] parsed result object
883
+ # @yieldparam err [StandardError] error object if request failed
884
+ #
885
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Operation]
886
+ #
887
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
888
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
889
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
890
+ def patch_project_location_ipam_admin_scope(name, ipam_admin_scope_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
891
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
892
+ command.request_representation = Google::Apis::CloudnumberregistryV1alpha::IpamAdminScope::Representation
893
+ command.request_object = ipam_admin_scope_object
894
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Operation::Representation
895
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Operation
896
+ command.params['name'] = name unless name.nil?
897
+ command.query['requestId'] = request_id unless request_id.nil?
898
+ command.query['updateMask'] = update_mask unless update_mask.nil?
899
+ command.query['fields'] = fields unless fields.nil?
900
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
901
+ execute_or_queue_command(command, &block)
902
+ end
903
+
904
+ # Starts asynchronous cancellation on a long-running operation. The server makes
905
+ # a best effort to cancel the operation, but success is not guaranteed. If the
906
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
907
+ # Clients can use Operations.GetOperation or other methods to check whether the
908
+ # cancellation succeeded or whether the operation completed despite cancellation.
909
+ # On successful cancellation, the operation is not deleted; instead, it becomes
910
+ # an operation with an Operation.error value with a google.rpc.Status.code of `1`
911
+ # , corresponding to `Code.CANCELLED`.
912
+ # @param [String] name
913
+ # The name of the operation resource to be cancelled.
914
+ # @param [Google::Apis::CloudnumberregistryV1alpha::CancelOperationRequest] cancel_operation_request_object
915
+ # @param [String] fields
916
+ # Selector specifying which fields to include in a partial response.
917
+ # @param [String] quota_user
918
+ # Available to use for quota purposes for server-side applications. Can be any
919
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
920
+ # @param [Google::Apis::RequestOptions] options
921
+ # Request-specific options
922
+ #
923
+ # @yield [result, err] Result & error if block supplied
924
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Empty] parsed result object
925
+ # @yieldparam err [StandardError] error object if request failed
926
+ #
927
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Empty]
928
+ #
929
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
930
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
931
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
932
+ def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
933
+ command = make_simple_command(:post, 'v1alpha/{+name}:cancel', options)
934
+ command.request_representation = Google::Apis::CloudnumberregistryV1alpha::CancelOperationRequest::Representation
935
+ command.request_object = cancel_operation_request_object
936
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Empty::Representation
937
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Empty
938
+ command.params['name'] = name unless name.nil?
939
+ command.query['fields'] = fields unless fields.nil?
940
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
941
+ execute_or_queue_command(command, &block)
942
+ end
943
+
944
+ # Deletes a long-running operation. This method indicates that the client is no
945
+ # longer interested in the operation result. It does not cancel the operation.
946
+ # If the server doesn't support this method, it returns `google.rpc.Code.
947
+ # UNIMPLEMENTED`.
948
+ # @param [String] name
949
+ # The name of the operation resource to be deleted.
950
+ # @param [String] fields
951
+ # Selector specifying which fields to include in a partial response.
952
+ # @param [String] quota_user
953
+ # Available to use for quota purposes for server-side applications. Can be any
954
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
955
+ # @param [Google::Apis::RequestOptions] options
956
+ # Request-specific options
957
+ #
958
+ # @yield [result, err] Result & error if block supplied
959
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Empty] parsed result object
960
+ # @yieldparam err [StandardError] error object if request failed
961
+ #
962
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Empty]
963
+ #
964
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
965
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
966
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
967
+ def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
968
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
969
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Empty::Representation
970
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Empty
971
+ command.params['name'] = name unless name.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
+ # Gets the latest state of a long-running operation. Clients can use this method
978
+ # to poll the operation result at intervals as recommended by the API service.
979
+ # @param [String] name
980
+ # The name of the operation resource.
981
+ # @param [String] fields
982
+ # Selector specifying which fields to include in a partial response.
983
+ # @param [String] quota_user
984
+ # Available to use for quota purposes for server-side applications. Can be any
985
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
986
+ # @param [Google::Apis::RequestOptions] options
987
+ # Request-specific options
988
+ #
989
+ # @yield [result, err] Result & error if block supplied
990
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Operation] parsed result object
991
+ # @yieldparam err [StandardError] error object if request failed
992
+ #
993
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Operation]
994
+ #
995
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
996
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
997
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
998
+ def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
999
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1000
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Operation::Representation
1001
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Operation
1002
+ command.params['name'] = name unless name.nil?
1003
+ command.query['fields'] = fields unless fields.nil?
1004
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1005
+ execute_or_queue_command(command, &block)
1006
+ end
1007
+
1008
+ # Lists operations that match the specified filter in the request. If the server
1009
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
1010
+ # @param [String] name
1011
+ # The name of the operation's parent resource.
1012
+ # @param [String] filter
1013
+ # The standard list filter.
1014
+ # @param [Fixnum] page_size
1015
+ # The standard list page size.
1016
+ # @param [String] page_token
1017
+ # The standard list page token.
1018
+ # @param [Boolean] return_partial_success
1019
+ # When set to `true`, operations that are reachable are returned as normal, and
1020
+ # those that are unreachable are returned in the ListOperationsResponse.
1021
+ # unreachable field. This can only be `true` when reading across collections.
1022
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
1023
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
1024
+ # if set unless explicitly documented otherwise in service or product specific
1025
+ # documentation.
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::CloudnumberregistryV1alpha::ListOperationsResponse] parsed result object
1036
+ # @yieldparam err [StandardError] error object if request failed
1037
+ #
1038
+ # @return [Google::Apis::CloudnumberregistryV1alpha::ListOperationsResponse]
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 list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
1044
+ command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
1045
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::ListOperationsResponse::Representation
1046
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::ListOperationsResponse
1047
+ command.params['name'] = name unless name.nil?
1048
+ command.query['filter'] = filter unless filter.nil?
1049
+ command.query['pageSize'] = page_size unless page_size.nil?
1050
+ command.query['pageToken'] = page_token unless page_token.nil?
1051
+ command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
1052
+ command.query['fields'] = fields unless fields.nil?
1053
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1054
+ execute_or_queue_command(command, &block)
1055
+ end
1056
+
1057
+ # Creates a new Realm in a given project and location.
1058
+ # @param [String] parent
1059
+ # Required. Value for parent.
1060
+ # @param [Google::Apis::CloudnumberregistryV1alpha::Realm] realm_object
1061
+ # @param [String] realm_id
1062
+ # Required. Id of the requesting object.
1063
+ # @param [String] request_id
1064
+ # Optional. An optional request ID to identify requests. Specify a unique
1065
+ # request ID so that if you must retry your request, the server will know to
1066
+ # ignore the request if it has already been completed. The server will guarantee
1067
+ # that for at least 60 minutes since the first request.
1068
+ # @param [String] fields
1069
+ # Selector specifying which fields to include in a partial response.
1070
+ # @param [String] quota_user
1071
+ # Available to use for quota purposes for server-side applications. Can be any
1072
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1073
+ # @param [Google::Apis::RequestOptions] options
1074
+ # Request-specific options
1075
+ #
1076
+ # @yield [result, err] Result & error if block supplied
1077
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Operation] parsed result object
1078
+ # @yieldparam err [StandardError] error object if request failed
1079
+ #
1080
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Operation]
1081
+ #
1082
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1083
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1084
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1085
+ def create_project_location_realm(parent, realm_object = nil, realm_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1086
+ command = make_simple_command(:post, 'v1alpha/{+parent}/realms', options)
1087
+ command.request_representation = Google::Apis::CloudnumberregistryV1alpha::Realm::Representation
1088
+ command.request_object = realm_object
1089
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Operation::Representation
1090
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Operation
1091
+ command.params['parent'] = parent unless parent.nil?
1092
+ command.query['realmId'] = realm_id unless realm_id.nil?
1093
+ command.query['requestId'] = request_id unless request_id.nil?
1094
+ command.query['fields'] = fields unless fields.nil?
1095
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1096
+ execute_or_queue_command(command, &block)
1097
+ end
1098
+
1099
+ # Deletes a single Realm.
1100
+ # @param [String] name
1101
+ # Required. Name of the resource
1102
+ # @param [Boolean] force
1103
+ # Optional. If set to true, all associated resources will be deleted.
1104
+ # @param [String] request_id
1105
+ # Optional. An optional request ID to identify requests. Specify a unique
1106
+ # request ID so that if you must retry your request, the server will know to
1107
+ # ignore the request if it has already been completed. The server will guarantee
1108
+ # that for at least 60 minutes after the first request.
1109
+ # @param [String] fields
1110
+ # Selector specifying which fields to include in a partial response.
1111
+ # @param [String] quota_user
1112
+ # Available to use for quota purposes for server-side applications. Can be any
1113
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1114
+ # @param [Google::Apis::RequestOptions] options
1115
+ # Request-specific options
1116
+ #
1117
+ # @yield [result, err] Result & error if block supplied
1118
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Operation] parsed result object
1119
+ # @yieldparam err [StandardError] error object if request failed
1120
+ #
1121
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Operation]
1122
+ #
1123
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1124
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1125
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1126
+ def delete_project_location_realm(name, force: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1127
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
1128
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Operation::Representation
1129
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Operation
1130
+ command.params['name'] = name unless name.nil?
1131
+ command.query['force'] = force unless force.nil?
1132
+ command.query['requestId'] = request_id unless request_id.nil?
1133
+ command.query['fields'] = fields unless fields.nil?
1134
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1135
+ execute_or_queue_command(command, &block)
1136
+ end
1137
+
1138
+ # Gets details of a single Realm.
1139
+ # @param [String] name
1140
+ # Required. Name of the resource
1141
+ # @param [String] view
1142
+ # Optional. The view of the Realm.
1143
+ # @param [String] fields
1144
+ # Selector specifying which fields to include in a partial response.
1145
+ # @param [String] quota_user
1146
+ # Available to use for quota purposes for server-side applications. Can be any
1147
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1148
+ # @param [Google::Apis::RequestOptions] options
1149
+ # Request-specific options
1150
+ #
1151
+ # @yield [result, err] Result & error if block supplied
1152
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Realm] parsed result object
1153
+ # @yieldparam err [StandardError] error object if request failed
1154
+ #
1155
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Realm]
1156
+ #
1157
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1158
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1159
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1160
+ def get_project_location_realm(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
1161
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1162
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Realm::Representation
1163
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Realm
1164
+ command.params['name'] = name unless name.nil?
1165
+ command.query['view'] = view unless view.nil?
1166
+ command.query['fields'] = fields unless fields.nil?
1167
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1168
+ execute_or_queue_command(command, &block)
1169
+ end
1170
+
1171
+ # Lists Realms in a given project and location.
1172
+ # @param [String] parent
1173
+ # Required. Parent value for ListRealmsRequest
1174
+ # @param [String] filter
1175
+ # Optional. Filtering results
1176
+ # @param [String] order_by
1177
+ # Optional. Hint for how to order the results
1178
+ # @param [Fixnum] page_size
1179
+ # Optional. Requested page size. Server may return fewer items than requested.
1180
+ # If unspecified, server will pick an appropriate default.
1181
+ # @param [String] page_token
1182
+ # Optional. A token identifying a page of results the server should return.
1183
+ # @param [String] view
1184
+ # Optional. The view of the Realm.
1185
+ # @param [String] fields
1186
+ # Selector specifying which fields to include in a partial response.
1187
+ # @param [String] quota_user
1188
+ # Available to use for quota purposes for server-side applications. Can be any
1189
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1190
+ # @param [Google::Apis::RequestOptions] options
1191
+ # Request-specific options
1192
+ #
1193
+ # @yield [result, err] Result & error if block supplied
1194
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::ListRealmsResponse] parsed result object
1195
+ # @yieldparam err [StandardError] error object if request failed
1196
+ #
1197
+ # @return [Google::Apis::CloudnumberregistryV1alpha::ListRealmsResponse]
1198
+ #
1199
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1200
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1201
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1202
+ def list_project_location_realms(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
1203
+ command = make_simple_command(:get, 'v1alpha/{+parent}/realms', options)
1204
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::ListRealmsResponse::Representation
1205
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::ListRealmsResponse
1206
+ command.params['parent'] = parent unless parent.nil?
1207
+ command.query['filter'] = filter unless filter.nil?
1208
+ command.query['orderBy'] = order_by unless order_by.nil?
1209
+ command.query['pageSize'] = page_size unless page_size.nil?
1210
+ command.query['pageToken'] = page_token unless page_token.nil?
1211
+ command.query['view'] = view unless view.nil?
1212
+ command.query['fields'] = fields unless fields.nil?
1213
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1214
+ execute_or_queue_command(command, &block)
1215
+ end
1216
+
1217
+ # Updates the parameters of a single Realm.
1218
+ # @param [String] name
1219
+ # Required. Identifier. Unique name/ID of the realm
1220
+ # @param [Google::Apis::CloudnumberregistryV1alpha::Realm] realm_object
1221
+ # @param [String] request_id
1222
+ # Optional. An optional request ID to identify requests. Specify a unique
1223
+ # request ID so that if you must retry your request, the server will know to
1224
+ # ignore the request if it has already been completed. The server will guarantee
1225
+ # that for at least 60 minutes since the first request.
1226
+ # @param [String] update_mask
1227
+ # Optional. Field mask is used to specify the fields to be overwritten in the
1228
+ # Realm resource by the update.
1229
+ # @param [String] fields
1230
+ # Selector specifying which fields to include in a partial response.
1231
+ # @param [String] quota_user
1232
+ # Available to use for quota purposes for server-side applications. Can be any
1233
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1234
+ # @param [Google::Apis::RequestOptions] options
1235
+ # Request-specific options
1236
+ #
1237
+ # @yield [result, err] Result & error if block supplied
1238
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Operation] parsed result object
1239
+ # @yieldparam err [StandardError] error object if request failed
1240
+ #
1241
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Operation]
1242
+ #
1243
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1244
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1245
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1246
+ def patch_project_location_realm(name, realm_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1247
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
1248
+ command.request_representation = Google::Apis::CloudnumberregistryV1alpha::Realm::Representation
1249
+ command.request_object = realm_object
1250
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Operation::Representation
1251
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Operation
1252
+ command.params['name'] = name unless name.nil?
1253
+ command.query['requestId'] = request_id unless request_id.nil?
1254
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1255
+ command.query['fields'] = fields unless fields.nil?
1256
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1257
+ execute_or_queue_command(command, &block)
1258
+ end
1259
+
1260
+ # Creates a new RegistryBook in a given project and location.
1261
+ # @param [String] parent
1262
+ # Required. Value for parent.
1263
+ # @param [Google::Apis::CloudnumberregistryV1alpha::RegistryBook] registry_book_object
1264
+ # @param [String] registry_book_id
1265
+ # Required. Id of the requesting object.
1266
+ # @param [String] request_id
1267
+ # Optional. An optional request ID to identify requests. Specify a unique
1268
+ # request ID so that if you must retry your request, the server will know to
1269
+ # ignore the request if it has already been completed. The server will guarantee
1270
+ # that for at least 60 minutes since the first request. For example, consider a
1271
+ # situation where you make an initial request and the request times out. If you
1272
+ # make the request again with the same request ID, the server can check if
1273
+ # original operation with the same request ID was received, and if so, will
1274
+ # ignore the second request. This prevents clients from accidentally creating
1275
+ # duplicate commitments. The request ID must be a valid UUID with the exception
1276
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1277
+ # @param [String] fields
1278
+ # Selector specifying which fields to include in a partial response.
1279
+ # @param [String] quota_user
1280
+ # Available to use for quota purposes for server-side applications. Can be any
1281
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1282
+ # @param [Google::Apis::RequestOptions] options
1283
+ # Request-specific options
1284
+ #
1285
+ # @yield [result, err] Result & error if block supplied
1286
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Operation] parsed result object
1287
+ # @yieldparam err [StandardError] error object if request failed
1288
+ #
1289
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Operation]
1290
+ #
1291
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1292
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1293
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1294
+ def create_project_location_registry_book(parent, registry_book_object = nil, registry_book_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1295
+ command = make_simple_command(:post, 'v1alpha/{+parent}/registryBooks', options)
1296
+ command.request_representation = Google::Apis::CloudnumberregistryV1alpha::RegistryBook::Representation
1297
+ command.request_object = registry_book_object
1298
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Operation::Representation
1299
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Operation
1300
+ command.params['parent'] = parent unless parent.nil?
1301
+ command.query['registryBookId'] = registry_book_id unless registry_book_id.nil?
1302
+ command.query['requestId'] = request_id unless request_id.nil?
1303
+ command.query['fields'] = fields unless fields.nil?
1304
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1305
+ execute_or_queue_command(command, &block)
1306
+ end
1307
+
1308
+ # Deletes a single RegistryBook.
1309
+ # @param [String] name
1310
+ # Required. Name of the resource
1311
+ # @param [Boolean] force
1312
+ # Optional. If set to true, all associated resources will be deleted.
1313
+ # @param [String] request_id
1314
+ # Optional. An optional request ID to identify requests. Specify a unique
1315
+ # request ID so that if you must retry your request, the server will know to
1316
+ # ignore the request if it has already been completed. The server will guarantee
1317
+ # that for at least 60 minutes after the first request. For example, consider a
1318
+ # situation where you make an initial request and the request times out. If you
1319
+ # make the request again with the same request ID, the server can check if
1320
+ # original operation with the same request ID was received, and if so, will
1321
+ # ignore the second request. This prevents clients from accidentally creating
1322
+ # duplicate commitments. The request ID must be a valid UUID with the exception
1323
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1324
+ # @param [String] fields
1325
+ # Selector specifying which fields to include in a partial response.
1326
+ # @param [String] quota_user
1327
+ # Available to use for quota purposes for server-side applications. Can be any
1328
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1329
+ # @param [Google::Apis::RequestOptions] options
1330
+ # Request-specific options
1331
+ #
1332
+ # @yield [result, err] Result & error if block supplied
1333
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Operation] parsed result object
1334
+ # @yieldparam err [StandardError] error object if request failed
1335
+ #
1336
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Operation]
1337
+ #
1338
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1339
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1340
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1341
+ def delete_project_location_registry_book(name, force: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1342
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
1343
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Operation::Representation
1344
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Operation
1345
+ command.params['name'] = name unless name.nil?
1346
+ command.query['force'] = force unless force.nil?
1347
+ command.query['requestId'] = request_id unless request_id.nil?
1348
+ command.query['fields'] = fields unless fields.nil?
1349
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1350
+ execute_or_queue_command(command, &block)
1351
+ end
1352
+
1353
+ # Gets details of a single RegistryBook.
1354
+ # @param [String] name
1355
+ # Required. Name of the resource
1356
+ # @param [String] view
1357
+ # Optional. The view of the RegistryBook.
1358
+ # @param [String] fields
1359
+ # Selector specifying which fields to include in a partial response.
1360
+ # @param [String] quota_user
1361
+ # Available to use for quota purposes for server-side applications. Can be any
1362
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1363
+ # @param [Google::Apis::RequestOptions] options
1364
+ # Request-specific options
1365
+ #
1366
+ # @yield [result, err] Result & error if block supplied
1367
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::RegistryBook] parsed result object
1368
+ # @yieldparam err [StandardError] error object if request failed
1369
+ #
1370
+ # @return [Google::Apis::CloudnumberregistryV1alpha::RegistryBook]
1371
+ #
1372
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1373
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1374
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1375
+ def get_project_location_registry_book(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
1376
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1377
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::RegistryBook::Representation
1378
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::RegistryBook
1379
+ command.params['name'] = name unless name.nil?
1380
+ command.query['view'] = view unless view.nil?
1381
+ command.query['fields'] = fields unless fields.nil?
1382
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1383
+ execute_or_queue_command(command, &block)
1384
+ end
1385
+
1386
+ # Lists RegistryBooks in a given project and location.
1387
+ # @param [String] parent
1388
+ # Required. Parent value for ListRegistryBooksRequest
1389
+ # @param [String] filter
1390
+ # Optional. Filtering results
1391
+ # @param [String] order_by
1392
+ # Optional. Hint for how to order the results
1393
+ # @param [Fixnum] page_size
1394
+ # Optional. Requested page size. Server may return fewer items than requested.
1395
+ # If unspecified, server will pick an appropriate default.
1396
+ # @param [String] page_token
1397
+ # Optional. A token identifying a page of results the server should return.
1398
+ # @param [String] view
1399
+ # Optional. The view of the RegistryBook.
1400
+ # @param [String] fields
1401
+ # Selector specifying which fields to include in a partial response.
1402
+ # @param [String] quota_user
1403
+ # Available to use for quota purposes for server-side applications. Can be any
1404
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1405
+ # @param [Google::Apis::RequestOptions] options
1406
+ # Request-specific options
1407
+ #
1408
+ # @yield [result, err] Result & error if block supplied
1409
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::ListRegistryBooksResponse] parsed result object
1410
+ # @yieldparam err [StandardError] error object if request failed
1411
+ #
1412
+ # @return [Google::Apis::CloudnumberregistryV1alpha::ListRegistryBooksResponse]
1413
+ #
1414
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1415
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1416
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1417
+ def list_project_location_registry_books(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
1418
+ command = make_simple_command(:get, 'v1alpha/{+parent}/registryBooks', options)
1419
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::ListRegistryBooksResponse::Representation
1420
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::ListRegistryBooksResponse
1421
+ command.params['parent'] = parent unless parent.nil?
1422
+ command.query['filter'] = filter unless filter.nil?
1423
+ command.query['orderBy'] = order_by unless order_by.nil?
1424
+ command.query['pageSize'] = page_size unless page_size.nil?
1425
+ command.query['pageToken'] = page_token unless page_token.nil?
1426
+ command.query['view'] = view unless view.nil?
1427
+ command.query['fields'] = fields unless fields.nil?
1428
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1429
+ execute_or_queue_command(command, &block)
1430
+ end
1431
+
1432
+ # Updates the parameters of a single RegistryBook.
1433
+ # @param [String] name
1434
+ # Required. Identifier. name of resource
1435
+ # @param [Google::Apis::CloudnumberregistryV1alpha::RegistryBook] registry_book_object
1436
+ # @param [String] request_id
1437
+ # Optional. An optional request ID to identify requests. Specify a unique
1438
+ # request ID so that if you must retry your request, the server will know to
1439
+ # ignore the request if it has already been completed. The server will guarantee
1440
+ # that for at least 60 minutes since the first request. For example, consider a
1441
+ # situation where you make an initial request and the request times out. If you
1442
+ # make the request again with the same request ID, the server can check if
1443
+ # original operation with the same request ID was received, and if so, will
1444
+ # ignore the second request. This prevents clients from accidentally creating
1445
+ # duplicate commitments. The request ID must be a valid UUID with the exception
1446
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1447
+ # @param [String] update_mask
1448
+ # Optional. Field mask is used to specify the fields to be overwritten in the
1449
+ # RegistryBook resource by the update. The fields specified in the update_mask
1450
+ # are relative to the resource, not the full request. A field will be
1451
+ # overwritten if it is in the mask. If the user does not provide a mask then all
1452
+ # fields will be overwritten.
1453
+ # @param [String] fields
1454
+ # Selector specifying which fields to include in a partial response.
1455
+ # @param [String] quota_user
1456
+ # Available to use for quota purposes for server-side applications. Can be any
1457
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1458
+ # @param [Google::Apis::RequestOptions] options
1459
+ # Request-specific options
1460
+ #
1461
+ # @yield [result, err] Result & error if block supplied
1462
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::Operation] parsed result object
1463
+ # @yieldparam err [StandardError] error object if request failed
1464
+ #
1465
+ # @return [Google::Apis::CloudnumberregistryV1alpha::Operation]
1466
+ #
1467
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1468
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1469
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1470
+ def patch_project_location_registry_book(name, registry_book_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1471
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
1472
+ command.request_representation = Google::Apis::CloudnumberregistryV1alpha::RegistryBook::Representation
1473
+ command.request_object = registry_book_object
1474
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::Operation::Representation
1475
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::Operation
1476
+ command.params['name'] = name unless name.nil?
1477
+ command.query['requestId'] = request_id unless request_id.nil?
1478
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1479
+ command.query['fields'] = fields unless fields.nil?
1480
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1481
+ execute_or_queue_command(command, &block)
1482
+ end
1483
+
1484
+ # Searches IP resources in a given RegistryBook.
1485
+ # @param [String] name
1486
+ # Required. The name of the RegistryBook to search in.
1487
+ # @param [Google::Apis::CloudnumberregistryV1alpha::SearchIpResourcesRequest] search_ip_resources_request_object
1488
+ # @param [String] fields
1489
+ # Selector specifying which fields to include in a partial response.
1490
+ # @param [String] quota_user
1491
+ # Available to use for quota purposes for server-side applications. Can be any
1492
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1493
+ # @param [Google::Apis::RequestOptions] options
1494
+ # Request-specific options
1495
+ #
1496
+ # @yield [result, err] Result & error if block supplied
1497
+ # @yieldparam result [Google::Apis::CloudnumberregistryV1alpha::SearchIpResourcesResponse] parsed result object
1498
+ # @yieldparam err [StandardError] error object if request failed
1499
+ #
1500
+ # @return [Google::Apis::CloudnumberregistryV1alpha::SearchIpResourcesResponse]
1501
+ #
1502
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1503
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1504
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1505
+ def search_registry_book_ip_resources(name, search_ip_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1506
+ command = make_simple_command(:post, 'v1alpha/{+name}:searchIpResources', options)
1507
+ command.request_representation = Google::Apis::CloudnumberregistryV1alpha::SearchIpResourcesRequest::Representation
1508
+ command.request_object = search_ip_resources_request_object
1509
+ command.response_representation = Google::Apis::CloudnumberregistryV1alpha::SearchIpResourcesResponse::Representation
1510
+ command.response_class = Google::Apis::CloudnumberregistryV1alpha::SearchIpResourcesResponse
1511
+ command.params['name'] = name unless name.nil?
1512
+ command.query['fields'] = fields unless fields.nil?
1513
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1514
+ execute_or_queue_command(command, &block)
1515
+ end
1516
+
1517
+ protected
1518
+
1519
+ def apply_command_defaults(command)
1520
+ command.query['key'] = key unless key.nil?
1521
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1522
+ end
1523
+ end
1524
+ end
1525
+ end
1526
+ end