@maxim_mazurok/gapi.client.cloudnumberregistry-v1alpha 0.0.0 → 0.0.20260527

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/index.d.ts +1929 -1
  2. package/package.json +16 -3
  3. package/readme.md +91 -0
  4. package/README.md +0 -3
package/index.d.ts CHANGED
@@ -1 +1,1929 @@
1
- export {};
1
+ /* Type definitions for non-npm package Cloud Number Registry API v1alpha 0.0 */
2
+ // Project: https://docs.cloud.google.com/number-registry/reference/rest
3
+ // Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
4
+ // Nick Amoscato <https://github.com/namoscato>
5
+ // Declan Vong <https://github.com/declanvong>
6
+ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
7
+
8
+ // IMPORTANT
9
+ // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
+ // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
+ // Generated from: https://cloudnumberregistry.googleapis.com/$discovery/rest?version=v1alpha
12
+ // Revision: 20260527
13
+
14
+ /// <reference types="gapi.client" />
15
+
16
+ declare namespace gapi.client {
17
+ /** Load Cloud Number Registry API v1alpha */
18
+ function load(
19
+ urlOrObject: 'https://cloudnumberregistry.googleapis.com/$discovery/rest?version=v1alpha',
20
+ ): Promise<void>;
21
+ /** @deprecated Please load APIs with discovery documents. */
22
+ function load(name: 'cloudnumberregistry', version: 'v1alpha'): Promise<void>;
23
+ /** @deprecated Please load APIs with discovery documents. */
24
+ function load(
25
+ name: 'cloudnumberregistry',
26
+ version: 'v1alpha',
27
+ callback: () => any,
28
+ ): void;
29
+
30
+ namespace cloudnumberregistry {
31
+ interface AggregatedData {
32
+ /** Output only. Number of CustomRanges in the RegistryBook. */
33
+ customRangesCount?: number;
34
+ /** Output only. Number of custom Realms in the RegistryBook. */
35
+ customRealmsCount?: number;
36
+ /** Output only. Number of DiscoveredRanges in the RegistryBook. */
37
+ discoveredRangesCount?: number;
38
+ /** Output only. Number of discovered Realms in the RegistryBook. */
39
+ discoveredRealmsCount?: number;
40
+ /** Output only. Number of scopes unique to the RegistryBook. */
41
+ uniqueScopesCount?: number;
42
+ }
43
+ interface Attribute {
44
+ /** Required. The key of the attribute. */
45
+ key?: string;
46
+ /** Required. The value of the attribute. */
47
+ value?: string;
48
+ }
49
+ interface CancelOperationRequest {}
50
+ interface CheckAvailabilityIpamAdminScopesResponse {
51
+ /** The details of the requested scopes. */
52
+ scopeAvailabilities?: IpamAdminScopeAvailability[];
53
+ }
54
+ interface CleanupIpamAdminScopeRequest {
55
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
56
+ requestId?: string;
57
+ }
58
+ interface CustomRange {
59
+ /** Optional. The attributes of the CustomRange. */
60
+ attributes?: Attribute[];
61
+ /** Optional. The description of the CustomRange. */
62
+ description?: string;
63
+ /** Optional. The IPv4 CIDR range of the CustomRange. */
64
+ ipv4CidrRange?: string;
65
+ /** Optional. The IPv6 CIDR range of the CustomRange. */
66
+ ipv6CidrRange?: string;
67
+ /** Optional. User-defined labels. */
68
+ labels?: {[P in string]: string};
69
+ /** Required. Identifier. The resource name of the CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`. */
70
+ name?: string;
71
+ /** Optional. The resource name of the parent CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`. If specified, the parent CustomRange must be in the same RegistryBook. This field is mutually exclusive with the `realm` field, as the Realm is inherited from the parent CustomRange. */
72
+ parentRange?: string;
73
+ /** Optional. The resource name of the Realm associated with the CustomRange, in the format `projects/{project}/locations/{location}/realms/{realm}`. The Realm must be in the same project as the CustomRange. This field must not be set if the `parent_range` field is set, as the Realm will be inherited from the parent CustomRange. */
74
+ realm?: string;
75
+ /** Output only. The RegistryBook of the CustomRange. This field is inherited from the Realm or parent CustomRange depending on which one is specified. */
76
+ registryBook?: string;
77
+ }
78
+ interface DisableIpamAdminScopeRequest {
79
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
80
+ requestId?: string;
81
+ }
82
+ interface DiscoveredRange {
83
+ /** Optional. The attributes of the DiscoveredRange. */
84
+ attributes?: Attribute[];
85
+ /** Output only. If true, allows child DiscoveredRanges of this DiscoveredRange to overlap with each other. */
86
+ childCidrOverlapAllowed?: boolean;
87
+ /** Output only. The time at which the DiscoveredRange was created. */
88
+ createTime?: string;
89
+ /** Optional. Description of the DiscoveredRange. */
90
+ description?: string;
91
+ /** Output only. Owner metadata for this DiscoveredRange. A unique set of metadata is associated with each DiscoveredRange. If an IP range is shared by multiple resources (e.g., an Address resource and an Instance resource, or multiple ForwardingRules),separate DiscoveredRanges are created, each with a distinct owner. This ensures each DiscoveredRange has its own unique set of attributes, labels, create time and update time. */
92
+ discoveryMetadata?: DiscoveryMetadata;
93
+ /** Optional. The IPv4 CIDR range of the DiscoveredRange. */
94
+ ipv4CidrRange?: string;
95
+ /** Optional. The IPv6 CIDR range of the DiscoveredRange. */
96
+ ipv6CidrRange?: string;
97
+ /** Optional. User-defined labels. */
98
+ labels?: {[P in string]: string};
99
+ /** Required. Identifier. The resource name of the DiscoveredRange, in the format `projects/{project}/locations/{location}/discoveredRanges/{discovered_range}`. */
100
+ name?: string;
101
+ /** Optional. The resource name of the parent DiscoveredRange, in the format `projects/{project}/locations/{location}/discoveredRanges/{discovered_range}`. */
102
+ parentRange?: string;
103
+ /** Optional. The Realm of the DiscoveredRange. */
104
+ realm?: string;
105
+ /** Output only. The RegistryBook of the DiscoveredRange. */
106
+ registryBook?: string;
107
+ /** Output only. The time at which the DiscoveredRange was last updated. */
108
+ updateTime?: string;
109
+ }
110
+ interface DiscoveryMetadata {
111
+ /** Output only. The time when the resource was created. */
112
+ createTime?: string;
113
+ /** Output only. The time when the event happened. */
114
+ eventTime?: string;
115
+ /** Output only. The resource name of the discovered resource, should be API-agnostic. Example: "projects/{project_number}/networks/{network_id}". */
116
+ resource?: string;
117
+ /** Output only. The resource uri of the discovered resource. */
118
+ resourceUri?: string;
119
+ /** Output only. The canonical google.aip.dev/122 name of the source resource. */
120
+ sourceId?: string;
121
+ /** Output only. A single source resource can be the source of multiple CNR resources. This sub_id is used to distinguish between the different CNR resources derived from the same upstream resource. For example, a single subnetwork can be the source of multiple Ranges, one for each protocol. In this case, the sub_id could be "private-ipv4" or "private-ipv6". */
122
+ sourceSubId?: string;
123
+ /** Output only. The state of the resource. */
124
+ state?:
125
+ | 'RESOURCE_STATE_UNSPECIFIED'
126
+ | 'INVALID'
127
+ | 'EXISTS'
128
+ | 'DOES_NOT_EXIST'
129
+ | 'ERROR';
130
+ /** Output only. The time when the resource was last modified. */
131
+ updateTime?: string;
132
+ }
133
+ interface Empty {}
134
+ interface FindCustomRangeFreeIpRangesResponse {
135
+ /** Output only. The free IP CIDR ranges found. */
136
+ freeIpCidrRanges?: string[];
137
+ }
138
+ interface FindDiscoveredRangeFreeIpRangesResponse {
139
+ /** Output only. The free IP CIDR ranges found. */
140
+ freeIpCidrRanges?: string[];
141
+ }
142
+ interface IpamAdminScope {
143
+ /** Output only. The time at which the IpamAdminScope was created. */
144
+ createTime?: string;
145
+ /** Required. Add-on platforms that are enabled for this IpamAdminScope. Cloud Number Registry only discovers the IP addresses from the enabled platforms. */
146
+ enabledAddonPlatforms?:
147
+ | 'ADD_ON_PLATFORM_UNSPECIFIED'
148
+ | 'COMPUTE_ENGINE'
149
+ | 'GCE'[];
150
+ /** Optional. User-defined labels. */
151
+ labels?: {[P in string]: string};
152
+ /** Required. Identifier. The resource name of the IpamAdminScope. */
153
+ name?: string;
154
+ /** Required. Administrative scopes enabled for IP address discovery and management. For example, "organizations/1234567890". Minimum of 1 scope is required. In preview, only one organization scope is allowed. */
155
+ scopes?: string[];
156
+ /** Output only. State of resource discovery pipeline. */
157
+ state?:
158
+ | 'DISCOVERY_PIPELINE_STATE_UNSPECIFIED'
159
+ | 'INTERNAL_FAILURE'
160
+ | 'FAILED'
161
+ | 'SETUP_IN_PROGRESS'
162
+ | 'READY_FOR_USE'
163
+ | 'DELETING_IN_PROGRESS'
164
+ | 'UPDATING'
165
+ | 'RECOVERING'
166
+ | 'DISABLED'
167
+ | 'DELETION_COMPLETED'
168
+ | 'CLEANUP_IN_PROGRESS'
169
+ | 'READY_FOR_DELETION';
170
+ /** Output only. The time at which the IpamAdminScope was last updated. */
171
+ updateTime?: string;
172
+ }
173
+ interface IpamAdminScopeAvailability {
174
+ /** The admin project of the IpamAdminScope if it exists. */
175
+ adminProject?: string;
176
+ /** The availability of the scope. */
177
+ availability?: 'AVAILABILITY_UNSPECIFIED' | 'AVAILABLE' | 'UNAVAILABLE';
178
+ /** The scope of the IpamAdminScope. */
179
+ scope?: string;
180
+ }
181
+ interface ListCustomRangesResponse {
182
+ /** The list of CustomRanges. */
183
+ customRanges?: CustomRange[];
184
+ /** A token to retrieve the next page of results, or empty if there are no more results in the list. */
185
+ nextPageToken?: string;
186
+ /** Locations that could not be reached. */
187
+ unreachable?: string[];
188
+ }
189
+ interface ListDiscoveredRangesResponse {
190
+ /** The list of DiscoveredRanges. */
191
+ discoveredRanges?: DiscoveredRange[];
192
+ /** A token to retrieve the next page of results, or empty if there are no more results in the list. */
193
+ nextPageToken?: string;
194
+ /** Locations that could not be reached. */
195
+ unreachable?: string[];
196
+ }
197
+ interface ListIpamAdminScopesResponse {
198
+ /** The list of IpamAdminScopes. */
199
+ ipamAdminScopes?: IpamAdminScope[];
200
+ /** A token to retrieve the next page of results, or empty if there are no more results in the list. */
201
+ nextPageToken?: string;
202
+ /** Locations that could not be reached. */
203
+ unreachable?: string[];
204
+ }
205
+ interface ListLocationsResponse {
206
+ /** A list of locations that matches the specified filter in the request. */
207
+ locations?: Location[];
208
+ /** The standard List next-page token. */
209
+ nextPageToken?: string;
210
+ }
211
+ interface ListOperationsResponse {
212
+ /** The standard List next-page token. */
213
+ nextPageToken?: string;
214
+ /** A list of operations that matches the specified filter in the request. */
215
+ operations?: Operation[];
216
+ /** Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */
217
+ unreachable?: string[];
218
+ }
219
+ interface ListRealmsResponse {
220
+ /** A token identifying a page of results the server should return. */
221
+ nextPageToken?: string;
222
+ /** The list of Realms. */
223
+ realms?: Realm[];
224
+ /** Locations that could not be reached. */
225
+ unreachable?: string[];
226
+ }
227
+ interface ListRegistryBooksResponse {
228
+ /** A token identifying a page of results the server should return. */
229
+ nextPageToken?: string;
230
+ /** The list of RegistryBook */
231
+ registryBooks?: RegistryBook[];
232
+ /** Locations that could not be reached. */
233
+ unreachable?: string[];
234
+ }
235
+ interface Location {
236
+ /** The friendly name for this location, typically a nearby city name. For example, "Tokyo". */
237
+ displayName?: string;
238
+ /** Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */
239
+ labels?: {[P in string]: string};
240
+ /** The canonical id for this location. For example: `"us-east1"`. */
241
+ locationId?: string;
242
+ /** Service-specific metadata. For example the available capacity at the given location. */
243
+ metadata?: {[P in string]: any};
244
+ /** Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */
245
+ name?: string;
246
+ }
247
+ interface Operation {
248
+ /** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
249
+ done?: boolean;
250
+ /** The error result of the operation in case of failure or cancellation. */
251
+ error?: Status;
252
+ /** Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */
253
+ metadata?: {[P in string]: any};
254
+ /** The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */
255
+ name?: string;
256
+ /** The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */
257
+ response?: {[P in string]: any};
258
+ }
259
+ interface OperationMetadata {
260
+ /** Output only. API version used to start the operation. */
261
+ apiVersion?: string;
262
+ /** Output only. The time the operation was created. */
263
+ createTime?: string;
264
+ /** Output only. The time the operation finished running. */
265
+ endTime?: string;
266
+ /** Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */
267
+ requestedCancellation?: boolean;
268
+ /** Output only. Human-readable status of the operation, if any. */
269
+ statusMessage?: string;
270
+ /** Output only. Server-defined resource path for the target of the operation. */
271
+ target?: string;
272
+ /** Output only. Name of the verb executed by the operation. */
273
+ verb?: string;
274
+ }
275
+ interface Range {
276
+ /** A CustomRange. */
277
+ customRange?: CustomRange;
278
+ /** A DiscoveredRange. */
279
+ discoveredRange?: DiscoveredRange;
280
+ /** The utilization of the Range. */
281
+ utilization?: RangeUtilization;
282
+ }
283
+ interface RangeUtilization {
284
+ /** Output only. The total number of IP addresses consumed in the Range. */
285
+ totalConsumed?: string;
286
+ /** Output only. The total number of IP addresses produced in the Range. */
287
+ totalProduced?: string;
288
+ /** Output only. The usage of the Range as a percentage. This is marked as optional so that we have presence tracking and API responses show 0.0 instead of NULL. */
289
+ usage?: number;
290
+ }
291
+ interface Realm {
292
+ /** Output only. Aggregated data for the Realm. Populated only when the view is AGGREGATE. */
293
+ aggregatedData?: RealmAggregatedData;
294
+ /** Output only. The time at which the Realm was created. */
295
+ createTime?: string;
296
+ /** Output only. Discovery metadata of the Realm. */
297
+ discoveryMetadata?: DiscoveryMetadata;
298
+ /** Optional. IP version of the Realm. */
299
+ ipVersion?: 'IP_VERSION_UNSPECIFIED' | 'IPV4' | 'IPV6';
300
+ /** Optional. User-defined labels. */
301
+ labels?: {[P in string]: string};
302
+ /** Required. Management type of the Realm. */
303
+ managementType?: 'MANAGEMENT_TYPE_UNSPECIFIED' | 'CNR' | 'USER';
304
+ /** Required. Identifier. The resource name of the Realm. */
305
+ name?: string;
306
+ /** Required. Name of the RegistryBook that claims the Realm. */
307
+ registryBook?: string;
308
+ /** Required. Traffic type of the Realm. */
309
+ trafficType?:
310
+ | 'TRAFFIC_TYPE_UNSPECIFIED'
311
+ | 'UNSET'
312
+ | 'INTERNET'
313
+ | 'PRIVATE'
314
+ | 'LINKLOCAL';
315
+ /** Output only. The time at which the Realm was last updated. */
316
+ updateTime?: string;
317
+ }
318
+ interface RealmAggregatedData {
319
+ /** Output only. Number of CustomRanges in the Realm. */
320
+ customRangesCount?: number;
321
+ /** Output only. Number of DiscoveredRanges in the Realm. */
322
+ discoveredRangesCount?: number;
323
+ }
324
+ interface RegistryBook {
325
+ /** Output only. Aggregated data for the RegistryBook. Populated only when the view is AGGREGATE. */
326
+ aggregatedData?: AggregatedData;
327
+ /** Optional. List of scopes claimed by the RegistryBook. In Preview, Only project scope is supported. Each scope is in the format of projects/{project}. Each scope can only be claimed once. */
328
+ claimedScopes?: string[];
329
+ /** Output only. The time at which the RegistryBook was created. */
330
+ createTime?: string;
331
+ /** Output only. Whether the RegistryBook is the default one. */
332
+ isDefault?: boolean;
333
+ /** Optional. User-defined labels. */
334
+ labels?: {[P in string]: string};
335
+ /** Required. Identifier. The resource name of the RegistryBook. */
336
+ name?: string;
337
+ /** Output only. The time at which the RegistryBook was last updated. */
338
+ updateTime?: string;
339
+ }
340
+ interface SearchIpResourcesRequest {
341
+ /** Optional. Hint for how to order the results. Supported sort fields are: - `name`: Sort alphabetically by the resource name. - `create_time`: Sort by the creation timestamp of the resource. - `update_time`: Sort by the last update timestamp of the resource. Supported directions are `asc` (ascending) and `desc` (descending). If unspecified, direction defaults to `asc`. Only sorting by a single field is supported. */
342
+ orderBy?: string;
343
+ /** Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
344
+ pageSize?: number;
345
+ /** Optional. A token identifying a page of results the server should return. */
346
+ pageToken?: string;
347
+ /** Optional. Search query. This string filters resources in an AIP-160-like format. It has some limitations. You can only specify top level conjunctions or attribute level negations. Each restriction can only be used once except the attribute restriction. The available restrictions for Ranges are: - `realm`: The Realm name to search in. - `ip_address`: The IP address to search for within Ranges. - `ip_version`: The IP version to filter by (e.g., "IPV4", "IPV6"). - `parent_range`: The parent Range of the Range to search for. - `attribute_text`: The attribute text to search for within Ranges. - `attribute`: The attribute key and value to filter by. The available restrictions for Realms are: - `ip_version`: The IP version to search for. - `management_type`: The management type of the Realm (e.g., "CNR", "USER"). Only one of attribute_text or multiple attribute filters can be specified. Examples: - `realm=test-realm` - `realm=test-realm AND ip_address=10.0.0.0` - `realm=test-realm AND ip_version=IPV6` - `realm=test-realm AND attribute_text=test` - `ip_address=10.0.0.0 AND attribute:(key1=value1) AND attribute:(key2=value2)` - `attribute_text=test AND parent_range=projects/123/locations/global/discoveredRanges/test-parent-range` - `management_type=CNR` */
348
+ query?: string;
349
+ /** Optional. The type of resources to search for. If not specified, the server will return Ranges. */
350
+ searchResourceTypes?:
351
+ | 'SEARCH_RESOURCE_TYPE_UNSPECIFIED'
352
+ | 'RANGES'
353
+ | 'REALMS'[];
354
+ /** Optional. Whether to show the utilization of the Ranges in the response. */
355
+ showUtilization?: boolean;
356
+ }
357
+ interface SearchIpResourcesResponse {
358
+ /** A token identifying a page of results the server should return. */
359
+ nextPageToken?: string;
360
+ /** Deprecated: Use results field instead. The list of Ranges matching the search query. */
361
+ ranges?: Range[];
362
+ /** The list of results matching the search query. */
363
+ results?: SearchIpResourcesResult[];
364
+ /** Locations that could not be reached. */
365
+ unreachable?: string[];
366
+ }
367
+ interface SearchIpResourcesResult {
368
+ /** A Range matching the search query. */
369
+ range?: Range;
370
+ /** A Realm matching the search query. */
371
+ realm?: Realm;
372
+ }
373
+ interface ShowCustomRangeUtilizationResponse {
374
+ /** The CustomRange resource. */
375
+ customRange?: CustomRange;
376
+ /** The utilization details of the CustomRange. */
377
+ rangeUtilization?: RangeUtilization;
378
+ }
379
+ interface ShowDiscoveredRangeUtilizationResponse {
380
+ /** The DiscoveredRange resource. */
381
+ discoveredRange?: DiscoveredRange;
382
+ /** The utilization details of the DiscoveredRange. */
383
+ rangeUtilization?: RangeUtilization;
384
+ }
385
+ interface Status {
386
+ /** The status code, which should be an enum value of google.rpc.Code. */
387
+ code?: number;
388
+ /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
389
+ details?: {[P in string]: any}[];
390
+ /** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
391
+ message?: string;
392
+ }
393
+ interface CustomRangesResource {
394
+ /** Creates a new CustomRange in a given project and location. */
395
+ create(request: {
396
+ /** V1 error format. */
397
+ '$.xgafv'?: '1' | '2';
398
+ /** OAuth access token. */
399
+ access_token?: string;
400
+ /** Data format for response. */
401
+ alt?: 'json' | 'media' | 'proto';
402
+ /** JSONP */
403
+ callback?: string;
404
+ /** Required. The ID to use for the CustomRange, which will become the final segment of the resource name. */
405
+ customRangeId?: string;
406
+ /** Selector specifying which fields to include in a partial response. */
407
+ fields?: string;
408
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
409
+ key?: string;
410
+ /** OAuth 2.0 token for the current user. */
411
+ oauth_token?: string;
412
+ /** Required. The parent resource name where the CustomRange will be created. */
413
+ parent: string;
414
+ /** Returns response with indentations and line breaks. */
415
+ prettyPrint?: boolean;
416
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
417
+ quotaUser?: string;
418
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
419
+ requestId?: string;
420
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
421
+ upload_protocol?: string;
422
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
423
+ uploadType?: string;
424
+ /** Request body */
425
+ resource: CustomRange;
426
+ }): Request<Operation>;
427
+ create(
428
+ request: {
429
+ /** V1 error format. */
430
+ '$.xgafv'?: '1' | '2';
431
+ /** OAuth access token. */
432
+ access_token?: string;
433
+ /** Data format for response. */
434
+ alt?: 'json' | 'media' | 'proto';
435
+ /** JSONP */
436
+ callback?: string;
437
+ /** Required. The ID to use for the CustomRange, which will become the final segment of the resource name. */
438
+ customRangeId?: string;
439
+ /** Selector specifying which fields to include in a partial response. */
440
+ fields?: string;
441
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
442
+ key?: string;
443
+ /** OAuth 2.0 token for the current user. */
444
+ oauth_token?: string;
445
+ /** Required. The parent resource name where the CustomRange will be created. */
446
+ parent: string;
447
+ /** Returns response with indentations and line breaks. */
448
+ prettyPrint?: boolean;
449
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
450
+ quotaUser?: string;
451
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
452
+ requestId?: string;
453
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
454
+ upload_protocol?: string;
455
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
456
+ uploadType?: string;
457
+ },
458
+ body: CustomRange,
459
+ ): Request<Operation>;
460
+ /** Deletes a single CustomRange. */
461
+ delete(request?: {
462
+ /** V1 error format. */
463
+ '$.xgafv'?: '1' | '2';
464
+ /** OAuth access token. */
465
+ access_token?: string;
466
+ /** Data format for response. */
467
+ alt?: 'json' | 'media' | 'proto';
468
+ /** JSONP */
469
+ callback?: string;
470
+ /** Selector specifying which fields to include in a partial response. */
471
+ fields?: string;
472
+ /** Optional. If set to true, all associated resources will be deleted. */
473
+ force?: boolean;
474
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
475
+ key?: string;
476
+ /** Required. The resource name of the CustomRange to delete. */
477
+ name: string;
478
+ /** OAuth 2.0 token for the current user. */
479
+ oauth_token?: string;
480
+ /** Returns response with indentations and line breaks. */
481
+ prettyPrint?: boolean;
482
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
483
+ quotaUser?: string;
484
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
485
+ requestId?: string;
486
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
487
+ upload_protocol?: string;
488
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
489
+ uploadType?: string;
490
+ }): Request<Operation>;
491
+ /** Finds free IP ranges in a single CustomRange. */
492
+ findFreeIpRanges(request?: {
493
+ /** V1 error format. */
494
+ '$.xgafv'?: '1' | '2';
495
+ /** OAuth access token. */
496
+ access_token?: string;
497
+ /** Data format for response. */
498
+ alt?: 'json' | 'media' | 'proto';
499
+ /** JSONP */
500
+ callback?: string;
501
+ /** Required. The prefix length of the free IP ranges to find. */
502
+ cidrPrefixLength?: number;
503
+ /** Selector specifying which fields to include in a partial response. */
504
+ fields?: string;
505
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
506
+ key?: string;
507
+ /** Required. The resource name of the CustomRange to search within. */
508
+ name: string;
509
+ /** OAuth 2.0 token for the current user. */
510
+ oauth_token?: string;
511
+ /** Returns response with indentations and line breaks. */
512
+ prettyPrint?: boolean;
513
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
514
+ quotaUser?: string;
515
+ /** Optional. The number of free IP ranges to find. */
516
+ rangeCount?: number;
517
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
518
+ requestId?: string;
519
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
520
+ upload_protocol?: string;
521
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
522
+ uploadType?: string;
523
+ }): Request<FindCustomRangeFreeIpRangesResponse>;
524
+ /** Gets details of a single CustomRange. */
525
+ get(request?: {
526
+ /** V1 error format. */
527
+ '$.xgafv'?: '1' | '2';
528
+ /** OAuth access token. */
529
+ access_token?: string;
530
+ /** Data format for response. */
531
+ alt?: 'json' | 'media' | 'proto';
532
+ /** JSONP */
533
+ callback?: string;
534
+ /** Selector specifying which fields to include in a partial response. */
535
+ fields?: string;
536
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
537
+ key?: string;
538
+ /** Required. The resource name of the CustomRange to retrieve. */
539
+ name: string;
540
+ /** OAuth 2.0 token for the current user. */
541
+ oauth_token?: string;
542
+ /** Returns response with indentations and line breaks. */
543
+ prettyPrint?: boolean;
544
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
545
+ quotaUser?: string;
546
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
547
+ upload_protocol?: string;
548
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
549
+ uploadType?: string;
550
+ }): Request<CustomRange>;
551
+ /** Lists CustomRanges in a given project and location. */
552
+ list(request?: {
553
+ /** V1 error format. */
554
+ '$.xgafv'?: '1' | '2';
555
+ /** OAuth access token. */
556
+ access_token?: string;
557
+ /** Data format for response. */
558
+ alt?: 'json' | 'media' | 'proto';
559
+ /** JSONP */
560
+ callback?: string;
561
+ /** Selector specifying which fields to include in a partial response. */
562
+ fields?: string;
563
+ /** Optional. Filter expression to filter the results. */
564
+ filter?: string;
565
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
566
+ key?: string;
567
+ /** OAuth 2.0 token for the current user. */
568
+ oauth_token?: string;
569
+ /** Optional. Hint for how to order the results. */
570
+ orderBy?: string;
571
+ /** Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
572
+ pageSize?: number;
573
+ /** Optional. A token identifying a page of results the server should return. */
574
+ pageToken?: string;
575
+ /** Required. The parent resource name, for example `projects/*‍/locations/*`. */
576
+ parent: string;
577
+ /** Returns response with indentations and line breaks. */
578
+ prettyPrint?: boolean;
579
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
580
+ quotaUser?: string;
581
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
582
+ upload_protocol?: string;
583
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
584
+ uploadType?: string;
585
+ }): Request<ListCustomRangesResponse>;
586
+ /** Updates the parameters of a single CustomRange. */
587
+ patch(request: {
588
+ /** V1 error format. */
589
+ '$.xgafv'?: '1' | '2';
590
+ /** OAuth access token. */
591
+ access_token?: string;
592
+ /** Data format for response. */
593
+ alt?: 'json' | 'media' | 'proto';
594
+ /** JSONP */
595
+ callback?: string;
596
+ /** Selector specifying which fields to include in a partial response. */
597
+ fields?: string;
598
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
599
+ key?: string;
600
+ /** Required. Identifier. The resource name of the CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`. */
601
+ name: string;
602
+ /** OAuth 2.0 token for the current user. */
603
+ oauth_token?: string;
604
+ /** Returns response with indentations and line breaks. */
605
+ prettyPrint?: boolean;
606
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
607
+ quotaUser?: string;
608
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
609
+ requestId?: string;
610
+ /** Optional. Field mask is used to specify the fields to be overwritten in the CustomRange resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. */
611
+ updateMask?: string;
612
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
613
+ upload_protocol?: string;
614
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
615
+ uploadType?: string;
616
+ /** Request body */
617
+ resource: CustomRange;
618
+ }): Request<Operation>;
619
+ patch(
620
+ request: {
621
+ /** V1 error format. */
622
+ '$.xgafv'?: '1' | '2';
623
+ /** OAuth access token. */
624
+ access_token?: string;
625
+ /** Data format for response. */
626
+ alt?: 'json' | 'media' | 'proto';
627
+ /** JSONP */
628
+ callback?: string;
629
+ /** Selector specifying which fields to include in a partial response. */
630
+ fields?: string;
631
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
632
+ key?: string;
633
+ /** Required. Identifier. The resource name of the CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`. */
634
+ name: string;
635
+ /** OAuth 2.0 token for the current user. */
636
+ oauth_token?: string;
637
+ /** Returns response with indentations and line breaks. */
638
+ prettyPrint?: boolean;
639
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
640
+ quotaUser?: string;
641
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
642
+ requestId?: string;
643
+ /** Optional. Field mask is used to specify the fields to be overwritten in the CustomRange resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. */
644
+ updateMask?: string;
645
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
646
+ upload_protocol?: string;
647
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
648
+ uploadType?: string;
649
+ },
650
+ body: CustomRange,
651
+ ): Request<Operation>;
652
+ /** Gets the details of a single CustomRange and its utilization. */
653
+ showUtilization(request?: {
654
+ /** V1 error format. */
655
+ '$.xgafv'?: '1' | '2';
656
+ /** OAuth access token. */
657
+ access_token?: string;
658
+ /** Data format for response. */
659
+ alt?: 'json' | 'media' | 'proto';
660
+ /** JSONP */
661
+ callback?: string;
662
+ /** Selector specifying which fields to include in a partial response. */
663
+ fields?: string;
664
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
665
+ key?: string;
666
+ /** Required. The resource name of the CustomRange. */
667
+ name: string;
668
+ /** OAuth 2.0 token for the current user. */
669
+ oauth_token?: string;
670
+ /** Returns response with indentations and line breaks. */
671
+ prettyPrint?: boolean;
672
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
673
+ quotaUser?: string;
674
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
675
+ upload_protocol?: string;
676
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
677
+ uploadType?: string;
678
+ }): Request<ShowCustomRangeUtilizationResponse>;
679
+ }
680
+ interface DiscoveredRangesResource {
681
+ /** Finds free IP ranges in a single DiscoveredRange. */
682
+ findFreeIpRanges(request?: {
683
+ /** V1 error format. */
684
+ '$.xgafv'?: '1' | '2';
685
+ /** OAuth access token. */
686
+ access_token?: string;
687
+ /** Data format for response. */
688
+ alt?: 'json' | 'media' | 'proto';
689
+ /** JSONP */
690
+ callback?: string;
691
+ /** Required. The prefix length of the free IP ranges to find. */
692
+ cidrPrefixLength?: number;
693
+ /** Selector specifying which fields to include in a partial response. */
694
+ fields?: string;
695
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
696
+ key?: string;
697
+ /** Required. The resource name of the DiscoveredRange to search within. */
698
+ name: string;
699
+ /** OAuth 2.0 token for the current user. */
700
+ oauth_token?: string;
701
+ /** Returns response with indentations and line breaks. */
702
+ prettyPrint?: boolean;
703
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
704
+ quotaUser?: string;
705
+ /** Optional. The number of free IP ranges to find. */
706
+ rangeCount?: number;
707
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
708
+ requestId?: string;
709
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
710
+ upload_protocol?: string;
711
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
712
+ uploadType?: string;
713
+ }): Request<FindDiscoveredRangeFreeIpRangesResponse>;
714
+ /** Gets details of a single DiscoveredRange. */
715
+ get(request?: {
716
+ /** V1 error format. */
717
+ '$.xgafv'?: '1' | '2';
718
+ /** OAuth access token. */
719
+ access_token?: string;
720
+ /** Data format for response. */
721
+ alt?: 'json' | 'media' | 'proto';
722
+ /** JSONP */
723
+ callback?: string;
724
+ /** Selector specifying which fields to include in a partial response. */
725
+ fields?: string;
726
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
727
+ key?: string;
728
+ /** Required. The resource name of the DiscoveredRange to retrieve. */
729
+ name: string;
730
+ /** OAuth 2.0 token for the current user. */
731
+ oauth_token?: string;
732
+ /** Returns response with indentations and line breaks. */
733
+ prettyPrint?: boolean;
734
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
735
+ quotaUser?: string;
736
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
737
+ upload_protocol?: string;
738
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
739
+ uploadType?: string;
740
+ }): Request<DiscoveredRange>;
741
+ /** Lists DiscoveredRanges in a given project and location. */
742
+ list(request?: {
743
+ /** V1 error format. */
744
+ '$.xgafv'?: '1' | '2';
745
+ /** OAuth access token. */
746
+ access_token?: string;
747
+ /** Data format for response. */
748
+ alt?: 'json' | 'media' | 'proto';
749
+ /** JSONP */
750
+ callback?: string;
751
+ /** Selector specifying which fields to include in a partial response. */
752
+ fields?: string;
753
+ /** Optional. Filter expression to filter the results. */
754
+ filter?: string;
755
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
756
+ key?: string;
757
+ /** OAuth 2.0 token for the current user. */
758
+ oauth_token?: string;
759
+ /** Optional. Hint for how to order the results. */
760
+ orderBy?: string;
761
+ /** Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
762
+ pageSize?: number;
763
+ /** Optional. A token identifying a page of results the server should return. */
764
+ pageToken?: string;
765
+ /** Required. The parent resource name, for example `projects/*‍/locations/*`. */
766
+ parent: string;
767
+ /** Returns response with indentations and line breaks. */
768
+ prettyPrint?: boolean;
769
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
770
+ quotaUser?: string;
771
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
772
+ upload_protocol?: string;
773
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
774
+ uploadType?: string;
775
+ }): Request<ListDiscoveredRangesResponse>;
776
+ /** Gets the details of a single DiscoveredRange and its utilization. */
777
+ showUtilization(request?: {
778
+ /** V1 error format. */
779
+ '$.xgafv'?: '1' | '2';
780
+ /** OAuth access token. */
781
+ access_token?: string;
782
+ /** Data format for response. */
783
+ alt?: 'json' | 'media' | 'proto';
784
+ /** JSONP */
785
+ callback?: string;
786
+ /** Selector specifying which fields to include in a partial response. */
787
+ fields?: string;
788
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
789
+ key?: string;
790
+ /** Required. The resource name of the DiscoveredRange. */
791
+ name: string;
792
+ /** OAuth 2.0 token for the current user. */
793
+ oauth_token?: string;
794
+ /** Returns response with indentations and line breaks. */
795
+ prettyPrint?: boolean;
796
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
797
+ quotaUser?: string;
798
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
799
+ upload_protocol?: string;
800
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
801
+ uploadType?: string;
802
+ }): Request<ShowDiscoveredRangeUtilizationResponse>;
803
+ }
804
+ interface IpamAdminScopesResource {
805
+ /** Checks the availability of IpamAdminScopes in a given project and location. */
806
+ checkAvailability(request?: {
807
+ /** V1 error format. */
808
+ '$.xgafv'?: '1' | '2';
809
+ /** OAuth access token. */
810
+ access_token?: string;
811
+ /** Data format for response. */
812
+ alt?: 'json' | 'media' | 'proto';
813
+ /** JSONP */
814
+ callback?: string;
815
+ /** Selector specifying which fields to include in a partial response. */
816
+ fields?: string;
817
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
818
+ key?: string;
819
+ /** OAuth 2.0 token for the current user. */
820
+ oauth_token?: string;
821
+ /** Required. The parent resource name, for example `projects/*‍/locations/*`. */
822
+ parent: string;
823
+ /** Returns response with indentations and line breaks. */
824
+ prettyPrint?: boolean;
825
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
826
+ quotaUser?: string;
827
+ /** Required. The administrative scopes to check for availability. */
828
+ scopes?: string | string[];
829
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
830
+ upload_protocol?: string;
831
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
832
+ uploadType?: string;
833
+ }): Request<CheckAvailabilityIpamAdminScopesResponse>;
834
+ /** Cleans up a single IpamAdminScope. */
835
+ cleanup(request: {
836
+ /** V1 error format. */
837
+ '$.xgafv'?: '1' | '2';
838
+ /** OAuth access token. */
839
+ access_token?: string;
840
+ /** Data format for response. */
841
+ alt?: 'json' | 'media' | 'proto';
842
+ /** JSONP */
843
+ callback?: string;
844
+ /** Selector specifying which fields to include in a partial response. */
845
+ fields?: string;
846
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
847
+ key?: string;
848
+ /** Required. The resource name of the IpamAdminScope to clean up. */
849
+ name: string;
850
+ /** OAuth 2.0 token for the current user. */
851
+ oauth_token?: string;
852
+ /** Returns response with indentations and line breaks. */
853
+ prettyPrint?: boolean;
854
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
855
+ quotaUser?: string;
856
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
857
+ upload_protocol?: string;
858
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
859
+ uploadType?: string;
860
+ /** Request body */
861
+ resource: CleanupIpamAdminScopeRequest;
862
+ }): Request<Operation>;
863
+ cleanup(
864
+ request: {
865
+ /** V1 error format. */
866
+ '$.xgafv'?: '1' | '2';
867
+ /** OAuth access token. */
868
+ access_token?: string;
869
+ /** Data format for response. */
870
+ alt?: 'json' | 'media' | 'proto';
871
+ /** JSONP */
872
+ callback?: string;
873
+ /** Selector specifying which fields to include in a partial response. */
874
+ fields?: string;
875
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
876
+ key?: string;
877
+ /** Required. The resource name of the IpamAdminScope to clean up. */
878
+ name: string;
879
+ /** OAuth 2.0 token for the current user. */
880
+ oauth_token?: string;
881
+ /** Returns response with indentations and line breaks. */
882
+ prettyPrint?: boolean;
883
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
884
+ quotaUser?: string;
885
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
886
+ upload_protocol?: string;
887
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
888
+ uploadType?: string;
889
+ },
890
+ body: CleanupIpamAdminScopeRequest,
891
+ ): Request<Operation>;
892
+ /** Creates a new IpamAdminScope in a given project and location. */
893
+ create(request: {
894
+ /** V1 error format. */
895
+ '$.xgafv'?: '1' | '2';
896
+ /** OAuth access token. */
897
+ access_token?: string;
898
+ /** Data format for response. */
899
+ alt?: 'json' | 'media' | 'proto';
900
+ /** JSONP */
901
+ callback?: string;
902
+ /** Selector specifying which fields to include in a partial response. */
903
+ fields?: string;
904
+ /** Required. The ID to use for the IpamAdminScope, which will become the final segment of the resource name. */
905
+ ipamAdminScopeId?: string;
906
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
907
+ key?: string;
908
+ /** OAuth 2.0 token for the current user. */
909
+ oauth_token?: string;
910
+ /** Required. The parent resource name where the IpamAdminScope will be created. */
911
+ parent: string;
912
+ /** Returns response with indentations and line breaks. */
913
+ prettyPrint?: boolean;
914
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
915
+ quotaUser?: string;
916
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
917
+ requestId?: string;
918
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
919
+ upload_protocol?: string;
920
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
921
+ uploadType?: string;
922
+ /** Request body */
923
+ resource: IpamAdminScope;
924
+ }): Request<Operation>;
925
+ create(
926
+ request: {
927
+ /** V1 error format. */
928
+ '$.xgafv'?: '1' | '2';
929
+ /** OAuth access token. */
930
+ access_token?: string;
931
+ /** Data format for response. */
932
+ alt?: 'json' | 'media' | 'proto';
933
+ /** JSONP */
934
+ callback?: string;
935
+ /** Selector specifying which fields to include in a partial response. */
936
+ fields?: string;
937
+ /** Required. The ID to use for the IpamAdminScope, which will become the final segment of the resource name. */
938
+ ipamAdminScopeId?: string;
939
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
940
+ key?: string;
941
+ /** OAuth 2.0 token for the current user. */
942
+ oauth_token?: string;
943
+ /** Required. The parent resource name where the IpamAdminScope will be created. */
944
+ parent: string;
945
+ /** Returns response with indentations and line breaks. */
946
+ prettyPrint?: boolean;
947
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
948
+ quotaUser?: string;
949
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
950
+ requestId?: string;
951
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
952
+ upload_protocol?: string;
953
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
954
+ uploadType?: string;
955
+ },
956
+ body: IpamAdminScope,
957
+ ): Request<Operation>;
958
+ /** Deletes a single IpamAdminScope. */
959
+ delete(request?: {
960
+ /** V1 error format. */
961
+ '$.xgafv'?: '1' | '2';
962
+ /** OAuth access token. */
963
+ access_token?: string;
964
+ /** Data format for response. */
965
+ alt?: 'json' | 'media' | 'proto';
966
+ /** JSONP */
967
+ callback?: string;
968
+ /** Selector specifying which fields to include in a partial response. */
969
+ fields?: string;
970
+ /** Optional. If set to true, all associated resources will be deleted. */
971
+ force?: boolean;
972
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
973
+ key?: string;
974
+ /** Required. The resource name of the IpamAdminScope to delete. */
975
+ name: string;
976
+ /** OAuth 2.0 token for the current user. */
977
+ oauth_token?: string;
978
+ /** Returns response with indentations and line breaks. */
979
+ prettyPrint?: boolean;
980
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
981
+ quotaUser?: string;
982
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
983
+ requestId?: string;
984
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
985
+ upload_protocol?: string;
986
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
987
+ uploadType?: string;
988
+ }): Request<Operation>;
989
+ /** Disables a single IpamAdminScope. */
990
+ disable(request: {
991
+ /** V1 error format. */
992
+ '$.xgafv'?: '1' | '2';
993
+ /** OAuth access token. */
994
+ access_token?: string;
995
+ /** Data format for response. */
996
+ alt?: 'json' | 'media' | 'proto';
997
+ /** JSONP */
998
+ callback?: string;
999
+ /** Selector specifying which fields to include in a partial response. */
1000
+ fields?: string;
1001
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1002
+ key?: string;
1003
+ /** Required. The resource name of the IpamAdminScope to disable. */
1004
+ name: string;
1005
+ /** OAuth 2.0 token for the current user. */
1006
+ oauth_token?: string;
1007
+ /** Returns response with indentations and line breaks. */
1008
+ prettyPrint?: boolean;
1009
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1010
+ quotaUser?: string;
1011
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1012
+ upload_protocol?: string;
1013
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1014
+ uploadType?: string;
1015
+ /** Request body */
1016
+ resource: DisableIpamAdminScopeRequest;
1017
+ }): Request<Operation>;
1018
+ disable(
1019
+ request: {
1020
+ /** V1 error format. */
1021
+ '$.xgafv'?: '1' | '2';
1022
+ /** OAuth access token. */
1023
+ access_token?: string;
1024
+ /** Data format for response. */
1025
+ alt?: 'json' | 'media' | 'proto';
1026
+ /** JSONP */
1027
+ callback?: string;
1028
+ /** Selector specifying which fields to include in a partial response. */
1029
+ fields?: string;
1030
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1031
+ key?: string;
1032
+ /** Required. The resource name of the IpamAdminScope to disable. */
1033
+ name: string;
1034
+ /** OAuth 2.0 token for the current user. */
1035
+ oauth_token?: string;
1036
+ /** Returns response with indentations and line breaks. */
1037
+ prettyPrint?: boolean;
1038
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1039
+ quotaUser?: string;
1040
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1041
+ upload_protocol?: string;
1042
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1043
+ uploadType?: string;
1044
+ },
1045
+ body: DisableIpamAdminScopeRequest,
1046
+ ): Request<Operation>;
1047
+ /** Gets details of a single IpamAdminScope. */
1048
+ get(request?: {
1049
+ /** V1 error format. */
1050
+ '$.xgafv'?: '1' | '2';
1051
+ /** OAuth access token. */
1052
+ access_token?: string;
1053
+ /** Data format for response. */
1054
+ alt?: 'json' | 'media' | 'proto';
1055
+ /** JSONP */
1056
+ callback?: string;
1057
+ /** Selector specifying which fields to include in a partial response. */
1058
+ fields?: string;
1059
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1060
+ key?: string;
1061
+ /** Required. The resource name of the IpamAdminScope to retrieve. */
1062
+ name: string;
1063
+ /** OAuth 2.0 token for the current user. */
1064
+ oauth_token?: string;
1065
+ /** Returns response with indentations and line breaks. */
1066
+ prettyPrint?: boolean;
1067
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1068
+ quotaUser?: string;
1069
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1070
+ upload_protocol?: string;
1071
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1072
+ uploadType?: string;
1073
+ }): Request<IpamAdminScope>;
1074
+ /** Lists IpamAdminScopes in a given project and location. */
1075
+ list(request?: {
1076
+ /** V1 error format. */
1077
+ '$.xgafv'?: '1' | '2';
1078
+ /** OAuth access token. */
1079
+ access_token?: string;
1080
+ /** Data format for response. */
1081
+ alt?: 'json' | 'media' | 'proto';
1082
+ /** JSONP */
1083
+ callback?: string;
1084
+ /** Selector specifying which fields to include in a partial response. */
1085
+ fields?: string;
1086
+ /** Optional. Filter expression to filter the results. */
1087
+ filter?: string;
1088
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1089
+ key?: string;
1090
+ /** OAuth 2.0 token for the current user. */
1091
+ oauth_token?: string;
1092
+ /** Optional. Hint for how to order the results. */
1093
+ orderBy?: string;
1094
+ /** Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
1095
+ pageSize?: number;
1096
+ /** Optional. A token identifying a page of results the server should return. */
1097
+ pageToken?: string;
1098
+ /** Required. The parent resource name, for example `projects/*‍/locations/*`. */
1099
+ parent: string;
1100
+ /** Returns response with indentations and line breaks. */
1101
+ prettyPrint?: boolean;
1102
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1103
+ quotaUser?: string;
1104
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1105
+ upload_protocol?: string;
1106
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1107
+ uploadType?: string;
1108
+ }): Request<ListIpamAdminScopesResponse>;
1109
+ /** Updates the parameters of a single IpamAdminScope. */
1110
+ patch(request: {
1111
+ /** V1 error format. */
1112
+ '$.xgafv'?: '1' | '2';
1113
+ /** OAuth access token. */
1114
+ access_token?: string;
1115
+ /** Data format for response. */
1116
+ alt?: 'json' | 'media' | 'proto';
1117
+ /** JSONP */
1118
+ callback?: string;
1119
+ /** Selector specifying which fields to include in a partial response. */
1120
+ fields?: string;
1121
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1122
+ key?: string;
1123
+ /** Required. Identifier. The resource name of the IpamAdminScope. */
1124
+ name: string;
1125
+ /** OAuth 2.0 token for the current user. */
1126
+ oauth_token?: string;
1127
+ /** Returns response with indentations and line breaks. */
1128
+ prettyPrint?: boolean;
1129
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1130
+ quotaUser?: string;
1131
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
1132
+ requestId?: string;
1133
+ /** Optional. Field mask is used to specify the fields to be overwritten in the IpamAdminScope resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. */
1134
+ updateMask?: string;
1135
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1136
+ upload_protocol?: string;
1137
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1138
+ uploadType?: string;
1139
+ /** Request body */
1140
+ resource: IpamAdminScope;
1141
+ }): Request<Operation>;
1142
+ patch(
1143
+ request: {
1144
+ /** V1 error format. */
1145
+ '$.xgafv'?: '1' | '2';
1146
+ /** OAuth access token. */
1147
+ access_token?: string;
1148
+ /** Data format for response. */
1149
+ alt?: 'json' | 'media' | 'proto';
1150
+ /** JSONP */
1151
+ callback?: string;
1152
+ /** Selector specifying which fields to include in a partial response. */
1153
+ fields?: string;
1154
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1155
+ key?: string;
1156
+ /** Required. Identifier. The resource name of the IpamAdminScope. */
1157
+ name: string;
1158
+ /** OAuth 2.0 token for the current user. */
1159
+ oauth_token?: string;
1160
+ /** Returns response with indentations and line breaks. */
1161
+ prettyPrint?: boolean;
1162
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1163
+ quotaUser?: string;
1164
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
1165
+ requestId?: string;
1166
+ /** Optional. Field mask is used to specify the fields to be overwritten in the IpamAdminScope resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. */
1167
+ updateMask?: string;
1168
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1169
+ upload_protocol?: string;
1170
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1171
+ uploadType?: string;
1172
+ },
1173
+ body: IpamAdminScope,
1174
+ ): Request<Operation>;
1175
+ }
1176
+ interface OperationsResource {
1177
+ /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
1178
+ cancel(request: {
1179
+ /** V1 error format. */
1180
+ '$.xgafv'?: '1' | '2';
1181
+ /** OAuth access token. */
1182
+ access_token?: string;
1183
+ /** Data format for response. */
1184
+ alt?: 'json' | 'media' | 'proto';
1185
+ /** JSONP */
1186
+ callback?: string;
1187
+ /** Selector specifying which fields to include in a partial response. */
1188
+ fields?: string;
1189
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1190
+ key?: string;
1191
+ /** The name of the operation resource to be cancelled. */
1192
+ name: string;
1193
+ /** OAuth 2.0 token for the current user. */
1194
+ oauth_token?: string;
1195
+ /** Returns response with indentations and line breaks. */
1196
+ prettyPrint?: boolean;
1197
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1198
+ quotaUser?: string;
1199
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1200
+ upload_protocol?: string;
1201
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1202
+ uploadType?: string;
1203
+ /** Request body */
1204
+ resource: CancelOperationRequest;
1205
+ }): Request<{}>;
1206
+ cancel(
1207
+ request: {
1208
+ /** V1 error format. */
1209
+ '$.xgafv'?: '1' | '2';
1210
+ /** OAuth access token. */
1211
+ access_token?: string;
1212
+ /** Data format for response. */
1213
+ alt?: 'json' | 'media' | 'proto';
1214
+ /** JSONP */
1215
+ callback?: string;
1216
+ /** Selector specifying which fields to include in a partial response. */
1217
+ fields?: string;
1218
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1219
+ key?: string;
1220
+ /** The name of the operation resource to be cancelled. */
1221
+ name: string;
1222
+ /** OAuth 2.0 token for the current user. */
1223
+ oauth_token?: string;
1224
+ /** Returns response with indentations and line breaks. */
1225
+ prettyPrint?: boolean;
1226
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1227
+ quotaUser?: string;
1228
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1229
+ upload_protocol?: string;
1230
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1231
+ uploadType?: string;
1232
+ },
1233
+ body: CancelOperationRequest,
1234
+ ): Request<{}>;
1235
+ /** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
1236
+ delete(request?: {
1237
+ /** V1 error format. */
1238
+ '$.xgafv'?: '1' | '2';
1239
+ /** OAuth access token. */
1240
+ access_token?: string;
1241
+ /** Data format for response. */
1242
+ alt?: 'json' | 'media' | 'proto';
1243
+ /** JSONP */
1244
+ callback?: string;
1245
+ /** Selector specifying which fields to include in a partial response. */
1246
+ fields?: string;
1247
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1248
+ key?: string;
1249
+ /** The name of the operation resource to be deleted. */
1250
+ name: string;
1251
+ /** OAuth 2.0 token for the current user. */
1252
+ oauth_token?: string;
1253
+ /** Returns response with indentations and line breaks. */
1254
+ prettyPrint?: boolean;
1255
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1256
+ quotaUser?: string;
1257
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1258
+ upload_protocol?: string;
1259
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1260
+ uploadType?: string;
1261
+ }): Request<{}>;
1262
+ /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
1263
+ get(request?: {
1264
+ /** V1 error format. */
1265
+ '$.xgafv'?: '1' | '2';
1266
+ /** OAuth access token. */
1267
+ access_token?: string;
1268
+ /** Data format for response. */
1269
+ alt?: 'json' | 'media' | 'proto';
1270
+ /** JSONP */
1271
+ callback?: string;
1272
+ /** Selector specifying which fields to include in a partial response. */
1273
+ fields?: string;
1274
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1275
+ key?: string;
1276
+ /** The name of the operation resource. */
1277
+ name: string;
1278
+ /** OAuth 2.0 token for the current user. */
1279
+ oauth_token?: string;
1280
+ /** Returns response with indentations and line breaks. */
1281
+ prettyPrint?: boolean;
1282
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1283
+ quotaUser?: string;
1284
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1285
+ upload_protocol?: string;
1286
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1287
+ uploadType?: string;
1288
+ }): Request<Operation>;
1289
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
1290
+ list(request?: {
1291
+ /** V1 error format. */
1292
+ '$.xgafv'?: '1' | '2';
1293
+ /** OAuth access token. */
1294
+ access_token?: string;
1295
+ /** Data format for response. */
1296
+ alt?: 'json' | 'media' | 'proto';
1297
+ /** JSONP */
1298
+ callback?: string;
1299
+ /** Selector specifying which fields to include in a partial response. */
1300
+ fields?: string;
1301
+ /** The standard list filter. */
1302
+ filter?: string;
1303
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1304
+ key?: string;
1305
+ /** The name of the operation's parent resource. */
1306
+ name: string;
1307
+ /** OAuth 2.0 token for the current user. */
1308
+ oauth_token?: string;
1309
+ /** The standard list page size. */
1310
+ pageSize?: number;
1311
+ /** The standard list page token. */
1312
+ pageToken?: string;
1313
+ /** Returns response with indentations and line breaks. */
1314
+ prettyPrint?: boolean;
1315
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1316
+ quotaUser?: string;
1317
+ /** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
1318
+ returnPartialSuccess?: boolean;
1319
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1320
+ upload_protocol?: string;
1321
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1322
+ uploadType?: string;
1323
+ }): Request<ListOperationsResponse>;
1324
+ }
1325
+ interface RealmsResource {
1326
+ /** Creates a new Realm in a given project and location. */
1327
+ create(request: {
1328
+ /** V1 error format. */
1329
+ '$.xgafv'?: '1' | '2';
1330
+ /** OAuth access token. */
1331
+ access_token?: string;
1332
+ /** Data format for response. */
1333
+ alt?: 'json' | 'media' | 'proto';
1334
+ /** JSONP */
1335
+ callback?: string;
1336
+ /** Selector specifying which fields to include in a partial response. */
1337
+ fields?: string;
1338
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1339
+ key?: string;
1340
+ /** OAuth 2.0 token for the current user. */
1341
+ oauth_token?: string;
1342
+ /** Required. The parent resource name where the Realm will be created. */
1343
+ parent: string;
1344
+ /** Returns response with indentations and line breaks. */
1345
+ prettyPrint?: boolean;
1346
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1347
+ quotaUser?: string;
1348
+ /** Required. The ID to use for the Realm, which will become the final segment of the resource name. */
1349
+ realmId?: string;
1350
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. */
1351
+ requestId?: string;
1352
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1353
+ upload_protocol?: string;
1354
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1355
+ uploadType?: string;
1356
+ /** Request body */
1357
+ resource: Realm;
1358
+ }): Request<Operation>;
1359
+ create(
1360
+ request: {
1361
+ /** V1 error format. */
1362
+ '$.xgafv'?: '1' | '2';
1363
+ /** OAuth access token. */
1364
+ access_token?: string;
1365
+ /** Data format for response. */
1366
+ alt?: 'json' | 'media' | 'proto';
1367
+ /** JSONP */
1368
+ callback?: string;
1369
+ /** Selector specifying which fields to include in a partial response. */
1370
+ fields?: string;
1371
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1372
+ key?: string;
1373
+ /** OAuth 2.0 token for the current user. */
1374
+ oauth_token?: string;
1375
+ /** Required. The parent resource name where the Realm will be created. */
1376
+ parent: string;
1377
+ /** Returns response with indentations and line breaks. */
1378
+ prettyPrint?: boolean;
1379
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1380
+ quotaUser?: string;
1381
+ /** Required. The ID to use for the Realm, which will become the final segment of the resource name. */
1382
+ realmId?: string;
1383
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. */
1384
+ requestId?: string;
1385
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1386
+ upload_protocol?: string;
1387
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1388
+ uploadType?: string;
1389
+ },
1390
+ body: Realm,
1391
+ ): Request<Operation>;
1392
+ /** Deletes a single Realm. */
1393
+ delete(request?: {
1394
+ /** V1 error format. */
1395
+ '$.xgafv'?: '1' | '2';
1396
+ /** OAuth access token. */
1397
+ access_token?: string;
1398
+ /** Data format for response. */
1399
+ alt?: 'json' | 'media' | 'proto';
1400
+ /** JSONP */
1401
+ callback?: string;
1402
+ /** Selector specifying which fields to include in a partial response. */
1403
+ fields?: string;
1404
+ /** Optional. If set to true, all associated resources will be deleted. */
1405
+ force?: boolean;
1406
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1407
+ key?: string;
1408
+ /** Required. The resource name of the Realm to delete. */
1409
+ name: string;
1410
+ /** OAuth 2.0 token for the current user. */
1411
+ oauth_token?: string;
1412
+ /** Returns response with indentations and line breaks. */
1413
+ prettyPrint?: boolean;
1414
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1415
+ quotaUser?: string;
1416
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. */
1417
+ requestId?: string;
1418
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1419
+ upload_protocol?: string;
1420
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1421
+ uploadType?: string;
1422
+ }): Request<Operation>;
1423
+ /** Gets details of a single Realm. */
1424
+ get(request?: {
1425
+ /** V1 error format. */
1426
+ '$.xgafv'?: '1' | '2';
1427
+ /** OAuth access token. */
1428
+ access_token?: string;
1429
+ /** Data format for response. */
1430
+ alt?: 'json' | 'media' | 'proto';
1431
+ /** JSONP */
1432
+ callback?: string;
1433
+ /** Selector specifying which fields to include in a partial response. */
1434
+ fields?: string;
1435
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1436
+ key?: string;
1437
+ /** Required. The resource name of the Realm to retrieve. */
1438
+ name: string;
1439
+ /** OAuth 2.0 token for the current user. */
1440
+ oauth_token?: string;
1441
+ /** Returns response with indentations and line breaks. */
1442
+ prettyPrint?: boolean;
1443
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1444
+ quotaUser?: string;
1445
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1446
+ upload_protocol?: string;
1447
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1448
+ uploadType?: string;
1449
+ /** Optional. The view of the Realm to retrieve. */
1450
+ view?: 'REALM_VIEW_UNSPECIFIED' | 'BASIC' | 'FULL' | 'AGGREGATE';
1451
+ }): Request<Realm>;
1452
+ /** Lists Realms in a given project and location. */
1453
+ list(request?: {
1454
+ /** V1 error format. */
1455
+ '$.xgafv'?: '1' | '2';
1456
+ /** OAuth access token. */
1457
+ access_token?: string;
1458
+ /** Data format for response. */
1459
+ alt?: 'json' | 'media' | 'proto';
1460
+ /** JSONP */
1461
+ callback?: string;
1462
+ /** Selector specifying which fields to include in a partial response. */
1463
+ fields?: string;
1464
+ /** Optional. Filter expression to filter the results. */
1465
+ filter?: string;
1466
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1467
+ key?: string;
1468
+ /** OAuth 2.0 token for the current user. */
1469
+ oauth_token?: string;
1470
+ /** Optional. Hint for how to order the results. */
1471
+ orderBy?: string;
1472
+ /** Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
1473
+ pageSize?: number;
1474
+ /** Optional. A token identifying a page of results the server should return. */
1475
+ pageToken?: string;
1476
+ /** Required. The parent resource name, for example `projects/*‍/locations/*`. */
1477
+ parent: string;
1478
+ /** Returns response with indentations and line breaks. */
1479
+ prettyPrint?: boolean;
1480
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1481
+ quotaUser?: string;
1482
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1483
+ upload_protocol?: string;
1484
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1485
+ uploadType?: string;
1486
+ /** Optional. The view of the Realm to retrieve. */
1487
+ view?: 'REALM_VIEW_UNSPECIFIED' | 'BASIC' | 'FULL' | 'AGGREGATE';
1488
+ }): Request<ListRealmsResponse>;
1489
+ /** Updates the parameters of a single Realm. */
1490
+ patch(request: {
1491
+ /** V1 error format. */
1492
+ '$.xgafv'?: '1' | '2';
1493
+ /** OAuth access token. */
1494
+ access_token?: string;
1495
+ /** Data format for response. */
1496
+ alt?: 'json' | 'media' | 'proto';
1497
+ /** JSONP */
1498
+ callback?: string;
1499
+ /** Selector specifying which fields to include in a partial response. */
1500
+ fields?: string;
1501
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1502
+ key?: string;
1503
+ /** Required. Identifier. The resource name of the Realm. */
1504
+ name: string;
1505
+ /** OAuth 2.0 token for the current user. */
1506
+ oauth_token?: string;
1507
+ /** Returns response with indentations and line breaks. */
1508
+ prettyPrint?: boolean;
1509
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1510
+ quotaUser?: string;
1511
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. */
1512
+ requestId?: string;
1513
+ /** Optional. Field mask is used to specify the fields to be overwritten in the Realm resource by the update. */
1514
+ updateMask?: string;
1515
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1516
+ upload_protocol?: string;
1517
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1518
+ uploadType?: string;
1519
+ /** Request body */
1520
+ resource: Realm;
1521
+ }): Request<Operation>;
1522
+ patch(
1523
+ request: {
1524
+ /** V1 error format. */
1525
+ '$.xgafv'?: '1' | '2';
1526
+ /** OAuth access token. */
1527
+ access_token?: string;
1528
+ /** Data format for response. */
1529
+ alt?: 'json' | 'media' | 'proto';
1530
+ /** JSONP */
1531
+ callback?: string;
1532
+ /** Selector specifying which fields to include in a partial response. */
1533
+ fields?: string;
1534
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1535
+ key?: string;
1536
+ /** Required. Identifier. The resource name of the Realm. */
1537
+ name: string;
1538
+ /** OAuth 2.0 token for the current user. */
1539
+ oauth_token?: string;
1540
+ /** Returns response with indentations and line breaks. */
1541
+ prettyPrint?: boolean;
1542
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1543
+ quotaUser?: string;
1544
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. */
1545
+ requestId?: string;
1546
+ /** Optional. Field mask is used to specify the fields to be overwritten in the Realm resource by the update. */
1547
+ updateMask?: string;
1548
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1549
+ upload_protocol?: string;
1550
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1551
+ uploadType?: string;
1552
+ },
1553
+ body: Realm,
1554
+ ): Request<Operation>;
1555
+ }
1556
+ interface RegistryBooksResource {
1557
+ /** Creates a new RegistryBook in a given project and location. */
1558
+ create(request: {
1559
+ /** V1 error format. */
1560
+ '$.xgafv'?: '1' | '2';
1561
+ /** OAuth access token. */
1562
+ access_token?: string;
1563
+ /** Data format for response. */
1564
+ alt?: 'json' | 'media' | 'proto';
1565
+ /** JSONP */
1566
+ callback?: string;
1567
+ /** Selector specifying which fields to include in a partial response. */
1568
+ fields?: string;
1569
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1570
+ key?: string;
1571
+ /** OAuth 2.0 token for the current user. */
1572
+ oauth_token?: string;
1573
+ /** Required. The parent resource name where the RegistryBook will be created. */
1574
+ parent: string;
1575
+ /** Returns response with indentations and line breaks. */
1576
+ prettyPrint?: boolean;
1577
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1578
+ quotaUser?: string;
1579
+ /** Required. The ID to use for the RegistryBook, which will become the final segment of the resource name. */
1580
+ registryBookId?: string;
1581
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
1582
+ requestId?: string;
1583
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1584
+ upload_protocol?: string;
1585
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1586
+ uploadType?: string;
1587
+ /** Request body */
1588
+ resource: RegistryBook;
1589
+ }): Request<Operation>;
1590
+ create(
1591
+ request: {
1592
+ /** V1 error format. */
1593
+ '$.xgafv'?: '1' | '2';
1594
+ /** OAuth access token. */
1595
+ access_token?: string;
1596
+ /** Data format for response. */
1597
+ alt?: 'json' | 'media' | 'proto';
1598
+ /** JSONP */
1599
+ callback?: string;
1600
+ /** Selector specifying which fields to include in a partial response. */
1601
+ fields?: string;
1602
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1603
+ key?: string;
1604
+ /** OAuth 2.0 token for the current user. */
1605
+ oauth_token?: string;
1606
+ /** Required. The parent resource name where the RegistryBook will be created. */
1607
+ parent: string;
1608
+ /** Returns response with indentations and line breaks. */
1609
+ prettyPrint?: boolean;
1610
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1611
+ quotaUser?: string;
1612
+ /** Required. The ID to use for the RegistryBook, which will become the final segment of the resource name. */
1613
+ registryBookId?: string;
1614
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
1615
+ requestId?: string;
1616
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1617
+ upload_protocol?: string;
1618
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1619
+ uploadType?: string;
1620
+ },
1621
+ body: RegistryBook,
1622
+ ): Request<Operation>;
1623
+ /** Deletes a single RegistryBook. */
1624
+ delete(request?: {
1625
+ /** V1 error format. */
1626
+ '$.xgafv'?: '1' | '2';
1627
+ /** OAuth access token. */
1628
+ access_token?: string;
1629
+ /** Data format for response. */
1630
+ alt?: 'json' | 'media' | 'proto';
1631
+ /** JSONP */
1632
+ callback?: string;
1633
+ /** Selector specifying which fields to include in a partial response. */
1634
+ fields?: string;
1635
+ /** Optional. If set to true, all associated resources will be deleted. */
1636
+ force?: boolean;
1637
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1638
+ key?: string;
1639
+ /** Required. The resource name of the RegistryBook to delete. */
1640
+ name: string;
1641
+ /** OAuth 2.0 token for the current user. */
1642
+ oauth_token?: string;
1643
+ /** Returns response with indentations and line breaks. */
1644
+ prettyPrint?: boolean;
1645
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1646
+ quotaUser?: string;
1647
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
1648
+ requestId?: string;
1649
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1650
+ upload_protocol?: string;
1651
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1652
+ uploadType?: string;
1653
+ }): Request<Operation>;
1654
+ /** Gets details of a single RegistryBook. */
1655
+ get(request?: {
1656
+ /** V1 error format. */
1657
+ '$.xgafv'?: '1' | '2';
1658
+ /** OAuth access token. */
1659
+ access_token?: string;
1660
+ /** Data format for response. */
1661
+ alt?: 'json' | 'media' | 'proto';
1662
+ /** JSONP */
1663
+ callback?: string;
1664
+ /** Selector specifying which fields to include in a partial response. */
1665
+ fields?: string;
1666
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1667
+ key?: string;
1668
+ /** Required. The resource name of the RegistryBook to retrieve. */
1669
+ name: string;
1670
+ /** OAuth 2.0 token for the current user. */
1671
+ oauth_token?: string;
1672
+ /** Returns response with indentations and line breaks. */
1673
+ prettyPrint?: boolean;
1674
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1675
+ quotaUser?: string;
1676
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1677
+ upload_protocol?: string;
1678
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1679
+ uploadType?: string;
1680
+ /** Optional. The view of the RegistryBook to retrieve. */
1681
+ view?:
1682
+ | 'REGISTRY_BOOK_VIEW_UNSPECIFIED'
1683
+ | 'BASIC'
1684
+ | 'FULL'
1685
+ | 'AGGREGATE';
1686
+ }): Request<RegistryBook>;
1687
+ /** Lists RegistryBooks in a given project and location. */
1688
+ list(request?: {
1689
+ /** V1 error format. */
1690
+ '$.xgafv'?: '1' | '2';
1691
+ /** OAuth access token. */
1692
+ access_token?: string;
1693
+ /** Data format for response. */
1694
+ alt?: 'json' | 'media' | 'proto';
1695
+ /** JSONP */
1696
+ callback?: string;
1697
+ /** Selector specifying which fields to include in a partial response. */
1698
+ fields?: string;
1699
+ /** Optional. Filter expression to filter the results. */
1700
+ filter?: string;
1701
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1702
+ key?: string;
1703
+ /** OAuth 2.0 token for the current user. */
1704
+ oauth_token?: string;
1705
+ /** Optional. Hint for how to order the results. */
1706
+ orderBy?: string;
1707
+ /** Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
1708
+ pageSize?: number;
1709
+ /** Optional. A token identifying a page of results the server should return. */
1710
+ pageToken?: string;
1711
+ /** Required. The parent resource name, for example `projects/*‍/locations/*`. */
1712
+ parent: string;
1713
+ /** Returns response with indentations and line breaks. */
1714
+ prettyPrint?: boolean;
1715
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1716
+ quotaUser?: string;
1717
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1718
+ upload_protocol?: string;
1719
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1720
+ uploadType?: string;
1721
+ /** Optional. The view of the RegistryBook to retrieve. */
1722
+ view?:
1723
+ | 'REGISTRY_BOOK_VIEW_UNSPECIFIED'
1724
+ | 'BASIC'
1725
+ | 'FULL'
1726
+ | 'AGGREGATE';
1727
+ }): Request<ListRegistryBooksResponse>;
1728
+ /** Updates the parameters of a single RegistryBook. */
1729
+ patch(request: {
1730
+ /** V1 error format. */
1731
+ '$.xgafv'?: '1' | '2';
1732
+ /** OAuth access token. */
1733
+ access_token?: string;
1734
+ /** Data format for response. */
1735
+ alt?: 'json' | 'media' | 'proto';
1736
+ /** JSONP */
1737
+ callback?: string;
1738
+ /** Selector specifying which fields to include in a partial response. */
1739
+ fields?: string;
1740
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1741
+ key?: string;
1742
+ /** Required. Identifier. The resource name of the RegistryBook. */
1743
+ name: string;
1744
+ /** OAuth 2.0 token for the current user. */
1745
+ oauth_token?: string;
1746
+ /** Returns response with indentations and line breaks. */
1747
+ prettyPrint?: boolean;
1748
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1749
+ quotaUser?: string;
1750
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
1751
+ requestId?: string;
1752
+ /** Optional. Field mask is used to specify the fields to be overwritten in the RegistryBook resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. */
1753
+ updateMask?: string;
1754
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1755
+ upload_protocol?: string;
1756
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1757
+ uploadType?: string;
1758
+ /** Request body */
1759
+ resource: RegistryBook;
1760
+ }): Request<Operation>;
1761
+ patch(
1762
+ request: {
1763
+ /** V1 error format. */
1764
+ '$.xgafv'?: '1' | '2';
1765
+ /** OAuth access token. */
1766
+ access_token?: string;
1767
+ /** Data format for response. */
1768
+ alt?: 'json' | 'media' | 'proto';
1769
+ /** JSONP */
1770
+ callback?: string;
1771
+ /** Selector specifying which fields to include in a partial response. */
1772
+ fields?: string;
1773
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1774
+ key?: string;
1775
+ /** Required. Identifier. The resource name of the RegistryBook. */
1776
+ name: string;
1777
+ /** OAuth 2.0 token for the current user. */
1778
+ oauth_token?: string;
1779
+ /** Returns response with indentations and line breaks. */
1780
+ prettyPrint?: boolean;
1781
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1782
+ quotaUser?: string;
1783
+ /** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
1784
+ requestId?: string;
1785
+ /** Optional. Field mask is used to specify the fields to be overwritten in the RegistryBook resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. */
1786
+ updateMask?: string;
1787
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1788
+ upload_protocol?: string;
1789
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1790
+ uploadType?: string;
1791
+ },
1792
+ body: RegistryBook,
1793
+ ): Request<Operation>;
1794
+ /** Searches IP resources in a given RegistryBook. */
1795
+ searchIpResources(request: {
1796
+ /** V1 error format. */
1797
+ '$.xgafv'?: '1' | '2';
1798
+ /** OAuth access token. */
1799
+ access_token?: string;
1800
+ /** Data format for response. */
1801
+ alt?: 'json' | 'media' | 'proto';
1802
+ /** JSONP */
1803
+ callback?: string;
1804
+ /** Selector specifying which fields to include in a partial response. */
1805
+ fields?: string;
1806
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1807
+ key?: string;
1808
+ /** Required. The resource name of the RegistryBook to search in. */
1809
+ name: string;
1810
+ /** OAuth 2.0 token for the current user. */
1811
+ oauth_token?: string;
1812
+ /** Returns response with indentations and line breaks. */
1813
+ prettyPrint?: boolean;
1814
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1815
+ quotaUser?: string;
1816
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1817
+ upload_protocol?: string;
1818
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1819
+ uploadType?: string;
1820
+ /** Request body */
1821
+ resource: SearchIpResourcesRequest;
1822
+ }): Request<SearchIpResourcesResponse>;
1823
+ searchIpResources(
1824
+ request: {
1825
+ /** V1 error format. */
1826
+ '$.xgafv'?: '1' | '2';
1827
+ /** OAuth access token. */
1828
+ access_token?: string;
1829
+ /** Data format for response. */
1830
+ alt?: 'json' | 'media' | 'proto';
1831
+ /** JSONP */
1832
+ callback?: string;
1833
+ /** Selector specifying which fields to include in a partial response. */
1834
+ fields?: string;
1835
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1836
+ key?: string;
1837
+ /** Required. The resource name of the RegistryBook to search in. */
1838
+ name: string;
1839
+ /** OAuth 2.0 token for the current user. */
1840
+ oauth_token?: string;
1841
+ /** Returns response with indentations and line breaks. */
1842
+ prettyPrint?: boolean;
1843
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1844
+ quotaUser?: string;
1845
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1846
+ upload_protocol?: string;
1847
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1848
+ uploadType?: string;
1849
+ },
1850
+ body: SearchIpResourcesRequest,
1851
+ ): Request<SearchIpResourcesResponse>;
1852
+ }
1853
+ interface LocationsResource {
1854
+ /** Gets information about a location. */
1855
+ get(request?: {
1856
+ /** V1 error format. */
1857
+ '$.xgafv'?: '1' | '2';
1858
+ /** OAuth access token. */
1859
+ access_token?: string;
1860
+ /** Data format for response. */
1861
+ alt?: 'json' | 'media' | 'proto';
1862
+ /** JSONP */
1863
+ callback?: string;
1864
+ /** Selector specifying which fields to include in a partial response. */
1865
+ fields?: string;
1866
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1867
+ key?: string;
1868
+ /** Resource name for the location. */
1869
+ name: string;
1870
+ /** OAuth 2.0 token for the current user. */
1871
+ oauth_token?: string;
1872
+ /** Returns response with indentations and line breaks. */
1873
+ prettyPrint?: boolean;
1874
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1875
+ quotaUser?: string;
1876
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1877
+ upload_protocol?: string;
1878
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1879
+ uploadType?: string;
1880
+ }): Request<Location>;
1881
+ /** Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. */
1882
+ list(request?: {
1883
+ /** V1 error format. */
1884
+ '$.xgafv'?: '1' | '2';
1885
+ /** OAuth access token. */
1886
+ access_token?: string;
1887
+ /** Data format for response. */
1888
+ alt?: 'json' | 'media' | 'proto';
1889
+ /** JSONP */
1890
+ callback?: string;
1891
+ /** Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */
1892
+ extraLocationTypes?: string | string[];
1893
+ /** Selector specifying which fields to include in a partial response. */
1894
+ fields?: string;
1895
+ /** A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). */
1896
+ filter?: string;
1897
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1898
+ key?: string;
1899
+ /** The resource that owns the locations collection, if applicable. */
1900
+ name: string;
1901
+ /** OAuth 2.0 token for the current user. */
1902
+ oauth_token?: string;
1903
+ /** The maximum number of results to return. If not set, the service selects a default. */
1904
+ pageSize?: number;
1905
+ /** A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. */
1906
+ pageToken?: string;
1907
+ /** Returns response with indentations and line breaks. */
1908
+ prettyPrint?: boolean;
1909
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1910
+ quotaUser?: string;
1911
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1912
+ upload_protocol?: string;
1913
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1914
+ uploadType?: string;
1915
+ }): Request<ListLocationsResponse>;
1916
+ customRanges: CustomRangesResource;
1917
+ discoveredRanges: DiscoveredRangesResource;
1918
+ ipamAdminScopes: IpamAdminScopesResource;
1919
+ operations: OperationsResource;
1920
+ realms: RealmsResource;
1921
+ registryBooks: RegistryBooksResource;
1922
+ }
1923
+ interface ProjectsResource {
1924
+ locations: LocationsResource;
1925
+ }
1926
+
1927
+ const projects: ProjectsResource;
1928
+ }
1929
+ }