OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/cloud-platform": { | 5 "https://www.googleapis.com/auth/cloud-platform": { |
6 "description": "View and manage your data across Google Clou
d Platform services" | 6 "description": "View and manage your data across Google Clou
d Platform services" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/cloud-platform.read-only": { | 8 "https://www.googleapis.com/auth/cloud-platform.read-only": { |
9 "description": "View your data across Google Cloud Platform
services" | 9 "description": "View your data across Google Cloud Platform
services" |
10 }, | 10 }, |
(...skipping 118 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
129 "description": "Gets the access control policy for a resourc
e.\nReturns an empty policy if the resource exists and does not have a policy\ns
et.", | 129 "description": "Gets the access control policy for a resourc
e.\nReturns an empty policy if the resource exists and does not have a policy\ns
et.", |
130 "httpMethod": "POST", | 130 "httpMethod": "POST", |
131 "id": "servicemanagement.services.getIamPolicy", | 131 "id": "servicemanagement.services.getIamPolicy", |
132 "parameterOrder": [ | 132 "parameterOrder": [ |
133 "resource" | 133 "resource" |
134 ], | 134 ], |
135 "parameters": { | 135 "parameters": { |
136 "resource": { | 136 "resource": { |
137 "description": "REQUIRED: The resource for which the
policy is being requested.\n`resource` is usually specified as a path. For exam
ple, a Project\nresource is specified as `projects/{project}`.", | 137 "description": "REQUIRED: The resource for which the
policy is being requested.\n`resource` is usually specified as a path. For exam
ple, a Project\nresource is specified as `projects/{project}`.", |
138 "location": "path", | 138 "location": "path", |
139 "pattern": "^services/[^/]*$", | 139 "pattern": "^services/[^/]+$", |
140 "required": true, | 140 "required": true, |
141 "type": "string" | 141 "type": "string" |
142 } | 142 } |
143 }, | 143 }, |
144 "path": "v1/{+resource}:getIamPolicy", | 144 "path": "v1/{+resource}:getIamPolicy", |
145 "request": { | 145 "request": { |
146 "$ref": "GetIamPolicyRequest" | 146 "$ref": "GetIamPolicyRequest" |
147 }, | 147 }, |
148 "response": { | 148 "response": { |
149 "$ref": "Policy" | 149 "$ref": "Policy" |
(...skipping 50 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
200 }, | 200 }, |
201 "getConfig": { | 201 "getConfig": { |
202 "description": "Gets a service configuration (version) for a
managed service.", | 202 "description": "Gets a service configuration (version) for a
managed service.", |
203 "httpMethod": "GET", | 203 "httpMethod": "GET", |
204 "id": "servicemanagement.services.getConfig", | 204 "id": "servicemanagement.services.getConfig", |
205 "parameterOrder": [ | 205 "parameterOrder": [ |
206 "serviceName" | 206 "serviceName" |
207 ], | 207 ], |
208 "parameters": { | 208 "parameters": { |
209 "configId": { | 209 "configId": { |
| 210 "description": "The id of the service configuration
resource.", |
210 "location": "query", | 211 "location": "query", |
211 "type": "string" | 212 "type": "string" |
212 }, | 213 }, |
213 "serviceName": { | 214 "serviceName": { |
214 "description": "The name of the service. See the [o
verview](/service-management/overview)\nfor naming requirements. For example: `
example.googleapis.com`.", | 215 "description": "The name of the service. See the [o
verview](/service-management/overview)\nfor naming requirements. For example: `
example.googleapis.com`.", |
215 "location": "path", | 216 "location": "path", |
216 "required": true, | 217 "required": true, |
217 "type": "string" | 218 "type": "string" |
218 } | 219 } |
219 }, | 220 }, |
(...skipping 26 matching lines...) Expand all Loading... |
246 "path": "v1/services/{serviceName}:undelete", | 247 "path": "v1/services/{serviceName}:undelete", |
247 "response": { | 248 "response": { |
248 "$ref": "Operation" | 249 "$ref": "Operation" |
249 }, | 250 }, |
250 "scopes": [ | 251 "scopes": [ |
251 "https://www.googleapis.com/auth/cloud-platform", | 252 "https://www.googleapis.com/auth/cloud-platform", |
252 "https://www.googleapis.com/auth/service.management" | 253 "https://www.googleapis.com/auth/service.management" |
253 ] | 254 ] |
254 }, | 255 }, |
255 "get": { | 256 "get": { |
256 "description": "Gets a managed service.", | 257 "description": "Gets a managed service. Authentication is re
quired unless the service is\npublic.", |
257 "httpMethod": "GET", | 258 "httpMethod": "GET", |
258 "id": "servicemanagement.services.get", | 259 "id": "servicemanagement.services.get", |
259 "parameterOrder": [ | 260 "parameterOrder": [ |
260 "serviceName" | 261 "serviceName" |
261 ], | 262 ], |
262 "parameters": { | 263 "parameters": { |
263 "serviceName": { | 264 "serviceName": { |
264 "description": "The name of the service. See the `S
erviceManager` overview for naming\nrequirements. For example: `example.googlea
pis.com`.", | 265 "description": "The name of the service. See the `S
erviceManager` overview for naming\nrequirements. For example: `example.googlea
pis.com`.", |
265 "location": "path", | 266 "location": "path", |
266 "required": true, | 267 "required": true, |
267 "type": "string" | 268 "type": "string" |
268 } | 269 } |
269 }, | 270 }, |
270 "path": "v1/services/{serviceName}", | 271 "path": "v1/services/{serviceName}", |
271 "response": { | 272 "response": { |
272 "$ref": "ManagedService" | 273 "$ref": "ManagedService" |
273 }, | 274 }, |
274 "scopes": [ | 275 "scopes": [ |
275 "https://www.googleapis.com/auth/cloud-platform", | 276 "https://www.googleapis.com/auth/cloud-platform", |
276 "https://www.googleapis.com/auth/cloud-platform.read-onl
y", | 277 "https://www.googleapis.com/auth/cloud-platform.read-onl
y", |
277 "https://www.googleapis.com/auth/service.management", | 278 "https://www.googleapis.com/auth/service.management", |
278 "https://www.googleapis.com/auth/service.management.read
only" | 279 "https://www.googleapis.com/auth/service.management.read
only" |
279 ] | 280 ] |
280 }, | 281 }, |
281 "list": { | 282 "list": { |
282 "description": "Lists all managed services.", | 283 "description": "Lists all managed services. The result is li
mited to services that the\ncaller has \"servicemanagement.services.get\" permis
sion for. If the request\nis made without authentication, it returns only public
services that are\navailable to everyone.", |
283 "httpMethod": "GET", | 284 "httpMethod": "GET", |
284 "id": "servicemanagement.services.list", | 285 "id": "servicemanagement.services.list", |
285 "parameterOrder": [], | 286 "parameterOrder": [], |
286 "parameters": { | 287 "parameters": { |
287 "pageSize": { | 288 "pageSize": { |
288 "description": "Requested size of the next page of d
ata.", | 289 "description": "Requested size of the next page of d
ata.", |
289 "format": "int32", | 290 "format": "int32", |
290 "location": "query", | 291 "location": "query", |
291 "type": "integer" | 292 "type": "integer" |
292 }, | 293 }, |
(...skipping 68 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
361 "description": "Sets the access control policy on the specif
ied resource. Replaces any\nexisting policy.", | 362 "description": "Sets the access control policy on the specif
ied resource. Replaces any\nexisting policy.", |
362 "httpMethod": "POST", | 363 "httpMethod": "POST", |
363 "id": "servicemanagement.services.setIamPolicy", | 364 "id": "servicemanagement.services.setIamPolicy", |
364 "parameterOrder": [ | 365 "parameterOrder": [ |
365 "resource" | 366 "resource" |
366 ], | 367 ], |
367 "parameters": { | 368 "parameters": { |
368 "resource": { | 369 "resource": { |
369 "description": "REQUIRED: The resource for which the
policy is being specified.\n`resource` is usually specified as a path. For exam
ple, a Project\nresource is specified as `projects/{project}`.", | 370 "description": "REQUIRED: The resource for which the
policy is being specified.\n`resource` is usually specified as a path. For exam
ple, a Project\nresource is specified as `projects/{project}`.", |
370 "location": "path", | 371 "location": "path", |
371 "pattern": "^services/[^/]*$", | 372 "pattern": "^services/[^/]+$", |
372 "required": true, | 373 "required": true, |
373 "type": "string" | 374 "type": "string" |
374 } | 375 } |
375 }, | 376 }, |
376 "path": "v1/{+resource}:setIamPolicy", | 377 "path": "v1/{+resource}:setIamPolicy", |
377 "request": { | 378 "request": { |
378 "$ref": "SetIamPolicyRequest" | 379 "$ref": "SetIamPolicyRequest" |
379 }, | 380 }, |
380 "response": { | 381 "response": { |
381 "$ref": "Policy" | 382 "$ref": "Policy" |
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
413 "description": "Returns permissions that a caller has on the
specified resource.", | 414 "description": "Returns permissions that a caller has on the
specified resource.", |
414 "httpMethod": "POST", | 415 "httpMethod": "POST", |
415 "id": "servicemanagement.services.testIamPermissions", | 416 "id": "servicemanagement.services.testIamPermissions", |
416 "parameterOrder": [ | 417 "parameterOrder": [ |
417 "resource" | 418 "resource" |
418 ], | 419 ], |
419 "parameters": { | 420 "parameters": { |
420 "resource": { | 421 "resource": { |
421 "description": "REQUIRED: The resource for which the
policy detail is being requested.\n`resource` is usually specified as a path. F
or example, a Project\nresource is specified as `projects/{project}`.", | 422 "description": "REQUIRED: The resource for which the
policy detail is being requested.\n`resource` is usually specified as a path. F
or example, a Project\nresource is specified as `projects/{project}`.", |
422 "location": "path", | 423 "location": "path", |
423 "pattern": "^services/[^/]*$", | 424 "pattern": "^services/[^/]+$", |
424 "required": true, | 425 "required": true, |
425 "type": "string" | 426 "type": "string" |
426 } | 427 } |
427 }, | 428 }, |
428 "path": "v1/{+resource}:testIamPermissions", | 429 "path": "v1/{+resource}:testIamPermissions", |
429 "request": { | 430 "request": { |
430 "$ref": "TestIamPermissionsRequest" | 431 "$ref": "TestIamPermissionsRequest" |
431 }, | 432 }, |
432 "response": { | 433 "response": { |
433 "$ref": "TestIamPermissionsResponse" | 434 "$ref": "TestIamPermissionsResponse" |
(...skipping 138 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
572 "get": { | 573 "get": { |
573 "description": "Gets a service configuration (versio
n) for a managed service.", | 574 "description": "Gets a service configuration (versio
n) for a managed service.", |
574 "httpMethod": "GET", | 575 "httpMethod": "GET", |
575 "id": "servicemanagement.services.configs.get", | 576 "id": "servicemanagement.services.configs.get", |
576 "parameterOrder": [ | 577 "parameterOrder": [ |
577 "serviceName", | 578 "serviceName", |
578 "configId" | 579 "configId" |
579 ], | 580 ], |
580 "parameters": { | 581 "parameters": { |
581 "configId": { | 582 "configId": { |
| 583 "description": "The id of the service config
uration resource.", |
582 "location": "path", | 584 "location": "path", |
583 "required": true, | 585 "required": true, |
584 "type": "string" | 586 "type": "string" |
585 }, | 587 }, |
586 "serviceName": { | 588 "serviceName": { |
587 "description": "The name of the service. Se
e the [overview](/service-management/overview)\nfor naming requirements. For ex
ample: `example.googleapis.com`.", | 589 "description": "The name of the service. Se
e the [overview](/service-management/overview)\nfor naming requirements. For ex
ample: `example.googleapis.com`.", |
588 "location": "path", | 590 "location": "path", |
589 "required": true, | 591 "required": true, |
590 "type": "string" | 592 "type": "string" |
591 } | 593 } |
(...skipping 83 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
675 "description": "Gets the latest state of a long-running oper
ation. Clients can use this\nmethod to poll the operation result at intervals a
s recommended by the API\nservice.", | 677 "description": "Gets the latest state of a long-running oper
ation. Clients can use this\nmethod to poll the operation result at intervals a
s recommended by the API\nservice.", |
676 "httpMethod": "GET", | 678 "httpMethod": "GET", |
677 "id": "servicemanagement.operations.get", | 679 "id": "servicemanagement.operations.get", |
678 "parameterOrder": [ | 680 "parameterOrder": [ |
679 "name" | 681 "name" |
680 ], | 682 ], |
681 "parameters": { | 683 "parameters": { |
682 "name": { | 684 "name": { |
683 "description": "The name of the operation resource."
, | 685 "description": "The name of the operation resource."
, |
684 "location": "path", | 686 "location": "path", |
685 "pattern": "^operations/.*$", | 687 "pattern": "^operations/.+$", |
686 "required": true, | 688 "required": true, |
687 "type": "string" | 689 "type": "string" |
688 } | 690 } |
689 }, | 691 }, |
690 "path": "v1/{+name}", | 692 "path": "v1/{+name}", |
691 "response": { | 693 "response": { |
692 "$ref": "Operation" | 694 "$ref": "Operation" |
693 }, | 695 }, |
694 "scopes": [ | 696 "scopes": [ |
695 "https://www.googleapis.com/auth/cloud-platform", | 697 "https://www.googleapis.com/auth/cloud-platform", |
696 "https://www.googleapis.com/auth/service.management" | 698 "https://www.googleapis.com/auth/service.management" |
697 ] | 699 ] |
698 } | 700 } |
699 } | 701 } |
700 } | 702 } |
701 }, | 703 }, |
702 "revision": "20160822", | 704 "revision": "20161102", |
703 "rootUrl": "https://servicemanagement.googleapis.com/", | 705 "rootUrl": "https://servicemanagement.googleapis.com/", |
704 "schemas": { | 706 "schemas": { |
705 "Api": { | 707 "Api": { |
706 "description": "Api is a light-weight descriptor for a protocol buff
er service.", | 708 "description": "Api is a light-weight descriptor for a protocol buff
er service.", |
707 "id": "Api", | 709 "id": "Api", |
708 "properties": { | 710 "properties": { |
709 "methods": { | 711 "methods": { |
710 "description": "The methods of this api, in unspecified orde
r.", | 712 "description": "The methods of this api, in unspecified orde
r.", |
711 "items": { | 713 "items": { |
712 "$ref": "Method" | 714 "$ref": "Method" |
(...skipping 158 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
871 "type": "string" | 873 "type": "string" |
872 }, | 874 }, |
873 "name": { | 875 "name": { |
874 "description": "The fully qualified name of the API which is
included.", | 876 "description": "The fully qualified name of the API which is
included.", |
875 "type": "string" | 877 "type": "string" |
876 } | 878 } |
877 }, | 879 }, |
878 "type": "object" | 880 "type": "object" |
879 }, | 881 }, |
880 "Service": { | 882 "Service": { |
881 "description": "`Service` is the root object of the configuration sc
hema. It\ndescribes basic information like the name of the service and the\nexpo
sed API interfaces, and delegates other aspects to configuration\nsub-sections.\
n\nExample:\n\n type: google.api.Service\n config_version: 1\n name: ca
lendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: go
ogle.calendar.Calendar\n backend:\n rules:\n - selector: \"*\"\n
address: calendar.example.com", | 883 "description": "`Service` is the root object of Google service confi
guration schema. It\ndescribes basic information about a service, such as the na
me and the\ntitle, and delegates other aspects to sub-sections. Each sub-section
is\neither a proto message or a repeated proto message that configures a\nspeci
fic aspect, such as auth. See each proto message definition for details.\n\nExam
ple:\n\n type: google.api.Service\n config_version: 3\n name: calendar.
googleapis.com\n title: Google Calendar API\n apis:\n - name: google.ca
lendar.v3.Calendar\n backend:\n rules:\n - selector: \"google.calen
dar.v3.*\"\n address: calendar.example.com", |
882 "id": "Service", | 884 "id": "Service", |
883 "properties": { | 885 "properties": { |
884 "id": { | 886 "id": { |
885 "description": "A unique ID for a specific instance of this
message, typically assigned\nby the client for tracking purpose. If empty, the s
erver may choose to\ngenerate one instead.", | 887 "description": "A unique ID for a specific instance of this
message, typically assigned\nby the client for tracking purpose. If empty, the s
erver may choose to\ngenerate one instead.", |
886 "type": "string" | 888 "type": "string" |
887 }, | 889 }, |
888 "enums": { | 890 "enums": { |
889 "description": "A list of all enum types included in this AP
I service. Enums\nreferenced directly or indirectly by the `apis` are automatic
ally\nincluded. Enums which are not referenced but shall be included\nshould be
listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.Some
Enum", | 891 "description": "A list of all enum types included in this AP
I service. Enums\nreferenced directly or indirectly by the `apis` are automatic
ally\nincluded. Enums which are not referenced but shall be included\nshould be
listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.Some
Enum", |
890 "items": { | 892 "items": { |
891 "$ref": "Enum" | 893 "$ref": "Enum" |
(...skipping 27 matching lines...) Expand all Loading... |
919 "description": "The version of the service configuration. Th
e config version may\ninfluence interpretation of the configuration, for example
, to\ndetermine defaults. This is documented together with applicable\noptions.
The current default for the config version itself is `3`.", | 921 "description": "The version of the service configuration. Th
e config version may\ninfluence interpretation of the configuration, for example
, to\ndetermine defaults. This is documented together with applicable\noptions.
The current default for the config version itself is `3`.", |
920 "format": "uint32", | 922 "format": "uint32", |
921 "type": "integer" | 923 "type": "integer" |
922 }, | 924 }, |
923 "backend": { | 925 "backend": { |
924 "$ref": "Backend", | 926 "$ref": "Backend", |
925 "description": "API backend configuration." | 927 "description": "API backend configuration." |
926 }, | 928 }, |
927 "monitoring": { | 929 "monitoring": { |
928 "$ref": "Monitoring", | 930 "$ref": "Monitoring", |
929 "description": "Monitoring configuration of the service." | 931 "description": "Monitoring configuration." |
930 }, | 932 }, |
931 "visibility": { | 933 "visibility": { |
932 "$ref": "Visibility", | 934 "$ref": "Visibility", |
933 "description": "API visibility configuration." | 935 "description": "API visibility configuration." |
934 }, | 936 }, |
935 "logging": { | 937 "logging": { |
936 "$ref": "Logging", | 938 "$ref": "Logging", |
937 "description": "Logging configuration of the service." | 939 "description": "Logging configuration." |
938 }, | 940 }, |
939 "customError": { | 941 "customError": { |
940 "$ref": "CustomError", | 942 "$ref": "CustomError", |
941 "description": "Custom error configuration." | 943 "description": "Custom error configuration." |
942 }, | 944 }, |
943 "context": { | 945 "context": { |
944 "$ref": "Context", | 946 "$ref": "Context", |
945 "description": "Context configuration." | 947 "description": "Context configuration." |
946 }, | 948 }, |
947 "apis": { | 949 "apis": { |
948 "description": "A list of API interfaces exported by this se
rvice. Only the `name` field\nof the google.protobuf.Api needs to be provided by
the configuration\nauthor, as the remaining fields will be derived from the IDL
during the\nnormalization process. It is an error to specify an API interface h
ere\nwhich cannot be resolved against the associated IDL files.", | 950 "description": "A list of API interfaces exported by this se
rvice. Only the `name` field\nof the google.protobuf.Api needs to be provided by
the configuration\nauthor, as the remaining fields will be derived from the IDL
during the\nnormalization process. It is an error to specify an API interface h
ere\nwhich cannot be resolved against the associated IDL files.", |
949 "items": { | 951 "items": { |
950 "$ref": "Api" | 952 "$ref": "Api" |
951 }, | 953 }, |
952 "type": "array" | 954 "type": "array" |
953 }, | 955 }, |
954 "metrics": { | 956 "metrics": { |
955 "description": "Defines the metrics used by this service.", | 957 "description": "Defines the metrics used by this service.", |
956 "items": { | 958 "items": { |
957 "$ref": "MetricDescriptor" | 959 "$ref": "MetricDescriptor" |
958 }, | 960 }, |
959 "type": "array" | 961 "type": "array" |
960 }, | 962 }, |
961 "systemParameters": { | 963 "systemParameters": { |
962 "$ref": "SystemParameters", | 964 "$ref": "SystemParameters", |
963 "description": "Configuration for system parameters." | 965 "description": "System parameter configuration." |
964 }, | 966 }, |
965 "endpoints": { | 967 "endpoints": { |
966 "description": "Configuration for network endpoints. If thi
s is empty, then an endpoint\nwith the same name as the service is automatically
generated to service all\ndefined APIs.", | 968 "description": "Configuration for network endpoints. If thi
s is empty, then an endpoint\nwith the same name as the service is automatically
generated to service all\ndefined APIs.", |
967 "items": { | 969 "items": { |
968 "$ref": "Endpoint" | 970 "$ref": "Endpoint" |
969 }, | 971 }, |
970 "type": "array" | 972 "type": "array" |
971 }, | 973 }, |
972 "name": { | 974 "name": { |
973 "description": "The DNS address at which this service is ava
ilable,\ne.g. `calendar.googleapis.com`.", | 975 "description": "The DNS address at which this service is ava
ilable,\ne.g. `calendar.googleapis.com`.", |
(...skipping 133 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1107 }, | 1109 }, |
1108 "ListServicesResponse": { | 1110 "ListServicesResponse": { |
1109 "description": "Response message for `ListServices` method.", | 1111 "description": "Response message for `ListServices` method.", |
1110 "id": "ListServicesResponse", | 1112 "id": "ListServicesResponse", |
1111 "properties": { | 1113 "properties": { |
1112 "nextPageToken": { | 1114 "nextPageToken": { |
1113 "description": "Token that can be passed to `ListServices` t
o resume a paginated query.", | 1115 "description": "Token that can be passed to `ListServices` t
o resume a paginated query.", |
1114 "type": "string" | 1116 "type": "string" |
1115 }, | 1117 }, |
1116 "services": { | 1118 "services": { |
1117 "description": "The results of the query.", | 1119 "description": "The returned services will only have the nam
e field set.", |
1118 "items": { | 1120 "items": { |
1119 "$ref": "ManagedService" | 1121 "$ref": "ManagedService" |
1120 }, | 1122 }, |
1121 "type": "array" | 1123 "type": "array" |
1122 } | 1124 } |
1123 }, | 1125 }, |
1124 "type": "object" | 1126 "type": "object" |
1125 }, | 1127 }, |
1126 "Step": { | 1128 "Step": { |
1127 "description": "Represents the status of one operation step.", | 1129 "description": "Represents the status of one operation step.", |
(...skipping 170 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1298 "description": "Request message for `GetIamPolicy` method.", | 1300 "description": "Request message for `GetIamPolicy` method.", |
1299 "id": "GetIamPolicyRequest", | 1301 "id": "GetIamPolicyRequest", |
1300 "properties": {}, | 1302 "properties": {}, |
1301 "type": "object" | 1303 "type": "object" |
1302 }, | 1304 }, |
1303 "LoggingDestination": { | 1305 "LoggingDestination": { |
1304 "description": "Configuration of a specific logging destination (the
producer project\nor the consumer project).", | 1306 "description": "Configuration of a specific logging destination (the
producer project\nor the consumer project).", |
1305 "id": "LoggingDestination", | 1307 "id": "LoggingDestination", |
1306 "properties": { | 1308 "properties": { |
1307 "monitoredResource": { | 1309 "monitoredResource": { |
1308 "description": "The monitored resource type. The type must b
e defined in\nService.monitored_resources section.", | 1310 "description": "The monitored resource type. The type must b
e defined in the\nService.monitored_resources section.", |
1309 "type": "string" | 1311 "type": "string" |
1310 }, | 1312 }, |
1311 "logs": { | 1313 "logs": { |
1312 "description": "Names of the logs to be sent to this destina
tion. Each name must\nbe defined in the Service.logs section.", | 1314 "description": "Names of the logs to be sent to this destina
tion. Each name must\nbe defined in the Service.logs section. If the log name is
\nnot a domain scoped name, it will be automatically prefixed with\nthe service
name followed by \"/\".", |
1313 "items": { | 1315 "items": { |
1314 "type": "string" | 1316 "type": "string" |
1315 }, | 1317 }, |
1316 "type": "array" | 1318 "type": "array" |
1317 } | 1319 } |
1318 }, | 1320 }, |
1319 "type": "object" | 1321 "type": "object" |
1320 }, | 1322 }, |
1321 "Authentication": { | 1323 "Authentication": { |
1322 "description": "`Authentication` defines the authentication configur
ation for an API.\n\nExample for an API targeted for external use:\n\n name:
calendar.googleapis.com\n authentication:\n rules:\n - selector: \"
*\"\n oauth:\n canonical_scopes: https://www.googleapis.com/auth
/calendar\n\n - selector: google.calendar.Delegate\n oauth:\n
canonical_scopes: https://www.googleapis.com/auth/calendar.read", | 1324 "description": "`Authentication` defines the authentication configur
ation for an API.\n\nExample for an API targeted for external use:\n\n name:
calendar.googleapis.com\n authentication:\n rules:\n - selector: \"
*\"\n oauth:\n canonical_scopes: https://www.googleapis.com/auth
/calendar\n\n - selector: google.calendar.Delegate\n oauth:\n
canonical_scopes: https://www.googleapis.com/auth/calendar.read", |
(...skipping 229 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1552 } | 1554 } |
1553 }, | 1555 }, |
1554 "type": "object" | 1556 "type": "object" |
1555 }, | 1557 }, |
1556 "Operation": { | 1558 "Operation": { |
1557 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", | 1559 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", |
1558 "id": "Operation", | 1560 "id": "Operation", |
1559 "properties": { | 1561 "properties": { |
1560 "error": { | 1562 "error": { |
1561 "$ref": "Status", | 1563 "$ref": "Status", |
1562 "description": "The error result of the operation in case of
failure." | 1564 "description": "The error result of the operation in case of
failure or cancellation." |
1563 }, | 1565 }, |
1564 "done": { | 1566 "done": { |
1565 "description": "If the value is `false`, it means the operat
ion is still in progress.\nIf true, the operation is completed, and either `erro
r` or `response` is\navailable.", | 1567 "description": "If the value is `false`, it means the operat
ion is still in progress.\nIf true, the operation is completed, and either `erro
r` or `response` is\navailable.", |
1566 "type": "boolean" | 1568 "type": "boolean" |
1567 }, | 1569 }, |
1568 "metadata": { | 1570 "metadata": { |
1569 "additionalProperties": { | 1571 "additionalProperties": { |
1570 "description": "Properties of the object. Contains field
@type with type URL.", | 1572 "description": "Properties of the object. Contains field
@type with type URL.", |
1571 "type": "any" | 1573 "type": "any" |
1572 }, | 1574 }, |
(...skipping 75 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1648 "description": "A permission is a string of form '<service>.
<resource type>.<verb>'\n(e.g., 'storage.buckets.list'). A value of '*' matches
all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all
verbs.", | 1650 "description": "A permission is a string of form '<service>.
<resource type>.<verb>'\n(e.g., 'storage.buckets.list'). A value of '*' matches
all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all
verbs.", |
1649 "items": { | 1651 "items": { |
1650 "type": "string" | 1652 "type": "string" |
1651 }, | 1653 }, |
1652 "type": "array" | 1654 "type": "array" |
1653 } | 1655 } |
1654 }, | 1656 }, |
1655 "type": "object" | 1657 "type": "object" |
1656 }, | 1658 }, |
1657 "MetricDescriptor": { | 1659 "MetricDescriptor": { |
1658 "description": "Defines a metric type and its schema.", | 1660 "description": "Defines a metric type and its schema. Once a metric
descriptor is created,\ndeleting or altering it stops data collection and makes
the metric type's\nexisting data unusable.", |
1659 "id": "MetricDescriptor", | 1661 "id": "MetricDescriptor", |
1660 "properties": { | 1662 "properties": { |
1661 "description": { | 1663 "description": { |
1662 "description": "A detailed description of the metric, which
can be used in documentation.", | 1664 "description": "A detailed description of the metric, which
can be used in documentation.", |
1663 "type": "string" | 1665 "type": "string" |
1664 }, | 1666 }, |
1665 "unit": { | 1667 "unit": { |
1666 "description": "The unit in which the metric value is report
ed. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIB
UTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMea
sure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n
\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` h
our\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M`
mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P
` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n
* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-
6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (
10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yo
cto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi`
gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includ
es the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these
connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.`
multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is
as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component
} ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotati
on\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\"
;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n
equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`
, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable AS
CII characters not\n containing '{' or '}'.", | 1668 "description": "The unit in which the metric value is report
ed. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIB
UTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMea
sure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n
\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` h
our\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M`
mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P
` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n
* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-
6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (
10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yo
cto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi`
gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includ
es the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these
connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.`
multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is
as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component
} ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotati
on\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\"
;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n
equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`
, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable AS
CII characters not\n containing '{' or '}'.", |
1667 "type": "string" | 1669 "type": "string" |
1668 }, | 1670 }, |
1669 "labels": { | 1671 "labels": { |
1670 "description": "The set of labels that can be used to descri
be a specific instance of this\nmetric type. For example, the\n`compute.googleap
is.com/instance/network/received_bytes_count` metric type\nhas a label, `loadbal
anced`, that specifies whether the traffic was\nreceived through a load balanced
IP address.", | 1672 "description": "The set of labels that can be used to descri
be a specific\ninstance of this metric type. For example, the\n`appengine.google
apis.com/http/server/response_latencies` metric\ntype has a label for the HTTP r
esponse code, `response_code`, so\nyou can look at latencies for successful resp
onses or just\nfor responses that failed.", |
1671 "items": { | 1673 "items": { |
1672 "$ref": "LabelDescriptor" | 1674 "$ref": "LabelDescriptor" |
1673 }, | 1675 }, |
1674 "type": "array" | 1676 "type": "array" |
1675 }, | 1677 }, |
1676 "metricKind": { | 1678 "metricKind": { |
1677 "description": "Whether the metric records instantaneous val
ues, changes to a value, etc.", | 1679 "description": "Whether the metric records instantaneous val
ues, changes to a value, etc.\nSome combinations of `metric_kind` and `value_typ
e` might not be supported.", |
1678 "enum": [ | 1680 "enum": [ |
1679 "METRIC_KIND_UNSPECIFIED", | 1681 "METRIC_KIND_UNSPECIFIED", |
1680 "GAUGE", | 1682 "GAUGE", |
1681 "DELTA", | 1683 "DELTA", |
1682 "CUMULATIVE" | 1684 "CUMULATIVE" |
1683 ], | 1685 ], |
1684 "enumDescriptions": [ | 1686 "enumDescriptions": [ |
1685 "Do not use this default value.", | 1687 "Do not use this default value.", |
1686 "An instantaneous measurement of a value.", | 1688 "An instantaneous measurement of a value.", |
1687 "The change in a value during a time interval.", | 1689 "The change in a value during a time interval.", |
1688 "A value accumulated over a time interval. Cumulative\n
measurements in a time series should have the same start time\nand increasing en
d times, until an event resets the cumulative\nvalue to zero and sets a new star
t time for the following\npoints." | 1690 "A value accumulated over a time interval. Cumulative\n
measurements in a time series should have the same start time\nand increasing en
d times, until an event resets the cumulative\nvalue to zero and sets a new star
t time for the following\npoints." |
1689 ], | 1691 ], |
1690 "type": "string" | 1692 "type": "string" |
1691 }, | 1693 }, |
1692 "valueType": { | 1694 "valueType": { |
1693 "description": "Whether the measurement is an integer, a flo
ating-point number, etc.", | 1695 "description": "Whether the measurement is an integer, a flo
ating-point number, etc.\nSome combinations of `metric_kind` and `value_type` mi
ght not be supported.", |
1694 "enum": [ | 1696 "enum": [ |
1695 "VALUE_TYPE_UNSPECIFIED", | 1697 "VALUE_TYPE_UNSPECIFIED", |
1696 "BOOL", | 1698 "BOOL", |
1697 "INT64", | 1699 "INT64", |
1698 "DOUBLE", | 1700 "DOUBLE", |
1699 "STRING", | 1701 "STRING", |
1700 "DISTRIBUTION", | 1702 "DISTRIBUTION", |
1701 "MONEY" | 1703 "MONEY" |
1702 ], | 1704 ], |
1703 "enumDescriptions": [ | 1705 "enumDescriptions": [ |
1704 "Do not use this default value.", | 1706 "Do not use this default value.", |
1705 "The value is a boolean.\nThis value type can be used on
ly if the metric kind is `GAUGE`.", | 1707 "The value is a boolean.\nThis value type can be used on
ly if the metric kind is `GAUGE`.", |
1706 "The value is a signed 64-bit integer.", | 1708 "The value is a signed 64-bit integer.", |
1707 "The value is a double precision floating point number."
, | 1709 "The value is a double precision floating point number."
, |
1708 "The value is a text string.\nThis value type can be use
d only if the metric kind is `GAUGE`.", | 1710 "The value is a text string.\nThis value type can be use
d only if the metric kind is `GAUGE`.", |
1709 "The value is a `Distribution`.", | 1711 "The value is a `Distribution`.", |
1710 "The value is money." | 1712 "The value is money." |
1711 ], | 1713 ], |
1712 "type": "string" | 1714 "type": "string" |
1713 }, | 1715 }, |
1714 "displayName": { | 1716 "displayName": { |
1715 "description": "A concise name for the metric, which can be
displayed in user interfaces.\nUse sentence case without an ending period, for e
xample \"Request count\".", | 1717 "description": "A concise name for the metric, which can be
displayed in user interfaces.\nUse sentence case without an ending period, for e
xample \"Request count\".", |
1716 "type": "string" | 1718 "type": "string" |
1717 }, | 1719 }, |
1718 "name": { | 1720 "name": { |
1719 "description": "Resource name. The format of the name may va
ry between different\nimplementations. For examples:\n\n projects/{project_id
}/metricDescriptors/{type=**}\n metricDescriptors/{type=**}", | 1721 "description": "The resource name of the metric descriptor.
Depending on the\nimplementation, the name typically includes: (1) the parent re
source name\nthat defines the scope of the metric type or of its data; and (2) t
he\nmetric's URL-encoded type, which also appears in the `type` field of this\nd
escriptor. For example, following is the resource name of a custom\nmetric withi
n the GCP project 123456789:\n\n \"projects/123456789/metricDescriptors/custo
m.googleapis.com%2Finvoice%2Fpaid%2Famount\"", |
1720 "type": "string" | 1722 "type": "string" |
1721 }, | 1723 }, |
1722 "type": { | 1724 "type": { |
1723 "description": "The metric type including a DNS name prefix,
for example\n`\"compute.googleapis.com/instance/cpu/utilization\"`. Metric type
s\nshould use a natural hierarchical grouping such as the following:\n\n comp
ute.googleapis.com/instance/cpu/utilization\n compute.googleapis.com/instance
/disk/read_ops_count\n compute.googleapis.com/instance/network/received_bytes
_count\n\nNote that if the metric type changes, the monitoring data will be\ndis
continued, and anything depends on it will break, such as monitoring\ndashboards
, alerting rules and quota limits. Therefore, once a metric has\nbeen published,
its type should be immutable.", | 1725 "description": "The metric type, including its DNS name pref
ix. The type is not\nURL-encoded. All user-defined metric types have the DNS na
me\n`custom.googleapis.com`. Metric types should use a natural hierarchical\ngr
ouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"\n \
"appengine.googleapis.com/http/server/response_latencies\"", |
1724 "type": "string" | 1726 "type": "string" |
1725 } | 1727 } |
1726 }, | 1728 }, |
1727 "type": "object" | 1729 "type": "object" |
1728 }, | 1730 }, |
1729 "EnableServiceRequest": { | 1731 "EnableServiceRequest": { |
1730 "description": "Request message for EnableService method.", | 1732 "description": "Request message for EnableService method.", |
1731 "id": "EnableServiceRequest", | 1733 "id": "EnableServiceRequest", |
1732 "properties": { | 1734 "properties": { |
1733 "consumerId": { | 1735 "consumerId": { |
1734 "description": "The identity of consumer resource which serv
ice enablement will be\napplied to.\n\nThe Google Service Management implementat
ion accepts the following\nforms: \"project:<project_id>\", \"project_number:<pr
oject_number>\".\n\nNote: this is made compatible with\ngoogle.api.servicecontro
l.v1.Operation.consumer_id.", | 1736 "description": "The identity of consumer resource which serv
ice enablement will be\napplied to.\n\nThe Google Service Management implementat
ion accepts the following\nforms:\n- \"project:<project_id>\"\n\nNote: this is m
ade compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.", |
1735 "type": "string" | 1737 "type": "string" |
1736 } | 1738 } |
1737 }, | 1739 }, |
1738 "type": "object" | 1740 "type": "object" |
1739 }, | 1741 }, |
1740 "DocumentationRule": { | 1742 "DocumentationRule": { |
1741 "description": "A documentation rule provides information about indi
vidual API elements.", | 1743 "description": "A documentation rule provides information about indi
vidual API elements.", |
1742 "id": "DocumentationRule", | 1744 "id": "DocumentationRule", |
1743 "properties": { | 1745 "properties": { |
1744 "description": { | 1746 "description": { |
(...skipping 68 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1813 }, | 1815 }, |
1814 "iam": { | 1816 "iam": { |
1815 "description": "Trusted attributes supplied by the IAM syste
m.", | 1817 "description": "Trusted attributes supplied by the IAM syste
m.", |
1816 "enum": [ | 1818 "enum": [ |
1817 "NO_ATTR", | 1819 "NO_ATTR", |
1818 "AUTHORITY", | 1820 "AUTHORITY", |
1819 "ATTRIBUTION" | 1821 "ATTRIBUTION" |
1820 ], | 1822 ], |
1821 "enumDescriptions": [ | 1823 "enumDescriptions": [ |
1822 "Default non-attribute.", | 1824 "Default non-attribute.", |
1823 "Either principal or (if present) authority", | 1825 "Either principal or (if present) authority selector.", |
1824 "selector\nAlways the original principal, but making cle
ar" | 1826 "The principal (even if an authority selector is present
), which\nmust only be used for attribution, not authorization." |
1825 ], | 1827 ], |
1826 "type": "string" | 1828 "type": "string" |
1827 }, | 1829 }, |
1828 "op": { | 1830 "op": { |
1829 "description": "An operator to apply the subject with.", | 1831 "description": "An operator to apply the subject with.", |
1830 "enum": [ | 1832 "enum": [ |
1831 "NO_OP", | 1833 "NO_OP", |
1832 "EQUALS", | 1834 "EQUALS", |
1833 "NOT_EQUALS", | 1835 "NOT_EQUALS", |
1834 "IN", | 1836 "IN", |
(...skipping 134 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1969 "type": "object" | 1971 "type": "object" |
1970 }, | 1972 }, |
1971 "name": { | 1973 "name": { |
1972 "description": "The option's name. For example, `\"java_pack
age\"`.", | 1974 "description": "The option's name. For example, `\"java_pack
age\"`.", |
1973 "type": "string" | 1975 "type": "string" |
1974 } | 1976 } |
1975 }, | 1977 }, |
1976 "type": "object" | 1978 "type": "object" |
1977 }, | 1979 }, |
1978 "HttpRule": { | 1980 "HttpRule": { |
1979 "description": "`HttpRule` defines the mapping of an RPC method to o
ne or more HTTP\nREST APIs. The mapping determines what portions of the request
\nmessage are populated from the path, query parameters, or body of\nthe HTTP re
quest. The mapping is typically specified as an\n`google.api.http` annotation,
see \"google/api/annotations.proto\"\nfor details.\n\nThe mapping consists of a
field specifying the path template and\nmethod kind. The path template can refe
r to fields in the request\nmessage, as in the example below which describes a R
EST GET\noperation on a resource collection of messages:\n\n```proto\nservice Me
ssaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (
google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n}\nme
ssage GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }
\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `su
b.subfield` is url-mapped\n}\nmessage Message {\n string text = 1; // content o
f the resource\n}\n```\n\nThis definition enables an automatic, bidrectional map
ping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/message
s/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"
foo\"))`\n\nIn general, not only fields but also field paths can be referenced\n
from a path pattern. Fields mapped to the path pattern cannot be\nrepeated and m
ust have a primitive (non-message) type.\n\nAny fields in the request message wh
ich are not bound by the path\npattern automatically become (optional) HTTP quer
y\nparameters. Assume the following definition of the request message:\n\n```pro
to\nmessage GetMessageRequest {\n message SubMessage {\n string subfield = 1
;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2;
// becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a par
ameter\n}\n```\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RP
C\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMess
age(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nN
ote that fields which are mapped to HTTP parameters must have a\nprimitive type
or a repeated primitive type. Message types are not\nallowed. In the case of a r
epeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶
m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspe
cifies the mapping. Consider a REST update method on the\nmessage resource colle
ction:\n\n```proto\nservice Messaging {\n rpc UpdateMessage(UpdateMessageReques
t) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messa
ges/{message_id}\"\n body: \"message\"\n };\n }\n}\nmessage UpdateMessa
geRequest {\n string message_id = 1; // mapped to the URL\n Message message =
2; // mapped to the body\n}\n```\n\nThe following HTTP JSON to RPC mapping is
enabled, where the\nrepresentation of the JSON in the request body is determined
by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456
{ \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \
"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define tha
t\nevery field not bound by the path template should be mapped to the\nrequest b
ody. This enables the following alternative definition of\nthe update method:\n
\n```proto\nservice Messaging {\n rpc UpdateMessage(Message) returns (Message)
{\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n
body: \"*\"\n };\n }\n}\nmessage Message {\n string message_id = 1;\n
string text = 2;\n}\n```\n\nThe following HTTP JSON to RPC mapping is enabled:\
n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `U
pdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*`
in the body mapping, it is not possible to\nhave HTTP parameters, as all fields
not bound by the path end in\nthe body. This makes this option more rarely used
in practice of\ndefining REST APIs. The common usage of `*` is in custom methods
\nwhich don't use the URL at all for transferring data.\n\nIt is possible to def
ine multiple HTTP methods for one RPC by using\nthe `additional_bindings` option
. Example:\n\n```proto\nservice Messaging {\n rpc GetMessage(GetMessageRequest)
returns (Message) {\n option (google.api.http) = {\n get: \"/v1/message
s/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id
}/messages/{message_id}\"\n }\n };\n }\n}\nmessage GetMessageRequest {\
n string message_id = 1;\n string user_id = 2;\n}\n```\n\nThis enables the fol
lowing two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`
GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/
me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n#
Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and
body fields\nto the request message are as follows:\n\n1. The `body` field spec
ifies either `*` or a field path, or is\n omitted. If omitted, it assumes ther
e is no HTTP body.\n2. Leaf fields (recursive expansion of nested messages in th
e\n request) can be classified into three types:\n (a) Matched in the URL t
emplate.\n (b) Covered by body (if body is `*`, everything except (a) fields;
\n else everything under the body field)\n (c) All other fields.\n3. U
RL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any
body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the
path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n S
egments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL |
Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n Fiel
dPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*
` matches a single path segment. It follows the semantics of\n[RFC 6570](https:/
/tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String\nExpansion.\n\nThe syn
tax `**` matches zero or more path segments. It follows the semantics\nof [RFC 6
570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved\nExpansion.\n\n
The syntax `LITERAL` matches literal text in the URL path.\n\nThe syntax `Variab
le` matches the entire path as specified by its template;\nthis nested template
must not contain further variables. If a variable\nmatches a single path segment
, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nNOTE
: the field paths in variables and in the `body` must not refer to\nrepeated fie
lds or map fields.\n\nUse CustomHttpPattern to specify any HTTP method that is n
ot included in the\n`pattern` field, such as HEAD, or \"*\" to leave the HTTP me
thod unspecified for\na given URL path rule. The wild-card rule is useful for se
rvices that provide\ncontent to Web (HTML) clients.", | 1981 "description": "`HttpRule` defines the mapping of an RPC method to o
ne or more HTTP\nREST APIs. The mapping determines what portions of the request
\nmessage are populated from the path, query parameters, or body of\nthe HTTP re
quest. The mapping is typically specified as an\n`google.api.http` annotation,
see \"google/api/annotations.proto\"\nfor details.\n\nThe mapping consists of a
field specifying the path template and\nmethod kind. The path template can refe
r to fields in the request\nmessage, as in the example below which describes a R
EST GET\noperation on a resource collection of messages:\n\n```proto\nservice Me
ssaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (
google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n}\nme
ssage GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }
\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `su
b.subfield` is url-mapped\n}\nmessage Message {\n string text = 1; // content o
f the resource\n}\n```\n\nThis definition enables an automatic, bidrectional map
ping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/message
s/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"
foo\"))`\n\nIn general, not only fields but also field paths can be referenced\n
from a path pattern. Fields mapped to the path pattern cannot be\nrepeated and m
ust have a primitive (non-message) type.\n\nAny fields in the request message wh
ich are not bound by the path\npattern automatically become (optional) HTTP quer
y\nparameters. Assume the following definition of the request message:\n\n```pro
to\nmessage GetMessageRequest {\n message SubMessage {\n string subfield = 1
;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2;
// becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a par
ameter\n}\n```\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RP
C\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMess
age(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nN
ote that fields which are mapped to HTTP parameters must have a\nprimitive type
or a repeated primitive type. Message types are not\nallowed. In the case of a r
epeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶
m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspe
cifies the mapping. Consider a REST update method on the\nmessage resource colle
ction:\n\n```proto\nservice Messaging {\n rpc UpdateMessage(UpdateMessageReques
t) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messa
ges/{message_id}\"\n body: \"message\"\n };\n }\n}\nmessage UpdateMessa
geRequest {\n string message_id = 1; // mapped to the URL\n Message message =
2; // mapped to the body\n}\n```\n\nThe following HTTP JSON to RPC mapping is
enabled, where the\nrepresentation of the JSON in the request body is determined
by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456
{ \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \
"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define tha
t\nevery field not bound by the path template should be mapped to the\nrequest b
ody. This enables the following alternative definition of\nthe update method:\n
\n```proto\nservice Messaging {\n rpc UpdateMessage(Message) returns (Message)
{\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n
body: \"*\"\n };\n }\n}\nmessage Message {\n string message_id = 1;\n
string text = 2;\n}\n```\n\nThe following HTTP JSON to RPC mapping is enabled:\
n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `U
pdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*`
in the body mapping, it is not possible to\nhave HTTP parameters, as all fields
not bound by the path end in\nthe body. This makes this option more rarely used
in practice of\ndefining REST APIs. The common usage of `*` is in custom methods
\nwhich don't use the URL at all for transferring data.\n\nIt is possible to def
ine multiple HTTP methods for one RPC by using\nthe `additional_bindings` option
. Example:\n\n```proto\nservice Messaging {\n rpc GetMessage(GetMessageRequest)
returns (Message) {\n option (google.api.http) = {\n get: \"/v1/message
s/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id
}/messages/{message_id}\"\n }\n };\n }\n}\nmessage GetMessageRequest {\
n string message_id = 1;\n string user_id = 2;\n}\n```\n\nThis enables the fol
lowing two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`
GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/
me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n#
Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and
body fields\nto the request message are as follows:\n\n1. The `body` field spec
ifies either `*` or a field path, or is\n omitted. If omitted, it assumes ther
e is no HTTP body.\n2. Leaf fields (recursive expansion of nested messages in th
e\n request) can be classified into three types:\n (a) Matched in the URL t
emplate.\n (b) Covered by body (if body is `*`, everything except (a) fields;
\n else everything under the body field)\n (c) All other fields.\n3. U
RL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any
body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the
path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n S
egments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL |
Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n Fiel
dPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*
` matches a single path segment. It follows the semantics of\n[RFC 6570](https:/
/tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String\nExpansion.\n\nThe syn
tax `**` matches zero or more path segments. It follows the semantics\nof [RFC 6
570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved\nExpansion. NOT
E: it must be the last segment in the path except the Verb.\n\nThe syntax `LITER
AL` matches literal text in the URL path.\n\nThe syntax `Variable` matches the e
ntire path as specified by its template;\nthis nested template must not contain
further variables. If a variable\nmatches a single path segment, its template ma
y be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nNOTE: the field paths
in variables and in the `body` must not refer to\nrepeated fields or map fields
.\n\nUse CustomHttpPattern to specify any HTTP method that is not included in th
e\n`pattern` field, such as HEAD, or \"*\" to leave the HTTP method unspecified
for\na given URL path rule. The wild-card rule is useful for services that provi
de\ncontent to Web (HTML) clients.", |
1980 "id": "HttpRule", | 1982 "id": "HttpRule", |
1981 "properties": { | 1983 "properties": { |
1982 "custom": { | 1984 "custom": { |
1983 "$ref": "CustomHttpPattern", | 1985 "$ref": "CustomHttpPattern", |
1984 "description": "Custom pattern is used for defining custom v
erbs." | 1986 "description": "Custom pattern is used for defining custom v
erbs." |
1985 }, | 1987 }, |
1986 "responseBody": { | 1988 "responseBody": { |
1987 "description": "The name of the response field whose value i
s mapped to the HTTP body of\nresponse. Other response fields are ignored. This
field is optional. When\nnot set, the response message will be used as HTTP body
of response.\nNOTE: the referred field must be not a repeated field and must be
present\nat the top-level of response message type.", | 1989 "description": "The name of the response field whose value i
s mapped to the HTTP body of\nresponse. Other response fields are ignored. This
field is optional. When\nnot set, the response message will be used as HTTP body
of response.\nNOTE: the referred field must be not a repeated field and must be
present\nat the top-level of response message type.", |
1988 "type": "string" | 1990 "type": "string" |
1989 }, | 1991 }, |
(...skipping 138 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2128 "type": "array" | 2130 "type": "array" |
2129 }, | 2131 }, |
2130 "selector": { | 2132 "selector": { |
2131 "description": "Selects the methods to which this rule appli
es.\n\nRefer to selector for syntax details.", | 2133 "description": "Selects the methods to which this rule appli
es.\n\nRefer to selector for syntax details.", |
2132 "type": "string" | 2134 "type": "string" |
2133 } | 2135 } |
2134 }, | 2136 }, |
2135 "type": "object" | 2137 "type": "object" |
2136 }, | 2138 }, |
2137 "Logging": { | 2139 "Logging": { |
2138 "description": "Logging configuration of the service.\n\nThe followi
ng example shows how to configure logs to be sent to the\nproducer and consumer
projects. In the example,\nthe `library.googleapis.com/activity_history` log is\
nsent to both the producer and consumer projects, whereas\nthe `library.googleap
is.com/purchase_history` log is only sent to the\nproducer project:\n\n monit
ored_resources:\n - type: library.googleapis.com/branch\n labels:\n
- key: /city\n description: The city where the library branch is located
in.\n - key: /name\n description: The name of the branch.\n logs
:\n - name: library.googleapis.com/activity_history\n labels:\n - k
ey: /customer_id\n - name: library.googleapis.com/purchase_history\n loggi
ng:\n producer_destinations:\n - monitored_resource: library.googleapi
s.com/branch\n logs:\n - library.googleapis.com/activity_history\n
- library.googleapis.com/purchase_history\n consumer_destinations:\
n - monitored_resource: library.googleapis.com/branch\n logs:\n
- library.googleapis.com/activity_history", | 2140 "description": "Logging configuration of the service.\n\nThe followi
ng example shows how to configure logs to be sent to the\nproducer and consumer
projects. In the example, the `activity_history`\nlog is sent to both the produc
er and consumer projects, whereas the\n`purchase_history` log is only sent to th
e producer project.\n\n monitored_resources:\n - type: library.googleapis.
com/branch\n labels:\n - key: /city\n description: The city whe
re the library branch is located in.\n - key: /name\n description: T
he name of the branch.\n logs:\n - name: activity_history\n labels:\n
- key: /customer_id\n - name: purchase_history\n logging:\n pro
ducer_destinations:\n - monitored_resource: library.googleapis.com/branch\n
logs:\n - activity_history\n - purchase_history\n con
sumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n
logs:\n - activity_history", |
2139 "id": "Logging", | 2141 "id": "Logging", |
2140 "properties": { | 2142 "properties": { |
2141 "producerDestinations": { | 2143 "producerDestinations": { |
2142 "description": "Logging configurations for sending logs to t
he producer project.\nThere can be multiple producer destinations, each one must
have a\ndifferent monitored resource type. A log can be used in at most\none pr
oducer destination.", | 2144 "description": "Logging configurations for sending logs to t
he producer project.\nThere can be multiple producer destinations, each one must
have a\ndifferent monitored resource type. A log can be used in at most\none pr
oducer destination.", |
2143 "items": { | 2145 "items": { |
2144 "$ref": "LoggingDestination" | 2146 "$ref": "LoggingDestination" |
2145 }, | 2147 }, |
2146 "type": "array" | 2148 "type": "array" |
2147 }, | 2149 }, |
2148 "consumerDestinations": { | 2150 "consumerDestinations": { |
(...skipping 130 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2279 "type": "integer" | 2281 "type": "integer" |
2280 } | 2282 } |
2281 }, | 2283 }, |
2282 "type": "object" | 2284 "type": "object" |
2283 }, | 2285 }, |
2284 "DisableServiceRequest": { | 2286 "DisableServiceRequest": { |
2285 "description": "Request message for DisableService method.", | 2287 "description": "Request message for DisableService method.", |
2286 "id": "DisableServiceRequest", | 2288 "id": "DisableServiceRequest", |
2287 "properties": { | 2289 "properties": { |
2288 "consumerId": { | 2290 "consumerId": { |
2289 "description": "The identity of consumer resource which serv
ice disablement will be\napplied to.\n\nThe Google Service Management implementa
tion accepts the following\nforms: \"project:<project_id>\", \"project_number:<p
roject_number>\".\n\nNote: this is made compatible with\ngoogle.api.servicecontr
ol.v1.Operation.consumer_id.", | 2291 "description": "The identity of consumer resource which serv
ice disablement will be\napplied to.\n\nThe Google Service Management implementa
tion accepts the following\nforms:\n- \"project:<project_id>\"\n\nNote: this is
made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.", |
2290 "type": "string" | 2292 "type": "string" |
2291 } | 2293 } |
2292 }, | 2294 }, |
2293 "type": "object" | 2295 "type": "object" |
2294 }, | 2296 }, |
2295 "CustomHttpPattern": { | 2297 "CustomHttpPattern": { |
2296 "description": "A custom pattern is used for defining custom HTTP ve
rb.", | 2298 "description": "A custom pattern is used for defining custom HTTP ve
rb.", |
2297 "id": "CustomHttpPattern", | 2299 "id": "CustomHttpPattern", |
2298 "properties": { | 2300 "properties": { |
2299 "path": { | 2301 "path": { |
(...skipping 155 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2455 "type": "string" | 2457 "type": "string" |
2456 } | 2458 } |
2457 }, | 2459 }, |
2458 "type": "object" | 2460 "type": "object" |
2459 }, | 2461 }, |
2460 "Binding": { | 2462 "Binding": { |
2461 "description": "Associates `members` with a `role`.", | 2463 "description": "Associates `members` with a `role`.", |
2462 "id": "Binding", | 2464 "id": "Binding", |
2463 "properties": { | 2465 "properties": { |
2464 "members": { | 2466 "members": { |
2465 "description": "Specifies the identities requesting access f
or a Cloud Platform resource.\n`members` can have the following values:\n\n* `al
lUsers`: A special identifier that represents anyone who is\n on the internet;
with or without a Google account.\n\n* `allAuthenticatedUsers`: A special ident
ifier that represents anyone\n who is authenticated with a Google account or a
service account.\n\n* `user:{emailid}`: An email address that represents a spec
ific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\
n* `serviceAccount:{emailid}`: An email address that represents a service\n ac
count. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{ema
ilid}`: An email address that represents a Google group.\n For example, `admin
s@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represent
s all the\n users of that domain. For example, `google.com` or `example.com`.\
n\n", | 2467 "description": "Specifies the identities requesting access f
or a Cloud Platform resource.\n`members` can have the following values:\n\n* `al
lUsers`: A special identifier that represents anyone who is\n on the internet;
with or without a Google account.\n\n* `allAuthenticatedUsers`: A special ident
ifier that represents anyone\n who is authenticated with a Google account or a
service account.\n\n* `user:{emailid}`: An email address that represents a spec
ific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\
n\n* `serviceAccount:{emailid}`: An email address that represents a service\n
account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{e
mailid}`: An email address that represents a Google group.\n For example, `adm
ins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represe
nts all the\n users of that domain. For example, `google.com` or `example.com`
.\n\n", |
2466 "items": { | 2468 "items": { |
2467 "type": "string" | 2469 "type": "string" |
2468 }, | 2470 }, |
2469 "type": "array" | 2471 "type": "array" |
2470 }, | 2472 }, |
2471 "role": { | 2473 "role": { |
2472 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", | 2474 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", |
2473 "type": "string" | 2475 "type": "string" |
2474 } | 2476 } |
2475 }, | 2477 }, |
(...skipping 13 matching lines...) Expand all Loading... |
2489 "DataAccessOptions": { | 2491 "DataAccessOptions": { |
2490 "description": "Write a Data Access (Gin) log", | 2492 "description": "Write a Data Access (Gin) log", |
2491 "id": "DataAccessOptions", | 2493 "id": "DataAccessOptions", |
2492 "properties": {}, | 2494 "properties": {}, |
2493 "type": "object" | 2495 "type": "object" |
2494 }, | 2496 }, |
2495 "AuthProvider": { | 2497 "AuthProvider": { |
2496 "description": "Configuration for an anthentication provider, includ
ing support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-o
auth-json-web-token-32).", | 2498 "description": "Configuration for an anthentication provider, includ
ing support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-o
auth-json-web-token-32).", |
2497 "id": "AuthProvider", | 2499 "id": "AuthProvider", |
2498 "properties": { | 2500 "properties": { |
| 2501 "audiences": { |
| 2502 "description": "The list of JWT\n[audiences](https://tools.i
etf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowe
d to access. A JWT containing any of these audiences will\nbe accepted. When thi
s setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\
nwill be accepted. For example, if no audiences are in the setting,\nLibraryServ
ice API will only accept JWTs with the following audience\n\"https://library-exa
mple.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n
audiences: bookstore_android.apps.googleusercontent.com,\n book
store_web.apps.googleusercontent.com", |
| 2503 "type": "string" |
| 2504 }, |
2499 "jwksUri": { | 2505 "jwksUri": { |
2500 "description": "URL of the provider's public key set to vali
date signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/open
id-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set docume
nt:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/op
enid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the
email domain of the issuer (e.g. a Google service account).\n\nExample: https://
www.googleapis.com/oauth2/v1/certs", | 2506 "description": "URL of the provider's public key set to vali
date signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/open
id-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set docume
nt:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/op
enid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the
email domain of the issuer (e.g. a Google service account).\n\nExample: https://
www.googleapis.com/oauth2/v1/certs", |
2501 "type": "string" | 2507 "type": "string" |
2502 }, | 2508 }, |
2503 "id": { | 2509 "id": { |
2504 "description": "The unique identifier of the auth provider.
It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstor
e_auth\".", | 2510 "description": "The unique identifier of the auth provider.
It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstor
e_auth\".", |
2505 "type": "string" | 2511 "type": "string" |
2506 }, | 2512 }, |
2507 "issuer": { | 2513 "issuer": { |
2508 "description": "Identifies the principal that issued the JWT
. See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.
1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.c
om\nExample: 1234567-compute@developer.gserviceaccount.com", | 2514 "description": "Identifies the principal that issued the JWT
. See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.
1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.c
om\nExample: 1234567-compute@developer.gserviceaccount.com", |
2509 "type": "string" | 2515 "type": "string" |
2510 } | 2516 } |
2511 }, | 2517 }, |
2512 "type": "object" | 2518 "type": "object" |
2513 }, | 2519 }, |
2514 "VisibilityRule": { | 2520 "VisibilityRule": { |
2515 "description": "A visibility rule provides visibility configuration
for an individual API\nelement.", | 2521 "description": "A visibility rule provides visibility configuration
for an individual API\nelement.", |
2516 "id": "VisibilityRule", | 2522 "id": "VisibilityRule", |
2517 "properties": { | 2523 "properties": { |
2518 "restriction": { | 2524 "restriction": { |
2519 "description": "Lists the visibility labels for this rule. A
ny of the listed labels grants\nvisibility to the element.\n\nIf a rule has mult
iple labels, removing one of the labels but not all of\nthem can break clients.\
n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.
Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\
nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on
this method and only had access to it through GOOGLE_INTERNAL.", | 2525 "description": "A comma-separated list of visibility labels
that apply to the `selector`.\nAny of the listed labels can be used to grant the
visibility.\n\nIf a rule has multiple labels, removing one of the labels but no
t all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n
- selector: google.calendar.Calendar.EnhancedSearch\n restriction:
GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restrictio
n will break clients that\nrely on this method and only had access to it through
GOOGLE_INTERNAL.", |
2520 "type": "string" | 2526 "type": "string" |
2521 }, | 2527 }, |
2522 "selector": { | 2528 "selector": { |
2523 "description": "Selects methods, messages, fields, enums, et
c. to which this rule applies.\n\nRefer to selector for syntax details.", | 2529 "description": "Selects methods, messages, fields, enums, et
c. to which this rule applies.\n\nRefer to selector for syntax details.", |
2524 "type": "string" | 2530 "type": "string" |
2525 } | 2531 } |
2526 }, | 2532 }, |
2527 "type": "object" | 2533 "type": "object" |
2528 }, | 2534 }, |
2529 "UndeleteServiceResponse": { | 2535 "UndeleteServiceResponse": { |
(...skipping 250 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2780 "description": "Write a Cloud Audit log", | 2786 "description": "Write a Cloud Audit log", |
2781 "id": "CloudAuditOptions", | 2787 "id": "CloudAuditOptions", |
2782 "properties": {}, | 2788 "properties": {}, |
2783 "type": "object" | 2789 "type": "object" |
2784 }, | 2790 }, |
2785 "AuthRequirement": { | 2791 "AuthRequirement": { |
2786 "description": "User-defined authentication requirements, including
support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth
-json-web-token-32).", | 2792 "description": "User-defined authentication requirements, including
support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth
-json-web-token-32).", |
2787 "id": "AuthRequirement", | 2793 "id": "AuthRequirement", |
2788 "properties": { | 2794 "properties": { |
2789 "audiences": { | 2795 "audiences": { |
2790 "description": "The list of JWT\n[audiences](https://tools.i
etf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowe
d to access. A JWT containing any of these audiences will\nbe accepted. When thi
s setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\
nwill be accepted. For example, if no audiences are in the setting,\nLibraryServ
ice API will only accept JWTs with the following audience\n\"https://library-exa
mple.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n
audiences: bookstore_android.apps.googleusercontent.com,\n book
store_web.apps.googleusercontent.com", | 2796 "description": "NOTE: This will be deprecated soon, once Aut
hProvider.audiences is\nimplemented and accepted in all the runtime components.\
n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-jso
n-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any
of these audiences will\nbe accepted. When this setting is absent, only JWTs wi
th audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, i
f no audiences are in the setting,\nLibraryService API will only accept JWTs wit
h the following audience\n\"https://library-example.googleapis.com/google.exampl
e.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.a
pps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.
com", |
2791 "type": "string" | 2797 "type": "string" |
2792 }, | 2798 }, |
2793 "providerId": { | 2799 "providerId": { |
2794 "description": "id from authentication provider.\n\nExample:
\n\n provider_id: bookstore_auth", | 2800 "description": "id from authentication provider.\n\nExample:
\n\n provider_id: bookstore_auth", |
2795 "type": "string" | 2801 "type": "string" |
2796 } | 2802 } |
2797 }, | 2803 }, |
2798 "type": "object" | 2804 "type": "object" |
2799 }, | 2805 }, |
2800 "Control": { | 2806 "Control": { |
(...skipping 16 matching lines...) Expand all Loading... |
2817 "type": "string" | 2823 "type": "string" |
2818 } | 2824 } |
2819 }, | 2825 }, |
2820 "type": "object" | 2826 "type": "object" |
2821 } | 2827 } |
2822 }, | 2828 }, |
2823 "servicePath": "", | 2829 "servicePath": "", |
2824 "title": "Google Service Management API", | 2830 "title": "Google Service Management API", |
2825 "version": "v1" | 2831 "version": "v1" |
2826 } | 2832 } |
OLD | NEW |