@googleapis/servicenetworking 22.0.1 → 24.0.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/v1.ts CHANGED
@@ -256,7 +256,7 @@ export namespace servicenetworking_v1 {
256
256
  */
257
257
  purpose?: string | null;
258
258
  /**
259
- * Required. The name of a [region](/compute/docs/regions-zones) for the subnet, such `europe-west1`.
259
+ * Required. The name of a [region](https://cloud.google.com/compute/docs/regions-zones) for the subnet, such `europe-west1`.
260
260
  */
261
261
  region?: string | null;
262
262
  /**
@@ -280,7 +280,7 @@ export namespace servicenetworking_v1 {
280
280
  */
281
281
  skipRequestedAddressValidation?: boolean | null;
282
282
  /**
283
- * Required. A name for the new subnet. For information about the naming requirements, see [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the Compute API documentation.
283
+ * Required. A name for the new subnet. For information about the naming requirements, see [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) in the Compute API documentation.
284
284
  */
285
285
  subnetwork?: string | null;
286
286
  /**
@@ -296,6 +296,10 @@ export namespace servicenetworking_v1 {
296
296
  * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.
297
297
  */
298
298
  export interface Schema$Api {
299
+ /**
300
+ * The source edition string, only valid when syntax is SYNTAX_EDITIONS.
301
+ */
302
+ edition?: string | null;
299
303
  /**
300
304
  * The methods of this interface, in unspecified order.
301
305
  */
@@ -459,6 +463,9 @@ export namespace servicenetworking_v1 {
459
463
  * The map between request protocol and the backend address.
460
464
  */
461
465
  overridesByRequestProtocol?: {[key: string]: Schema$BackendRule} | null;
466
+ /**
467
+ * no-lint
468
+ */
462
469
  pathTranslation?: string | null;
463
470
  /**
464
471
  * The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.
@@ -469,6 +476,73 @@ export namespace servicenetworking_v1 {
469
476
  */
470
477
  selector?: string | null;
471
478
  }
479
+ /**
480
+ * `BatchingConfigProto` defines the batching configuration for an API method.
481
+ */
482
+ export interface Schema$BatchingConfigProto {
483
+ /**
484
+ * The request and response fields used in batching.
485
+ */
486
+ batchDescriptor?: Schema$BatchingDescriptorProto;
487
+ /**
488
+ * The thresholds which trigger a batched request to be sent.
489
+ */
490
+ thresholds?: Schema$BatchingSettingsProto;
491
+ }
492
+ /**
493
+ * `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.
494
+ */
495
+ export interface Schema$BatchingDescriptorProto {
496
+ /**
497
+ * The repeated field in the request message to be aggregated by batching.
498
+ */
499
+ batchedField?: string | null;
500
+ /**
501
+ * 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.
502
+ */
503
+ discriminatorFields?: string[] | null;
504
+ /**
505
+ * 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.
506
+ */
507
+ subresponseField?: string | null;
508
+ }
509
+ /**
510
+ * `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.
511
+ */
512
+ export interface Schema$BatchingSettingsProto {
513
+ /**
514
+ * The duration after which a batch should be sent, starting from the addition of the first message to that batch.
515
+ */
516
+ delayThreshold?: string | null;
517
+ /**
518
+ * The maximum number of elements collected in a batch that could be accepted by server.
519
+ */
520
+ elementCountLimit?: number | null;
521
+ /**
522
+ * The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.
523
+ */
524
+ elementCountThreshold?: number | null;
525
+ /**
526
+ * The maximum size of data allowed by flow control.
527
+ */
528
+ flowControlByteLimit?: number | null;
529
+ /**
530
+ * The maximum number of elements allowed by flow control.
531
+ */
532
+ flowControlElementLimit?: number | null;
533
+ /**
534
+ * The behavior to take when the flow control limit is exceeded.
535
+ */
536
+ flowControlLimitExceededBehavior?: string | null;
537
+ /**
538
+ * The maximum size of the request that could be accepted by server.
539
+ */
540
+ requestByteLimit?: number | null;
541
+ /**
542
+ * 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.
543
+ */
544
+ requestByteThreshold?: string | null;
545
+ }
472
546
  /**
473
547
  * 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
474
548
  */
@@ -495,6 +569,10 @@ export namespace servicenetworking_v1 {
495
569
  * The request message for Operations.CancelOperation.
496
570
  */
497
571
  export interface Schema$CancelOperationRequest {}
572
+ /**
573
+ * Metadata provided through GetOperation request for the LRO generated by Cleanup Connection API
574
+ */
575
+ export interface Schema$CleanupConnectionMetadata {}
498
576
  /**
499
577
  * Details about how and where to publish client libraries.
500
578
  */
@@ -549,15 +627,15 @@ export namespace servicenetworking_v1 {
549
627
  */
550
628
  export interface Schema$CloudSQLConfig {
551
629
  /**
552
- * Peering service used for peering with the Cloud SQL project.
630
+ * Required. Peering service used for peering with the Cloud SQL project.
553
631
  */
554
632
  service?: string | null;
555
633
  /**
556
- * The name of the umbrella network in the Cloud SQL umbrella project.
634
+ * Required. The name of the umbrella network in the Cloud SQL umbrella project.
557
635
  */
558
636
  umbrellaNetwork?: string | null;
559
637
  /**
560
- * The project number of the Cloud SQL umbrella project.
638
+ * Required. The project number of the Cloud SQL umbrella project.
561
639
  */
562
640
  umbrellaProject?: string | null;
563
641
  }
@@ -583,7 +661,7 @@ export namespace servicenetworking_v1 {
583
661
  */
584
662
  export interface Schema$Connection {
585
663
  /**
586
- * 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.
664
+ * 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.
587
665
  */
588
666
  network?: string | null;
589
667
  /**
@@ -1164,7 +1242,7 @@ export namespace servicenetworking_v1 {
1164
1242
  */
1165
1243
  common?: Schema$CommonLanguageSettings;
1166
1244
  /**
1167
- * Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin
1245
+ * Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin
1168
1246
  */
1169
1247
  renamedServices?: {[key: string]: string} | null;
1170
1248
  }
@@ -1402,6 +1480,10 @@ export namespace servicenetworking_v1 {
1402
1480
  * Method represents a method of an API interface.
1403
1481
  */
1404
1482
  export interface Schema$Method {
1483
+ /**
1484
+ * The source edition string, only valid when syntax is SYNTAX_EDITIONS.
1485
+ */
1486
+ edition?: string | null;
1405
1487
  /**
1406
1488
  * The simple name of this method.
1407
1489
  */
@@ -1452,6 +1534,10 @@ export namespace servicenetworking_v1 {
1452
1534
  * 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
1453
1535
  */
1454
1536
  autoPopulatedFields?: string[] | null;
1537
+ /**
1538
+ * 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
1539
+ */
1540
+ batching?: Schema$BatchingConfigProto;
1455
1541
  /**
1456
1542
  * 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
1457
1543
  */
@@ -1698,7 +1784,7 @@ export namespace servicenetworking_v1 {
1698
1784
  */
1699
1785
  dnsSuffix?: string | null;
1700
1786
  /**
1701
- * 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.
1787
+ * 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.
1702
1788
  */
1703
1789
  name?: string | null;
1704
1790
  }
@@ -1714,6 +1800,10 @@ export namespace servicenetworking_v1 {
1714
1800
  * Some settings.
1715
1801
  */
1716
1802
  common?: Schema$CommonLanguageSettings;
1803
+ /**
1804
+ * 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
1805
+ */
1806
+ libraryPackage?: string | null;
1717
1807
  }
1718
1808
  /**
1719
1809
  * Grouping of IAM role and IAM member.
@@ -1967,7 +2057,7 @@ export namespace servicenetworking_v1 {
1967
2057
  */
1968
2058
  ipPrefixLength?: number | null;
1969
2059
  /**
1970
- * Network name in the consumer project. This network must have been already peered with a shared VPC network using CreateConnection method. Must be in a form 'projects/{project\}/global/networks/{network\}'. {project\} is a project number, as in '12345' {network\} is network name.
2060
+ * Required. Network name in the consumer project. This network must have been already peered with a shared VPC network using CreateConnection method. Must be in a form 'projects/{project\}/global/networks/{network\}'. {project\} is a project number, as in '12345' {network\} is network name.
1971
2061
  */
1972
2062
  network?: string | null;
1973
2063
  }
@@ -2351,7 +2441,7 @@ export namespace servicenetworking_v1 {
2351
2441
  */
2352
2442
  consumerProject?: Schema$ConsumerProject;
2353
2443
  /**
2354
- * RANGES_EXHAUSTED, RANGES_EXHAUSTED, and RANGES_DELETED_LATER are done when range_reservation is provided.
2444
+ * RANGES_EXHAUSTED, RANGES_NOT_RESERVED, and RANGES_DELETED_LATER are done when range_reservation is provided.
2355
2445
  */
2356
2446
  rangeReservation?: Schema$RangeReservation;
2357
2447
  /**
@@ -2391,6 +2481,59 @@ export namespace servicenetworking_v1 {
2391
2481
 
2392
2482
  /**
2393
2483
  * 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`.
2484
+ * @example
2485
+ * ```js
2486
+ * // Before running the sample:
2487
+ * // - Enable the API at:
2488
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
2489
+ * // - Login into gcloud by running:
2490
+ * // ```sh
2491
+ * // $ gcloud auth application-default login
2492
+ * // ```
2493
+ * // - Install the npm module by running:
2494
+ * // ```sh
2495
+ * // $ npm install googleapis
2496
+ * // ```
2497
+ *
2498
+ * const {google} = require('googleapis');
2499
+ * const servicenetworking = google.servicenetworking('v1');
2500
+ *
2501
+ * async function main() {
2502
+ * const auth = new google.auth.GoogleAuth({
2503
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2504
+ * scopes: [
2505
+ * 'https://www.googleapis.com/auth/cloud-platform',
2506
+ * 'https://www.googleapis.com/auth/service.management',
2507
+ * ],
2508
+ * });
2509
+ *
2510
+ * // Acquire an auth client, and bind it to all future calls
2511
+ * const authClient = await auth.getClient();
2512
+ * google.options({auth: authClient});
2513
+ *
2514
+ * // Do the magic
2515
+ * const res = await servicenetworking.operations.cancel({
2516
+ * // The name of the operation resource to be cancelled.
2517
+ * name: 'operations/.*',
2518
+ *
2519
+ * // Request body metadata
2520
+ * requestBody: {
2521
+ * // request body parameters
2522
+ * // {}
2523
+ * },
2524
+ * });
2525
+ * console.log(res.data);
2526
+ *
2527
+ * // Example response
2528
+ * // {}
2529
+ * }
2530
+ *
2531
+ * main().catch(e => {
2532
+ * console.error(e);
2533
+ * throw e;
2534
+ * });
2535
+ *
2536
+ * ```
2394
2537
  *
2395
2538
  * @param params - Parameters for request
2396
2539
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2480,6 +2623,53 @@ export namespace servicenetworking_v1 {
2480
2623
 
2481
2624
  /**
2482
2625
  * 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`.
2626
+ * @example
2627
+ * ```js
2628
+ * // Before running the sample:
2629
+ * // - Enable the API at:
2630
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
2631
+ * // - Login into gcloud by running:
2632
+ * // ```sh
2633
+ * // $ gcloud auth application-default login
2634
+ * // ```
2635
+ * // - Install the npm module by running:
2636
+ * // ```sh
2637
+ * // $ npm install googleapis
2638
+ * // ```
2639
+ *
2640
+ * const {google} = require('googleapis');
2641
+ * const servicenetworking = google.servicenetworking('v1');
2642
+ *
2643
+ * async function main() {
2644
+ * const auth = new google.auth.GoogleAuth({
2645
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2646
+ * scopes: [
2647
+ * 'https://www.googleapis.com/auth/cloud-platform',
2648
+ * 'https://www.googleapis.com/auth/service.management',
2649
+ * ],
2650
+ * });
2651
+ *
2652
+ * // Acquire an auth client, and bind it to all future calls
2653
+ * const authClient = await auth.getClient();
2654
+ * google.options({auth: authClient});
2655
+ *
2656
+ * // Do the magic
2657
+ * const res = await servicenetworking.operations.delete({
2658
+ * // The name of the operation resource to be deleted.
2659
+ * name: 'operations/.*',
2660
+ * });
2661
+ * console.log(res.data);
2662
+ *
2663
+ * // Example response
2664
+ * // {}
2665
+ * }
2666
+ *
2667
+ * main().catch(e => {
2668
+ * console.error(e);
2669
+ * throw e;
2670
+ * });
2671
+ *
2672
+ * ```
2483
2673
  *
2484
2674
  * @param params - Parameters for request
2485
2675
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2569,6 +2759,59 @@ export namespace servicenetworking_v1 {
2569
2759
 
2570
2760
  /**
2571
2761
  * 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.
2762
+ * @example
2763
+ * ```js
2764
+ * // Before running the sample:
2765
+ * // - Enable the API at:
2766
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
2767
+ * // - Login into gcloud by running:
2768
+ * // ```sh
2769
+ * // $ gcloud auth application-default login
2770
+ * // ```
2771
+ * // - Install the npm module by running:
2772
+ * // ```sh
2773
+ * // $ npm install googleapis
2774
+ * // ```
2775
+ *
2776
+ * const {google} = require('googleapis');
2777
+ * const servicenetworking = google.servicenetworking('v1');
2778
+ *
2779
+ * async function main() {
2780
+ * const auth = new google.auth.GoogleAuth({
2781
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2782
+ * scopes: [
2783
+ * 'https://www.googleapis.com/auth/cloud-platform',
2784
+ * 'https://www.googleapis.com/auth/service.management',
2785
+ * ],
2786
+ * });
2787
+ *
2788
+ * // Acquire an auth client, and bind it to all future calls
2789
+ * const authClient = await auth.getClient();
2790
+ * google.options({auth: authClient});
2791
+ *
2792
+ * // Do the magic
2793
+ * const res = await servicenetworking.operations.get({
2794
+ * // The name of the operation resource.
2795
+ * name: 'operations/my-operation',
2796
+ * });
2797
+ * console.log(res.data);
2798
+ *
2799
+ * // Example response
2800
+ * // {
2801
+ * // "done": false,
2802
+ * // "error": {},
2803
+ * // "metadata": {},
2804
+ * // "name": "my_name",
2805
+ * // "response": {}
2806
+ * // }
2807
+ * }
2808
+ *
2809
+ * main().catch(e => {
2810
+ * console.error(e);
2811
+ * throw e;
2812
+ * });
2813
+ *
2814
+ * ```
2572
2815
  *
2573
2816
  * @param params - Parameters for request
2574
2817
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2657,6 +2900,62 @@ export namespace servicenetworking_v1 {
2657
2900
 
2658
2901
  /**
2659
2902
  * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
2903
+ * @example
2904
+ * ```js
2905
+ * // Before running the sample:
2906
+ * // - Enable the API at:
2907
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
2908
+ * // - Login into gcloud by running:
2909
+ * // ```sh
2910
+ * // $ gcloud auth application-default login
2911
+ * // ```
2912
+ * // - Install the npm module by running:
2913
+ * // ```sh
2914
+ * // $ npm install googleapis
2915
+ * // ```
2916
+ *
2917
+ * const {google} = require('googleapis');
2918
+ * const servicenetworking = google.servicenetworking('v1');
2919
+ *
2920
+ * async function main() {
2921
+ * const auth = new google.auth.GoogleAuth({
2922
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2923
+ * scopes: [
2924
+ * 'https://www.googleapis.com/auth/cloud-platform',
2925
+ * 'https://www.googleapis.com/auth/service.management',
2926
+ * ],
2927
+ * });
2928
+ *
2929
+ * // Acquire an auth client, and bind it to all future calls
2930
+ * const authClient = await auth.getClient();
2931
+ * google.options({auth: authClient});
2932
+ *
2933
+ * // Do the magic
2934
+ * const res = await servicenetworking.operations.list({
2935
+ * // The standard list filter.
2936
+ * filter: 'placeholder-value',
2937
+ * // The name of the operation's parent resource.
2938
+ * name: 'operations',
2939
+ * // The standard list page size.
2940
+ * pageSize: 'placeholder-value',
2941
+ * // The standard list page token.
2942
+ * pageToken: 'placeholder-value',
2943
+ * });
2944
+ * console.log(res.data);
2945
+ *
2946
+ * // Example response
2947
+ * // {
2948
+ * // "nextPageToken": "my_nextPageToken",
2949
+ * // "operations": []
2950
+ * // }
2951
+ * }
2952
+ *
2953
+ * main().catch(e => {
2954
+ * console.error(e);
2955
+ * throw e;
2956
+ * });
2957
+ *
2958
+ * ```
2660
2959
  *
2661
2960
  * @param params - Parameters for request
2662
2961
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2808,6 +3107,86 @@ export namespace servicenetworking_v1 {
2808
3107
 
2809
3108
  /**
2810
3109
  * 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.
3110
+ * @example
3111
+ * ```js
3112
+ * // Before running the sample:
3113
+ * // - Enable the API at:
3114
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
3115
+ * // - Login into gcloud by running:
3116
+ * // ```sh
3117
+ * // $ gcloud auth application-default login
3118
+ * // ```
3119
+ * // - Install the npm module by running:
3120
+ * // ```sh
3121
+ * // $ npm install googleapis
3122
+ * // ```
3123
+ *
3124
+ * const {google} = require('googleapis');
3125
+ * const servicenetworking = google.servicenetworking('v1');
3126
+ *
3127
+ * async function main() {
3128
+ * const auth = new google.auth.GoogleAuth({
3129
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3130
+ * scopes: [
3131
+ * 'https://www.googleapis.com/auth/cloud-platform',
3132
+ * 'https://www.googleapis.com/auth/service.management',
3133
+ * ],
3134
+ * });
3135
+ *
3136
+ * // Acquire an auth client, and bind it to all future calls
3137
+ * const authClient = await auth.getClient();
3138
+ * google.options({auth: authClient});
3139
+ *
3140
+ * // Do the magic
3141
+ * const res = await servicenetworking.services.addSubnetwork({
3142
+ * // 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.
3143
+ * parent: 'services/my-service/[^/]+/[^/]+',
3144
+ *
3145
+ * // Request body metadata
3146
+ * requestBody: {
3147
+ * // request body parameters
3148
+ * // {
3149
+ * // "allowSubnetCidrRoutesOverlap": false,
3150
+ * // "checkServiceNetworkingUsePermission": false,
3151
+ * // "computeIdempotencyWindow": "my_computeIdempotencyWindow",
3152
+ * // "consumer": "my_consumer",
3153
+ * // "consumerNetwork": "my_consumerNetwork",
3154
+ * // "description": "my_description",
3155
+ * // "internalRange": "my_internalRange",
3156
+ * // "ipPrefixLength": 0,
3157
+ * // "outsideAllocationPublicIpRange": "my_outsideAllocationPublicIpRange",
3158
+ * // "privateIpv6GoogleAccess": "my_privateIpv6GoogleAccess",
3159
+ * // "purpose": "my_purpose",
3160
+ * // "region": "my_region",
3161
+ * // "requestedAddress": "my_requestedAddress",
3162
+ * // "requestedRanges": [],
3163
+ * // "role": "my_role",
3164
+ * // "secondaryIpRangeSpecs": [],
3165
+ * // "skipRequestedAddressValidation": false,
3166
+ * // "subnetwork": "my_subnetwork",
3167
+ * // "subnetworkUsers": [],
3168
+ * // "useCustomComputeIdempotencyWindow": false
3169
+ * // }
3170
+ * },
3171
+ * });
3172
+ * console.log(res.data);
3173
+ *
3174
+ * // Example response
3175
+ * // {
3176
+ * // "done": false,
3177
+ * // "error": {},
3178
+ * // "metadata": {},
3179
+ * // "name": "my_name",
3180
+ * // "response": {}
3181
+ * // }
3182
+ * }
3183
+ *
3184
+ * main().catch(e => {
3185
+ * console.error(e);
3186
+ * throw e;
3187
+ * });
3188
+ *
3189
+ * ```
2811
3190
  *
2812
3191
  * @param params - Parameters for request
2813
3192
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2900,6 +3279,67 @@ export namespace servicenetworking_v1 {
2900
3279
 
2901
3280
  /**
2902
3281
  * Disables VPC service controls for a connection.
3282
+ * @example
3283
+ * ```js
3284
+ * // Before running the sample:
3285
+ * // - Enable the API at:
3286
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
3287
+ * // - Login into gcloud by running:
3288
+ * // ```sh
3289
+ * // $ gcloud auth application-default login
3290
+ * // ```
3291
+ * // - Install the npm module by running:
3292
+ * // ```sh
3293
+ * // $ npm install googleapis
3294
+ * // ```
3295
+ *
3296
+ * const {google} = require('googleapis');
3297
+ * const servicenetworking = google.servicenetworking('v1');
3298
+ *
3299
+ * async function main() {
3300
+ * const auth = new google.auth.GoogleAuth({
3301
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3302
+ * scopes: [
3303
+ * 'https://www.googleapis.com/auth/cloud-platform',
3304
+ * 'https://www.googleapis.com/auth/service.management',
3305
+ * ],
3306
+ * });
3307
+ *
3308
+ * // Acquire an auth client, and bind it to all future calls
3309
+ * const authClient = await auth.getClient();
3310
+ * google.options({auth: authClient});
3311
+ *
3312
+ * // Do the magic
3313
+ * const res = await servicenetworking.services.disableVpcServiceControls({
3314
+ * // Required. 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`.
3315
+ * parent: 'services/my-service',
3316
+ *
3317
+ * // Request body metadata
3318
+ * requestBody: {
3319
+ * // request body parameters
3320
+ * // {
3321
+ * // "consumerNetwork": "my_consumerNetwork"
3322
+ * // }
3323
+ * },
3324
+ * });
3325
+ * console.log(res.data);
3326
+ *
3327
+ * // Example response
3328
+ * // {
3329
+ * // "done": false,
3330
+ * // "error": {},
3331
+ * // "metadata": {},
3332
+ * // "name": "my_name",
3333
+ * // "response": {}
3334
+ * // }
3335
+ * }
3336
+ *
3337
+ * main().catch(e => {
3338
+ * console.error(e);
3339
+ * throw e;
3340
+ * });
3341
+ *
3342
+ * ```
2903
3343
  *
2904
3344
  * @param params - Parameters for request
2905
3345
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2994,6 +3434,67 @@ export namespace servicenetworking_v1 {
2994
3434
 
2995
3435
  /**
2996
3436
  * Enables VPC service controls for a connection.
3437
+ * @example
3438
+ * ```js
3439
+ * // Before running the sample:
3440
+ * // - Enable the API at:
3441
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
3442
+ * // - Login into gcloud by running:
3443
+ * // ```sh
3444
+ * // $ gcloud auth application-default login
3445
+ * // ```
3446
+ * // - Install the npm module by running:
3447
+ * // ```sh
3448
+ * // $ npm install googleapis
3449
+ * // ```
3450
+ *
3451
+ * const {google} = require('googleapis');
3452
+ * const servicenetworking = google.servicenetworking('v1');
3453
+ *
3454
+ * async function main() {
3455
+ * const auth = new google.auth.GoogleAuth({
3456
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3457
+ * scopes: [
3458
+ * 'https://www.googleapis.com/auth/cloud-platform',
3459
+ * 'https://www.googleapis.com/auth/service.management',
3460
+ * ],
3461
+ * });
3462
+ *
3463
+ * // Acquire an auth client, and bind it to all future calls
3464
+ * const authClient = await auth.getClient();
3465
+ * google.options({auth: authClient});
3466
+ *
3467
+ * // Do the magic
3468
+ * const res = await servicenetworking.services.enableVpcServiceControls({
3469
+ * // Required. 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`.
3470
+ * parent: 'services/my-service',
3471
+ *
3472
+ * // Request body metadata
3473
+ * requestBody: {
3474
+ * // request body parameters
3475
+ * // {
3476
+ * // "consumerNetwork": "my_consumerNetwork"
3477
+ * // }
3478
+ * },
3479
+ * });
3480
+ * console.log(res.data);
3481
+ *
3482
+ * // Example response
3483
+ * // {
3484
+ * // "done": false,
3485
+ * // "error": {},
3486
+ * // "metadata": {},
3487
+ * // "name": "my_name",
3488
+ * // "response": {}
3489
+ * // }
3490
+ * }
3491
+ *
3492
+ * main().catch(e => {
3493
+ * console.error(e);
3494
+ * throw e;
3495
+ * });
3496
+ *
3497
+ * ```
2997
3498
  *
2998
3499
  * @param params - Parameters for request
2999
3500
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3088,6 +3589,68 @@ export namespace servicenetworking_v1 {
3088
3589
 
3089
3590
  /**
3090
3591
  * 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).
3592
+ * @example
3593
+ * ```js
3594
+ * // Before running the sample:
3595
+ * // - Enable the API at:
3596
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
3597
+ * // - Login into gcloud by running:
3598
+ * // ```sh
3599
+ * // $ gcloud auth application-default login
3600
+ * // ```
3601
+ * // - Install the npm module by running:
3602
+ * // ```sh
3603
+ * // $ npm install googleapis
3604
+ * // ```
3605
+ *
3606
+ * const {google} = require('googleapis');
3607
+ * const servicenetworking = google.servicenetworking('v1');
3608
+ *
3609
+ * async function main() {
3610
+ * const auth = new google.auth.GoogleAuth({
3611
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3612
+ * scopes: [
3613
+ * 'https://www.googleapis.com/auth/cloud-platform',
3614
+ * 'https://www.googleapis.com/auth/service.management',
3615
+ * ],
3616
+ * });
3617
+ *
3618
+ * // Acquire an auth client, and bind it to all future calls
3619
+ * const authClient = await auth.getClient();
3620
+ * google.options({auth: authClient});
3621
+ *
3622
+ * // Do the magic
3623
+ * const res = await servicenetworking.services.searchRange({
3624
+ * // Required. This is in a form services/{service\}. {service\} the name of the private access management service, for example 'service-peering.example.com'.
3625
+ * parent: 'services/my-service',
3626
+ *
3627
+ * // Request body metadata
3628
+ * requestBody: {
3629
+ * // request body parameters
3630
+ * // {
3631
+ * // "ipPrefixLength": 0,
3632
+ * // "network": "my_network"
3633
+ * // }
3634
+ * },
3635
+ * });
3636
+ * console.log(res.data);
3637
+ *
3638
+ * // Example response
3639
+ * // {
3640
+ * // "done": false,
3641
+ * // "error": {},
3642
+ * // "metadata": {},
3643
+ * // "name": "my_name",
3644
+ * // "response": {}
3645
+ * // }
3646
+ * }
3647
+ *
3648
+ * main().catch(e => {
3649
+ * console.error(e);
3650
+ * throw e;
3651
+ * });
3652
+ *
3653
+ * ```
3091
3654
  *
3092
3655
  * @param params - Parameters for request
3093
3656
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3180,6 +3743,69 @@ export namespace servicenetworking_v1 {
3180
3743
 
3181
3744
  /**
3182
3745
  * Service producers use this method to validate if the consumer provided network, project and requested range are valid. This allows them to use a fail-fast mechanism for consumer requests, and not have to wait for AddSubnetwork operation completion to determine if user request is invalid.
3746
+ * @example
3747
+ * ```js
3748
+ * // Before running the sample:
3749
+ * // - Enable the API at:
3750
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
3751
+ * // - Login into gcloud by running:
3752
+ * // ```sh
3753
+ * // $ gcloud auth application-default login
3754
+ * // ```
3755
+ * // - Install the npm module by running:
3756
+ * // ```sh
3757
+ * // $ npm install googleapis
3758
+ * // ```
3759
+ *
3760
+ * const {google} = require('googleapis');
3761
+ * const servicenetworking = google.servicenetworking('v1');
3762
+ *
3763
+ * async function main() {
3764
+ * const auth = new google.auth.GoogleAuth({
3765
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3766
+ * scopes: [
3767
+ * 'https://www.googleapis.com/auth/cloud-platform',
3768
+ * 'https://www.googleapis.com/auth/service.management',
3769
+ * ],
3770
+ * });
3771
+ *
3772
+ * // Acquire an auth client, and bind it to all future calls
3773
+ * const authClient = await auth.getClient();
3774
+ * google.options({auth: authClient});
3775
+ *
3776
+ * // Do the magic
3777
+ * const res = await servicenetworking.services.validate({
3778
+ * // Required. This is in a form services/{service\} where {service\} is the name of the private access management service. For example 'service-peering.example.com'.
3779
+ * parent: 'services/my-service',
3780
+ *
3781
+ * // Request body metadata
3782
+ * requestBody: {
3783
+ * // request body parameters
3784
+ * // {
3785
+ * // "checkServiceNetworkingUsePermission": false,
3786
+ * // "consumerNetwork": "my_consumerNetwork",
3787
+ * // "consumerProject": {},
3788
+ * // "rangeReservation": {},
3789
+ * // "validateNetwork": false
3790
+ * // }
3791
+ * },
3792
+ * });
3793
+ * console.log(res.data);
3794
+ *
3795
+ * // Example response
3796
+ * // {
3797
+ * // "existingSubnetworkCandidates": [],
3798
+ * // "isValid": false,
3799
+ * // "validationError": "my_validationError"
3800
+ * // }
3801
+ * }
3802
+ *
3803
+ * main().catch(e => {
3804
+ * console.error(e);
3805
+ * throw e;
3806
+ * });
3807
+ *
3808
+ * ```
3183
3809
  *
3184
3810
  * @param params - Parameters for request
3185
3811
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3292,7 +3918,7 @@ export namespace servicenetworking_v1 {
3292
3918
  export interface Params$Resource$Services$Disablevpcservicecontrols
3293
3919
  extends StandardParameters {
3294
3920
  /**
3295
- * 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`.
3921
+ * Required. 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`.
3296
3922
  */
3297
3923
  parent?: string;
3298
3924
 
@@ -3304,7 +3930,7 @@ export namespace servicenetworking_v1 {
3304
3930
  export interface Params$Resource$Services$Enablevpcservicecontrols
3305
3931
  extends StandardParameters {
3306
3932
  /**
3307
- * 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`.
3933
+ * Required. 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`.
3308
3934
  */
3309
3935
  parent?: string;
3310
3936
 
@@ -3346,6 +3972,70 @@ export namespace servicenetworking_v1 {
3346
3972
 
3347
3973
  /**
3348
3974
  * 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.
3975
+ * @example
3976
+ * ```js
3977
+ * // Before running the sample:
3978
+ * // - Enable the API at:
3979
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
3980
+ * // - Login into gcloud by running:
3981
+ * // ```sh
3982
+ * // $ gcloud auth application-default login
3983
+ * // ```
3984
+ * // - Install the npm module by running:
3985
+ * // ```sh
3986
+ * // $ npm install googleapis
3987
+ * // ```
3988
+ *
3989
+ * const {google} = require('googleapis');
3990
+ * const servicenetworking = google.servicenetworking('v1');
3991
+ *
3992
+ * async function main() {
3993
+ * const auth = new google.auth.GoogleAuth({
3994
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3995
+ * scopes: [
3996
+ * 'https://www.googleapis.com/auth/cloud-platform',
3997
+ * 'https://www.googleapis.com/auth/service.management',
3998
+ * ],
3999
+ * });
4000
+ *
4001
+ * // Acquire an auth client, and bind it to all future calls
4002
+ * const authClient = await auth.getClient();
4003
+ * google.options({auth: authClient});
4004
+ *
4005
+ * // Do the magic
4006
+ * const res = await servicenetworking.services.connections.create({
4007
+ * // Required. 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`.
4008
+ * parent: 'services/my-service',
4009
+ *
4010
+ * // Request body metadata
4011
+ * requestBody: {
4012
+ * // request body parameters
4013
+ * // {
4014
+ * // "network": "my_network",
4015
+ * // "peering": "my_peering",
4016
+ * // "reservedPeeringRanges": [],
4017
+ * // "service": "my_service"
4018
+ * // }
4019
+ * },
4020
+ * });
4021
+ * console.log(res.data);
4022
+ *
4023
+ * // Example response
4024
+ * // {
4025
+ * // "done": false,
4026
+ * // "error": {},
4027
+ * // "metadata": {},
4028
+ * // "name": "my_name",
4029
+ * // "response": {}
4030
+ * // }
4031
+ * }
4032
+ *
4033
+ * main().catch(e => {
4034
+ * console.error(e);
4035
+ * throw e;
4036
+ * });
4037
+ *
4038
+ * ```
3349
4039
  *
3350
4040
  * @param params - Parameters for request
3351
4041
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3438,6 +4128,67 @@ export namespace servicenetworking_v1 {
3438
4128
 
3439
4129
  /**
3440
4130
  * Deletes a private service access connection.
4131
+ * @example
4132
+ * ```js
4133
+ * // Before running the sample:
4134
+ * // - Enable the API at:
4135
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
4136
+ * // - Login into gcloud by running:
4137
+ * // ```sh
4138
+ * // $ gcloud auth application-default login
4139
+ * // ```
4140
+ * // - Install the npm module by running:
4141
+ * // ```sh
4142
+ * // $ npm install googleapis
4143
+ * // ```
4144
+ *
4145
+ * const {google} = require('googleapis');
4146
+ * const servicenetworking = google.servicenetworking('v1');
4147
+ *
4148
+ * async function main() {
4149
+ * const auth = new google.auth.GoogleAuth({
4150
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4151
+ * scopes: [
4152
+ * 'https://www.googleapis.com/auth/cloud-platform',
4153
+ * 'https://www.googleapis.com/auth/service.management',
4154
+ * ],
4155
+ * });
4156
+ *
4157
+ * // Acquire an auth client, and bind it to all future calls
4158
+ * const authClient = await auth.getClient();
4159
+ * google.options({auth: authClient});
4160
+ *
4161
+ * // Do the magic
4162
+ * const res = await servicenetworking.services.connections.deleteConnection({
4163
+ * // Required. The private service connection that connects to a service producer organization. The name includes both the private service name and the VPC network peering name in the format of `services/{peering_service_name\}/connections/{vpc_peering_name\}`. For Google services that support this functionality, this is `services/servicenetworking.googleapis.com/connections/servicenetworking-googleapis-com`.
4164
+ * name: 'services/my-service/connections/my-connection',
4165
+ *
4166
+ * // Request body metadata
4167
+ * requestBody: {
4168
+ * // request body parameters
4169
+ * // {
4170
+ * // "consumerNetwork": "my_consumerNetwork"
4171
+ * // }
4172
+ * },
4173
+ * });
4174
+ * console.log(res.data);
4175
+ *
4176
+ * // Example response
4177
+ * // {
4178
+ * // "done": false,
4179
+ * // "error": {},
4180
+ * // "metadata": {},
4181
+ * // "name": "my_name",
4182
+ * // "response": {}
4183
+ * // }
4184
+ * }
4185
+ *
4186
+ * main().catch(e => {
4187
+ * console.error(e);
4188
+ * throw e;
4189
+ * });
4190
+ *
4191
+ * ```
3441
4192
  *
3442
4193
  * @param params - Parameters for request
3443
4194
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3527,6 +4278,57 @@ export namespace servicenetworking_v1 {
3527
4278
 
3528
4279
  /**
3529
4280
  * List the private connections that are configured in a service consumer's VPC network.
4281
+ * @example
4282
+ * ```js
4283
+ * // Before running the sample:
4284
+ * // - Enable the API at:
4285
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
4286
+ * // - Login into gcloud by running:
4287
+ * // ```sh
4288
+ * // $ gcloud auth application-default login
4289
+ * // ```
4290
+ * // - Install the npm module by running:
4291
+ * // ```sh
4292
+ * // $ npm install googleapis
4293
+ * // ```
4294
+ *
4295
+ * const {google} = require('googleapis');
4296
+ * const servicenetworking = google.servicenetworking('v1');
4297
+ *
4298
+ * async function main() {
4299
+ * const auth = new google.auth.GoogleAuth({
4300
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4301
+ * scopes: [
4302
+ * 'https://www.googleapis.com/auth/cloud-platform',
4303
+ * 'https://www.googleapis.com/auth/service.management',
4304
+ * ],
4305
+ * });
4306
+ *
4307
+ * // Acquire an auth client, and bind it to all future calls
4308
+ * const authClient = await auth.getClient();
4309
+ * google.options({auth: authClient});
4310
+ *
4311
+ * // Do the magic
4312
+ * const res = await servicenetworking.services.connections.list({
4313
+ * // Required. 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.
4314
+ * network: 'placeholder-value',
4315
+ * // Required. 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 `services/-` as the parameter value, all configured peering services are listed.
4316
+ * parent: 'services/my-service',
4317
+ * });
4318
+ * console.log(res.data);
4319
+ *
4320
+ * // Example response
4321
+ * // {
4322
+ * // "connections": []
4323
+ * // }
4324
+ * }
4325
+ *
4326
+ * main().catch(e => {
4327
+ * console.error(e);
4328
+ * throw e;
4329
+ * });
4330
+ *
4331
+ * ```
3530
4332
  *
3531
4333
  * @param params - Parameters for request
3532
4334
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3621,6 +4423,74 @@ export namespace servicenetworking_v1 {
3621
4423
 
3622
4424
  /**
3623
4425
  * Updates the allocated ranges that are assigned to a connection.
4426
+ * @example
4427
+ * ```js
4428
+ * // Before running the sample:
4429
+ * // - Enable the API at:
4430
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
4431
+ * // - Login into gcloud by running:
4432
+ * // ```sh
4433
+ * // $ gcloud auth application-default login
4434
+ * // ```
4435
+ * // - Install the npm module by running:
4436
+ * // ```sh
4437
+ * // $ npm install googleapis
4438
+ * // ```
4439
+ *
4440
+ * const {google} = require('googleapis');
4441
+ * const servicenetworking = google.servicenetworking('v1');
4442
+ *
4443
+ * async function main() {
4444
+ * const auth = new google.auth.GoogleAuth({
4445
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4446
+ * scopes: [
4447
+ * 'https://www.googleapis.com/auth/cloud-platform',
4448
+ * 'https://www.googleapis.com/auth/service.management',
4449
+ * ],
4450
+ * });
4451
+ *
4452
+ * // Acquire an auth client, and bind it to all future calls
4453
+ * const authClient = await auth.getClient();
4454
+ * google.options({auth: authClient});
4455
+ *
4456
+ * // Do the magic
4457
+ * const res = await servicenetworking.services.connections.patch({
4458
+ * // If a previously defined allocated range is removed, force flag must be set to true.
4459
+ * force: 'placeholder-value',
4460
+ * // Required. The private service connection that connects to a service producer organization. The name includes both the private service name and the VPC network peering name in the format of `services/{peering_service_name\}/connections/{vpc_peering_name\}`. For Google services that support this functionality, this is `services/servicenetworking.googleapis.com/connections/servicenetworking-googleapis-com`.
4461
+ * name: 'services/my-service/connections/my-connection',
4462
+ * // The update mask. If this is omitted, it defaults to "*". You can only update the listed peering ranges.
4463
+ * updateMask: 'placeholder-value',
4464
+ *
4465
+ * // Request body metadata
4466
+ * requestBody: {
4467
+ * // request body parameters
4468
+ * // {
4469
+ * // "network": "my_network",
4470
+ * // "peering": "my_peering",
4471
+ * // "reservedPeeringRanges": [],
4472
+ * // "service": "my_service"
4473
+ * // }
4474
+ * },
4475
+ * });
4476
+ * console.log(res.data);
4477
+ *
4478
+ * // Example response
4479
+ * // {
4480
+ * // "done": false,
4481
+ * // "error": {},
4482
+ * // "metadata": {},
4483
+ * // "name": "my_name",
4484
+ * // "response": {}
4485
+ * // }
4486
+ * }
4487
+ *
4488
+ * main().catch(e => {
4489
+ * console.error(e);
4490
+ * throw e;
4491
+ * });
4492
+ *
4493
+ * ```
3624
4494
  *
3625
4495
  * @param params - Parameters for request
3626
4496
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3712,7 +4582,7 @@ export namespace servicenetworking_v1 {
3712
4582
  export interface Params$Resource$Services$Connections$Create
3713
4583
  extends StandardParameters {
3714
4584
  /**
3715
- * 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`.
4585
+ * Required. 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`.
3716
4586
  */
3717
4587
  parent?: string;
3718
4588
 
@@ -3736,11 +4606,11 @@ export namespace servicenetworking_v1 {
3736
4606
  export interface Params$Resource$Services$Connections$List
3737
4607
  extends StandardParameters {
3738
4608
  /**
3739
- * 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.
4609
+ * Required. 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.
3740
4610
  */
3741
4611
  network?: string;
3742
4612
  /**
3743
- * 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 `services/-` as the parameter value, all configured peering services are listed.
4613
+ * Required. 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 `services/-` as the parameter value, all configured peering services are listed.
3744
4614
  */
3745
4615
  parent?: string;
3746
4616
  }
@@ -3751,7 +4621,7 @@ export namespace servicenetworking_v1 {
3751
4621
  */
3752
4622
  force?: boolean;
3753
4623
  /**
3754
- * The private service connection that connects to a service producer organization. The name includes both the private service name and the VPC network peering name in the format of `services/{peering_service_name\}/connections/{vpc_peering_name\}`. For Google services that support this functionality, this is `services/servicenetworking.googleapis.com/connections/servicenetworking-googleapis-com`.
4624
+ * Required. The private service connection that connects to a service producer organization. The name includes both the private service name and the VPC network peering name in the format of `services/{peering_service_name\}/connections/{vpc_peering_name\}`. For Google services that support this functionality, this is `services/servicenetworking.googleapis.com/connections/servicenetworking-googleapis-com`.
3755
4625
  */
3756
4626
  name?: string;
3757
4627
  /**
@@ -3773,6 +4643,69 @@ export namespace servicenetworking_v1 {
3773
4643
 
3774
4644
  /**
3775
4645
  * Service producers can use this method to add DNS record sets to private DNS zones in the shared producer host project.
4646
+ * @example
4647
+ * ```js
4648
+ * // Before running the sample:
4649
+ * // - Enable the API at:
4650
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
4651
+ * // - Login into gcloud by running:
4652
+ * // ```sh
4653
+ * // $ gcloud auth application-default login
4654
+ * // ```
4655
+ * // - Install the npm module by running:
4656
+ * // ```sh
4657
+ * // $ npm install googleapis
4658
+ * // ```
4659
+ *
4660
+ * const {google} = require('googleapis');
4661
+ * const servicenetworking = google.servicenetworking('v1');
4662
+ *
4663
+ * async function main() {
4664
+ * const auth = new google.auth.GoogleAuth({
4665
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4666
+ * scopes: [
4667
+ * 'https://www.googleapis.com/auth/cloud-platform',
4668
+ * 'https://www.googleapis.com/auth/service.management',
4669
+ * ],
4670
+ * });
4671
+ *
4672
+ * // Acquire an auth client, and bind it to all future calls
4673
+ * const authClient = await auth.getClient();
4674
+ * google.options({auth: authClient});
4675
+ *
4676
+ * // Do the magic
4677
+ * const res = await servicenetworking.services.dnsRecordSets.add({
4678
+ * // Required. 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`.
4679
+ * parent: 'services/my-service',
4680
+ *
4681
+ * // Request body metadata
4682
+ * requestBody: {
4683
+ * // request body parameters
4684
+ * // {
4685
+ * // "consumerNetwork": "my_consumerNetwork",
4686
+ * // "dnsRecordSet": {},
4687
+ * // "zone": "my_zone"
4688
+ * // }
4689
+ * },
4690
+ * });
4691
+ * console.log(res.data);
4692
+ *
4693
+ * // Example response
4694
+ * // {
4695
+ * // "done": false,
4696
+ * // "error": {},
4697
+ * // "metadata": {},
4698
+ * // "name": "my_name",
4699
+ * // "response": {}
4700
+ * // }
4701
+ * }
4702
+ *
4703
+ * main().catch(e => {
4704
+ * console.error(e);
4705
+ * throw e;
4706
+ * });
4707
+ *
4708
+ * ```
3776
4709
  *
3777
4710
  * @param params - Parameters for request
3778
4711
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3865,6 +4798,66 @@ export namespace servicenetworking_v1 {
3865
4798
 
3866
4799
  /**
3867
4800
  * Producers can use this method to retrieve information about the DNS record set added to the private zone inside the shared tenant host project associated with a consumer network.
4801
+ * @example
4802
+ * ```js
4803
+ * // Before running the sample:
4804
+ * // - Enable the API at:
4805
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
4806
+ * // - Login into gcloud by running:
4807
+ * // ```sh
4808
+ * // $ gcloud auth application-default login
4809
+ * // ```
4810
+ * // - Install the npm module by running:
4811
+ * // ```sh
4812
+ * // $ npm install googleapis
4813
+ * // ```
4814
+ *
4815
+ * const {google} = require('googleapis');
4816
+ * const servicenetworking = google.servicenetworking('v1');
4817
+ *
4818
+ * async function main() {
4819
+ * const auth = new google.auth.GoogleAuth({
4820
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4821
+ * scopes: [
4822
+ * 'https://www.googleapis.com/auth/cloud-platform',
4823
+ * 'https://www.googleapis.com/auth/service.management',
4824
+ * ],
4825
+ * });
4826
+ *
4827
+ * // Acquire an auth client, and bind it to all future calls
4828
+ * const authClient = await auth.getClient();
4829
+ * google.options({auth: authClient});
4830
+ *
4831
+ * // Do the magic
4832
+ * const res = await servicenetworking.services.dnsRecordSets.get({
4833
+ * // Required. The consumer network containing the record set. Must be in the form of projects/{project\}/global/networks/{network\}
4834
+ * consumerNetwork: 'placeholder-value',
4835
+ * // Required. The domain name of the zone containing the recordset.
4836
+ * domain: 'placeholder-value',
4837
+ * // Required. Parent resource identifying the connection which owns this collection of DNS zones in the format services/{service\}.
4838
+ * parent: 'services/my-service',
4839
+ * // Required. RecordSet Type eg. type='A'. See the list of [Supported DNS Types](https://cloud.google.com/dns/records/json-record).
4840
+ * type: 'placeholder-value',
4841
+ * // Required. The name of the zone containing the record set.
4842
+ * zone: 'placeholder-value',
4843
+ * });
4844
+ * console.log(res.data);
4845
+ *
4846
+ * // Example response
4847
+ * // {
4848
+ * // "data": [],
4849
+ * // "domain": "my_domain",
4850
+ * // "ttl": "my_ttl",
4851
+ * // "type": "my_type"
4852
+ * // }
4853
+ * }
4854
+ *
4855
+ * main().catch(e => {
4856
+ * console.error(e);
4857
+ * throw e;
4858
+ * });
4859
+ *
4860
+ * ```
3868
4861
  *
3869
4862
  * @param params - Parameters for request
3870
4863
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3957,6 +4950,59 @@ export namespace servicenetworking_v1 {
3957
4950
 
3958
4951
  /**
3959
4952
  * Producers can use this method to retrieve a list of available DNS RecordSets available inside the private zone on the tenant host project accessible from their network.
4953
+ * @example
4954
+ * ```js
4955
+ * // Before running the sample:
4956
+ * // - Enable the API at:
4957
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
4958
+ * // - Login into gcloud by running:
4959
+ * // ```sh
4960
+ * // $ gcloud auth application-default login
4961
+ * // ```
4962
+ * // - Install the npm module by running:
4963
+ * // ```sh
4964
+ * // $ npm install googleapis
4965
+ * // ```
4966
+ *
4967
+ * const {google} = require('googleapis');
4968
+ * const servicenetworking = google.servicenetworking('v1');
4969
+ *
4970
+ * async function main() {
4971
+ * const auth = new google.auth.GoogleAuth({
4972
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4973
+ * scopes: [
4974
+ * 'https://www.googleapis.com/auth/cloud-platform',
4975
+ * 'https://www.googleapis.com/auth/service.management',
4976
+ * ],
4977
+ * });
4978
+ *
4979
+ * // Acquire an auth client, and bind it to all future calls
4980
+ * const authClient = await auth.getClient();
4981
+ * google.options({auth: authClient});
4982
+ *
4983
+ * // Do the magic
4984
+ * const res = await servicenetworking.services.dnsRecordSets.list({
4985
+ * // Required. The network that the consumer is using to connect with services. Must be in the form of projects/{project\}/global/networks/{network\} {project\} is the project number, as in '12345' {network\} is the network name.
4986
+ * consumerNetwork: 'placeholder-value',
4987
+ * // Required. 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`.
4988
+ * parent: 'services/my-service',
4989
+ * // Required. The name of the private DNS zone in the shared producer host project from which the record set will be removed.
4990
+ * zone: 'placeholder-value',
4991
+ * });
4992
+ * console.log(res.data);
4993
+ *
4994
+ * // Example response
4995
+ * // {
4996
+ * // "dnsRecordSets": []
4997
+ * // }
4998
+ * }
4999
+ *
5000
+ * main().catch(e => {
5001
+ * console.error(e);
5002
+ * throw e;
5003
+ * });
5004
+ *
5005
+ * ```
3960
5006
  *
3961
5007
  * @param params - Parameters for request
3962
5008
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4053,6 +5099,69 @@ export namespace servicenetworking_v1 {
4053
5099
 
4054
5100
  /**
4055
5101
  * Service producers can use this method to remove DNS record sets from private DNS zones in the shared producer host project.
5102
+ * @example
5103
+ * ```js
5104
+ * // Before running the sample:
5105
+ * // - Enable the API at:
5106
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
5107
+ * // - Login into gcloud by running:
5108
+ * // ```sh
5109
+ * // $ gcloud auth application-default login
5110
+ * // ```
5111
+ * // - Install the npm module by running:
5112
+ * // ```sh
5113
+ * // $ npm install googleapis
5114
+ * // ```
5115
+ *
5116
+ * const {google} = require('googleapis');
5117
+ * const servicenetworking = google.servicenetworking('v1');
5118
+ *
5119
+ * async function main() {
5120
+ * const auth = new google.auth.GoogleAuth({
5121
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5122
+ * scopes: [
5123
+ * 'https://www.googleapis.com/auth/cloud-platform',
5124
+ * 'https://www.googleapis.com/auth/service.management',
5125
+ * ],
5126
+ * });
5127
+ *
5128
+ * // Acquire an auth client, and bind it to all future calls
5129
+ * const authClient = await auth.getClient();
5130
+ * google.options({auth: authClient});
5131
+ *
5132
+ * // Do the magic
5133
+ * const res = await servicenetworking.services.dnsRecordSets.remove({
5134
+ * // Required. 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`.
5135
+ * parent: 'services/my-service',
5136
+ *
5137
+ * // Request body metadata
5138
+ * requestBody: {
5139
+ * // request body parameters
5140
+ * // {
5141
+ * // "consumerNetwork": "my_consumerNetwork",
5142
+ * // "dnsRecordSet": {},
5143
+ * // "zone": "my_zone"
5144
+ * // }
5145
+ * },
5146
+ * });
5147
+ * console.log(res.data);
5148
+ *
5149
+ * // Example response
5150
+ * // {
5151
+ * // "done": false,
5152
+ * // "error": {},
5153
+ * // "metadata": {},
5154
+ * // "name": "my_name",
5155
+ * // "response": {}
5156
+ * // }
5157
+ * }
5158
+ *
5159
+ * main().catch(e => {
5160
+ * console.error(e);
5161
+ * throw e;
5162
+ * });
5163
+ *
5164
+ * ```
4056
5165
  *
4057
5166
  * @param params - Parameters for request
4058
5167
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4145,6 +5254,70 @@ export namespace servicenetworking_v1 {
4145
5254
 
4146
5255
  /**
4147
5256
  * Service producers can use this method to update DNS record sets from private DNS zones in the shared producer host project.
5257
+ * @example
5258
+ * ```js
5259
+ * // Before running the sample:
5260
+ * // - Enable the API at:
5261
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
5262
+ * // - Login into gcloud by running:
5263
+ * // ```sh
5264
+ * // $ gcloud auth application-default login
5265
+ * // ```
5266
+ * // - Install the npm module by running:
5267
+ * // ```sh
5268
+ * // $ npm install googleapis
5269
+ * // ```
5270
+ *
5271
+ * const {google} = require('googleapis');
5272
+ * const servicenetworking = google.servicenetworking('v1');
5273
+ *
5274
+ * async function main() {
5275
+ * const auth = new google.auth.GoogleAuth({
5276
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5277
+ * scopes: [
5278
+ * 'https://www.googleapis.com/auth/cloud-platform',
5279
+ * 'https://www.googleapis.com/auth/service.management',
5280
+ * ],
5281
+ * });
5282
+ *
5283
+ * // Acquire an auth client, and bind it to all future calls
5284
+ * const authClient = await auth.getClient();
5285
+ * google.options({auth: authClient});
5286
+ *
5287
+ * // Do the magic
5288
+ * const res = await servicenetworking.services.dnsRecordSets.update({
5289
+ * // Required. 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`.
5290
+ * parent: 'services/my-service',
5291
+ *
5292
+ * // Request body metadata
5293
+ * requestBody: {
5294
+ * // request body parameters
5295
+ * // {
5296
+ * // "consumerNetwork": "my_consumerNetwork",
5297
+ * // "existingDnsRecordSet": {},
5298
+ * // "newDnsRecordSet": {},
5299
+ * // "zone": "my_zone"
5300
+ * // }
5301
+ * },
5302
+ * });
5303
+ * console.log(res.data);
5304
+ *
5305
+ * // Example response
5306
+ * // {
5307
+ * // "done": false,
5308
+ * // "error": {},
5309
+ * // "metadata": {},
5310
+ * // "name": "my_name",
5311
+ * // "response": {}
5312
+ * // }
5313
+ * }
5314
+ *
5315
+ * main().catch(e => {
5316
+ * console.error(e);
5317
+ * throw e;
5318
+ * });
5319
+ *
5320
+ * ```
4148
5321
  *
4149
5322
  * @param params - Parameters for request
4150
5323
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4319,6 +5492,69 @@ export namespace servicenetworking_v1 {
4319
5492
 
4320
5493
  /**
4321
5494
  * Service producers can use this method to add private DNS zones in the shared producer host project and matching peering zones in the consumer project.
5495
+ * @example
5496
+ * ```js
5497
+ * // Before running the sample:
5498
+ * // - Enable the API at:
5499
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
5500
+ * // - Login into gcloud by running:
5501
+ * // ```sh
5502
+ * // $ gcloud auth application-default login
5503
+ * // ```
5504
+ * // - Install the npm module by running:
5505
+ * // ```sh
5506
+ * // $ npm install googleapis
5507
+ * // ```
5508
+ *
5509
+ * const {google} = require('googleapis');
5510
+ * const servicenetworking = google.servicenetworking('v1');
5511
+ *
5512
+ * async function main() {
5513
+ * const auth = new google.auth.GoogleAuth({
5514
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5515
+ * scopes: [
5516
+ * 'https://www.googleapis.com/auth/cloud-platform',
5517
+ * 'https://www.googleapis.com/auth/service.management',
5518
+ * ],
5519
+ * });
5520
+ *
5521
+ * // Acquire an auth client, and bind it to all future calls
5522
+ * const authClient = await auth.getClient();
5523
+ * google.options({auth: authClient});
5524
+ *
5525
+ * // Do the magic
5526
+ * const res = await servicenetworking.services.dnsZones.add({
5527
+ * // Required. 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`.
5528
+ * parent: 'services/my-service',
5529
+ *
5530
+ * // Request body metadata
5531
+ * requestBody: {
5532
+ * // request body parameters
5533
+ * // {
5534
+ * // "consumerNetwork": "my_consumerNetwork",
5535
+ * // "dnsSuffix": "my_dnsSuffix",
5536
+ * // "name": "my_name"
5537
+ * // }
5538
+ * },
5539
+ * });
5540
+ * console.log(res.data);
5541
+ *
5542
+ * // Example response
5543
+ * // {
5544
+ * // "done": false,
5545
+ * // "error": {},
5546
+ * // "metadata": {},
5547
+ * // "name": "my_name",
5548
+ * // "response": {}
5549
+ * // }
5550
+ * }
5551
+ *
5552
+ * main().catch(e => {
5553
+ * console.error(e);
5554
+ * throw e;
5555
+ * });
5556
+ *
5557
+ * ```
4322
5558
  *
4323
5559
  * @param params - Parameters for request
4324
5560
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4411,6 +5647,68 @@ export namespace servicenetworking_v1 {
4411
5647
 
4412
5648
  /**
4413
5649
  * Service producers can use this method to remove private DNS zones in the shared producer host project and matching peering zones in the consumer project.
5650
+ * @example
5651
+ * ```js
5652
+ * // Before running the sample:
5653
+ * // - Enable the API at:
5654
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
5655
+ * // - Login into gcloud by running:
5656
+ * // ```sh
5657
+ * // $ gcloud auth application-default login
5658
+ * // ```
5659
+ * // - Install the npm module by running:
5660
+ * // ```sh
5661
+ * // $ npm install googleapis
5662
+ * // ```
5663
+ *
5664
+ * const {google} = require('googleapis');
5665
+ * const servicenetworking = google.servicenetworking('v1');
5666
+ *
5667
+ * async function main() {
5668
+ * const auth = new google.auth.GoogleAuth({
5669
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5670
+ * scopes: [
5671
+ * 'https://www.googleapis.com/auth/cloud-platform',
5672
+ * 'https://www.googleapis.com/auth/service.management',
5673
+ * ],
5674
+ * });
5675
+ *
5676
+ * // Acquire an auth client, and bind it to all future calls
5677
+ * const authClient = await auth.getClient();
5678
+ * google.options({auth: authClient});
5679
+ *
5680
+ * // Do the magic
5681
+ * const res = await servicenetworking.services.dnsZones.remove({
5682
+ * // Required. 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`.
5683
+ * parent: 'services/my-service',
5684
+ *
5685
+ * // Request body metadata
5686
+ * requestBody: {
5687
+ * // request body parameters
5688
+ * // {
5689
+ * // "consumerNetwork": "my_consumerNetwork",
5690
+ * // "name": "my_name"
5691
+ * // }
5692
+ * },
5693
+ * });
5694
+ * console.log(res.data);
5695
+ *
5696
+ * // Example response
5697
+ * // {
5698
+ * // "done": false,
5699
+ * // "error": {},
5700
+ * // "metadata": {},
5701
+ * // "name": "my_name",
5702
+ * // "response": {}
5703
+ * // }
5704
+ * }
5705
+ *
5706
+ * main().catch(e => {
5707
+ * console.error(e);
5708
+ * throw e;
5709
+ * });
5710
+ *
5711
+ * ```
4414
5712
  *
4415
5713
  * @param params - Parameters for request
4416
5714
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4564,6 +5862,69 @@ export namespace servicenetworking_v1 {
4564
5862
 
4565
5863
  /**
4566
5864
  * Service producers use this method to get the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.
5865
+ * @example
5866
+ * ```js
5867
+ * // Before running the sample:
5868
+ * // - Enable the API at:
5869
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
5870
+ * // - Login into gcloud by running:
5871
+ * // ```sh
5872
+ * // $ gcloud auth application-default login
5873
+ * // ```
5874
+ * // - Install the npm module by running:
5875
+ * // ```sh
5876
+ * // $ npm install googleapis
5877
+ * // ```
5878
+ *
5879
+ * const {google} = require('googleapis');
5880
+ * const servicenetworking = google.servicenetworking('v1');
5881
+ *
5882
+ * async function main() {
5883
+ * const auth = new google.auth.GoogleAuth({
5884
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5885
+ * scopes: [
5886
+ * 'https://www.googleapis.com/auth/cloud-platform',
5887
+ * 'https://www.googleapis.com/auth/service.management',
5888
+ * ],
5889
+ * });
5890
+ *
5891
+ * // Acquire an auth client, and bind it to all future calls
5892
+ * const authClient = await auth.getClient();
5893
+ * google.options({auth: authClient});
5894
+ *
5895
+ * // Do the magic
5896
+ * const res = await servicenetworking.services.projects.global.networks.get({
5897
+ * // Optional. When true, include the used IP ranges as part of the GetConsumerConfig output. This includes routes created inside the service networking network, consumer network, peers of the consumer network, and reserved ranges inside the service networking network. By default, this is false
5898
+ * includeUsedIpRanges: 'placeholder-value',
5899
+ * // Required. Name of the consumer config to retrieve in the format: `services/{service\}/projects/{project\}/global/networks/{network\}`. {service\} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project\} is a project number e.g. `12345` that contains the service consumer's VPC network. {network\} is the name of the service consumer's VPC network.
5900
+ * name: 'services/my-service/projects/my-project/global/networks/my-network',
5901
+ * });
5902
+ * console.log(res.data);
5903
+ *
5904
+ * // Example response
5905
+ * // {
5906
+ * // "cloudsqlConfigs": [],
5907
+ * // "consumerExportCustomRoutes": false,
5908
+ * // "consumerExportSubnetRoutesWithPublicIp": false,
5909
+ * // "consumerImportCustomRoutes": false,
5910
+ * // "consumerImportSubnetRoutesWithPublicIp": false,
5911
+ * // "producerExportCustomRoutes": false,
5912
+ * // "producerExportSubnetRoutesWithPublicIp": false,
5913
+ * // "producerImportCustomRoutes": false,
5914
+ * // "producerImportSubnetRoutesWithPublicIp": false,
5915
+ * // "producerNetwork": "my_producerNetwork",
5916
+ * // "reservedRanges": [],
5917
+ * // "usedIpRanges": [],
5918
+ * // "vpcScReferenceArchitectureEnabled": false
5919
+ * // }
5920
+ * }
5921
+ *
5922
+ * main().catch(e => {
5923
+ * console.error(e);
5924
+ * throw e;
5925
+ * });
5926
+ *
5927
+ * ```
4567
5928
  *
4568
5929
  * @param params - Parameters for request
4569
5930
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4653,6 +6014,58 @@ export namespace servicenetworking_v1 {
4653
6014
 
4654
6015
  /**
4655
6016
  * Consumers use this method to find out the state of VPC Service Controls. The controls could be enabled or disabled for a connection.
6017
+ * @example
6018
+ * ```js
6019
+ * // Before running the sample:
6020
+ * // - Enable the API at:
6021
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
6022
+ * // - Login into gcloud by running:
6023
+ * // ```sh
6024
+ * // $ gcloud auth application-default login
6025
+ * // ```
6026
+ * // - Install the npm module by running:
6027
+ * // ```sh
6028
+ * // $ npm install googleapis
6029
+ * // ```
6030
+ *
6031
+ * const {google} = require('googleapis');
6032
+ * const servicenetworking = google.servicenetworking('v1');
6033
+ *
6034
+ * async function main() {
6035
+ * const auth = new google.auth.GoogleAuth({
6036
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6037
+ * scopes: [
6038
+ * 'https://www.googleapis.com/auth/cloud-platform',
6039
+ * 'https://www.googleapis.com/auth/service.management',
6040
+ * ],
6041
+ * });
6042
+ *
6043
+ * // Acquire an auth client, and bind it to all future calls
6044
+ * const authClient = await auth.getClient();
6045
+ * google.options({auth: authClient});
6046
+ *
6047
+ * // Do the magic
6048
+ * const res =
6049
+ * await servicenetworking.services.projects.global.networks.getVpcServiceControls(
6050
+ * {
6051
+ * // Required. Name of the VPC Service Controls config to retrieve in the format: `services/{service\}/projects/{project\}/global/networks/{network\}`. {service\} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project\} is a project number e.g. `12345` that contains the service consumer's VPC network. {network\} is the name of the service consumer's VPC network.
6052
+ * name: 'services/my-service/projects/my-project/global/networks/my-network',
6053
+ * },
6054
+ * );
6055
+ * console.log(res.data);
6056
+ *
6057
+ * // Example response
6058
+ * // {
6059
+ * // "enabled": false
6060
+ * // }
6061
+ * }
6062
+ *
6063
+ * main().catch(e => {
6064
+ * console.error(e);
6065
+ * throw e;
6066
+ * });
6067
+ *
6068
+ * ```
4656
6069
  *
4657
6070
  * @param params - Parameters for request
4658
6071
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4748,6 +6161,71 @@ export namespace servicenetworking_v1 {
4748
6161
 
4749
6162
  /**
4750
6163
  * Service producers use this method to update the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.
6164
+ * @example
6165
+ * ```js
6166
+ * // Before running the sample:
6167
+ * // - Enable the API at:
6168
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
6169
+ * // - Login into gcloud by running:
6170
+ * // ```sh
6171
+ * // $ gcloud auth application-default login
6172
+ * // ```
6173
+ * // - Install the npm module by running:
6174
+ * // ```sh
6175
+ * // $ npm install googleapis
6176
+ * // ```
6177
+ *
6178
+ * const {google} = require('googleapis');
6179
+ * const servicenetworking = google.servicenetworking('v1');
6180
+ *
6181
+ * async function main() {
6182
+ * const auth = new google.auth.GoogleAuth({
6183
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6184
+ * scopes: [
6185
+ * 'https://www.googleapis.com/auth/cloud-platform',
6186
+ * 'https://www.googleapis.com/auth/service.management',
6187
+ * ],
6188
+ * });
6189
+ *
6190
+ * // Acquire an auth client, and bind it to all future calls
6191
+ * const authClient = await auth.getClient();
6192
+ * google.options({auth: authClient});
6193
+ *
6194
+ * // Do the magic
6195
+ * const res =
6196
+ * await servicenetworking.services.projects.global.networks.updateConsumerConfig(
6197
+ * {
6198
+ * // Required. Parent resource identifying the connection for which the consumer config is being updated in the format: `services/{service\}/projects/{project\}/global/networks/{network\}` {service\} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project\} is the number of the project that contains the service consumer's VPC network e.g. `12345`. {network\} is the name of the service consumer's VPC network.
6199
+ * parent:
6200
+ * 'services/my-service/projects/my-project/global/networks/my-network',
6201
+ *
6202
+ * // Request body metadata
6203
+ * requestBody: {
6204
+ * // request body parameters
6205
+ * // {
6206
+ * // "consumerConfig": {}
6207
+ * // }
6208
+ * },
6209
+ * },
6210
+ * );
6211
+ * console.log(res.data);
6212
+ *
6213
+ * // Example response
6214
+ * // {
6215
+ * // "done": false,
6216
+ * // "error": {},
6217
+ * // "metadata": {},
6218
+ * // "name": "my_name",
6219
+ * // "response": {}
6220
+ * // }
6221
+ * }
6222
+ *
6223
+ * main().catch(e => {
6224
+ * console.error(e);
6225
+ * throw e;
6226
+ * });
6227
+ *
6228
+ * ```
4751
6229
  *
4752
6230
  * @param params - Parameters for request
4753
6231
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4881,6 +6359,57 @@ export namespace servicenetworking_v1 {
4881
6359
 
4882
6360
  /**
4883
6361
  * Service producers can use this method to retrieve a DNS zone in the shared producer host project and the matching peering zones in consumer project
6362
+ * @example
6363
+ * ```js
6364
+ * // Before running the sample:
6365
+ * // - Enable the API at:
6366
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
6367
+ * // - Login into gcloud by running:
6368
+ * // ```sh
6369
+ * // $ gcloud auth application-default login
6370
+ * // ```
6371
+ * // - Install the npm module by running:
6372
+ * // ```sh
6373
+ * // $ npm install googleapis
6374
+ * // ```
6375
+ *
6376
+ * const {google} = require('googleapis');
6377
+ * const servicenetworking = google.servicenetworking('v1');
6378
+ *
6379
+ * async function main() {
6380
+ * const auth = new google.auth.GoogleAuth({
6381
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6382
+ * scopes: [
6383
+ * 'https://www.googleapis.com/auth/cloud-platform',
6384
+ * 'https://www.googleapis.com/auth/service.management',
6385
+ * ],
6386
+ * });
6387
+ *
6388
+ * // Acquire an auth client, and bind it to all future calls
6389
+ * const authClient = await auth.getClient();
6390
+ * google.options({auth: authClient});
6391
+ *
6392
+ * // Do the magic
6393
+ * const res =
6394
+ * await servicenetworking.services.projects.global.networks.dnsZones.get({
6395
+ * // Required. The network that the consumer is using to connect with services. Must be in the form of services/{service\}/projects/{project\}/global/networks/{network\}/dnsZones/{zoneName\} Where {service\} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this {project\} is the project number, as in '12345' {network\} is the network name. {zoneName\} is the DNS zone name
6396
+ * name: 'services/my-service/projects/my-project/global/networks/my-network/dnsZones/my-dnsZone',
6397
+ * });
6398
+ * console.log(res.data);
6399
+ *
6400
+ * // Example response
6401
+ * // {
6402
+ * // "consumerPeeringZone": {},
6403
+ * // "producerPrivateZone": {}
6404
+ * // }
6405
+ * }
6406
+ *
6407
+ * main().catch(e => {
6408
+ * console.error(e);
6409
+ * throw e;
6410
+ * });
6411
+ *
6412
+ * ```
4884
6413
  *
4885
6414
  * @param params - Parameters for request
4886
6415
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4971,6 +6500,57 @@ export namespace servicenetworking_v1 {
4971
6500
 
4972
6501
  /**
4973
6502
  * * Service producers can use this method to retrieve a list of available DNS zones in the shared producer host project and the matching peering zones in the consumer project. *
6503
+ * @example
6504
+ * ```js
6505
+ * // Before running the sample:
6506
+ * // - Enable the API at:
6507
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
6508
+ * // - Login into gcloud by running:
6509
+ * // ```sh
6510
+ * // $ gcloud auth application-default login
6511
+ * // ```
6512
+ * // - Install the npm module by running:
6513
+ * // ```sh
6514
+ * // $ npm install googleapis
6515
+ * // ```
6516
+ *
6517
+ * const {google} = require('googleapis');
6518
+ * const servicenetworking = google.servicenetworking('v1');
6519
+ *
6520
+ * async function main() {
6521
+ * const auth = new google.auth.GoogleAuth({
6522
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6523
+ * scopes: [
6524
+ * 'https://www.googleapis.com/auth/cloud-platform',
6525
+ * 'https://www.googleapis.com/auth/service.management',
6526
+ * ],
6527
+ * });
6528
+ *
6529
+ * // Acquire an auth client, and bind it to all future calls
6530
+ * const authClient = await auth.getClient();
6531
+ * google.options({auth: authClient});
6532
+ *
6533
+ * // Do the magic
6534
+ * const res =
6535
+ * await servicenetworking.services.projects.global.networks.dnsZones.list({
6536
+ * // Required. Parent resource identifying the connection which owns this collection of DNS zones in the format services/{service\}/projects/{project\}/global/networks/{network\} Service: The service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. Projects: the consumer project containing the consumer network. Network: The consumer network accessible from the tenant project.
6537
+ * parent:
6538
+ * 'services/my-service/projects/my-project/global/networks/my-network',
6539
+ * });
6540
+ * console.log(res.data);
6541
+ *
6542
+ * // Example response
6543
+ * // {
6544
+ * // "dnsZonePairs": []
6545
+ * // }
6546
+ * }
6547
+ *
6548
+ * main().catch(e => {
6549
+ * console.error(e);
6550
+ * throw e;
6551
+ * });
6552
+ *
6553
+ * ```
4974
6554
  *
4975
6555
  * @param params - Parameters for request
4976
6556
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5088,6 +6668,72 @@ export namespace servicenetworking_v1 {
5088
6668
 
5089
6669
  /**
5090
6670
  * Creates a peered DNS domain which sends requests for records in given namespace originating in the service producer VPC network to the consumer VPC network to be resolved.
6671
+ * @example
6672
+ * ```js
6673
+ * // Before running the sample:
6674
+ * // - Enable the API at:
6675
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
6676
+ * // - Login into gcloud by running:
6677
+ * // ```sh
6678
+ * // $ gcloud auth application-default login
6679
+ * // ```
6680
+ * // - Install the npm module by running:
6681
+ * // ```sh
6682
+ * // $ npm install googleapis
6683
+ * // ```
6684
+ *
6685
+ * const {google} = require('googleapis');
6686
+ * const servicenetworking = google.servicenetworking('v1');
6687
+ *
6688
+ * async function main() {
6689
+ * const auth = new google.auth.GoogleAuth({
6690
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6691
+ * scopes: [
6692
+ * 'https://www.googleapis.com/auth/cloud-platform',
6693
+ * 'https://www.googleapis.com/auth/service.management',
6694
+ * ],
6695
+ * });
6696
+ *
6697
+ * // Acquire an auth client, and bind it to all future calls
6698
+ * const authClient = await auth.getClient();
6699
+ * google.options({auth: authClient});
6700
+ *
6701
+ * // Do the magic
6702
+ * const res =
6703
+ * await servicenetworking.services.projects.global.networks.peeredDnsDomains.create(
6704
+ * {
6705
+ * // Required. Parent resource identifying the connection for which the peered DNS domain will be created in the format: `services/{service\}/projects/{project\}/global/networks/{network\}` {service\} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project\} is the number of the project that contains the service consumer's VPC network e.g. `12345`. {network\} is the name of the service consumer's VPC network.
6706
+ * parent:
6707
+ * 'services/my-service/projects/my-project/global/networks/my-network',
6708
+ *
6709
+ * // Request body metadata
6710
+ * requestBody: {
6711
+ * // request body parameters
6712
+ * // {
6713
+ * // "dnsSuffix": "my_dnsSuffix",
6714
+ * // "name": "my_name"
6715
+ * // }
6716
+ * },
6717
+ * },
6718
+ * );
6719
+ * console.log(res.data);
6720
+ *
6721
+ * // Example response
6722
+ * // {
6723
+ * // "done": false,
6724
+ * // "error": {},
6725
+ * // "metadata": {},
6726
+ * // "name": "my_name",
6727
+ * // "response": {}
6728
+ * // }
6729
+ * }
6730
+ *
6731
+ * main().catch(e => {
6732
+ * console.error(e);
6733
+ * throw e;
6734
+ * });
6735
+ *
6736
+ * ```
5091
6737
  *
5092
6738
  * @param params - Parameters for request
5093
6739
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5181,6 +6827,62 @@ export namespace servicenetworking_v1 {
5181
6827
 
5182
6828
  /**
5183
6829
  * Deletes a peered DNS domain.
6830
+ * @example
6831
+ * ```js
6832
+ * // Before running the sample:
6833
+ * // - Enable the API at:
6834
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
6835
+ * // - Login into gcloud by running:
6836
+ * // ```sh
6837
+ * // $ gcloud auth application-default login
6838
+ * // ```
6839
+ * // - Install the npm module by running:
6840
+ * // ```sh
6841
+ * // $ npm install googleapis
6842
+ * // ```
6843
+ *
6844
+ * const {google} = require('googleapis');
6845
+ * const servicenetworking = google.servicenetworking('v1');
6846
+ *
6847
+ * async function main() {
6848
+ * const auth = new google.auth.GoogleAuth({
6849
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6850
+ * scopes: [
6851
+ * 'https://www.googleapis.com/auth/cloud-platform',
6852
+ * 'https://www.googleapis.com/auth/service.management',
6853
+ * ],
6854
+ * });
6855
+ *
6856
+ * // Acquire an auth client, and bind it to all future calls
6857
+ * const authClient = await auth.getClient();
6858
+ * google.options({auth: authClient});
6859
+ *
6860
+ * // Do the magic
6861
+ * const res =
6862
+ * await servicenetworking.services.projects.global.networks.peeredDnsDomains.delete(
6863
+ * {
6864
+ * // Required. The name of the peered DNS domain to delete in the format: `services/{service\}/projects/{project\}/global/networks/{network\}/peeredDnsDomains/{name\}`. {service\} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project\} is the number of the project that contains the service consumer's VPC network e.g. `12345`. {network\} is the name of the service consumer's VPC network. {name\} is the name of the peered DNS domain.
6865
+ * name: 'services/my-service/projects/my-project/global/networks/my-network/peeredDnsDomains/my-peeredDnsDomain',
6866
+ * },
6867
+ * );
6868
+ * console.log(res.data);
6869
+ *
6870
+ * // Example response
6871
+ * // {
6872
+ * // "done": false,
6873
+ * // "error": {},
6874
+ * // "metadata": {},
6875
+ * // "name": "my_name",
6876
+ * // "response": {}
6877
+ * // }
6878
+ * }
6879
+ *
6880
+ * main().catch(e => {
6881
+ * console.error(e);
6882
+ * throw e;
6883
+ * });
6884
+ *
6885
+ * ```
5184
6886
  *
5185
6887
  * @param params - Parameters for request
5186
6888
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5271,6 +6973,59 @@ export namespace servicenetworking_v1 {
5271
6973
 
5272
6974
  /**
5273
6975
  * Lists peered DNS domains for a connection.
6976
+ * @example
6977
+ * ```js
6978
+ * // Before running the sample:
6979
+ * // - Enable the API at:
6980
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
6981
+ * // - Login into gcloud by running:
6982
+ * // ```sh
6983
+ * // $ gcloud auth application-default login
6984
+ * // ```
6985
+ * // - Install the npm module by running:
6986
+ * // ```sh
6987
+ * // $ npm install googleapis
6988
+ * // ```
6989
+ *
6990
+ * const {google} = require('googleapis');
6991
+ * const servicenetworking = google.servicenetworking('v1');
6992
+ *
6993
+ * async function main() {
6994
+ * const auth = new google.auth.GoogleAuth({
6995
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6996
+ * scopes: [
6997
+ * 'https://www.googleapis.com/auth/cloud-platform',
6998
+ * 'https://www.googleapis.com/auth/service.management',
6999
+ * ],
7000
+ * });
7001
+ *
7002
+ * // Acquire an auth client, and bind it to all future calls
7003
+ * const authClient = await auth.getClient();
7004
+ * google.options({auth: authClient});
7005
+ *
7006
+ * // Do the magic
7007
+ * const res =
7008
+ * await servicenetworking.services.projects.global.networks.peeredDnsDomains.list(
7009
+ * {
7010
+ * // Required. Parent resource identifying the connection which owns this collection of peered DNS domains in the format: `services/{service\}/projects/{project\}/global/networks/{network\}`. {service\} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project\} is a project number e.g. `12345` that contains the service consumer's VPC network. {network\} is the name of the service consumer's VPC network.
7011
+ * parent:
7012
+ * 'services/my-service/projects/my-project/global/networks/my-network',
7013
+ * },
7014
+ * );
7015
+ * console.log(res.data);
7016
+ *
7017
+ * // Example response
7018
+ * // {
7019
+ * // "peeredDnsDomains": []
7020
+ * // }
7021
+ * }
7022
+ *
7023
+ * main().catch(e => {
7024
+ * console.error(e);
7025
+ * throw e;
7026
+ * });
7027
+ *
7028
+ * ```
5274
7029
  *
5275
7030
  * @param params - Parameters for request
5276
7031
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5404,6 +7159,68 @@ export namespace servicenetworking_v1 {
5404
7159
 
5405
7160
  /**
5406
7161
  * Service producers can use this method to add roles in the shared VPC host project. Each role is bound to the provided member. Each role must be selected from within an allowlisted set of roles. Each role is applied at only the granularity specified in the allowlist.
7162
+ * @example
7163
+ * ```js
7164
+ * // Before running the sample:
7165
+ * // - Enable the API at:
7166
+ * // https://console.developers.google.com/apis/api/servicenetworking.googleapis.com
7167
+ * // - Login into gcloud by running:
7168
+ * // ```sh
7169
+ * // $ gcloud auth application-default login
7170
+ * // ```
7171
+ * // - Install the npm module by running:
7172
+ * // ```sh
7173
+ * // $ npm install googleapis
7174
+ * // ```
7175
+ *
7176
+ * const {google} = require('googleapis');
7177
+ * const servicenetworking = google.servicenetworking('v1');
7178
+ *
7179
+ * async function main() {
7180
+ * const auth = new google.auth.GoogleAuth({
7181
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7182
+ * scopes: [
7183
+ * 'https://www.googleapis.com/auth/cloud-platform',
7184
+ * 'https://www.googleapis.com/auth/service.management',
7185
+ * ],
7186
+ * });
7187
+ *
7188
+ * // Acquire an auth client, and bind it to all future calls
7189
+ * const authClient = await auth.getClient();
7190
+ * google.options({auth: authClient});
7191
+ *
7192
+ * // Do the magic
7193
+ * const res = await servicenetworking.services.roles.add({
7194
+ * // Required. This is in a form services/{service\} where {service\} is the name of the private access management service. For example 'service-peering.example.com'.
7195
+ * parent: 'services/my-service',
7196
+ *
7197
+ * // Request body metadata
7198
+ * requestBody: {
7199
+ * // request body parameters
7200
+ * // {
7201
+ * // "consumerNetwork": "my_consumerNetwork",
7202
+ * // "policyBinding": []
7203
+ * // }
7204
+ * },
7205
+ * });
7206
+ * console.log(res.data);
7207
+ *
7208
+ * // Example response
7209
+ * // {
7210
+ * // "done": false,
7211
+ * // "error": {},
7212
+ * // "metadata": {},
7213
+ * // "name": "my_name",
7214
+ * // "response": {}
7215
+ * // }
7216
+ * }
7217
+ *
7218
+ * main().catch(e => {
7219
+ * console.error(e);
7220
+ * throw e;
7221
+ * });
7222
+ *
7223
+ * ```
5407
7224
  *
5408
7225
  * @param params - Parameters for request
5409
7226
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.