-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
servicenetworking.v1beta.json
2861 lines (2861 loc) 路 162 KB
/
servicenetworking.v1beta.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/service.management": {
"description": "Manage your Google API service configuration"
}
}
}
},
"basePath": "",
"baseUrl": "https://servicenetworking.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Service Networking",
"description": "Provides automatic management of network configurations necessary for certain services.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "servicenetworking:v1beta",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://servicenetworking.mtls.googleapis.com/",
"name": "servicenetworking",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"operations": {
"methods": {
"get": {
"description": "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.",
"flatPath": "v1beta/operations/{operationsId}",
"httpMethod": "GET",
"id": "servicenetworking.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
}
}
},
"services": {
"methods": {
"addSubnetwork": {
"description": "For service producers, provisions a new subnet in a peered service's shared VPC network in the requested region and with the requested size that's expressed as a CIDR range (number of leading bits of ipV4 network mask). The method checks against the assigned allocated ranges to find a non-conflicting IP address range. The method will reuse a subnet if subsequent calls contain the same subnet name, region, and prefix length. This method will make producer's tenant project to be a shared VPC service project as needed. The response from the `get` operation will be of type `Subnetwork` if the operation successfully completes.",
"flatPath": "v1beta/services/{servicesId}/{servicesId1}/{servicesId2}:addSubnetwork",
"httpMethod": "POST",
"id": "servicenetworking.services.addSubnetwork",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "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.",
"location": "path",
"pattern": "^services/[^/]+/[^/]+/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}:addSubnetwork",
"request": {
"$ref": "AddSubnetworkRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"searchRange": {
"description": "Service producers can use this method to find a currently unused range within consumer allocated ranges. This returned range is not reserved, and not guaranteed to remain unused. It will validate previously provided allocated ranges, find non-conflicting sub-range of requested size (expressed in number of leading bits of ipv4 network mask, as in CIDR range notation). Operation",
"flatPath": "v1beta/services/{servicesId}:searchRange",
"httpMethod": "POST",
"id": "servicenetworking.services.searchRange",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. This is in a form services/{service}. {service} the name of the private access management service, for example 'service-peering.example.com'.",
"location": "path",
"pattern": "^services/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}:searchRange",
"request": {
"$ref": "SearchRangeRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"updateConnections": {
"description": "Updates the allocated ranges that are assigned to a connection. The response from the `get` operation will be of type `Connection` if the operation successfully completes.",
"flatPath": "v1beta/services/{servicesId}/connections",
"httpMethod": "PATCH",
"id": "servicenetworking.services.updateConnections",
"parameterOrder": [
"name"
],
"parameters": {
"force": {
"description": "If a previously defined allocated range is removed, force flag must be set to true.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "The service producer peering service that is managing peering connectivity for a service producer organization. For Google services that support this functionality, this is `services/servicenetworking.googleapis.com`.",
"location": "path",
"pattern": "^services/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The update mask. If this is omitted, it defaults to \"*\". You can only update the listed peering ranges.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}/connections",
"request": {
"$ref": "GoogleCloudServicenetworkingV1betaConnection"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
}
},
"resources": {
"connections": {
"methods": {
"create": {
"description": "Creates a private connection that establishes a VPC Network Peering connection to a VPC network in the service producer's organization. The administrator of the service consumer's VPC network invokes this method. The administrator must assign one or more allocated IP ranges for provisioning subnetworks in the service producer's VPC network. This connection is used for all supported services in the service producer's organization, so it only needs to be invoked once. The response from the `get` operation will be of type `Connection` if the operation successfully completes.",
"flatPath": "v1beta/services/{servicesId}/connections",
"httpMethod": "POST",
"id": "servicenetworking.services.connections.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "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`.",
"location": "path",
"pattern": "^services/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/connections",
"request": {
"$ref": "GoogleCloudServicenetworkingV1betaConnection"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"list": {
"description": "List the private connections that are configured in a service consumer's VPC network.",
"flatPath": "v1beta/services/{servicesId}/connections",
"httpMethod": "GET",
"id": "servicenetworking.services.connections.list",
"parameterOrder": [
"parent"
],
"parameters": {
"network": {
"description": "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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`. If you specify `-` as the parameter value, all configured public peering services are listed.",
"location": "path",
"pattern": "^services/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/connections",
"response": {
"$ref": "ListConnectionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
}
}
}
}
}
},
"revision": "20230703",
"rootUrl": "https://servicenetworking.googleapis.com/",
"schemas": {
"AddDnsRecordSetMetadata": {
"description": "Metadata provided through GetOperation request for the LRO generated by AddDnsRecordSet API",
"id": "AddDnsRecordSetMetadata",
"properties": {},
"type": "object"
},
"AddDnsZoneMetadata": {
"description": "Metadata provided through GetOperation request for the LRO generated by AddDnsZone API",
"id": "AddDnsZoneMetadata",
"properties": {},
"type": "object"
},
"AddDnsZoneResponse": {
"description": "Represents managed DNS zones created in the shared producer host and consumer projects.",
"id": "AddDnsZoneResponse",
"properties": {
"consumerPeeringZone": {
"$ref": "DnsZone",
"description": "The DNS peering zone created in the consumer project."
},
"producerPrivateZone": {
"$ref": "DnsZone",
"description": "The private DNS zone created in the shared producer host project."
}
},
"type": "object"
},
"AddRolesMetadata": {
"description": "Metadata provided through GetOperation request for the LRO generated by AddRoles API",
"id": "AddRolesMetadata",
"properties": {},
"type": "object"
},
"AddRolesResponse": {
"description": "Represents IAM roles added to the shared VPC host project.",
"id": "AddRolesResponse",
"properties": {
"policyBinding": {
"description": "Required. List of policy bindings that were added to the shared VPC host project.",
"items": {
"$ref": "PolicyBinding"
},
"type": "array"
}
},
"type": "object"
},
"AddSubnetworkRequest": {
"description": "Request to create a subnetwork in a previously peered service network.",
"id": "AddSubnetworkRequest",
"properties": {
"consumer": {
"description": "Required. A resource that represents the service consumer, such as `projects/123456`. The project number can be different from the value in the consumer network parameter. For example, the network might be part of a Shared VPC network. In those cases, Service Networking validates that this resource belongs to that Shared VPC.",
"type": "string"
},
"consumerNetwork": {
"description": "Required. The name of the service consumer's VPC network. The network must have an existing private connection that was provisioned through the connections.create method. The name must be in the following format: `projects/{project}/global/networks/{network}`, where {project} is a project number, such as `12345`. {network} is the name of a VPC network in the project.",
"type": "string"
},
"description": {
"description": "An optional description of the subnet.",
"type": "string"
},
"ipPrefixLength": {
"description": "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.",
"format": "int32",
"type": "integer"
},
"region": {
"description": "Required. The name of a [region](/compute/docs/regions-zones) for the subnet, such `europe-west1`.",
"type": "string"
},
"requestedAddress": {
"description": "Optional. The starting address of a range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix range is the CIDR range for the subnet. The range must be within the allocated range that is assigned to the private connection. If the CIDR range isn't available, the call fails.",
"type": "string"
},
"subnetwork": {
"description": "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.",
"type": "string"
},
"subnetworkUsers": {
"description": "A list of members that are granted the `compute.networkUser` role on the subnet.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Api": {
"description": "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.",
"id": "Api",
"properties": {
"methods": {
"description": "The methods of this interface, in unspecified order.",
"items": {
"$ref": "Method"
},
"type": "array"
},
"mixins": {
"description": "Included interfaces. See Mixin.",
"items": {
"$ref": "Mixin"
},
"type": "array"
},
"name": {
"description": "The fully qualified name of this interface, including package name followed by the interface's simple name.",
"type": "string"
},
"options": {
"description": "Any metadata attached to the interface.",
"items": {
"$ref": "Option"
},
"type": "array"
},
"sourceContext": {
"$ref": "SourceContext",
"description": "Source context for the protocol buffer service represented by this message."
},
"syntax": {
"description": "The source syntax of the service.",
"enum": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3",
"SYNTAX_EDITIONS"
],
"enumDescriptions": [
"Syntax `proto2`.",
"Syntax `proto3`.",
"Syntax `editions`."
],
"type": "string"
},
"version": {
"description": "A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. ",
"type": "string"
}
},
"type": "object"
},
"AuthProvider": {
"description": "Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
"id": "AuthProvider",
"properties": {
"audiences": {
"description": "The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - \"https://[service.name]/[google.protobuf.Api.name]\" - \"https://[service.name]/\" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com",
"type": "string"
},
"authorizationUrl": {
"description": "Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.",
"type": "string"
},
"id": {
"description": "The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: \"bookstore_auth\".",
"type": "string"
},
"issuer": {
"description": "Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com",
"type": "string"
},
"jwksUri": {
"description": "URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs",
"type": "string"
},
"jwtLocations": {
"description": "Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: \"Bearer \" - header: x-goog-iap-jwt-assertion - query: access_token",
"items": {
"$ref": "JwtLocation"
},
"type": "array"
}
},
"type": "object"
},
"AuthRequirement": {
"description": "User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
"id": "AuthRequirement",
"properties": {
"audiences": {
"description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience \"https://Service_name/API_name\" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience \"https://library-example.googleapis.com/google.example.library.v1.LibraryService\". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com",
"type": "string"
},
"providerId": {
"description": "id from authentication provider. Example: provider_id: bookstore_auth",
"type": "string"
}
},
"type": "object"
},
"Authentication": {
"description": "`Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read",
"id": "Authentication",
"properties": {
"providers": {
"description": "Defines a set of authentication providers that a service supports.",
"items": {
"$ref": "AuthProvider"
},
"type": "array"
},
"rules": {
"description": "A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow \"last one wins\" order.",
"items": {
"$ref": "AuthenticationRule"
},
"type": "array"
}
},
"type": "object"
},
"AuthenticationRule": {
"description": "Authentication rules for the service. By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request. If a method doesn't have any auth requirements, request credentials will be ignored.",
"id": "AuthenticationRule",
"properties": {
"allowWithoutCredential": {
"description": "If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.",
"type": "boolean"
},
"oauth": {
"$ref": "OAuthRequirements",
"description": "The requirements for OAuth credentials."
},
"requirements": {
"description": "Requirements for additional authentication providers.",
"items": {
"$ref": "AuthRequirement"
},
"type": "array"
},
"selector": {
"description": "Selects the methods to which this rule applies. Refer to selector for syntax details.",
"type": "string"
}
},
"type": "object"
},
"Backend": {
"description": "`Backend` defines the backend configuration for a service.",
"id": "Backend",
"properties": {
"rules": {
"description": "A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow \"last one wins\" order.",
"items": {
"$ref": "BackendRule"
},
"type": "array"
}
},
"type": "object"
},
"BackendRule": {
"description": "A backend rule provides configuration for an individual API element.",
"id": "BackendRule",
"properties": {
"address": {
"description": "The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.",
"type": "string"
},
"deadline": {
"description": "The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.",
"format": "double",
"type": "number"
},
"disableAuth": {
"description": "When disable_auth is true, a JWT ID token won't be generated and the original \"Authorization\" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.",
"type": "boolean"
},
"jwtAudience": {
"description": "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.",
"type": "string"
},
"minDeadline": {
"deprecated": true,
"description": "Deprecated, do not use.",
"format": "double",
"type": "number"
},
"operationDeadline": {
"description": "The number of seconds to wait for the completion of a long running operation. The default is no deadline.",
"format": "double",
"type": "number"
},
"overridesByRequestProtocol": {
"additionalProperties": {
"$ref": "BackendRule"
},
"description": "The map between request protocol and the backend address.",
"type": "object"
},
"pathTranslation": {
"enum": [
"PATH_TRANSLATION_UNSPECIFIED",
"CONSTANT_ADDRESS",
"APPEND_PATH_TO_ADDRESS"
],
"enumDescriptions": [
"",
"Use the backend address as-is, with no modification to the path. If the URL pattern contains variables, the variable names and values will be appended to the query string. If a query string parameter and a URL pattern variable have the same name, this may result in duplicate keys in the query string. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.cloudfunctions.net/getUser Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe",
"The request path will be appended to the backend address. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.appspot.com Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST"
],
"type": "string"
},
"protocol": {
"description": "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.",
"type": "string"
},
"selector": {
"description": "Selects the methods to which this rule applies. Refer to selector for syntax details.",
"type": "string"
}
},
"type": "object"
},
"Billing": {
"description": "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",
"id": "Billing",
"properties": {
"consumerDestinations": {
"description": "Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.",
"items": {
"$ref": "BillingDestination"
},
"type": "array"
}
},
"type": "object"
},
"BillingDestination": {
"description": "Configuration of a specific billing destination (Currently only support bill against consumer project).",
"id": "BillingDestination",
"properties": {
"metrics": {
"description": "Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.",
"items": {
"type": "string"
},
"type": "array"
},
"monitoredResource": {
"description": "The monitored resource type. The type must be defined in Service.monitored_resources section.",
"type": "string"
}
},
"type": "object"
},
"ClientLibrarySettings": {
"description": "Details about how and where to publish client libraries.",
"id": "ClientLibrarySettings",
"properties": {
"cppSettings": {
"$ref": "CppSettings",
"description": "Settings for C++ client libraries."
},
"dotnetSettings": {
"$ref": "DotnetSettings",
"description": "Settings for .NET client libraries."
},
"goSettings": {
"$ref": "GoSettings",
"description": "Settings for Go client libraries."
},
"javaSettings": {
"$ref": "JavaSettings",
"description": "Settings for legacy Java features, supported in the Service YAML."
},
"launchStage": {
"description": "Launch stage of this version of the API.",
"enum": [
"LAUNCH_STAGE_UNSPECIFIED",
"UNIMPLEMENTED",
"PRELAUNCH",
"EARLY_ACCESS",
"ALPHA",
"BETA",
"GA",
"DEPRECATED"
],
"enumDescriptions": [
"Do not use this default value.",
"The feature is not yet implemented. Users can not use it.",
"Prelaunch features are hidden from users and are only visible internally.",
"Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.",
"Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.",
"Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.",
"GA features are open to all developers and are considered stable and fully qualified for production use.",
"Deprecated features are scheduled to be shut down and removed. For more information, see the \"Deprecation Policy\" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation."
],
"type": "string"
},
"nodeSettings": {
"$ref": "NodeSettings",
"description": "Settings for Node client libraries."
},
"phpSettings": {
"$ref": "PhpSettings",
"description": "Settings for PHP client libraries."
},
"pythonSettings": {
"$ref": "PythonSettings",
"description": "Settings for Python client libraries."
},
"restNumericEnums": {
"description": "When using transport=rest, the client request will encode enums as numbers rather than strings.",
"type": "boolean"
},
"rubySettings": {
"$ref": "RubySettings",
"description": "Settings for Ruby client libraries."
},
"version": {
"description": "Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element. Examples: \"google.cloud.speech.v1\" and \"google.spanner.admin.database.v1\".",
"type": "string"
}
},
"type": "object"
},
"CloudSQLConfig": {
"description": "Cloud SQL configuration.",
"id": "CloudSQLConfig",
"properties": {
"service": {
"description": "Peering service used for peering with the Cloud SQL project.",
"type": "string"
},
"umbrellaNetwork": {
"description": "The name of the umbrella network in the Cloud SQL umbrella project.",
"type": "string"
},
"umbrellaProject": {
"description": "The project number of the Cloud SQL umbrella project.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"CommonLanguageSettings": {
"description": "Required information for every language.",
"id": "CommonLanguageSettings",
"properties": {
"destinations": {
"description": "The destination where API teams want this client library to be published.",
"items": {
"enum": [
"CLIENT_LIBRARY_DESTINATION_UNSPECIFIED",
"GITHUB",
"PACKAGE_MANAGER"
],
"enumDescriptions": [
"Client libraries will neither be generated nor published to package managers.",
"Generate the client library in a repo under github.com/googleapis, but don't publish it to package managers.",
"Publish the library to package managers like nuget.org and npmjs.com."
],
"type": "string"
},
"type": "array"
},
"referenceDocsUri": {
"deprecated": true,
"description": "Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest",
"type": "string"
}
},
"type": "object"
},
"Connection": {
"description": "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.",
"id": "Connection",
"properties": {
"network": {
"description": "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.",
"type": "string"
},
"peering": {
"description": "Output only. The name of the VPC Network Peering connection that was created by the service producer.",
"readOnly": true,
"type": "string"
},
"reservedPeeringRanges": {
"description": "The name of one or more allocated IP address ranges for this service producer of type `PEERING`. Note that invoking CreateConnection method with a different range when connection is already established will not modify already provisioned service producer subnetworks. If CreateConnection method is invoked repeatedly to reconnect when peering connection had been disconnected on the consumer side, leaving this field empty will restore previously allocated IP ranges.",
"items": {
"type": "string"
},
"type": "array"
},
"service": {
"description": "Output only. The name of the peering service that's associated with this connection, in the following format: `services/{service name}`.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ConsumerConfig": {
"description": "Configuration information for a private service access connection.",
"id": "ConsumerConfig",
"properties": {
"cloudsqlConfigs": {
"description": "Represents one or multiple Cloud SQL configurations.",
"items": {
"$ref": "CloudSQLConfig"
},
"type": "array"
},
"consumerExportCustomRoutes": {
"description": "Export custom routes flag value for peering from consumer to producer.",
"type": "boolean"
},
"consumerExportSubnetRoutesWithPublicIp": {
"description": "Export subnet routes with public ip flag value for peering from consumer to producer.",
"type": "boolean"
},
"consumerImportCustomRoutes": {
"description": "Import custom routes flag value for peering from consumer to producer.",
"type": "boolean"
},
"consumerImportSubnetRoutesWithPublicIp": {
"description": "Import subnet routes with public ip flag value for peering from consumer to producer.",
"type": "boolean"
},
"producerExportCustomRoutes": {
"description": "Export custom routes flag value for peering from producer to consumer.",
"type": "boolean"
},
"producerExportSubnetRoutesWithPublicIp": {
"description": "Export subnet routes with public ip flag value for peering from producer to consumer.",
"type": "boolean"
},
"producerImportCustomRoutes": {
"description": "Import custom routes flag value for peering from producer to consumer.",
"type": "boolean"
},
"producerImportSubnetRoutesWithPublicIp": {
"description": "Import subnet routes with public ip flag value for peering from producer to consumer.",
"type": "boolean"
},
"producerNetwork": {
"description": "Output only. The VPC host network that is used to host managed service instances. In the format, projects/{project}/global/networks/{network} where {project} is the project number e.g. '12345' and {network} is the network name.",
"readOnly": true,
"type": "string"
},
"reservedRanges": {
"description": "Output only. The reserved ranges associated with this private service access connection.",
"items": {
"$ref": "GoogleCloudServicenetworkingV1ConsumerConfigReservedRange"
},
"readOnly": true,
"type": "array"
},
"usedIpRanges": {
"description": "Output only. The IP ranges already in use by consumer or producer",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"vpcScReferenceArchitectureEnabled": {
"description": "Output only. Indicates whether the VPC Service Controls reference architecture is configured for the producer VPC host network.",
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
},
"ConsumerConfigMetadata": {
"description": "Metadata provided through GetOperation request for the LRO generated by UpdateConsumerConfig API.",
"id": "ConsumerConfigMetadata",
"properties": {},
"type": "object"
},
"Context": {
"description": "`Context` defines which contexts an API requests. Example: context: rules: - selector: \"*\" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using \u201cx-goog-ext--bin\u201d and \u201cx-goog-ext--jspb\u201d format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.",
"id": "Context",
"properties": {
"rules": {
"description": "A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow \"last one wins\" order.",
"items": {
"$ref": "ContextRule"
},
"type": "array"
}
},
"type": "object"
},
"ContextRule": {
"description": "A context rule provides information about the context for an individual API element.",
"id": "ContextRule",
"properties": {
"allowedRequestExtensions": {
"description": "A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.",
"items": {
"type": "string"
},
"type": "array"
},
"allowedResponseExtensions": {
"description": "A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.",
"items": {
"type": "string"
},
"type": "array"
},
"provided": {
"description": "A list of full type names of provided contexts.",
"items": {
"type": "string"
},
"type": "array"
},
"requested": {
"description": "A list of full type names of requested contexts.",
"items": {
"type": "string"
},
"type": "array"
},
"selector": {
"description": "Selects the methods to which this rule applies. Refer to selector for syntax details.",
"type": "string"
}
},
"type": "object"
},
"Control": {
"description": "Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com",
"id": "Control",
"properties": {
"environment": {
"description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com",
"type": "string"
}
},
"type": "object"
},
"CppSettings": {
"description": "Settings for C++ client libraries.",
"id": "CppSettings",
"properties": {
"common": {
"$ref": "CommonLanguageSettings",
"description": "Some settings."
}
},
"type": "object"
},
"CustomError": {
"description": "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",
"id": "CustomError",
"properties": {
"rules": {
"description": "The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow \"last one wins\" order.",
"items": {
"$ref": "CustomErrorRule"
},
"type": "array"
},
"types": {
"description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"CustomErrorRule": {
"description": "A custom error rule.",
"id": "CustomErrorRule",
"properties": {
"isErrorType": {
"description": "Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.",
"type": "boolean"
},
"selector": {
"description": "Selects messages to which this rule applies. Refer to selector for syntax details.",
"type": "string"
}
},
"type": "object"
},
"CustomHttpPattern": {
"description": "A custom pattern is used for defining custom HTTP verb.",