@googleapis/servicenetworking 8.0.0 → 8.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v1.ts CHANGED
@@ -211,6 +211,10 @@ export namespace servicenetworking_v1 {
211
211
  * Request to create a subnetwork in a previously peered service network.
212
212
  */
213
213
  export interface Schema$AddSubnetworkRequest {
214
+ /**
215
+ * Optional. Defines the allowSubnetCidrRoutesOverlap field of the subnet, e.g. Available in alpha and beta according to [Compute API documentation](https://cloud.google.com/compute/docs/reference/rest/beta/subnetworks/insert)
216
+ */
217
+ allowSubnetCidrRoutesOverlap?: boolean | null;
214
218
  /**
215
219
  * Optional. The IAM permission check determines whether the consumer project has 'servicenetworking.services.use' permission or not.
216
220
  */
@@ -232,7 +236,7 @@ export namespace servicenetworking_v1 {
232
236
  */
233
237
  description?: string | null;
234
238
  /**
235
- * Required. The prefix length of the subnet's IP address range. Use CIDR range notation, such as `30` to provision a subnet with an `x.x.x.x/30` CIDR range. The IP address range is drawn from a pool of available ranges in the service consumer's allocated range.
239
+ * Required. The prefix length of the subnet's IP address range. Use CIDR range notation, such as `29` to provision a subnet with an `x.x.x.x/29` CIDR range. The IP address range is drawn from a pool of available ranges in the service consumer's allocated range. GCE disallows subnets with prefix_length \> 29
236
240
  */
237
241
  ipPrefixLength?: number | null;
238
242
  /**
@@ -414,6 +418,10 @@ export namespace servicenetworking_v1 {
414
418
  * The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.
415
419
  */
416
420
  jwtAudience?: string | null;
421
+ /**
422
+ * Deprecated, do not use.
423
+ */
424
+ minDeadline?: number | null;
417
425
  /**
418
426
  * The number of seconds to wait for the completion of a long running operation. The default is no deadline.
419
427
  */
@@ -454,6 +462,55 @@ export namespace servicenetworking_v1 {
454
462
  * The request message for Operations.CancelOperation.
455
463
  */
456
464
  export interface Schema$CancelOperationRequest {}
465
+ /**
466
+ * Details about how and where to publish client libraries.
467
+ */
468
+ export interface Schema$ClientLibrarySettings {
469
+ /**
470
+ * Settings for C++ client libraries.
471
+ */
472
+ cppSettings?: Schema$CppSettings;
473
+ /**
474
+ * Settings for .NET client libraries.
475
+ */
476
+ dotnetSettings?: Schema$DotnetSettings;
477
+ /**
478
+ * Settings for Go client libraries.
479
+ */
480
+ goSettings?: Schema$GoSettings;
481
+ /**
482
+ * Settings for legacy Java features, supported in the Service YAML.
483
+ */
484
+ javaSettings?: Schema$JavaSettings;
485
+ /**
486
+ * Launch stage of this version of the API.
487
+ */
488
+ launchStage?: string | null;
489
+ /**
490
+ * Settings for Node client libraries.
491
+ */
492
+ nodeSettings?: Schema$NodeSettings;
493
+ /**
494
+ * Settings for PHP client libraries.
495
+ */
496
+ phpSettings?: Schema$PhpSettings;
497
+ /**
498
+ * Settings for Python client libraries.
499
+ */
500
+ pythonSettings?: Schema$PythonSettings;
501
+ /**
502
+ * When using transport=rest, the client request will encode enums as numbers rather than strings.
503
+ */
504
+ restNumericEnums?: boolean | null;
505
+ /**
506
+ * Settings for Ruby client libraries.
507
+ */
508
+ rubySettings?: Schema$RubySettings;
509
+ /**
510
+ * Version of the API to apply these settings to.
511
+ */
512
+ version?: string | null;
513
+ }
457
514
  /**
458
515
  * Cloud SQL configuration.
459
516
  */
@@ -471,6 +528,19 @@ export namespace servicenetworking_v1 {
471
528
  */
472
529
  umbrellaProject?: string | null;
473
530
  }
531
+ /**
532
+ * Required information for every language.
533
+ */
534
+ export interface Schema$CommonLanguageSettings {
535
+ /**
536
+ * The destination where API teams want this client library to be published.
537
+ */
538
+ destinations?: string[] | null;
539
+ /**
540
+ * Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
541
+ */
542
+ referenceDocsUri?: string | null;
543
+ }
474
544
  /**
475
545
  * Represents a private connection resource. A private connection is implemented as a VPC Network Peering connection between a service producer's VPC network and a service consumer's VPC network.
476
546
  */
@@ -597,7 +667,7 @@ export namespace servicenetworking_v1 {
597
667
  selector?: string | null;
598
668
  }
599
669
  /**
600
- * Selects and configures the service controller used by the service. The service controller handles two things: - **What is allowed:** for each API request, Chemist checks the project status, activation status, abuse status, billing status, service status, location restrictions, VPC Service Controls, SuperQuota, and other policies. - **What has happened:** for each API response, Chemist reports the telemetry data to analytics, auditing, billing, eventing, logging, monitoring, sawmill, and tracing. Chemist also accepts telemetry data not associated with API traffic, such as billing metrics. Example: control: environment: servicecontrol.googleapis.com
670
+ * Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com
601
671
  */
602
672
  export interface Schema$Control {
603
673
  /**
@@ -605,6 +675,15 @@ export namespace servicenetworking_v1 {
605
675
  */
606
676
  environment?: string | null;
607
677
  }
678
+ /**
679
+ * Settings for C++ client libraries.
680
+ */
681
+ export interface Schema$CppSettings {
682
+ /**
683
+ * Some settings.
684
+ */
685
+ common?: Schema$CommonLanguageSettings;
686
+ }
608
687
  /**
609
688
  * Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError
610
689
  */
@@ -750,6 +829,15 @@ export namespace servicenetworking_v1 {
750
829
  */
751
830
  selector?: string | null;
752
831
  }
832
+ /**
833
+ * Settings for Dotnet client libraries.
834
+ */
835
+ export interface Schema$DotnetSettings {
836
+ /**
837
+ * Some settings.
838
+ */
839
+ common?: Schema$CommonLanguageSettings;
840
+ }
753
841
  /**
754
842
  * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
755
843
  */
@@ -767,6 +855,10 @@ export namespace servicenetworking_v1 {
767
855
  * `Endpoint` describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example: type: google.api.Service name: library-example.googleapis.com endpoints: # Declares network address `https://library-example.googleapis.com` # for service `library-example.googleapis.com`. The `https` scheme # is implicit for all service endpoints. Other schemes may be # supported in the future. - name: library-example.googleapis.com allow_cors: false - name: content-staging-library-example.googleapis.com # Allows HTTP OPTIONS calls to be passed to the API frontend, for it # to decide whether the subsequent cross-origin request is allowed # to proceed. allow_cors: true
768
856
  */
769
857
  export interface Schema$Endpoint {
858
+ /**
859
+ * Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
860
+ */
861
+ aliases?: string[] | null;
770
862
  /**
771
863
  * Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
772
864
  */
@@ -926,6 +1018,15 @@ export namespace servicenetworking_v1 {
926
1018
  */
927
1019
  name?: string | null;
928
1020
  }
1021
+ /**
1022
+ * Settings for Go client libraries.
1023
+ */
1024
+ export interface Schema$GoSettings {
1025
+ /**
1026
+ * Some settings.
1027
+ */
1028
+ common?: Schema$CommonLanguageSettings;
1029
+ }
929
1030
  /**
930
1031
  * Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.
931
1032
  */
@@ -984,6 +1085,23 @@ export namespace servicenetworking_v1 {
984
1085
  */
985
1086
  selector?: string | null;
986
1087
  }
1088
+ /**
1089
+ * Settings for Java client libraries.
1090
+ */
1091
+ export interface Schema$JavaSettings {
1092
+ /**
1093
+ * Some settings.
1094
+ */
1095
+ common?: Schema$CommonLanguageSettings;
1096
+ /**
1097
+ * The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1
1098
+ */
1099
+ libraryPackage?: string | null;
1100
+ /**
1101
+ * Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin
1102
+ */
1103
+ serviceClassNames?: {[key: string]: string} | null;
1104
+ }
987
1105
  /**
988
1106
  * Specifies a location to extract JWT from an API request.
989
1107
  */
@@ -1100,6 +1218,27 @@ export namespace servicenetworking_v1 {
1100
1218
  */
1101
1219
  monitoredResource?: string | null;
1102
1220
  }
1221
+ /**
1222
+ * Describes settings to use when generating API methods that use the long-running operation pattern. All default values below are from those used in the client library generators (e.g. [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
1223
+ */
1224
+ export interface Schema$LongRunning {
1225
+ /**
1226
+ * Initial delay after which the first poll request will be made. Default value: 5 seconds.
1227
+ */
1228
+ initialPollDelay?: string | null;
1229
+ /**
1230
+ * Maximum time between two subsequent poll requests. Default value: 45 seconds.
1231
+ */
1232
+ maxPollDelay?: string | null;
1233
+ /**
1234
+ * Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
1235
+ */
1236
+ pollDelayMultiplier?: number | null;
1237
+ /**
1238
+ * Total polling timeout. Default value: 5 minutes.
1239
+ */
1240
+ totalPollTimeout?: string | null;
1241
+ }
1103
1242
  /**
1104
1243
  * Method represents a method of an API interface.
1105
1244
  */
@@ -1133,6 +1272,19 @@ export namespace servicenetworking_v1 {
1133
1272
  */
1134
1273
  syntax?: string | null;
1135
1274
  }
1275
+ /**
1276
+ * Describes the generator configuration for a method.
1277
+ */
1278
+ export interface Schema$MethodSettings {
1279
+ /**
1280
+ * 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_behavior: - selector: CreateAdDomain long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
1281
+ */
1282
+ longRunning?: Schema$LongRunning;
1283
+ /**
1284
+ * The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
1285
+ */
1286
+ selector?: string | null;
1287
+ }
1136
1288
  /**
1137
1289
  * Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
1138
1290
  */
@@ -1280,6 +1432,15 @@ export namespace servicenetworking_v1 {
1280
1432
  */
1281
1433
  monitoredResource?: string | null;
1282
1434
  }
1435
+ /**
1436
+ * Settings for Node client libraries.
1437
+ */
1438
+ export interface Schema$NodeSettings {
1439
+ /**
1440
+ * Some settings.
1441
+ */
1442
+ common?: Schema$CommonLanguageSettings;
1443
+ }
1283
1444
  /**
1284
1445
  * OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.
1285
1446
  */
@@ -1365,6 +1526,15 @@ export namespace servicenetworking_v1 {
1365
1526
  * Metadata provided through GetOperation request for the LRO generated by CreatePeeredDnsDomain API.
1366
1527
  */
1367
1528
  export interface Schema$PeeredDnsDomainMetadata {}
1529
+ /**
1530
+ * Settings for Php client libraries.
1531
+ */
1532
+ export interface Schema$PhpSettings {
1533
+ /**
1534
+ * Some settings.
1535
+ */
1536
+ common?: Schema$CommonLanguageSettings;
1537
+ }
1368
1538
  /**
1369
1539
  * Grouping of IAM role and IAM member.
1370
1540
  */
@@ -1378,6 +1548,56 @@ export namespace servicenetworking_v1 {
1378
1548
  */
1379
1549
  role?: string | null;
1380
1550
  }
1551
+ /**
1552
+ * This message configures the settings for publishing [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from the service config.
1553
+ */
1554
+ export interface Schema$Publishing {
1555
+ /**
1556
+ * Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
1557
+ */
1558
+ apiShortName?: string | null;
1559
+ /**
1560
+ * GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
1561
+ */
1562
+ codeownerGithubTeams?: string[] | null;
1563
+ /**
1564
+ * A prefix used in sample code when demarking regions to be included in documentation.
1565
+ */
1566
+ docTagPrefix?: string | null;
1567
+ /**
1568
+ * Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
1569
+ */
1570
+ documentationUri?: string | null;
1571
+ /**
1572
+ * GitHub label to apply to issues and pull requests opened for this API.
1573
+ */
1574
+ githubLabel?: string | null;
1575
+ /**
1576
+ * Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are discarded.
1577
+ */
1578
+ librarySettings?: Schema$ClientLibrarySettings[];
1579
+ /**
1580
+ * A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
1581
+ */
1582
+ methodSettings?: Schema$MethodSettings[];
1583
+ /**
1584
+ * Link to a place that API users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
1585
+ */
1586
+ newIssueUri?: string | null;
1587
+ /**
1588
+ * For whom the client library is being published.
1589
+ */
1590
+ organization?: string | null;
1591
+ }
1592
+ /**
1593
+ * Settings for Python client libraries.
1594
+ */
1595
+ export interface Schema$PythonSettings {
1596
+ /**
1597
+ * Some settings.
1598
+ */
1599
+ common?: Schema$CommonLanguageSettings;
1600
+ }
1381
1601
  /**
1382
1602
  * Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project\}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64
1383
1603
  */
@@ -1454,7 +1674,7 @@ export namespace servicenetworking_v1 {
1454
1674
  */
1455
1675
  export interface Schema$RangeReservation {
1456
1676
  /**
1457
- * Required. The size of the desired subnet. Use usual CIDR range notation. For example, '30' to find unused x.x.x.x/30 CIDR range. The goal is to determine if one of the allocated ranges has enough free space for a subnet of the requested size.
1677
+ * Required. The size of the desired subnet. Use usual CIDR range notation. For example, '29' to find unused x.x.x.x/29 CIDR range. The goal is to determine if one of the allocated ranges has enough free space for a subnet of the requested size. GCE disallows subnets with prefix_length \> 29
1458
1678
  */
1459
1679
  ipPrefixLength?: number | null;
1460
1680
  /**
@@ -1462,7 +1682,7 @@ export namespace servicenetworking_v1 {
1462
1682
  */
1463
1683
  requestedRanges?: string[] | null;
1464
1684
  /**
1465
- * Optional. The size of the desired secondary ranges for the subnet. Use usual CIDR range notation. For example, '30' to find unused x.x.x.x/30 CIDR range. The goal is to determine that the allocated ranges have enough free space for all the requested secondary ranges.
1685
+ * Optional. The size of the desired secondary ranges for the subnet. Use usual CIDR range notation. For example, '29' to find unused x.x.x.x/29 CIDR range. The goal is to determine that the allocated ranges have enough free space for all the requested secondary ranges. GCE disallows subnets with prefix_length \> 29
1466
1686
  */
1467
1687
  secondaryRangeIpPrefixLengths?: number[] | null;
1468
1688
  /**
@@ -1537,6 +1757,15 @@ export namespace servicenetworking_v1 {
1537
1757
  */
1538
1758
  nextHopGateway?: string | null;
1539
1759
  }
1760
+ /**
1761
+ * Settings for Ruby client libraries.
1762
+ */
1763
+ export interface Schema$RubySettings {
1764
+ /**
1765
+ * Some settings.
1766
+ */
1767
+ common?: Schema$CommonLanguageSettings;
1768
+ }
1540
1769
  /**
1541
1770
  * Request to search for an unused range within allocated ranges.
1542
1771
  */
@@ -1662,6 +1891,10 @@ export namespace servicenetworking_v1 {
1662
1891
  * The Google project that owns this service.
1663
1892
  */
1664
1893
  producerProjectId?: string | null;
1894
+ /**
1895
+ * Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers.
1896
+ */
1897
+ publishing?: Schema$Publishing;
1665
1898
  /**
1666
1899
  * Quota configuration.
1667
1900
  */
@@ -2568,6 +2801,7 @@ export namespace servicenetworking_v1 {
2568
2801
  * requestBody: {
2569
2802
  * // request body parameters
2570
2803
  * // {
2804
+ * // "allowSubnetCidrRoutesOverlap": false,
2571
2805
  * // "checkServiceNetworkingUsePermission": false,
2572
2806
  * // "computeIdempotencyWindow": "my_computeIdempotencyWindow",
2573
2807
  * // "consumer": "my_consumer",