@googleapis/servicenetworking 8.0.0 → 8.2.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/v1beta.ts CHANGED
@@ -335,6 +335,10 @@ export namespace servicenetworking_v1beta {
335
335
  * 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.
336
336
  */
337
337
  jwtAudience?: string | null;
338
+ /**
339
+ * Deprecated, do not use.
340
+ */
341
+ minDeadline?: number | null;
338
342
  /**
339
343
  * The number of seconds to wait for the completion of a long running operation. The default is no deadline.
340
344
  */
@@ -371,6 +375,55 @@ export namespace servicenetworking_v1beta {
371
375
  */
372
376
  monitoredResource?: string | null;
373
377
  }
378
+ /**
379
+ * Details about how and where to publish client libraries.
380
+ */
381
+ export interface Schema$ClientLibrarySettings {
382
+ /**
383
+ * Settings for C++ client libraries.
384
+ */
385
+ cppSettings?: Schema$CppSettings;
386
+ /**
387
+ * Settings for .NET client libraries.
388
+ */
389
+ dotnetSettings?: Schema$DotnetSettings;
390
+ /**
391
+ * Settings for Go client libraries.
392
+ */
393
+ goSettings?: Schema$GoSettings;
394
+ /**
395
+ * Settings for legacy Java features, supported in the Service YAML.
396
+ */
397
+ javaSettings?: Schema$JavaSettings;
398
+ /**
399
+ * Launch stage of this version of the API.
400
+ */
401
+ launchStage?: string | null;
402
+ /**
403
+ * Settings for Node client libraries.
404
+ */
405
+ nodeSettings?: Schema$NodeSettings;
406
+ /**
407
+ * Settings for PHP client libraries.
408
+ */
409
+ phpSettings?: Schema$PhpSettings;
410
+ /**
411
+ * Settings for Python client libraries.
412
+ */
413
+ pythonSettings?: Schema$PythonSettings;
414
+ /**
415
+ * When using transport=rest, the client request will encode enums as numbers rather than strings.
416
+ */
417
+ restNumericEnums?: boolean | null;
418
+ /**
419
+ * Settings for Ruby client libraries.
420
+ */
421
+ rubySettings?: Schema$RubySettings;
422
+ /**
423
+ * Version of the API to apply these settings to.
424
+ */
425
+ version?: string | null;
426
+ }
374
427
  /**
375
428
  * Cloud SQL configuration.
376
429
  */
@@ -388,6 +441,19 @@ export namespace servicenetworking_v1beta {
388
441
  */
389
442
  umbrellaProject?: string | null;
390
443
  }
444
+ /**
445
+ * Required information for every language.
446
+ */
447
+ export interface Schema$CommonLanguageSettings {
448
+ /**
449
+ * The destination where API teams want this client library to be published.
450
+ */
451
+ destinations?: string[] | null;
452
+ /**
453
+ * Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
454
+ */
455
+ referenceDocsUri?: string | null;
456
+ }
391
457
  /**
392
458
  * 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.
393
459
  */
@@ -505,7 +571,7 @@ export namespace servicenetworking_v1beta {
505
571
  selector?: string | null;
506
572
  }
507
573
  /**
508
- * 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
574
+ * Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com
509
575
  */
510
576
  export interface Schema$Control {
511
577
  /**
@@ -513,6 +579,15 @@ export namespace servicenetworking_v1beta {
513
579
  */
514
580
  environment?: string | null;
515
581
  }
582
+ /**
583
+ * Settings for C++ client libraries.
584
+ */
585
+ export interface Schema$CppSettings {
586
+ /**
587
+ * Some settings.
588
+ */
589
+ common?: Schema$CommonLanguageSettings;
590
+ }
516
591
  /**
517
592
  * 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
518
593
  */
@@ -640,10 +715,23 @@ export namespace servicenetworking_v1beta {
640
715
  */
641
716
  selector?: string | null;
642
717
  }
718
+ /**
719
+ * Settings for Dotnet client libraries.
720
+ */
721
+ export interface Schema$DotnetSettings {
722
+ /**
723
+ * Some settings.
724
+ */
725
+ common?: Schema$CommonLanguageSettings;
726
+ }
643
727
  /**
644
728
  * `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
645
729
  */
646
730
  export interface Schema$Endpoint {
731
+ /**
732
+ * 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.
733
+ */
734
+ aliases?: string[] | null;
647
735
  /**
648
736
  * 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.
649
737
  */
@@ -803,6 +891,15 @@ export namespace servicenetworking_v1beta {
803
891
  */
804
892
  name?: string | null;
805
893
  }
894
+ /**
895
+ * Settings for Go client libraries.
896
+ */
897
+ export interface Schema$GoSettings {
898
+ /**
899
+ * Some settings.
900
+ */
901
+ common?: Schema$CommonLanguageSettings;
902
+ }
806
903
  /**
807
904
  * 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.
808
905
  */
@@ -861,6 +958,23 @@ export namespace servicenetworking_v1beta {
861
958
  */
862
959
  selector?: string | null;
863
960
  }
961
+ /**
962
+ * Settings for Java client libraries.
963
+ */
964
+ export interface Schema$JavaSettings {
965
+ /**
966
+ * Some settings.
967
+ */
968
+ common?: Schema$CommonLanguageSettings;
969
+ /**
970
+ * 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
971
+ */
972
+ libraryPackage?: string | null;
973
+ /**
974
+ * 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
975
+ */
976
+ serviceClassNames?: {[key: string]: string} | null;
977
+ }
864
978
  /**
865
979
  * Specifies a location to extract JWT from an API request.
866
980
  */
@@ -955,6 +1069,27 @@ export namespace servicenetworking_v1beta {
955
1069
  */
956
1070
  monitoredResource?: string | null;
957
1071
  }
1072
+ /**
1073
+ * 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)).
1074
+ */
1075
+ export interface Schema$LongRunning {
1076
+ /**
1077
+ * Initial delay after which the first poll request will be made. Default value: 5 seconds.
1078
+ */
1079
+ initialPollDelay?: string | null;
1080
+ /**
1081
+ * Maximum time between two subsequent poll requests. Default value: 45 seconds.
1082
+ */
1083
+ maxPollDelay?: string | null;
1084
+ /**
1085
+ * Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
1086
+ */
1087
+ pollDelayMultiplier?: number | null;
1088
+ /**
1089
+ * Total polling timeout. Default value: 5 minutes.
1090
+ */
1091
+ totalPollTimeout?: string | null;
1092
+ }
958
1093
  /**
959
1094
  * Method represents a method of an API interface.
960
1095
  */
@@ -988,6 +1123,19 @@ export namespace servicenetworking_v1beta {
988
1123
  */
989
1124
  syntax?: string | null;
990
1125
  }
1126
+ /**
1127
+ * Describes the generator configuration for a method.
1128
+ */
1129
+ export interface Schema$MethodSettings {
1130
+ /**
1131
+ * 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
1132
+ */
1133
+ longRunning?: Schema$LongRunning;
1134
+ /**
1135
+ * The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
1136
+ */
1137
+ selector?: string | null;
1138
+ }
991
1139
  /**
992
1140
  * 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.
993
1141
  */
@@ -1135,6 +1283,15 @@ export namespace servicenetworking_v1beta {
1135
1283
  */
1136
1284
  monitoredResource?: string | null;
1137
1285
  }
1286
+ /**
1287
+ * Settings for Node client libraries.
1288
+ */
1289
+ export interface Schema$NodeSettings {
1290
+ /**
1291
+ * Some settings.
1292
+ */
1293
+ common?: Schema$CommonLanguageSettings;
1294
+ }
1138
1295
  /**
1139
1296
  * 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.
1140
1297
  */
@@ -1220,6 +1377,15 @@ export namespace servicenetworking_v1beta {
1220
1377
  * Metadata provided through GetOperation request for the LRO generated by CreatePeeredDnsDomain API.
1221
1378
  */
1222
1379
  export interface Schema$PeeredDnsDomainMetadata {}
1380
+ /**
1381
+ * Settings for Php client libraries.
1382
+ */
1383
+ export interface Schema$PhpSettings {
1384
+ /**
1385
+ * Some settings.
1386
+ */
1387
+ common?: Schema$CommonLanguageSettings;
1388
+ }
1223
1389
  /**
1224
1390
  * Grouping of IAM role and IAM member.
1225
1391
  */
@@ -1233,6 +1399,56 @@ export namespace servicenetworking_v1beta {
1233
1399
  */
1234
1400
  role?: string | null;
1235
1401
  }
1402
+ /**
1403
+ * 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.
1404
+ */
1405
+ export interface Schema$Publishing {
1406
+ /**
1407
+ * Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
1408
+ */
1409
+ apiShortName?: string | null;
1410
+ /**
1411
+ * GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
1412
+ */
1413
+ codeownerGithubTeams?: string[] | null;
1414
+ /**
1415
+ * A prefix used in sample code when demarking regions to be included in documentation.
1416
+ */
1417
+ docTagPrefix?: string | null;
1418
+ /**
1419
+ * Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
1420
+ */
1421
+ documentationUri?: string | null;
1422
+ /**
1423
+ * GitHub label to apply to issues and pull requests opened for this API.
1424
+ */
1425
+ githubLabel?: string | null;
1426
+ /**
1427
+ * 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.
1428
+ */
1429
+ librarySettings?: Schema$ClientLibrarySettings[];
1430
+ /**
1431
+ * A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
1432
+ */
1433
+ methodSettings?: Schema$MethodSettings[];
1434
+ /**
1435
+ * Link to a place that API users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
1436
+ */
1437
+ newIssueUri?: string | null;
1438
+ /**
1439
+ * For whom the client library is being published.
1440
+ */
1441
+ organization?: string | null;
1442
+ }
1443
+ /**
1444
+ * Settings for Python client libraries.
1445
+ */
1446
+ export interface Schema$PythonSettings {
1447
+ /**
1448
+ * Some settings.
1449
+ */
1450
+ common?: Schema$CommonLanguageSettings;
1451
+ }
1236
1452
  /**
1237
1453
  * 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
1238
1454
  */
@@ -1341,6 +1557,15 @@ export namespace servicenetworking_v1beta {
1341
1557
  */
1342
1558
  nextHopGateway?: string | null;
1343
1559
  }
1560
+ /**
1561
+ * Settings for Ruby client libraries.
1562
+ */
1563
+ export interface Schema$RubySettings {
1564
+ /**
1565
+ * Some settings.
1566
+ */
1567
+ common?: Schema$CommonLanguageSettings;
1568
+ }
1344
1569
  /**
1345
1570
  * Request to search for an unused range within allocated ranges.
1346
1571
  */
@@ -1448,6 +1673,10 @@ export namespace servicenetworking_v1beta {
1448
1673
  * The Google project that owns this service.
1449
1674
  */
1450
1675
  producerProjectId?: string | null;
1676
+ /**
1677
+ * Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers.
1678
+ */
1679
+ publishing?: Schema$Publishing;
1451
1680
  /**
1452
1681
  * Quota configuration.
1453
1682
  */