@googleapis/servicenetworking 21.7.0 → 23.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +47 -0
- package/build/index.d.ts +1 -1
- package/build/index.js.map +1 -1
- package/build/v1.d.ts +1881 -74
- package/build/v1.js.map +1 -1
- package/build/v1beta.d.ts +465 -19
- package/build/v1beta.js.map +1 -1
- package/index.ts +0 -1
- package/package.json +2 -2
- package/v1.ts +1980 -111
- package/v1beta.ts +486 -26
package/build/v1beta.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
|
-
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient,
|
|
2
|
+
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
|
|
3
3
|
import { Readable } from 'stream';
|
|
4
4
|
export declare namespace servicenetworking_v1beta {
|
|
5
5
|
export interface Options extends GlobalOptions {
|
|
@@ -188,7 +188,7 @@ export declare namespace servicenetworking_v1beta {
|
|
|
188
188
|
*/
|
|
189
189
|
kind?: string | null;
|
|
190
190
|
/**
|
|
191
|
-
* Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `
|
|
191
|
+
* Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`.
|
|
192
192
|
*/
|
|
193
193
|
spec?: {
|
|
194
194
|
[key: string]: any;
|
|
@@ -327,6 +327,73 @@ export declare namespace servicenetworking_v1beta {
|
|
|
327
327
|
*/
|
|
328
328
|
selector?: string | null;
|
|
329
329
|
}
|
|
330
|
+
/**
|
|
331
|
+
* `BatchingConfigProto` defines the batching configuration for an API method.
|
|
332
|
+
*/
|
|
333
|
+
export interface Schema$BatchingConfigProto {
|
|
334
|
+
/**
|
|
335
|
+
* The request and response fields used in batching.
|
|
336
|
+
*/
|
|
337
|
+
batchDescriptor?: Schema$BatchingDescriptorProto;
|
|
338
|
+
/**
|
|
339
|
+
* The thresholds which trigger a batched request to be sent.
|
|
340
|
+
*/
|
|
341
|
+
thresholds?: Schema$BatchingSettingsProto;
|
|
342
|
+
}
|
|
343
|
+
/**
|
|
344
|
+
* `BatchingDescriptorProto` specifies the fields of the request message to be used for batching, and, optionally, the fields of the response message to be used for demultiplexing.
|
|
345
|
+
*/
|
|
346
|
+
export interface Schema$BatchingDescriptorProto {
|
|
347
|
+
/**
|
|
348
|
+
* The repeated field in the request message to be aggregated by batching.
|
|
349
|
+
*/
|
|
350
|
+
batchedField?: string | null;
|
|
351
|
+
/**
|
|
352
|
+
* A list of the fields in the request message. Two requests will be batched together only if the values of every field specified in `request_discriminator_fields` is equal between the two requests.
|
|
353
|
+
*/
|
|
354
|
+
discriminatorFields?: string[] | null;
|
|
355
|
+
/**
|
|
356
|
+
* Optional. When present, indicates the field in the response message to be used to demultiplex the response into multiple response messages, in correspondence with the multiple request messages originally batched together.
|
|
357
|
+
*/
|
|
358
|
+
subresponseField?: string | null;
|
|
359
|
+
}
|
|
360
|
+
/**
|
|
361
|
+
* `BatchingSettingsProto` specifies a set of batching thresholds, each of which acts as a trigger to send a batch of messages as a request. At least one threshold must be positive nonzero.
|
|
362
|
+
*/
|
|
363
|
+
export interface Schema$BatchingSettingsProto {
|
|
364
|
+
/**
|
|
365
|
+
* The duration after which a batch should be sent, starting from the addition of the first message to that batch.
|
|
366
|
+
*/
|
|
367
|
+
delayThreshold?: string | null;
|
|
368
|
+
/**
|
|
369
|
+
* The maximum number of elements collected in a batch that could be accepted by server.
|
|
370
|
+
*/
|
|
371
|
+
elementCountLimit?: number | null;
|
|
372
|
+
/**
|
|
373
|
+
* The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.
|
|
374
|
+
*/
|
|
375
|
+
elementCountThreshold?: number | null;
|
|
376
|
+
/**
|
|
377
|
+
* The maximum size of data allowed by flow control.
|
|
378
|
+
*/
|
|
379
|
+
flowControlByteLimit?: number | null;
|
|
380
|
+
/**
|
|
381
|
+
* The maximum number of elements allowed by flow control.
|
|
382
|
+
*/
|
|
383
|
+
flowControlElementLimit?: number | null;
|
|
384
|
+
/**
|
|
385
|
+
* The behavior to take when the flow control limit is exceeded.
|
|
386
|
+
*/
|
|
387
|
+
flowControlLimitExceededBehavior?: string | null;
|
|
388
|
+
/**
|
|
389
|
+
* The maximum size of the request that could be accepted by server.
|
|
390
|
+
*/
|
|
391
|
+
requestByteLimit?: number | null;
|
|
392
|
+
/**
|
|
393
|
+
* The aggregated size of the batched field which, if exceeded, causes the batch to be sent. This size is computed by aggregating the sizes of the request field to be batched, not of the entire request message.
|
|
394
|
+
*/
|
|
395
|
+
requestByteThreshold?: string | null;
|
|
396
|
+
}
|
|
330
397
|
/**
|
|
331
398
|
* Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count
|
|
332
399
|
*/
|
|
@@ -349,6 +416,11 @@ export declare namespace servicenetworking_v1beta {
|
|
|
349
416
|
*/
|
|
350
417
|
monitoredResource?: string | null;
|
|
351
418
|
}
|
|
419
|
+
/**
|
|
420
|
+
* Metadata provided through GetOperation request for the LRO generated by Cleanup Connection API
|
|
421
|
+
*/
|
|
422
|
+
export interface Schema$CleanupConnectionMetadata {
|
|
423
|
+
}
|
|
352
424
|
/**
|
|
353
425
|
* Details about how and where to publish client libraries.
|
|
354
426
|
*/
|
|
@@ -403,15 +475,15 @@ export declare namespace servicenetworking_v1beta {
|
|
|
403
475
|
*/
|
|
404
476
|
export interface Schema$CloudSQLConfig {
|
|
405
477
|
/**
|
|
406
|
-
* Peering service used for peering with the Cloud SQL project.
|
|
478
|
+
* Required. Peering service used for peering with the Cloud SQL project.
|
|
407
479
|
*/
|
|
408
480
|
service?: string | null;
|
|
409
481
|
/**
|
|
410
|
-
* The name of the umbrella network in the Cloud SQL umbrella project.
|
|
482
|
+
* Required. The name of the umbrella network in the Cloud SQL umbrella project.
|
|
411
483
|
*/
|
|
412
484
|
umbrellaNetwork?: string | null;
|
|
413
485
|
/**
|
|
414
|
-
* The project number of the Cloud SQL umbrella project.
|
|
486
|
+
* Required. The project number of the Cloud SQL umbrella project.
|
|
415
487
|
*/
|
|
416
488
|
umbrellaProject?: string | null;
|
|
417
489
|
}
|
|
@@ -437,7 +509,7 @@ export declare namespace servicenetworking_v1beta {
|
|
|
437
509
|
*/
|
|
438
510
|
export interface Schema$Connection {
|
|
439
511
|
/**
|
|
440
|
-
* The name of service consumer's VPC network that's connected with service producer network, in the following format: `projects/{project\}/global/networks/{network\}`. `{project\}` is a project number, such as in `12345` that includes the VPC service consumer's VPC network. `{network\}` is the name of the service consumer's VPC network.
|
|
512
|
+
* Required. The name of service consumer's VPC network that's connected with service producer network, in the following format: `projects/{project\}/global/networks/{network\}`. `{project\}` is a project number, such as in `12345` that includes the VPC service consumer's VPC network. `{network\}` is the name of the service consumer's VPC network.
|
|
441
513
|
*/
|
|
442
514
|
network?: string | null;
|
|
443
515
|
/**
|
|
@@ -1211,6 +1283,10 @@ export declare namespace servicenetworking_v1beta {
|
|
|
1211
1283
|
* List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4. Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.CreateExample auto_populated_fields: - request_id
|
|
1212
1284
|
*/
|
|
1213
1285
|
autoPopulatedFields?: string[] | null;
|
|
1286
|
+
/**
|
|
1287
|
+
* Batching configuration for an API method in client libraries. Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.BatchCreateExample batching: element_count_threshold: 1000 request_byte_threshold: 100000000 delay_threshold_millis: 10
|
|
1288
|
+
*/
|
|
1289
|
+
batching?: Schema$BatchingConfigProto;
|
|
1214
1290
|
/**
|
|
1215
1291
|
* Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 minutes
|
|
1216
1292
|
*/
|
|
@@ -1466,7 +1542,7 @@ export declare namespace servicenetworking_v1beta {
|
|
|
1466
1542
|
*/
|
|
1467
1543
|
dnsSuffix?: string | null;
|
|
1468
1544
|
/**
|
|
1469
|
-
* User assigned name for this resource. Must be unique within the consumer network. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
|
|
1545
|
+
* Required. User assigned name for this resource. Must be unique within the consumer network. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
|
|
1470
1546
|
*/
|
|
1471
1547
|
name?: string | null;
|
|
1472
1548
|
}
|
|
@@ -1483,6 +1559,10 @@ export declare namespace servicenetworking_v1beta {
|
|
|
1483
1559
|
* Some settings.
|
|
1484
1560
|
*/
|
|
1485
1561
|
common?: Schema$CommonLanguageSettings;
|
|
1562
|
+
/**
|
|
1563
|
+
* The package name to use in Php. Clobbers the php_namespace option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.php.package_name" field in gapic.yaml. API teams should use the protobuf php_namespace option where possible. Example of a YAML configuration:: publishing: library_settings: php_settings: library_package: Google\Cloud\PubSub\V1
|
|
1564
|
+
*/
|
|
1565
|
+
libraryPackage?: string | null;
|
|
1486
1566
|
}
|
|
1487
1567
|
/**
|
|
1488
1568
|
* Grouping of IAM role and IAM member.
|
|
@@ -2032,14 +2112,67 @@ export declare namespace servicenetworking_v1beta {
|
|
|
2032
2112
|
constructor(context: APIRequestContext);
|
|
2033
2113
|
/**
|
|
2034
2114
|
* 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.
|
|
2115
|
+
* @example
|
|
2116
|
+
* ```js
|
|
2117
|
+
* // Before running the sample:
|
|
2118
|
+
* // - Enable the API at:
|
|
2119
|
+
* // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
|
|
2120
|
+
* // - Login into gcloud by running:
|
|
2121
|
+
* // ```sh
|
|
2122
|
+
* // $ gcloud auth application-default login
|
|
2123
|
+
* // ```
|
|
2124
|
+
* // - Install the npm module by running:
|
|
2125
|
+
* // ```sh
|
|
2126
|
+
* // $ npm install googleapis
|
|
2127
|
+
* // ```
|
|
2128
|
+
*
|
|
2129
|
+
* const {google} = require('googleapis');
|
|
2130
|
+
* const servicenetworking = google.servicenetworking('v1beta');
|
|
2131
|
+
*
|
|
2132
|
+
* async function main() {
|
|
2133
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2134
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2135
|
+
* scopes: [
|
|
2136
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2137
|
+
* 'https://www.googleapis.com/auth/service.management',
|
|
2138
|
+
* ],
|
|
2139
|
+
* });
|
|
2140
|
+
*
|
|
2141
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2142
|
+
* const authClient = await auth.getClient();
|
|
2143
|
+
* google.options({auth: authClient});
|
|
2144
|
+
*
|
|
2145
|
+
* // Do the magic
|
|
2146
|
+
* const res = await servicenetworking.operations.get({
|
|
2147
|
+
* // The name of the operation resource.
|
|
2148
|
+
* name: 'operations/my-operation',
|
|
2149
|
+
* });
|
|
2150
|
+
* console.log(res.data);
|
|
2151
|
+
*
|
|
2152
|
+
* // Example response
|
|
2153
|
+
* // {
|
|
2154
|
+
* // "done": false,
|
|
2155
|
+
* // "error": {},
|
|
2156
|
+
* // "metadata": {},
|
|
2157
|
+
* // "name": "my_name",
|
|
2158
|
+
* // "response": {}
|
|
2159
|
+
* // }
|
|
2160
|
+
* }
|
|
2161
|
+
*
|
|
2162
|
+
* main().catch(e => {
|
|
2163
|
+
* console.error(e);
|
|
2164
|
+
* throw e;
|
|
2165
|
+
* });
|
|
2166
|
+
*
|
|
2167
|
+
* ```
|
|
2035
2168
|
*
|
|
2036
2169
|
* @param params - Parameters for request
|
|
2037
2170
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2038
2171
|
* @param callback - Optional callback that handles the response.
|
|
2039
2172
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2040
2173
|
*/
|
|
2041
|
-
get(params: Params$Resource$Operations$Get, options: StreamMethodOptions):
|
|
2042
|
-
get(params?: Params$Resource$Operations$Get, options?: MethodOptions):
|
|
2174
|
+
get(params: Params$Resource$Operations$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
2175
|
+
get(params?: Params$Resource$Operations$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2043
2176
|
get(params: Params$Resource$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2044
2177
|
get(params: Params$Resource$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2045
2178
|
get(params: Params$Resource$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
@@ -2057,42 +2190,240 @@ export declare namespace servicenetworking_v1beta {
|
|
|
2057
2190
|
constructor(context: APIRequestContext);
|
|
2058
2191
|
/**
|
|
2059
2192
|
* For service producers, provisions a new subnet in a peered service's shared VPC network in the requested region and with the requested size that's expressed as a CIDR range (number of leading bits of ipV4 network mask). The method checks against the assigned allocated ranges to find a non-conflicting IP address range. The method will reuse a subnet if subsequent calls contain the same subnet name, region, and prefix length. This method will make producer's tenant project to be a shared VPC service project as needed. The response from the `get` operation will be of type `Subnetwork` if the operation successfully completes.
|
|
2193
|
+
* @example
|
|
2194
|
+
* ```js
|
|
2195
|
+
* // Before running the sample:
|
|
2196
|
+
* // - Enable the API at:
|
|
2197
|
+
* // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
|
|
2198
|
+
* // - Login into gcloud by running:
|
|
2199
|
+
* // ```sh
|
|
2200
|
+
* // $ gcloud auth application-default login
|
|
2201
|
+
* // ```
|
|
2202
|
+
* // - Install the npm module by running:
|
|
2203
|
+
* // ```sh
|
|
2204
|
+
* // $ npm install googleapis
|
|
2205
|
+
* // ```
|
|
2206
|
+
*
|
|
2207
|
+
* const {google} = require('googleapis');
|
|
2208
|
+
* const servicenetworking = google.servicenetworking('v1beta');
|
|
2209
|
+
*
|
|
2210
|
+
* async function main() {
|
|
2211
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2212
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2213
|
+
* scopes: [
|
|
2214
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2215
|
+
* 'https://www.googleapis.com/auth/service.management',
|
|
2216
|
+
* ],
|
|
2217
|
+
* });
|
|
2218
|
+
*
|
|
2219
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2220
|
+
* const authClient = await auth.getClient();
|
|
2221
|
+
* google.options({auth: authClient});
|
|
2222
|
+
*
|
|
2223
|
+
* // Do the magic
|
|
2224
|
+
* const res = await servicenetworking.services.addSubnetwork({
|
|
2225
|
+
* // Required. A tenant project in the service producer organization, in the following format: services/{service\}/{collection-id\}/{resource-id\}. {collection-id\} is the cloud resource collection type that represents the tenant project. Only `projects` are supported. {resource-id\} is the tenant project numeric id, such as `123456`. {service\} the name of the peering service, such as `service-peering.example.com`. This service must already be enabled in the service consumer's project.
|
|
2226
|
+
* parent: 'services/my-service/[^/]+/[^/]+',
|
|
2227
|
+
*
|
|
2228
|
+
* // Request body metadata
|
|
2229
|
+
* requestBody: {
|
|
2230
|
+
* // request body parameters
|
|
2231
|
+
* // {
|
|
2232
|
+
* // "consumer": "my_consumer",
|
|
2233
|
+
* // "consumerNetwork": "my_consumerNetwork",
|
|
2234
|
+
* // "description": "my_description",
|
|
2235
|
+
* // "ipPrefixLength": 0,
|
|
2236
|
+
* // "region": "my_region",
|
|
2237
|
+
* // "requestedAddress": "my_requestedAddress",
|
|
2238
|
+
* // "subnetwork": "my_subnetwork",
|
|
2239
|
+
* // "subnetworkUsers": []
|
|
2240
|
+
* // }
|
|
2241
|
+
* },
|
|
2242
|
+
* });
|
|
2243
|
+
* console.log(res.data);
|
|
2244
|
+
*
|
|
2245
|
+
* // Example response
|
|
2246
|
+
* // {
|
|
2247
|
+
* // "done": false,
|
|
2248
|
+
* // "error": {},
|
|
2249
|
+
* // "metadata": {},
|
|
2250
|
+
* // "name": "my_name",
|
|
2251
|
+
* // "response": {}
|
|
2252
|
+
* // }
|
|
2253
|
+
* }
|
|
2254
|
+
*
|
|
2255
|
+
* main().catch(e => {
|
|
2256
|
+
* console.error(e);
|
|
2257
|
+
* throw e;
|
|
2258
|
+
* });
|
|
2259
|
+
*
|
|
2260
|
+
* ```
|
|
2060
2261
|
*
|
|
2061
2262
|
* @param params - Parameters for request
|
|
2062
2263
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2063
2264
|
* @param callback - Optional callback that handles the response.
|
|
2064
2265
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2065
2266
|
*/
|
|
2066
|
-
addSubnetwork(params: Params$Resource$Services$Addsubnetwork, options: StreamMethodOptions):
|
|
2067
|
-
addSubnetwork(params?: Params$Resource$Services$Addsubnetwork, options?: MethodOptions):
|
|
2267
|
+
addSubnetwork(params: Params$Resource$Services$Addsubnetwork, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
2268
|
+
addSubnetwork(params?: Params$Resource$Services$Addsubnetwork, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2068
2269
|
addSubnetwork(params: Params$Resource$Services$Addsubnetwork, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2069
2270
|
addSubnetwork(params: Params$Resource$Services$Addsubnetwork, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2070
2271
|
addSubnetwork(params: Params$Resource$Services$Addsubnetwork, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2071
2272
|
addSubnetwork(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2072
2273
|
/**
|
|
2073
2274
|
* Service producers can use this method to find a currently unused range within consumer allocated ranges. This returned range is not reserved, and not guaranteed to remain unused. It will validate previously provided allocated ranges, find non-conflicting sub-range of requested size (expressed in number of leading bits of ipv4 network mask, as in CIDR range notation). Operation
|
|
2275
|
+
* @example
|
|
2276
|
+
* ```js
|
|
2277
|
+
* // Before running the sample:
|
|
2278
|
+
* // - Enable the API at:
|
|
2279
|
+
* // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
|
|
2280
|
+
* // - Login into gcloud by running:
|
|
2281
|
+
* // ```sh
|
|
2282
|
+
* // $ gcloud auth application-default login
|
|
2283
|
+
* // ```
|
|
2284
|
+
* // - Install the npm module by running:
|
|
2285
|
+
* // ```sh
|
|
2286
|
+
* // $ npm install googleapis
|
|
2287
|
+
* // ```
|
|
2288
|
+
*
|
|
2289
|
+
* const {google} = require('googleapis');
|
|
2290
|
+
* const servicenetworking = google.servicenetworking('v1beta');
|
|
2291
|
+
*
|
|
2292
|
+
* async function main() {
|
|
2293
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2294
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2295
|
+
* scopes: [
|
|
2296
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2297
|
+
* 'https://www.googleapis.com/auth/service.management',
|
|
2298
|
+
* ],
|
|
2299
|
+
* });
|
|
2300
|
+
*
|
|
2301
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2302
|
+
* const authClient = await auth.getClient();
|
|
2303
|
+
* google.options({auth: authClient});
|
|
2304
|
+
*
|
|
2305
|
+
* // Do the magic
|
|
2306
|
+
* const res = await servicenetworking.services.searchRange({
|
|
2307
|
+
* // Required. This is in a form services/{service\}. {service\} the name of the private access management service, for example 'service-peering.example.com'.
|
|
2308
|
+
* parent: 'services/my-service',
|
|
2309
|
+
*
|
|
2310
|
+
* // Request body metadata
|
|
2311
|
+
* requestBody: {
|
|
2312
|
+
* // request body parameters
|
|
2313
|
+
* // {
|
|
2314
|
+
* // "ipPrefixLength": 0,
|
|
2315
|
+
* // "network": "my_network"
|
|
2316
|
+
* // }
|
|
2317
|
+
* },
|
|
2318
|
+
* });
|
|
2319
|
+
* console.log(res.data);
|
|
2320
|
+
*
|
|
2321
|
+
* // Example response
|
|
2322
|
+
* // {
|
|
2323
|
+
* // "done": false,
|
|
2324
|
+
* // "error": {},
|
|
2325
|
+
* // "metadata": {},
|
|
2326
|
+
* // "name": "my_name",
|
|
2327
|
+
* // "response": {}
|
|
2328
|
+
* // }
|
|
2329
|
+
* }
|
|
2330
|
+
*
|
|
2331
|
+
* main().catch(e => {
|
|
2332
|
+
* console.error(e);
|
|
2333
|
+
* throw e;
|
|
2334
|
+
* });
|
|
2335
|
+
*
|
|
2336
|
+
* ```
|
|
2074
2337
|
*
|
|
2075
2338
|
* @param params - Parameters for request
|
|
2076
2339
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2077
2340
|
* @param callback - Optional callback that handles the response.
|
|
2078
2341
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2079
2342
|
*/
|
|
2080
|
-
searchRange(params: Params$Resource$Services$Searchrange, options: StreamMethodOptions):
|
|
2081
|
-
searchRange(params?: Params$Resource$Services$Searchrange, options?: MethodOptions):
|
|
2343
|
+
searchRange(params: Params$Resource$Services$Searchrange, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
2344
|
+
searchRange(params?: Params$Resource$Services$Searchrange, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2082
2345
|
searchRange(params: Params$Resource$Services$Searchrange, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2083
2346
|
searchRange(params: Params$Resource$Services$Searchrange, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2084
2347
|
searchRange(params: Params$Resource$Services$Searchrange, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2085
2348
|
searchRange(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2086
2349
|
/**
|
|
2087
2350
|
* Updates the allocated ranges that are assigned to a connection. The response from the `get` operation will be of type `Connection` if the operation successfully completes.
|
|
2351
|
+
* @example
|
|
2352
|
+
* ```js
|
|
2353
|
+
* // Before running the sample:
|
|
2354
|
+
* // - Enable the API at:
|
|
2355
|
+
* // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
|
|
2356
|
+
* // - Login into gcloud by running:
|
|
2357
|
+
* // ```sh
|
|
2358
|
+
* // $ gcloud auth application-default login
|
|
2359
|
+
* // ```
|
|
2360
|
+
* // - Install the npm module by running:
|
|
2361
|
+
* // ```sh
|
|
2362
|
+
* // $ npm install googleapis
|
|
2363
|
+
* // ```
|
|
2364
|
+
*
|
|
2365
|
+
* const {google} = require('googleapis');
|
|
2366
|
+
* const servicenetworking = google.servicenetworking('v1beta');
|
|
2367
|
+
*
|
|
2368
|
+
* async function main() {
|
|
2369
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2370
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2371
|
+
* scopes: [
|
|
2372
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2373
|
+
* 'https://www.googleapis.com/auth/service.management',
|
|
2374
|
+
* ],
|
|
2375
|
+
* });
|
|
2376
|
+
*
|
|
2377
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2378
|
+
* const authClient = await auth.getClient();
|
|
2379
|
+
* google.options({auth: authClient});
|
|
2380
|
+
*
|
|
2381
|
+
* // Do the magic
|
|
2382
|
+
* const res = await servicenetworking.services.updateConnections({
|
|
2383
|
+
* // If a previously defined allocated range is removed, force flag must be set to true.
|
|
2384
|
+
* force: 'placeholder-value',
|
|
2385
|
+
* // The service producer peering service that is managing peering connectivity for a service producer organization. For Google services that support this functionality, this is `services/servicenetworking.googleapis.com`.
|
|
2386
|
+
* name: 'services/my-service',
|
|
2387
|
+
* // The update mask. If this is omitted, it defaults to "*". You can only update the listed peering ranges.
|
|
2388
|
+
* updateMask: 'placeholder-value',
|
|
2389
|
+
*
|
|
2390
|
+
* // Request body metadata
|
|
2391
|
+
* requestBody: {
|
|
2392
|
+
* // request body parameters
|
|
2393
|
+
* // {
|
|
2394
|
+
* // "network": "my_network",
|
|
2395
|
+
* // "peering": "my_peering",
|
|
2396
|
+
* // "reservedPeeringRanges": [],
|
|
2397
|
+
* // "service": "my_service"
|
|
2398
|
+
* // }
|
|
2399
|
+
* },
|
|
2400
|
+
* });
|
|
2401
|
+
* console.log(res.data);
|
|
2402
|
+
*
|
|
2403
|
+
* // Example response
|
|
2404
|
+
* // {
|
|
2405
|
+
* // "done": false,
|
|
2406
|
+
* // "error": {},
|
|
2407
|
+
* // "metadata": {},
|
|
2408
|
+
* // "name": "my_name",
|
|
2409
|
+
* // "response": {}
|
|
2410
|
+
* // }
|
|
2411
|
+
* }
|
|
2412
|
+
*
|
|
2413
|
+
* main().catch(e => {
|
|
2414
|
+
* console.error(e);
|
|
2415
|
+
* throw e;
|
|
2416
|
+
* });
|
|
2417
|
+
*
|
|
2418
|
+
* ```
|
|
2088
2419
|
*
|
|
2089
2420
|
* @param params - Parameters for request
|
|
2090
2421
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2091
2422
|
* @param callback - Optional callback that handles the response.
|
|
2092
2423
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2093
2424
|
*/
|
|
2094
|
-
updateConnections(params: Params$Resource$Services$Updateconnections, options: StreamMethodOptions):
|
|
2095
|
-
updateConnections(params?: Params$Resource$Services$Updateconnections, options?: MethodOptions):
|
|
2425
|
+
updateConnections(params: Params$Resource$Services$Updateconnections, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
2426
|
+
updateConnections(params?: Params$Resource$Services$Updateconnections, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2096
2427
|
updateConnections(params: Params$Resource$Services$Updateconnections, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2097
2428
|
updateConnections(params: Params$Resource$Services$Updateconnections, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2098
2429
|
updateConnections(params: Params$Resource$Services$Updateconnections, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
@@ -2141,28 +2472,143 @@ export declare namespace servicenetworking_v1beta {
|
|
|
2141
2472
|
constructor(context: APIRequestContext);
|
|
2142
2473
|
/**
|
|
2143
2474
|
* Creates a private connection that establishes a VPC Network Peering connection to a VPC network in the service producer's organization. The administrator of the service consumer's VPC network invokes this method. The administrator must assign one or more allocated IP ranges for provisioning subnetworks in the service producer's VPC network. This connection is used for all supported services in the service producer's organization, so it only needs to be invoked once. The response from the `get` operation will be of type `Connection` if the operation successfully completes.
|
|
2475
|
+
* @example
|
|
2476
|
+
* ```js
|
|
2477
|
+
* // Before running the sample:
|
|
2478
|
+
* // - Enable the API at:
|
|
2479
|
+
* // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
|
|
2480
|
+
* // - Login into gcloud by running:
|
|
2481
|
+
* // ```sh
|
|
2482
|
+
* // $ gcloud auth application-default login
|
|
2483
|
+
* // ```
|
|
2484
|
+
* // - Install the npm module by running:
|
|
2485
|
+
* // ```sh
|
|
2486
|
+
* // $ npm install googleapis
|
|
2487
|
+
* // ```
|
|
2488
|
+
*
|
|
2489
|
+
* const {google} = require('googleapis');
|
|
2490
|
+
* const servicenetworking = google.servicenetworking('v1beta');
|
|
2491
|
+
*
|
|
2492
|
+
* async function main() {
|
|
2493
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2494
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2495
|
+
* scopes: [
|
|
2496
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2497
|
+
* 'https://www.googleapis.com/auth/service.management',
|
|
2498
|
+
* ],
|
|
2499
|
+
* });
|
|
2500
|
+
*
|
|
2501
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2502
|
+
* const authClient = await auth.getClient();
|
|
2503
|
+
* google.options({auth: authClient});
|
|
2504
|
+
*
|
|
2505
|
+
* // Do the magic
|
|
2506
|
+
* const res = await servicenetworking.services.connections.create({
|
|
2507
|
+
* // The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`.
|
|
2508
|
+
* parent: 'services/my-service',
|
|
2509
|
+
*
|
|
2510
|
+
* // Request body metadata
|
|
2511
|
+
* requestBody: {
|
|
2512
|
+
* // request body parameters
|
|
2513
|
+
* // {
|
|
2514
|
+
* // "network": "my_network",
|
|
2515
|
+
* // "peering": "my_peering",
|
|
2516
|
+
* // "reservedPeeringRanges": [],
|
|
2517
|
+
* // "service": "my_service"
|
|
2518
|
+
* // }
|
|
2519
|
+
* },
|
|
2520
|
+
* });
|
|
2521
|
+
* console.log(res.data);
|
|
2522
|
+
*
|
|
2523
|
+
* // Example response
|
|
2524
|
+
* // {
|
|
2525
|
+
* // "done": false,
|
|
2526
|
+
* // "error": {},
|
|
2527
|
+
* // "metadata": {},
|
|
2528
|
+
* // "name": "my_name",
|
|
2529
|
+
* // "response": {}
|
|
2530
|
+
* // }
|
|
2531
|
+
* }
|
|
2532
|
+
*
|
|
2533
|
+
* main().catch(e => {
|
|
2534
|
+
* console.error(e);
|
|
2535
|
+
* throw e;
|
|
2536
|
+
* });
|
|
2537
|
+
*
|
|
2538
|
+
* ```
|
|
2144
2539
|
*
|
|
2145
2540
|
* @param params - Parameters for request
|
|
2146
2541
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2147
2542
|
* @param callback - Optional callback that handles the response.
|
|
2148
2543
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2149
2544
|
*/
|
|
2150
|
-
create(params: Params$Resource$Services$Connections$Create, options: StreamMethodOptions):
|
|
2151
|
-
create(params?: Params$Resource$Services$Connections$Create, options?: MethodOptions):
|
|
2545
|
+
create(params: Params$Resource$Services$Connections$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
2546
|
+
create(params?: Params$Resource$Services$Connections$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2152
2547
|
create(params: Params$Resource$Services$Connections$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2153
2548
|
create(params: Params$Resource$Services$Connections$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2154
2549
|
create(params: Params$Resource$Services$Connections$Create, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2155
2550
|
create(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2156
2551
|
/**
|
|
2157
2552
|
* List the private connections that are configured in a service consumer's VPC network.
|
|
2553
|
+
* @example
|
|
2554
|
+
* ```js
|
|
2555
|
+
* // Before running the sample:
|
|
2556
|
+
* // - Enable the API at:
|
|
2557
|
+
* // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
|
|
2558
|
+
* // - Login into gcloud by running:
|
|
2559
|
+
* // ```sh
|
|
2560
|
+
* // $ gcloud auth application-default login
|
|
2561
|
+
* // ```
|
|
2562
|
+
* // - Install the npm module by running:
|
|
2563
|
+
* // ```sh
|
|
2564
|
+
* // $ npm install googleapis
|
|
2565
|
+
* // ```
|
|
2566
|
+
*
|
|
2567
|
+
* const {google} = require('googleapis');
|
|
2568
|
+
* const servicenetworking = google.servicenetworking('v1beta');
|
|
2569
|
+
*
|
|
2570
|
+
* async function main() {
|
|
2571
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2572
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2573
|
+
* scopes: [
|
|
2574
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2575
|
+
* 'https://www.googleapis.com/auth/service.management',
|
|
2576
|
+
* ],
|
|
2577
|
+
* });
|
|
2578
|
+
*
|
|
2579
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2580
|
+
* const authClient = await auth.getClient();
|
|
2581
|
+
* google.options({auth: authClient});
|
|
2582
|
+
*
|
|
2583
|
+
* // Do the magic
|
|
2584
|
+
* const res = await servicenetworking.services.connections.list({
|
|
2585
|
+
* // The name of service consumer's VPC network that's connected with service producer network through a private connection. The network name must be in the following format: `projects/{project\}/global/networks/{network\}`. {project\} is a project number, such as in `12345` that includes the VPC service consumer's VPC network. {network\} is the name of the service consumer's VPC network.
|
|
2586
|
+
* network: 'placeholder-value',
|
|
2587
|
+
* // The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`. If you specify `-` as the parameter value, all configured public peering services are listed.
|
|
2588
|
+
* parent: 'services/my-service',
|
|
2589
|
+
* });
|
|
2590
|
+
* console.log(res.data);
|
|
2591
|
+
*
|
|
2592
|
+
* // Example response
|
|
2593
|
+
* // {
|
|
2594
|
+
* // "connections": []
|
|
2595
|
+
* // }
|
|
2596
|
+
* }
|
|
2597
|
+
*
|
|
2598
|
+
* main().catch(e => {
|
|
2599
|
+
* console.error(e);
|
|
2600
|
+
* throw e;
|
|
2601
|
+
* });
|
|
2602
|
+
*
|
|
2603
|
+
* ```
|
|
2158
2604
|
*
|
|
2159
2605
|
* @param params - Parameters for request
|
|
2160
2606
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2161
2607
|
* @param callback - Optional callback that handles the response.
|
|
2162
2608
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2163
2609
|
*/
|
|
2164
|
-
list(params: Params$Resource$Services$Connections$List, options: StreamMethodOptions):
|
|
2165
|
-
list(params?: Params$Resource$Services$Connections$List, options?: MethodOptions):
|
|
2610
|
+
list(params: Params$Resource$Services$Connections$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
2611
|
+
list(params?: Params$Resource$Services$Connections$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListConnectionsResponse>>;
|
|
2166
2612
|
list(params: Params$Resource$Services$Connections$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2167
2613
|
list(params: Params$Resource$Services$Connections$List, options: MethodOptions | BodyResponseCallback<Schema$ListConnectionsResponse>, callback: BodyResponseCallback<Schema$ListConnectionsResponse>): void;
|
|
2168
2614
|
list(params: Params$Resource$Services$Connections$List, callback: BodyResponseCallback<Schema$ListConnectionsResponse>): void;
|