OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/service.management": { | |
6 "description": "Manage your Google API service configuration
" | |
7 }, | |
8 "https://www.googleapis.com/auth/service.management.readonly": { | 5 "https://www.googleapis.com/auth/service.management.readonly": { |
9 "description": "View your Google API service configuration" | 6 "description": "View your Google API service configuration" |
10 }, | 7 }, |
11 "https://www.googleapis.com/auth/cloud-platform.read-only": { | 8 "https://www.googleapis.com/auth/cloud-platform.read-only": { |
12 "description": "View your data across Google Cloud Platform
services" | 9 "description": "View your data across Google Cloud Platform
services" |
13 }, | 10 }, |
14 "https://www.googleapis.com/auth/cloud-platform": { | 11 "https://www.googleapis.com/auth/cloud-platform": { |
15 "description": "View and manage your data across Google Clou
d Platform services" | 12 "description": "View and manage your data across Google Clou
d Platform services" |
| 13 }, |
| 14 "https://www.googleapis.com/auth/service.management": { |
| 15 "description": "Manage your Google API service configuration
" |
16 } | 16 } |
17 } | 17 } |
18 } | 18 } |
19 }, | 19 }, |
20 "basePath": "", | 20 "basePath": "", |
21 "baseUrl": "https://servicemanagement.googleapis.com/", | 21 "baseUrl": "https://servicemanagement.googleapis.com/", |
22 "batchPath": "batch", | 22 "batchPath": "batch", |
23 "canonicalName": "Service Management", | 23 "canonicalName": "Service Management", |
24 "description": "Google Service Management allows service producers to publis
h their services on Google Cloud Platform so that they can be discovered and use
d by service consumers.", | 24 "description": "Google Service Management allows service producers to publis
h their services on Google Cloud Platform so that they can be discovered and use
d by service consumers.", |
25 "discoveryVersion": "v1", | 25 "discoveryVersion": "v1", |
26 "documentationLink": "https://cloud.google.com/service-management/", | 26 "documentationLink": "https://cloud.google.com/service-management/", |
27 "icons": { | 27 "icons": { |
28 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 28 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
29 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 29 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
30 }, | 30 }, |
31 "id": "servicemanagement:v1", | 31 "id": "servicemanagement:v1", |
32 "kind": "discovery#restDescription", | 32 "kind": "discovery#restDescription", |
33 "name": "servicemanagement", | 33 "name": "servicemanagement", |
34 "ownerDomain": "google.com", | 34 "ownerDomain": "google.com", |
35 "ownerName": "Google", | 35 "ownerName": "Google", |
36 "parameters": { | 36 "parameters": { |
| 37 "quotaUser": { |
| 38 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 39 "location": "query", |
| 40 "type": "string" |
| 41 }, |
| 42 "pp": { |
| 43 "default": "true", |
| 44 "description": "Pretty-print response.", |
| 45 "location": "query", |
| 46 "type": "boolean" |
| 47 }, |
| 48 "oauth_token": { |
| 49 "description": "OAuth 2.0 token for the current user.", |
| 50 "location": "query", |
| 51 "type": "string" |
| 52 }, |
| 53 "bearer_token": { |
| 54 "description": "OAuth bearer token.", |
| 55 "location": "query", |
| 56 "type": "string" |
| 57 }, |
37 "upload_protocol": { | 58 "upload_protocol": { |
38 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 59 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
39 "location": "query", | 60 "location": "query", |
40 "type": "string" | 61 "type": "string" |
41 }, | 62 }, |
42 "prettyPrint": { | 63 "prettyPrint": { |
43 "default": "true", | 64 "default": "true", |
44 "description": "Returns response with indentations and line breaks."
, | 65 "description": "Returns response with indentations and line breaks."
, |
45 "location": "query", | 66 "location": "query", |
46 "type": "boolean" | 67 "type": "boolean" |
47 }, | 68 }, |
48 "fields": { | 69 "fields": { |
49 "description": "Selector specifying which fields to include in a par
tial response.", | 70 "description": "Selector specifying which fields to include in a par
tial response.", |
50 "location": "query", | 71 "location": "query", |
51 "type": "string" | 72 "type": "string" |
52 }, | 73 }, |
53 "uploadType": { | 74 "uploadType": { |
54 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 75 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
55 "location": "query", | 76 "location": "query", |
56 "type": "string" | 77 "type": "string" |
57 }, | 78 }, |
| 79 "callback": { |
| 80 "description": "JSONP", |
| 81 "location": "query", |
| 82 "type": "string" |
| 83 }, |
58 "$.xgafv": { | 84 "$.xgafv": { |
59 "description": "V1 error format.", | 85 "description": "V1 error format.", |
60 "enum": [ | 86 "enum": [ |
61 "1", | 87 "1", |
62 "2" | 88 "2" |
63 ], | 89 ], |
64 "enumDescriptions": [ | 90 "enumDescriptions": [ |
65 "v1 error format", | 91 "v1 error format", |
66 "v2 error format" | 92 "v2 error format" |
67 ], | 93 ], |
68 "location": "query", | 94 "location": "query", |
69 "type": "string" | 95 "type": "string" |
70 }, | 96 }, |
71 "callback": { | |
72 "description": "JSONP", | |
73 "location": "query", | |
74 "type": "string" | |
75 }, | |
76 "alt": { | 97 "alt": { |
77 "default": "json", | 98 "default": "json", |
78 "description": "Data format for response.", | 99 "description": "Data format for response.", |
79 "enum": [ | 100 "enum": [ |
80 "json", | 101 "json", |
81 "media", | 102 "media", |
82 "proto" | 103 "proto" |
83 ], | 104 ], |
84 "enumDescriptions": [ | 105 "enumDescriptions": [ |
85 "Responses with Content-Type of application/json", | 106 "Responses with Content-Type of application/json", |
86 "Media download with context-dependent Content-Type", | 107 "Media download with context-dependent Content-Type", |
87 "Responses with Content-Type of application/x-protobuf" | 108 "Responses with Content-Type of application/x-protobuf" |
88 ], | 109 ], |
89 "location": "query", | 110 "location": "query", |
90 "type": "string" | 111 "type": "string" |
91 }, | 112 }, |
92 "key": { | 113 "key": { |
93 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | 114 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
94 "location": "query", | 115 "location": "query", |
95 "type": "string" | 116 "type": "string" |
96 }, | 117 }, |
97 "access_token": { | 118 "access_token": { |
98 "description": "OAuth access token.", | 119 "description": "OAuth access token.", |
99 "location": "query", | 120 "location": "query", |
100 "type": "string" | 121 "type": "string" |
101 }, | |
102 "quotaUser": { | |
103 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | |
104 "location": "query", | |
105 "type": "string" | |
106 }, | |
107 "pp": { | |
108 "default": "true", | |
109 "description": "Pretty-print response.", | |
110 "location": "query", | |
111 "type": "boolean" | |
112 }, | |
113 "bearer_token": { | |
114 "description": "OAuth bearer token.", | |
115 "location": "query", | |
116 "type": "string" | |
117 }, | |
118 "oauth_token": { | |
119 "description": "OAuth 2.0 token for the current user.", | |
120 "location": "query", | |
121 "type": "string" | |
122 } | 122 } |
123 }, | 123 }, |
124 "protocol": "rest", | 124 "protocol": "rest", |
125 "resources": { | 125 "resources": { |
126 "operations": { | 126 "operations": { |
127 "methods": { | 127 "methods": { |
128 "get": { | 128 "get": { |
129 "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.", | 129 "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.", |
130 "httpMethod": "GET", | 130 "httpMethod": "GET", |
131 "id": "servicemanagement.operations.get", | 131 "id": "servicemanagement.operations.get", |
(...skipping 17 matching lines...) Expand all Loading... |
149 "https://www.googleapis.com/auth/cloud-platform", | 149 "https://www.googleapis.com/auth/cloud-platform", |
150 "https://www.googleapis.com/auth/service.management" | 150 "https://www.googleapis.com/auth/service.management" |
151 ] | 151 ] |
152 }, | 152 }, |
153 "list": { | 153 "list": { |
154 "description": "Lists service operations that match the spec
ified filter in the request.", | 154 "description": "Lists service operations that match the spec
ified filter in the request.", |
155 "httpMethod": "GET", | 155 "httpMethod": "GET", |
156 "id": "servicemanagement.operations.list", | 156 "id": "servicemanagement.operations.list", |
157 "parameterOrder": [], | 157 "parameterOrder": [], |
158 "parameters": { | 158 "parameters": { |
| 159 "pageSize": { |
| 160 "description": "The maximum number of operations to
return. If unspecified, defaults to\n50. The maximum value is 100.", |
| 161 "format": "int32", |
| 162 "location": "query", |
| 163 "type": "integer" |
| 164 }, |
159 "filter": { | 165 "filter": { |
160 "description": "A string for filtering Operations.\n
The following filter fields are supported:\n\n * serviceName: Require
d. Only `=` operator is allowed.\n * startTime: The time this job was start
ed, in ISO 8601 format.\n Allowed operators are `>=`, `>`, `<=`, and `<`.\n
* status: Can be `done`, `in_progress`, or `failed`. Allowed\n operators
are `=`, and `!=`.\n\n Filter expression supports conjunction (AND) and disjun
ction (OR)\n logical operators. However, the serviceName restriction must be at
the\n top-level and can only be combined with other restrictions via the AND\n
logical operator.\n\n Examples:\n\n * `serviceName={some-service}.google
apis.com`\n * `serviceName={some-service}.googleapis.com AND startTime>=\"2017-
02-01\"`\n * `serviceName={some-service}.googleapis.com AND status=done`\n * `
serviceName={some-service}.googleapis.com AND (status=done OR startTime>=\"2017-
02-01\")`", | 166 "description": "A string for filtering Operations.\n
The following filter fields are supported:\n\n * serviceName: Require
d. Only `=` operator is allowed.\n * startTime: The time this job was start
ed, in ISO 8601 format.\n Allowed operators are `>=`, `>`, `<=`, and `<`.\n
* status: Can be `done`, `in_progress`, or `failed`. Allowed\n operators
are `=`, and `!=`.\n\n Filter expression supports conjunction (AND) and disjun
ction (OR)\n logical operators. However, the serviceName restriction must be at
the\n top-level and can only be combined with other restrictions via the AND\n
logical operator.\n\n Examples:\n\n * `serviceName={some-service}.google
apis.com`\n * `serviceName={some-service}.googleapis.com AND startTime>=\"2017-
02-01\"`\n * `serviceName={some-service}.googleapis.com AND status=done`\n * `
serviceName={some-service}.googleapis.com AND (status=done OR startTime>=\"2017-
02-01\")`", |
161 "location": "query", | 167 "location": "query", |
162 "type": "string" | 168 "type": "string" |
163 }, | 169 }, |
164 "pageToken": { | 170 "pageToken": { |
165 "description": "The standard list page token.", | 171 "description": "The standard list page token.", |
166 "location": "query", | 172 "location": "query", |
167 "type": "string" | 173 "type": "string" |
168 }, | 174 }, |
169 "name": { | 175 "name": { |
170 "description": "Not used.", | 176 "description": "Not used.", |
171 "location": "query", | 177 "location": "query", |
172 "type": "string" | 178 "type": "string" |
173 }, | |
174 "pageSize": { | |
175 "description": "The maximum number of operations to
return. If unspecified, defaults to\n50. The maximum value is 100.", | |
176 "format": "int32", | |
177 "location": "query", | |
178 "type": "integer" | |
179 } | 179 } |
180 }, | 180 }, |
181 "path": "v1/operations", | 181 "path": "v1/operations", |
182 "response": { | 182 "response": { |
183 "$ref": "ListOperationsResponse" | 183 "$ref": "ListOperationsResponse" |
184 }, | 184 }, |
185 "scopes": [ | 185 "scopes": [ |
186 "https://www.googleapis.com/auth/cloud-platform", | 186 "https://www.googleapis.com/auth/cloud-platform", |
187 "https://www.googleapis.com/auth/service.management" | 187 "https://www.googleapis.com/auth/service.management" |
188 ] | 188 ] |
(...skipping 110 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
299 "https://www.googleapis.com/auth/cloud-platform", | 299 "https://www.googleapis.com/auth/cloud-platform", |
300 "https://www.googleapis.com/auth/service.management" | 300 "https://www.googleapis.com/auth/service.management" |
301 ] | 301 ] |
302 }, | 302 }, |
303 "list": { | 303 "list": { |
304 "description": "Lists managed services.\n\nReturns all publi
c services. For authenticated users, also returns all\nservices the calling user
has \"servicemanagement.services.get\" permission\nfor.\n\n**BETA:** If the cal
ler specifies the `consumer_id`, it returns only the\nservices enabled on the co
nsumer. The `consumer_id` must have the format\nof \"project:{PROJECT-ID}\".", | 304 "description": "Lists managed services.\n\nReturns all publi
c services. For authenticated users, also returns all\nservices the calling user
has \"servicemanagement.services.get\" permission\nfor.\n\n**BETA:** If the cal
ler specifies the `consumer_id`, it returns only the\nservices enabled on the co
nsumer. The `consumer_id` must have the format\nof \"project:{PROJECT-ID}\".", |
305 "httpMethod": "GET", | 305 "httpMethod": "GET", |
306 "id": "servicemanagement.services.list", | 306 "id": "servicemanagement.services.list", |
307 "parameterOrder": [], | 307 "parameterOrder": [], |
308 "parameters": { | 308 "parameters": { |
309 "consumerId": { | |
310 "description": "Include services consumed by the spe
cified consumer.\n\nThe Google Service Management implementation accepts the fol
lowing\nforms:\n- project:<project_id>", | |
311 "location": "query", | |
312 "type": "string" | |
313 }, | |
314 "pageToken": { | |
315 "description": "Token identifying which result to st
art with; returned by a previous list\ncall.", | |
316 "location": "query", | |
317 "type": "string" | |
318 }, | |
319 "pageSize": { | 309 "pageSize": { |
320 "description": "Requested size of the next page of d
ata.", | 310 "description": "Requested size of the next page of d
ata.", |
321 "format": "int32", | 311 "format": "int32", |
322 "location": "query", | 312 "location": "query", |
323 "type": "integer" | 313 "type": "integer" |
324 }, | 314 }, |
325 "producerProjectId": { | 315 "producerProjectId": { |
326 "description": "Include services produced by the spe
cified project.", | 316 "description": "Include services produced by the spe
cified project.", |
327 "location": "query", | 317 "location": "query", |
328 "type": "string" | 318 "type": "string" |
| 319 }, |
| 320 "consumerId": { |
| 321 "description": "Include services consumed by the spe
cified consumer.\n\nThe Google Service Management implementation accepts the fol
lowing\nforms:\n- project:<project_id>", |
| 322 "location": "query", |
| 323 "type": "string" |
| 324 }, |
| 325 "pageToken": { |
| 326 "description": "Token identifying which result to st
art with; returned by a previous list\ncall.", |
| 327 "location": "query", |
| 328 "type": "string" |
329 } | 329 } |
330 }, | 330 }, |
331 "path": "v1/services", | 331 "path": "v1/services", |
332 "response": { | 332 "response": { |
333 "$ref": "ListServicesResponse" | 333 "$ref": "ListServicesResponse" |
334 }, | 334 }, |
335 "scopes": [ | 335 "scopes": [ |
336 "https://www.googleapis.com/auth/cloud-platform", | 336 "https://www.googleapis.com/auth/cloud-platform", |
337 "https://www.googleapis.com/auth/cloud-platform.read-onl
y", | 337 "https://www.googleapis.com/auth/cloud-platform.read-onl
y", |
338 "https://www.googleapis.com/auth/service.management", | 338 "https://www.googleapis.com/auth/service.management", |
(...skipping 178 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
517 "response": { | 517 "response": { |
518 "$ref": "Operation" | 518 "$ref": "Operation" |
519 }, | 519 }, |
520 "scopes": [ | 520 "scopes": [ |
521 "https://www.googleapis.com/auth/cloud-platform", | 521 "https://www.googleapis.com/auth/cloud-platform", |
522 "https://www.googleapis.com/auth/service.management" | 522 "https://www.googleapis.com/auth/service.management" |
523 ] | 523 ] |
524 } | 524 } |
525 }, | 525 }, |
526 "resources": { | 526 "resources": { |
527 "configs": { | 527 "rollouts": { |
528 "methods": { | 528 "methods": { |
529 "create": { | 529 "get": { |
530 "description": "Creates a new service configuration
(version) for a managed service.\nThis method only stores the service configurat
ion. To roll out the service\nconfiguration to backend systems please call\nCrea
teServiceRollout.", | 530 "description": "Gets a service configuration rollout
.", |
531 "httpMethod": "POST", | 531 "httpMethod": "GET", |
532 "id": "servicemanagement.services.configs.create", | 532 "id": "servicemanagement.services.rollouts.get", |
533 "parameterOrder": [ | 533 "parameterOrder": [ |
534 "serviceName" | 534 "serviceName", |
| 535 "rolloutId" |
535 ], | 536 ], |
536 "parameters": { | 537 "parameters": { |
537 "serviceName": { | 538 "serviceName": { |
538 "description": "The name of the service. Se
e the [overview](/service-management/overview)\nfor naming requirements. For ex
ample: `example.googleapis.com`.", | 539 "description": "The name of the service. Se
e the [overview](/service-management/overview)\nfor naming requirements. For ex
ample: `example.googleapis.com`.", |
539 "location": "path", | 540 "location": "path", |
540 "required": true, | 541 "required": true, |
541 "type": "string" | 542 "type": "string" |
| 543 }, |
| 544 "rolloutId": { |
| 545 "description": "The id of the rollout resour
ce.", |
| 546 "location": "path", |
| 547 "required": true, |
| 548 "type": "string" |
542 } | 549 } |
543 }, | 550 }, |
544 "path": "v1/services/{serviceName}/configs", | 551 "path": "v1/services/{serviceName}/rollouts/{rollout
Id}", |
545 "request": { | |
546 "$ref": "Service" | |
547 }, | |
548 "response": { | 552 "response": { |
549 "$ref": "Service" | 553 "$ref": "Rollout" |
550 }, | 554 }, |
551 "scopes": [ | 555 "scopes": [ |
552 "https://www.googleapis.com/auth/cloud-platform"
, | 556 "https://www.googleapis.com/auth/cloud-platform"
, |
553 "https://www.googleapis.com/auth/service.managem
ent" | 557 "https://www.googleapis.com/auth/cloud-platform.
read-only", |
| 558 "https://www.googleapis.com/auth/service.managem
ent", |
| 559 "https://www.googleapis.com/auth/service.managem
ent.readonly" |
554 ] | 560 ] |
555 }, | 561 }, |
556 "submit": { | 562 "list": { |
557 "description": "Creates a new service configuration
(version) for a managed service based\non\nuser-supplied configuration source fi
les (for example: OpenAPI\nSpecification). This method stores the source configu
rations as well as the\ngenerated service configuration. To rollout the service
configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperatio
n<response: SubmitConfigSourceResponse>", | 563 "description": "Lists the history of the service con
figuration rollouts for a managed\nservice, from the newest to the oldest.", |
558 "httpMethod": "POST", | 564 "httpMethod": "GET", |
559 "id": "servicemanagement.services.configs.submit", | 565 "id": "servicemanagement.services.rollouts.list", |
560 "parameterOrder": [ | 566 "parameterOrder": [ |
561 "serviceName" | 567 "serviceName" |
562 ], | 568 ], |
| 569 "parameters": { |
| 570 "filter": { |
| 571 "description": "Use `filter` to return subse
t of rollouts.\nThe following filters are supported:\n -- To limit the results
to only those in\n [status](google.api.servicemanagement.v1.RolloutStatus) '
SUCCESS',\n use filter='status=SUCCESS'\n -- To limit the results to those
in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'\n
or 'FAILED', use filter='status=CANCELLED OR status=FAILED'", |
| 572 "location": "query", |
| 573 "type": "string" |
| 574 }, |
| 575 "serviceName": { |
| 576 "description": "The name of the service. Se
e the [overview](/service-management/overview)\nfor naming requirements. For ex
ample: `example.googleapis.com`.", |
| 577 "location": "path", |
| 578 "required": true, |
| 579 "type": "string" |
| 580 }, |
| 581 "pageToken": { |
| 582 "description": "The token of the page to ret
rieve.", |
| 583 "location": "query", |
| 584 "type": "string" |
| 585 }, |
| 586 "pageSize": { |
| 587 "description": "The max number of items to i
nclude in the response list.", |
| 588 "format": "int32", |
| 589 "location": "query", |
| 590 "type": "integer" |
| 591 } |
| 592 }, |
| 593 "path": "v1/services/{serviceName}/rollouts", |
| 594 "response": { |
| 595 "$ref": "ListServiceRolloutsResponse" |
| 596 }, |
| 597 "scopes": [ |
| 598 "https://www.googleapis.com/auth/cloud-platform"
, |
| 599 "https://www.googleapis.com/auth/cloud-platform.
read-only", |
| 600 "https://www.googleapis.com/auth/service.managem
ent", |
| 601 "https://www.googleapis.com/auth/service.managem
ent.readonly" |
| 602 ] |
| 603 }, |
| 604 "create": { |
| 605 "description": "Creates a new service configuration
rollout. Based on rollout, the\nGoogle Service Management will roll out the serv
ice configurations to\ndifferent backend services. For example, the logging conf
iguration will be\npushed to Google Cloud Logging.\n\nPlease note that any previ
ous pending and running Rollouts and associated\nOperations will be automaticall
y cancelled so that the latest Rollout will\nnot be blocked by previous Rollouts
.\n\nOperation<response: Rollout>", |
| 606 "httpMethod": "POST", |
| 607 "id": "servicemanagement.services.rollouts.create", |
| 608 "parameterOrder": [ |
| 609 "serviceName" |
| 610 ], |
563 "parameters": { | 611 "parameters": { |
564 "serviceName": { | 612 "serviceName": { |
565 "description": "The name of the service. Se
e the [overview](/service-management/overview)\nfor naming requirements. For ex
ample: `example.googleapis.com`.", | 613 "description": "The name of the service. Se
e the [overview](/service-management/overview)\nfor naming requirements. For ex
ample: `example.googleapis.com`.", |
566 "location": "path", | 614 "location": "path", |
567 "required": true, | 615 "required": true, |
568 "type": "string" | 616 "type": "string" |
569 } | 617 } |
570 }, | 618 }, |
571 "path": "v1/services/{serviceName}/configs:submit", | 619 "path": "v1/services/{serviceName}/rollouts", |
572 "request": { | 620 "request": { |
573 "$ref": "SubmitConfigSourceRequest" | 621 "$ref": "Rollout" |
574 }, | 622 }, |
575 "response": { | 623 "response": { |
576 "$ref": "Operation" | 624 "$ref": "Operation" |
577 }, | 625 }, |
578 "scopes": [ | 626 "scopes": [ |
579 "https://www.googleapis.com/auth/cloud-platform"
, | 627 "https://www.googleapis.com/auth/cloud-platform"
, |
580 "https://www.googleapis.com/auth/service.managem
ent" | 628 "https://www.googleapis.com/auth/service.managem
ent" |
581 ] | 629 ] |
582 }, | 630 } |
| 631 } |
| 632 }, |
| 633 "configs": { |
| 634 "methods": { |
583 "get": { | 635 "get": { |
584 "description": "Gets a service configuration (versio
n) for a managed service.", | 636 "description": "Gets a service configuration (versio
n) for a managed service.", |
585 "httpMethod": "GET", | 637 "httpMethod": "GET", |
586 "id": "servicemanagement.services.configs.get", | 638 "id": "servicemanagement.services.configs.get", |
587 "parameterOrder": [ | 639 "parameterOrder": [ |
588 "serviceName", | 640 "serviceName", |
589 "configId" | 641 "configId" |
590 ], | 642 ], |
591 "parameters": { | 643 "parameters": { |
592 "view": { | 644 "view": { |
(...skipping 58 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
651 "path": "v1/services/{serviceName}/configs", | 703 "path": "v1/services/{serviceName}/configs", |
652 "response": { | 704 "response": { |
653 "$ref": "ListServiceConfigsResponse" | 705 "$ref": "ListServiceConfigsResponse" |
654 }, | 706 }, |
655 "scopes": [ | 707 "scopes": [ |
656 "https://www.googleapis.com/auth/cloud-platform"
, | 708 "https://www.googleapis.com/auth/cloud-platform"
, |
657 "https://www.googleapis.com/auth/cloud-platform.
read-only", | 709 "https://www.googleapis.com/auth/cloud-platform.
read-only", |
658 "https://www.googleapis.com/auth/service.managem
ent", | 710 "https://www.googleapis.com/auth/service.managem
ent", |
659 "https://www.googleapis.com/auth/service.managem
ent.readonly" | 711 "https://www.googleapis.com/auth/service.managem
ent.readonly" |
660 ] | 712 ] |
| 713 }, |
| 714 "create": { |
| 715 "description": "Creates a new service configuration
(version) for a managed service.\nThis method only stores the service configurat
ion. To roll out the service\nconfiguration to backend systems please call\nCrea
teServiceRollout.", |
| 716 "httpMethod": "POST", |
| 717 "id": "servicemanagement.services.configs.create", |
| 718 "parameterOrder": [ |
| 719 "serviceName" |
| 720 ], |
| 721 "parameters": { |
| 722 "serviceName": { |
| 723 "description": "The name of the service. Se
e the [overview](/service-management/overview)\nfor naming requirements. For ex
ample: `example.googleapis.com`.", |
| 724 "location": "path", |
| 725 "required": true, |
| 726 "type": "string" |
| 727 } |
| 728 }, |
| 729 "path": "v1/services/{serviceName}/configs", |
| 730 "request": { |
| 731 "$ref": "Service" |
| 732 }, |
| 733 "response": { |
| 734 "$ref": "Service" |
| 735 }, |
| 736 "scopes": [ |
| 737 "https://www.googleapis.com/auth/cloud-platform"
, |
| 738 "https://www.googleapis.com/auth/service.managem
ent" |
| 739 ] |
| 740 }, |
| 741 "submit": { |
| 742 "description": "Creates a new service configuration
(version) for a managed service based\non\nuser-supplied configuration source fi
les (for example: OpenAPI\nSpecification). This method stores the source configu
rations as well as the\ngenerated service configuration. To rollout the service
configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperatio
n<response: SubmitConfigSourceResponse>", |
| 743 "httpMethod": "POST", |
| 744 "id": "servicemanagement.services.configs.submit", |
| 745 "parameterOrder": [ |
| 746 "serviceName" |
| 747 ], |
| 748 "parameters": { |
| 749 "serviceName": { |
| 750 "description": "The name of the service. Se
e the [overview](/service-management/overview)\nfor naming requirements. For ex
ample: `example.googleapis.com`.", |
| 751 "location": "path", |
| 752 "required": true, |
| 753 "type": "string" |
| 754 } |
| 755 }, |
| 756 "path": "v1/services/{serviceName}/configs:submit", |
| 757 "request": { |
| 758 "$ref": "SubmitConfigSourceRequest" |
| 759 }, |
| 760 "response": { |
| 761 "$ref": "Operation" |
| 762 }, |
| 763 "scopes": [ |
| 764 "https://www.googleapis.com/auth/cloud-platform"
, |
| 765 "https://www.googleapis.com/auth/service.managem
ent" |
| 766 ] |
661 } | 767 } |
662 } | 768 } |
663 }, | 769 }, |
664 "consumers": { | 770 "consumers": { |
665 "methods": { | 771 "methods": { |
666 "getIamPolicy": { | |
667 "description": "Gets the access control policy for a
resource.\nReturns an empty policy if the resource exists and does not have a p
olicy\nset.", | |
668 "httpMethod": "POST", | |
669 "id": "servicemanagement.services.consumers.getIamPo
licy", | |
670 "parameterOrder": [ | |
671 "resource" | |
672 ], | |
673 "parameters": { | |
674 "resource": { | |
675 "description": "REQUIRED: The resource for w
hich the policy is being requested.\nSee the operation documentation for the app
ropriate value for this field.", | |
676 "location": "path", | |
677 "pattern": "^services/[^/]+/consumers/[^/]+$
", | |
678 "required": true, | |
679 "type": "string" | |
680 } | |
681 }, | |
682 "path": "v1/{+resource}:getIamPolicy", | |
683 "request": { | |
684 "$ref": "GetIamPolicyRequest" | |
685 }, | |
686 "response": { | |
687 "$ref": "Policy" | |
688 }, | |
689 "scopes": [ | |
690 "https://www.googleapis.com/auth/cloud-platform"
, | |
691 "https://www.googleapis.com/auth/cloud-platform.
read-only", | |
692 "https://www.googleapis.com/auth/service.managem
ent", | |
693 "https://www.googleapis.com/auth/service.managem
ent.readonly" | |
694 ] | |
695 }, | |
696 "setIamPolicy": { | |
697 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", | |
698 "httpMethod": "POST", | |
699 "id": "servicemanagement.services.consumers.setIamPo
licy", | |
700 "parameterOrder": [ | |
701 "resource" | |
702 ], | |
703 "parameters": { | |
704 "resource": { | |
705 "description": "REQUIRED: The resource for w
hich the policy is being specified.\nSee the operation documentation for the app
ropriate value for this field.", | |
706 "location": "path", | |
707 "pattern": "^services/[^/]+/consumers/[^/]+$
", | |
708 "required": true, | |
709 "type": "string" | |
710 } | |
711 }, | |
712 "path": "v1/{+resource}:setIamPolicy", | |
713 "request": { | |
714 "$ref": "SetIamPolicyRequest" | |
715 }, | |
716 "response": { | |
717 "$ref": "Policy" | |
718 }, | |
719 "scopes": [ | |
720 "https://www.googleapis.com/auth/cloud-platform"
, | |
721 "https://www.googleapis.com/auth/service.managem
ent" | |
722 ] | |
723 }, | |
724 "testIamPermissions": { | 772 "testIamPermissions": { |
725 "description": "Returns permissions that a caller ha
s on the specified resource.\nIf the resource does not exist, this will return a
n empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is d
esigned to be used for building permission-aware\nUIs and command-line tools, no
t for authorization checking. This operation\nmay \"fail open\" without warning.
", | 773 "description": "Returns permissions that a caller ha
s on the specified resource.\nIf the resource does not exist, this will return a
n empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is d
esigned to be used for building permission-aware\nUIs and command-line tools, no
t for authorization checking. This operation\nmay \"fail open\" without warning.
", |
726 "httpMethod": "POST", | 774 "httpMethod": "POST", |
727 "id": "servicemanagement.services.consumers.testIamP
ermissions", | 775 "id": "servicemanagement.services.consumers.testIamP
ermissions", |
728 "parameterOrder": [ | 776 "parameterOrder": [ |
729 "resource" | 777 "resource" |
730 ], | 778 ], |
731 "parameters": { | 779 "parameters": { |
732 "resource": { | 780 "resource": { |
733 "description": "REQUIRED: The resource for w
hich the policy detail is being requested.\nSee the operation documentation for
the appropriate value for this field.", | 781 "description": "REQUIRED: The resource for w
hich the policy detail is being requested.\nSee the operation documentation for
the appropriate value for this field.", |
734 "location": "path", | 782 "location": "path", |
735 "pattern": "^services/[^/]+/consumers/[^/]+$
", | 783 "pattern": "^services/[^/]+/consumers/[^/]+$
", |
736 "required": true, | 784 "required": true, |
737 "type": "string" | 785 "type": "string" |
738 } | 786 } |
739 }, | 787 }, |
740 "path": "v1/{+resource}:testIamPermissions", | 788 "path": "v1/{+resource}:testIamPermissions", |
741 "request": { | 789 "request": { |
742 "$ref": "TestIamPermissionsRequest" | 790 "$ref": "TestIamPermissionsRequest" |
743 }, | 791 }, |
744 "response": { | 792 "response": { |
745 "$ref": "TestIamPermissionsResponse" | 793 "$ref": "TestIamPermissionsResponse" |
746 }, | 794 }, |
747 "scopes": [ | 795 "scopes": [ |
748 "https://www.googleapis.com/auth/cloud-platform"
, | 796 "https://www.googleapis.com/auth/cloud-platform"
, |
749 "https://www.googleapis.com/auth/cloud-platform.
read-only", | 797 "https://www.googleapis.com/auth/cloud-platform.
read-only", |
750 "https://www.googleapis.com/auth/service.managem
ent", | 798 "https://www.googleapis.com/auth/service.managem
ent", |
751 "https://www.googleapis.com/auth/service.managem
ent.readonly" | 799 "https://www.googleapis.com/auth/service.managem
ent.readonly" |
752 ] | 800 ] |
753 } | 801 }, |
754 } | 802 "getIamPolicy": { |
755 }, | 803 "description": "Gets the access control policy for a
resource.\nReturns an empty policy if the resource exists and does not have a p
olicy\nset.", |
756 "rollouts": { | 804 "httpMethod": "POST", |
757 "methods": { | 805 "id": "servicemanagement.services.consumers.getIamPo
licy", |
758 "get": { | |
759 "description": "Gets a service configuration rollout
.", | |
760 "httpMethod": "GET", | |
761 "id": "servicemanagement.services.rollouts.get", | |
762 "parameterOrder": [ | 806 "parameterOrder": [ |
763 "serviceName", | 807 "resource" |
764 "rolloutId" | |
765 ], | 808 ], |
766 "parameters": { | 809 "parameters": { |
767 "serviceName": { | 810 "resource": { |
768 "description": "The name of the service. Se
e the [overview](/service-management/overview)\nfor naming requirements. For ex
ample: `example.googleapis.com`.", | 811 "description": "REQUIRED: The resource for w
hich the policy is being requested.\nSee the operation documentation for the app
ropriate value for this field.", |
769 "location": "path", | 812 "location": "path", |
770 "required": true, | 813 "pattern": "^services/[^/]+/consumers/[^/]+$
", |
771 "type": "string" | |
772 }, | |
773 "rolloutId": { | |
774 "description": "The id of the rollout resour
ce.", | |
775 "location": "path", | |
776 "required": true, | 814 "required": true, |
777 "type": "string" | 815 "type": "string" |
778 } | 816 } |
779 }, | 817 }, |
780 "path": "v1/services/{serviceName}/rollouts/{rollout
Id}", | 818 "path": "v1/{+resource}:getIamPolicy", |
| 819 "request": { |
| 820 "$ref": "GetIamPolicyRequest" |
| 821 }, |
781 "response": { | 822 "response": { |
782 "$ref": "Rollout" | 823 "$ref": "Policy" |
783 }, | 824 }, |
784 "scopes": [ | 825 "scopes": [ |
785 "https://www.googleapis.com/auth/cloud-platform"
, | 826 "https://www.googleapis.com/auth/cloud-platform"
, |
786 "https://www.googleapis.com/auth/cloud-platform.
read-only", | |
787 "https://www.googleapis.com/auth/service.managem
ent", | |
788 "https://www.googleapis.com/auth/service.managem
ent.readonly" | |
789 ] | |
790 }, | |
791 "list": { | |
792 "description": "Lists the history of the service con
figuration rollouts for a managed\nservice, from the newest to the oldest.", | |
793 "httpMethod": "GET", | |
794 "id": "servicemanagement.services.rollouts.list", | |
795 "parameterOrder": [ | |
796 "serviceName" | |
797 ], | |
798 "parameters": { | |
799 "filter": { | |
800 "description": "Use `filter` to return subse
t of rollouts.\nThe following filters are supported:\n -- To limit the results
to only those in\n [status](google.api.servicemanagement.v1.RolloutStatus) '
SUCCESS',\n use filter='status=SUCCESS'\n -- To limit the results to those
in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'\n
or 'FAILED', use filter='status=CANCELLED OR status=FAILED'", | |
801 "location": "query", | |
802 "type": "string" | |
803 }, | |
804 "serviceName": { | |
805 "description": "The name of the service. Se
e the [overview](/service-management/overview)\nfor naming requirements. For ex
ample: `example.googleapis.com`.", | |
806 "location": "path", | |
807 "required": true, | |
808 "type": "string" | |
809 }, | |
810 "pageToken": { | |
811 "description": "The token of the page to ret
rieve.", | |
812 "location": "query", | |
813 "type": "string" | |
814 }, | |
815 "pageSize": { | |
816 "description": "The max number of items to i
nclude in the response list.", | |
817 "format": "int32", | |
818 "location": "query", | |
819 "type": "integer" | |
820 } | |
821 }, | |
822 "path": "v1/services/{serviceName}/rollouts", | |
823 "response": { | |
824 "$ref": "ListServiceRolloutsResponse" | |
825 }, | |
826 "scopes": [ | |
827 "https://www.googleapis.com/auth/cloud-platform"
, | |
828 "https://www.googleapis.com/auth/cloud-platform.
read-only", | 827 "https://www.googleapis.com/auth/cloud-platform.
read-only", |
829 "https://www.googleapis.com/auth/service.managem
ent", | 828 "https://www.googleapis.com/auth/service.managem
ent", |
830 "https://www.googleapis.com/auth/service.managem
ent.readonly" | 829 "https://www.googleapis.com/auth/service.managem
ent.readonly" |
831 ] | 830 ] |
832 }, | 831 }, |
833 "create": { | 832 "setIamPolicy": { |
834 "description": "Creates a new service configuration
rollout. Based on rollout, the\nGoogle Service Management will roll out the serv
ice configurations to\ndifferent backend services. For example, the logging conf
iguration will be\npushed to Google Cloud Logging.\n\nPlease note that any previ
ous pending and running Rollouts and associated\nOperations will be automaticall
y cancelled so that the latest Rollout will\nnot be blocked by previous Rollouts
.\n\nOperation<response: Rollout>", | 833 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", |
835 "httpMethod": "POST", | 834 "httpMethod": "POST", |
836 "id": "servicemanagement.services.rollouts.create", | 835 "id": "servicemanagement.services.consumers.setIamPo
licy", |
837 "parameterOrder": [ | 836 "parameterOrder": [ |
838 "serviceName" | 837 "resource" |
839 ], | 838 ], |
840 "parameters": { | 839 "parameters": { |
841 "serviceName": { | 840 "resource": { |
842 "description": "The name of the service. Se
e the [overview](/service-management/overview)\nfor naming requirements. For ex
ample: `example.googleapis.com`.", | 841 "description": "REQUIRED: The resource for w
hich the policy is being specified.\nSee the operation documentation for the app
ropriate value for this field.", |
843 "location": "path", | 842 "location": "path", |
| 843 "pattern": "^services/[^/]+/consumers/[^/]+$
", |
844 "required": true, | 844 "required": true, |
845 "type": "string" | 845 "type": "string" |
846 } | 846 } |
847 }, | 847 }, |
848 "path": "v1/services/{serviceName}/rollouts", | 848 "path": "v1/{+resource}:setIamPolicy", |
849 "request": { | 849 "request": { |
850 "$ref": "Rollout" | 850 "$ref": "SetIamPolicyRequest" |
851 }, | 851 }, |
852 "response": { | 852 "response": { |
853 "$ref": "Operation" | 853 "$ref": "Policy" |
854 }, | 854 }, |
855 "scopes": [ | 855 "scopes": [ |
856 "https://www.googleapis.com/auth/cloud-platform"
, | 856 "https://www.googleapis.com/auth/cloud-platform"
, |
857 "https://www.googleapis.com/auth/service.managem
ent" | 857 "https://www.googleapis.com/auth/service.managem
ent" |
858 ] | 858 ] |
859 } | 859 } |
860 } | 860 } |
861 } | 861 } |
862 } | 862 } |
863 } | 863 } |
864 }, | 864 }, |
865 "revision": "20170717", | 865 "revision": "20170811", |
866 "rootUrl": "https://servicemanagement.googleapis.com/", | 866 "rootUrl": "https://servicemanagement.googleapis.com/", |
867 "schemas": { | 867 "schemas": { |
868 "GenerateConfigReportRequest": { | |
869 "description": "Request message for GenerateConfigReport method.", | |
870 "id": "GenerateConfigReportRequest", | |
871 "properties": { | |
872 "newConfig": { | |
873 "additionalProperties": { | |
874 "description": "Properties of the object. Contains field
@type with type URL.", | |
875 "type": "any" | |
876 }, | |
877 "description": "Service configuration for which we want to g
enerate the report.\nFor this version of API, the supported types are\ngoogle.ap
i.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,
\nand google.api.Service", | |
878 "type": "object" | |
879 }, | |
880 "oldConfig": { | |
881 "additionalProperties": { | |
882 "description": "Properties of the object. Contains field
@type with type URL.", | |
883 "type": "any" | |
884 }, | |
885 "description": "Service configuration against which the comp
arison will be done.\nFor this version of API, the supported types are\ngoogle.a
pi.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource
,\nand google.api.Service", | |
886 "type": "object" | |
887 } | |
888 }, | |
889 "type": "object" | |
890 }, | |
891 "SetIamPolicyRequest": { | |
892 "description": "Request message for `SetIamPolicy` method.", | |
893 "id": "SetIamPolicyRequest", | |
894 "properties": { | |
895 "policy": { | |
896 "$ref": "Policy", | |
897 "description": "REQUIRED: The complete policy to be applied
to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An emp
ty policy is a\nvalid policy but certain Cloud Platform services (such as Projec
ts)\nmight reject them." | |
898 }, | |
899 "updateMask": { | |
900 "description": "OPTIONAL: A FieldMask specifying which field
s of the policy to modify. Only\nthe fields in the mask will be modified. If no
mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\
"\nThis field is only used by Cloud IAM.", | |
901 "format": "google-fieldmask", | |
902 "type": "string" | |
903 } | |
904 }, | |
905 "type": "object" | |
906 }, | |
907 "Step": { | |
908 "description": "Represents the status of one operation step.", | |
909 "id": "Step", | |
910 "properties": { | |
911 "status": { | |
912 "description": "The status code.", | |
913 "enum": [ | |
914 "STATUS_UNSPECIFIED", | |
915 "DONE", | |
916 "NOT_STARTED", | |
917 "IN_PROGRESS", | |
918 "FAILED", | |
919 "CANCELLED" | |
920 ], | |
921 "enumDescriptions": [ | |
922 "Unspecifed code.", | |
923 "The operation or step has completed without errors.", | |
924 "The operation or step has not started yet.", | |
925 "The operation or step is in progress.", | |
926 "The operation or step has completed with errors. If the
operation is\nrollbackable, the rollback completed with errors too.", | |
927 "The operation or step has completed with cancellation." | |
928 ], | |
929 "type": "string" | |
930 }, | |
931 "description": { | |
932 "description": "The short description of the step.", | |
933 "type": "string" | |
934 } | |
935 }, | |
936 "type": "object" | |
937 }, | |
938 "DeleteServiceStrategy": { | |
939 "description": "Strategy used to delete a service. This strategy is
a placeholder only\nused by the system generated rollout to delete a service.", | |
940 "id": "DeleteServiceStrategy", | |
941 "properties": {}, | |
942 "type": "object" | |
943 }, | |
944 "LoggingDestination": { | |
945 "description": "Configuration of a specific logging destination (the
producer project\nor the consumer project).", | |
946 "id": "LoggingDestination", | |
947 "properties": { | |
948 "logs": { | |
949 "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 \"/\".", | |
950 "items": { | |
951 "type": "string" | |
952 }, | |
953 "type": "array" | |
954 }, | |
955 "monitoredResource": { | |
956 "description": "The monitored resource type. The type must b
e defined in the\nService.monitored_resources section.", | |
957 "type": "string" | |
958 } | |
959 }, | |
960 "type": "object" | |
961 }, | |
962 "Option": { | |
963 "description": "A protocol buffer option, which can be attached to a
message, field,\nenumeration, etc.", | |
964 "id": "Option", | |
965 "properties": { | |
966 "value": { | |
967 "additionalProperties": { | |
968 "description": "Properties of the object. Contains field
@type with type URL.", | |
969 "type": "any" | |
970 }, | |
971 "description": "The option's value packed in an Any message.
If the value is a primitive,\nthe corresponding wrapper type defined in google/
protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be s
tored as an int32\nvalue using the google.protobuf.Int32Value type.", | |
972 "type": "object" | |
973 }, | |
974 "name": { | |
975 "description": "The option's name. For protobuf built-in opt
ions (options defined in\ndescriptor.proto), this is the short name. For example
, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. F
or example,\n`\"google.api.http\"`.", | |
976 "type": "string" | |
977 } | |
978 }, | |
979 "type": "object" | |
980 }, | |
981 "Logging": { | |
982 "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", | |
983 "id": "Logging", | |
984 "properties": { | |
985 "producerDestinations": { | |
986 "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.", | |
987 "items": { | |
988 "$ref": "LoggingDestination" | |
989 }, | |
990 "type": "array" | |
991 }, | |
992 "consumerDestinations": { | |
993 "description": "Logging configurations for sending logs to t
he consumer project.\nThere can be multiple consumer destinations, each one must
have a\ndifferent monitored resource type. A log can be used in at most\none co
nsumer destination.", | |
994 "items": { | |
995 "$ref": "LoggingDestination" | |
996 }, | |
997 "type": "array" | |
998 } | |
999 }, | |
1000 "type": "object" | |
1001 }, | |
1002 "Method": { | |
1003 "description": "Method represents a method of an api.", | |
1004 "id": "Method", | |
1005 "properties": { | |
1006 "name": { | |
1007 "description": "The simple name of this method.", | |
1008 "type": "string" | |
1009 }, | |
1010 "requestTypeUrl": { | |
1011 "description": "A URL of the input message type.", | |
1012 "type": "string" | |
1013 }, | |
1014 "requestStreaming": { | |
1015 "description": "If true, the request is streamed.", | |
1016 "type": "boolean" | |
1017 }, | |
1018 "syntax": { | |
1019 "description": "The source syntax of this method.", | |
1020 "enum": [ | |
1021 "SYNTAX_PROTO2", | |
1022 "SYNTAX_PROTO3" | |
1023 ], | |
1024 "enumDescriptions": [ | |
1025 "Syntax `proto2`.", | |
1026 "Syntax `proto3`." | |
1027 ], | |
1028 "type": "string" | |
1029 }, | |
1030 "responseTypeUrl": { | |
1031 "description": "The URL of the output message type.", | |
1032 "type": "string" | |
1033 }, | |
1034 "options": { | |
1035 "description": "Any metadata attached to the method.", | |
1036 "items": { | |
1037 "$ref": "Option" | |
1038 }, | |
1039 "type": "array" | |
1040 }, | |
1041 "responseStreaming": { | |
1042 "description": "If true, the response is streamed.", | |
1043 "type": "boolean" | |
1044 } | |
1045 }, | |
1046 "type": "object" | |
1047 }, | |
1048 "QuotaLimit": { | |
1049 "description": "`QuotaLimit` defines a specific limit that applies o
ver a specified duration\nfor a limit type. There can be at most one limit for a
duration and limit\ntype combination defined within a `QuotaGroup`.", | |
1050 "id": "QuotaLimit", | |
1051 "properties": { | |
1052 "unit": { | |
1053 "description": "Specify the unit of the quota limit. It uses
the same syntax as\nMetric.unit. The supported unit kinds are determined by the
quota\nbackend system.\n\nThe [Google Service Control](https://cloud.google.com
/service-control)\nsupports the following unit components:\n* One of the time in
tevals:\n * \"/min\" for quota every minute.\n * \"/d\" for quota every 24 h
ours, starting 00:00 US Pacific Time.\n * Otherwise the quota won't be reset by
time, such as storage limit.\n* One and only one of the granted containers:\n
* \"/{project}\" quota for a project\n\nHere are some examples:\n* \"1/min/{proj
ect}\" for quota per minute per project.\n\nNote: the order of unit components i
s insignificant.\nThe \"1\" at the beginning is required to follow the metric un
it syntax.\n\nUsed by metric-based quotas only.", | |
1054 "type": "string" | |
1055 }, | |
1056 "maxLimit": { | |
1057 "description": "Maximum number of tokens that can be consume
d during the specified\nduration. Client application developers can override the
default limit up\nto this maximum. If specified, this value cannot be set to a
value less\nthan the default limit. If not specified, it is set to the default l
imit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1
,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.", | |
1058 "format": "int64", | |
1059 "type": "string" | |
1060 }, | |
1061 "name": { | |
1062 "description": "Name of the quota limit. The name is used to
refer to the limit when\noverriding the default limit on per-consumer basis.\n\
nFor metric-based quota limits, the name must be provided, and it must be\nuniqu
e within the service. The name can only include alphanumeric\ncharacters as well
as '-'.\n\nThe maximum length of the limit name is 64 characters.\n\nThe name o
f a limit is used as a unique identifier for this limit.\nTherefore, once a limi
t has been put into use, its name should be\nimmutable. You can use the display_
name field to provide a user-friendly\nname for the limit. The display name can
be evolved over time without\naffecting the identity of the limit.", | |
1063 "type": "string" | |
1064 }, | |
1065 "freeTier": { | |
1066 "description": "Free tier value displayed in the Developers
Console for this limit.\nThe free tier is the number of tokens that will be subt
racted from the\nbilled amount when billing is enabled.\nThis field can only be
set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any
other limit. If this field is not set, it\ndefaults to 0, indicating that there
is no free tier for this service.\n\nUsed by group-based quotas only.", | |
1067 "format": "int64", | |
1068 "type": "string" | |
1069 }, | |
1070 "duration": { | |
1071 "description": "Duration of this limit in textual notation.
Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multip
le of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additiona
l support will be added in\nthe future. \"0\" indicates indefinite duration.\n\n
Used by group-based quotas only.", | |
1072 "type": "string" | |
1073 }, | |
1074 "defaultLimit": { | |
1075 "description": "Default number of tokens that can be consume
d during the specified\nduration. This is the number of tokens assigned when a c
lient\napplication developer activates the service for his/her project.\n\nSpeci
fying a value of 0 will block all requests. This can be used if you\nare provisi
oning quota to selected consumers and blocking others.\nSimilarly, a value of -1
will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUse
d by group-based quotas only.", | |
1076 "format": "int64", | |
1077 "type": "string" | |
1078 }, | |
1079 "description": { | |
1080 "description": "Optional. User-visible, extended description
for this quota limit.\nShould be used only when more context is needed to under
stand this limit\nthan provided by the limit's display name (see: `display_name`
).", | |
1081 "type": "string" | |
1082 }, | |
1083 "displayName": { | |
1084 "description": "User-visible display name for this limit.\nO
ptional. If not set, the UI will provide a default display name based on\nthe qu
ota configuration. This field can be used to override the default\ndisplay name
generated from the configuration.", | |
1085 "type": "string" | |
1086 }, | |
1087 "metric": { | |
1088 "description": "The name of the metric this quota limit appl
ies to. The quota limits with\nthe same metric will be checked together during r
untime. The metric must be\ndefined within the service config.\n\nUsed by metric
-based quotas only.", | |
1089 "type": "string" | |
1090 }, | |
1091 "values": { | |
1092 "additionalProperties": { | |
1093 "format": "int64", | |
1094 "type": "string" | |
1095 }, | |
1096 "description": "Tiered limit values, currently only STANDARD
is supported.", | |
1097 "type": "object" | |
1098 } | |
1099 }, | |
1100 "type": "object" | |
1101 }, | |
1102 "ConfigRef": { | |
1103 "description": "Represents a service configuration with its name and
id.", | |
1104 "id": "ConfigRef", | |
1105 "properties": { | |
1106 "name": { | |
1107 "description": "Resource name of a service config. It must h
ave the following\nformat: \"services/{service name}/configs/{config id}\".", | |
1108 "type": "string" | |
1109 } | |
1110 }, | |
1111 "type": "object" | |
1112 }, | |
1113 "ListServiceRolloutsResponse": { | |
1114 "description": "Response message for ListServiceRollouts method.", | |
1115 "id": "ListServiceRolloutsResponse", | |
1116 "properties": { | |
1117 "nextPageToken": { | |
1118 "description": "The token of the next page of results.", | |
1119 "type": "string" | |
1120 }, | |
1121 "rollouts": { | |
1122 "description": "The list of rollout resources.", | |
1123 "items": { | |
1124 "$ref": "Rollout" | |
1125 }, | |
1126 "type": "array" | |
1127 } | |
1128 }, | |
1129 "type": "object" | |
1130 }, | |
1131 "Mixin": { | |
1132 "description": "Declares an API to be included in this API. The incl
uding API must\nredeclare all the methods from the included API, but documentati
on\nand options are inherited as follows:\n\n- If after comment and whitespace s
tripping, the documentation\n string of the redeclared method is empty, it will
be inherited\n from the original method.\n\n- Each annotation belonging to the
service config (http,\n visibility) which is not set in the redeclared method
will be\n inherited.\n\n- If an http annotation is inherited, the path pattern
will be\n modified as follows. Any version prefix will be replaced by the\n ve
rsion of the including API plus the root path if specified.\n\nExample of a simp
le mixin:\n\n package google.acl.v1;\n service AccessControl {\n // G
et the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n
option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n
}\n\n package google.storage.v2;\n service Storage {\n // rp
c GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc
GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get
= \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\
n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name:
google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in `
AccessControl` are\nalso declared with same name and request/response types in\n
`Storage`. A documentation generator or annotation processor will\nsee the effec
tive `Storage.GetAcl` method after inherting\ndocumentation and annotations as f
ollows:\n\n service Storage {\n // Get the underlying ACL object.\n
rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get
= \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the vers
ion in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the
mixin is specified, it should be a\nrelative path under which inherited HTTP pa
ths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n
mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nTh
is implies the following inherited HTTP annotation:\n\n service Storage {\n
// Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (
Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"
;\n }\n ...\n }", | |
1133 "id": "Mixin", | |
1134 "properties": { | |
1135 "name": { | |
1136 "description": "The fully qualified name of the API which is
included.", | |
1137 "type": "string" | |
1138 }, | |
1139 "root": { | |
1140 "description": "If non-empty specifies a path under which in
herited HTTP paths\nare rooted.", | |
1141 "type": "string" | |
1142 } | |
1143 }, | |
1144 "type": "object" | |
1145 }, | |
1146 "FlowOperationMetadata": { | |
1147 "description": "The metadata associated with a long running operatio
n resource.", | |
1148 "id": "FlowOperationMetadata", | |
1149 "properties": { | |
1150 "resourceNames": { | |
1151 "description": "The full name of the resources that this flo
w is directly associated with.", | |
1152 "items": { | |
1153 "type": "string" | |
1154 }, | |
1155 "type": "array" | |
1156 }, | |
1157 "flowName": { | |
1158 "description": "The name of the top-level flow corresponding
to this operation.\nMust be equal to the \"name\" field for a FlowName enum.", | |
1159 "type": "string" | |
1160 }, | |
1161 "deadline": { | |
1162 "description": "Deadline for the flow to complete, to preven
t orphaned Operations.\n\nIf the flow has not completed by this time, it may be
terminated by\nthe engine, or force-failed by Operation lookup.\n\nNote that thi
s is not a hard deadline after which the Flow will\ndefinitely be failed, rather
it is a deadline after which it is reasonable\nto suspect a problem and other p
arts of the system may kill operation\nto ensure we don't have orphans.\nsee als
o: go/prevent-orphaned-operations", | |
1163 "format": "google-datetime", | |
1164 "type": "string" | |
1165 }, | |
1166 "cancelState": { | |
1167 "description": "The state of the operation with respect to c
ancellation.", | |
1168 "enum": [ | |
1169 "RUNNING", | |
1170 "UNCANCELLABLE", | |
1171 "CANCELLED" | |
1172 ], | |
1173 "enumDescriptions": [ | |
1174 "Default state, cancellable but not cancelled.", | |
1175 "The operation has proceeded past the point of no return
and cannot\nbe cancelled.", | |
1176 "The operation has been cancelled, work should cease\nan
d any needed rollback steps executed." | |
1177 ], | |
1178 "type": "string" | |
1179 }, | |
1180 "startTime": { | |
1181 "description": "The start time of the operation.", | |
1182 "format": "google-datetime", | |
1183 "type": "string" | |
1184 } | |
1185 }, | |
1186 "type": "object" | |
1187 }, | |
1188 "CustomError": { | |
1189 "description": "Customize service error responses. For example, lis
t any service\nspecific protobuf types that can appear in error detail lists of\
nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google
.foo.v1.CustomError\n - google.foo.v1.AnotherError", | |
1190 "id": "CustomError", | |
1191 "properties": { | |
1192 "types": { | |
1193 "description": "The list of custom error detail types, e.g.
'google.foo.v1.CustomError'.", | |
1194 "items": { | |
1195 "type": "string" | |
1196 }, | |
1197 "type": "array" | |
1198 }, | |
1199 "rules": { | |
1200 "description": "The list of custom error rules that apply to
individual API messages.\n\n**NOTE:** All service configuration rules follow \"
last one wins\" order.", | |
1201 "items": { | |
1202 "$ref": "CustomErrorRule" | |
1203 }, | |
1204 "type": "array" | |
1205 } | |
1206 }, | |
1207 "type": "object" | |
1208 }, | |
1209 "CounterOptions": { | |
1210 "description": "Options for counters", | |
1211 "id": "CounterOptions", | |
1212 "properties": { | |
1213 "field": { | |
1214 "description": "The field value to attribute.", | |
1215 "type": "string" | |
1216 }, | |
1217 "metric": { | |
1218 "description": "The metric to update.", | |
1219 "type": "string" | |
1220 } | |
1221 }, | |
1222 "type": "object" | |
1223 }, | |
1224 "Http": { | |
1225 "description": "Defines the HTTP configuration for an API service. I
t contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto
one or more HTTP REST API methods.", | |
1226 "id": "Http", | |
1227 "properties": { | |
1228 "rules": { | |
1229 "description": "A list of HTTP configuration rules that appl
y to individual API methods.\n\n**NOTE:** All service configuration rules follow
\"last one wins\" order.", | |
1230 "items": { | |
1231 "$ref": "HttpRule" | |
1232 }, | |
1233 "type": "array" | |
1234 }, | |
1235 "fullyDecodeReservedExpansion": { | |
1236 "description": "When set to true, URL path parmeters will be
fully URI-decoded except in\ncases of single segment matches in reserved expans
ion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not deco
de RFC 6570 reserved characters in multi\nsegment matches.", | |
1237 "type": "boolean" | |
1238 } | |
1239 }, | |
1240 "type": "object" | |
1241 }, | |
1242 "SourceInfo": { | |
1243 "description": "Source information used to create a Service Config", | |
1244 "id": "SourceInfo", | |
1245 "properties": { | |
1246 "sourceFiles": { | |
1247 "description": "All files used during config generation.", | |
1248 "items": { | |
1249 "additionalProperties": { | |
1250 "description": "Properties of the object. Contains f
ield @type with type URL.", | |
1251 "type": "any" | |
1252 }, | |
1253 "type": "object" | |
1254 }, | |
1255 "type": "array" | |
1256 } | |
1257 }, | |
1258 "type": "object" | |
1259 }, | |
1260 "Control": { | 868 "Control": { |
1261 "description": "Selects and configures the service controller used b
y the service. The\nservice controller handles features like abuse, quota, bill
ing, logging,\nmonitoring, etc.", | 869 "description": "Selects and configures the service controller used b
y the service. The\nservice controller handles features like abuse, quota, bill
ing, logging,\nmonitoring, etc.", |
1262 "id": "Control", | 870 "id": "Control", |
1263 "properties": { | 871 "properties": { |
1264 "environment": { | 872 "environment": { |
1265 "description": "The service control environment to use. If e
mpty, no control plane\nfeature (like quota and billing) will be enabled.", | 873 "description": "The service control environment to use. If e
mpty, no control plane\nfeature (like quota and billing) will be enabled.", |
1266 "type": "string" | 874 "type": "string" |
1267 } | 875 } |
1268 }, | 876 }, |
1269 "type": "object" | 877 "type": "object" |
1270 }, | 878 }, |
1271 "SystemParameter": { | 879 "SystemParameter": { |
1272 "description": "Define a parameter's name and location. The paramete
r may be passed as either\nan HTTP header or a URL query parameter, and if both
are passed the behavior\nis implementation-dependent.", | 880 "description": "Define a parameter's name and location. The paramete
r may be passed as either\nan HTTP header or a URL query parameter, and if both
are passed the behavior\nis implementation-dependent.", |
1273 "id": "SystemParameter", | 881 "id": "SystemParameter", |
1274 "properties": { | 882 "properties": { |
| 883 "httpHeader": { |
| 884 "description": "Define the HTTP header name to use for the p
arameter. It is case\ninsensitive.", |
| 885 "type": "string" |
| 886 }, |
| 887 "name": { |
| 888 "description": "Define the name of the parameter, such as \"
api_key\" . It is case sensitive.", |
| 889 "type": "string" |
| 890 }, |
1275 "urlQueryParameter": { | 891 "urlQueryParameter": { |
1276 "description": "Define the URL query parameter name to use f
or the parameter. It is case\nsensitive.", | 892 "description": "Define the URL query parameter name to use f
or the parameter. It is case\nsensitive.", |
1277 "type": "string" | 893 "type": "string" |
1278 }, | |
1279 "httpHeader": { | |
1280 "description": "Define the HTTP header name to use for the p
arameter. It is case\ninsensitive.", | |
1281 "type": "string" | |
1282 }, | |
1283 "name": { | |
1284 "description": "Define the name of the parameter, such as \"
api_key\" . It is case sensitive.", | |
1285 "type": "string" | |
1286 } | 894 } |
1287 }, | 895 }, |
1288 "type": "object" | 896 "type": "object" |
1289 }, | 897 }, |
1290 "Monitoring": { | 898 "Monitoring": { |
1291 "description": "Monitoring configuration of the service.\n\nThe exam
ple below shows how to configure monitored resources and metrics\nfor monitoring
. In the example, a monitored resource and two metrics are\ndefined. The `librar
y.googleapis.com/book/returned_count` metric is sent\nto both producer and consu
mer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is
only sent to the\nconsumer project.\n\n monitored_resources:\n - type: li
brary.googleapis.com/branch\n labels:\n - key: /city\n descript
ion: The city where the library branch is located in.\n - key: /name\n
description: The name of the branch.\n metrics:\n - name: library.googl
eapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64
\n labels:\n - key: /customer_id\n - name: library.googleapis.com/b
ook/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labe
ls:\n - key: /customer_id\n monitoring:\n producer_destinations:\n
- monitored_resource: library.googleapis.com/branch\n metrics:\n
- library.googleapis.com/book/returned_count\n consumer_destinations:\n
- monitored_resource: library.googleapis.com/branch\n metrics:\n
- library.googleapis.com/book/returned_count\n - library.googleapis.
com/book/overdue_count", | 899 "description": "Monitoring configuration of the service.\n\nThe exam
ple below shows how to configure monitored resources and metrics\nfor monitoring
. In the example, a monitored resource and two metrics are\ndefined. The `librar
y.googleapis.com/book/returned_count` metric is sent\nto both producer and consu
mer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is
only sent to the\nconsumer project.\n\n monitored_resources:\n - type: li
brary.googleapis.com/branch\n labels:\n - key: /city\n descript
ion: The city where the library branch is located in.\n - key: /name\n
description: The name of the branch.\n metrics:\n - name: library.googl
eapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64
\n labels:\n - key: /customer_id\n - name: library.googleapis.com/b
ook/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labe
ls:\n - key: /customer_id\n monitoring:\n producer_destinations:\n
- monitored_resource: library.googleapis.com/branch\n metrics:\n
- library.googleapis.com/book/returned_count\n consumer_destinations:\n
- monitored_resource: library.googleapis.com/branch\n metrics:\n
- library.googleapis.com/book/returned_count\n - library.googleapis.
com/book/overdue_count", |
1292 "id": "Monitoring", | 900 "id": "Monitoring", |
1293 "properties": { | 901 "properties": { |
1294 "consumerDestinations": { | 902 "consumerDestinations": { |
1295 "description": "Monitoring configurations for sending metric
s to the consumer project.\nThere can be multiple consumer destinations, each on
e must have a\ndifferent monitored resource type. A metric can be used in at mos
t\none consumer destination.", | 903 "description": "Monitoring configurations for sending metric
s to the consumer project.\nThere can be multiple consumer destinations, each on
e must have a\ndifferent monitored resource type. A metric can be used in at mos
t\none consumer destination.", |
1296 "items": { | 904 "items": { |
1297 "$ref": "MonitoringDestination" | 905 "$ref": "MonitoringDestination" |
1298 }, | 906 }, |
1299 "type": "array" | 907 "type": "array" |
1300 }, | 908 }, |
1301 "producerDestinations": { | 909 "producerDestinations": { |
1302 "description": "Monitoring configurations for sending metric
s to the producer project.\nThere can be multiple producer destinations, each on
e must have a\ndifferent monitored resource type. A metric can be used in at mos
t\none producer destination.", | 910 "description": "Monitoring configurations for sending metric
s to the producer project.\nThere can be multiple producer destinations, each on
e must have a\ndifferent monitored resource type. A metric can be used in at mos
t\none producer destination.", |
1303 "items": { | 911 "items": { |
1304 "$ref": "MonitoringDestination" | 912 "$ref": "MonitoringDestination" |
1305 }, | 913 }, |
1306 "type": "array" | 914 "type": "array" |
1307 } | 915 } |
1308 }, | 916 }, |
1309 "type": "object" | 917 "type": "object" |
1310 }, | 918 }, |
1311 "Field": { | 919 "Field": { |
1312 "description": "A single field of a message type.", | 920 "description": "A single field of a message type.", |
1313 "id": "Field", | 921 "id": "Field", |
1314 "properties": { | 922 "properties": { |
1315 "cardinality": { | |
1316 "description": "The field cardinality.", | |
1317 "enum": [ | |
1318 "CARDINALITY_UNKNOWN", | |
1319 "CARDINALITY_OPTIONAL", | |
1320 "CARDINALITY_REQUIRED", | |
1321 "CARDINALITY_REPEATED" | |
1322 ], | |
1323 "enumDescriptions": [ | |
1324 "For fields with unknown cardinality.", | |
1325 "For optional fields.", | |
1326 "For required fields. Proto2 syntax only.", | |
1327 "For repeated fields." | |
1328 ], | |
1329 "type": "string" | |
1330 }, | |
1331 "packed": { | |
1332 "description": "Whether to use alternative packed wire repre
sentation.", | |
1333 "type": "boolean" | |
1334 }, | |
1335 "defaultValue": { | 923 "defaultValue": { |
1336 "description": "The string value of the default value of thi
s field. Proto2 syntax only.", | 924 "description": "The string value of the default value of thi
s field. Proto2 syntax only.", |
1337 "type": "string" | 925 "type": "string" |
1338 }, | 926 }, |
1339 "name": { | 927 "name": { |
1340 "description": "The field name.", | 928 "description": "The field name.", |
1341 "type": "string" | 929 "type": "string" |
1342 }, | 930 }, |
1343 "typeUrl": { | 931 "typeUrl": { |
1344 "description": "The field type URL, without the scheme, for
message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.T
imestamp\"`.", | 932 "description": "The field type URL, without the scheme, for
message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.T
imestamp\"`.", |
1345 "type": "string" | 933 "type": "string" |
1346 }, | 934 }, |
1347 "number": { | 935 "number": { |
1348 "description": "The field number.", | 936 "description": "The field number.", |
1349 "format": "int32", | 937 "format": "int32", |
1350 "type": "integer" | 938 "type": "integer" |
1351 }, | 939 }, |
| 940 "jsonName": { |
| 941 "description": "The field JSON name.", |
| 942 "type": "string" |
| 943 }, |
1352 "kind": { | 944 "kind": { |
1353 "description": "The field type.", | 945 "description": "The field type.", |
1354 "enum": [ | 946 "enum": [ |
1355 "TYPE_UNKNOWN", | 947 "TYPE_UNKNOWN", |
1356 "TYPE_DOUBLE", | 948 "TYPE_DOUBLE", |
1357 "TYPE_FLOAT", | 949 "TYPE_FLOAT", |
1358 "TYPE_INT64", | 950 "TYPE_INT64", |
1359 "TYPE_UINT64", | 951 "TYPE_UINT64", |
1360 "TYPE_INT32", | 952 "TYPE_INT32", |
1361 "TYPE_FIXED64", | 953 "TYPE_FIXED64", |
(...skipping 26 matching lines...) Expand all Loading... |
1388 "Field type bytes.", | 980 "Field type bytes.", |
1389 "Field type uint32.", | 981 "Field type uint32.", |
1390 "Field type enum.", | 982 "Field type enum.", |
1391 "Field type sfixed32.", | 983 "Field type sfixed32.", |
1392 "Field type sfixed64.", | 984 "Field type sfixed64.", |
1393 "Field type sint32.", | 985 "Field type sint32.", |
1394 "Field type sint64." | 986 "Field type sint64." |
1395 ], | 987 ], |
1396 "type": "string" | 988 "type": "string" |
1397 }, | 989 }, |
1398 "jsonName": { | |
1399 "description": "The field JSON name.", | |
1400 "type": "string" | |
1401 }, | |
1402 "options": { | 990 "options": { |
1403 "description": "The protocol buffer options.", | 991 "description": "The protocol buffer options.", |
1404 "items": { | 992 "items": { |
1405 "$ref": "Option" | 993 "$ref": "Option" |
1406 }, | 994 }, |
1407 "type": "array" | 995 "type": "array" |
1408 }, | 996 }, |
1409 "oneofIndex": { | 997 "oneofIndex": { |
1410 "description": "The index of the field type in `Type.oneofs`
, for message or enumeration\ntypes. The first type has index 1; zero means the
type is not in the list.", | 998 "description": "The index of the field type in `Type.oneofs`
, for message or enumeration\ntypes. The first type has index 1; zero means the
type is not in the list.", |
1411 "format": "int32", | 999 "format": "int32", |
1412 "type": "integer" | 1000 "type": "integer" |
| 1001 }, |
| 1002 "packed": { |
| 1003 "description": "Whether to use alternative packed wire repre
sentation.", |
| 1004 "type": "boolean" |
| 1005 }, |
| 1006 "cardinality": { |
| 1007 "description": "The field cardinality.", |
| 1008 "enum": [ |
| 1009 "CARDINALITY_UNKNOWN", |
| 1010 "CARDINALITY_OPTIONAL", |
| 1011 "CARDINALITY_REQUIRED", |
| 1012 "CARDINALITY_REPEATED" |
| 1013 ], |
| 1014 "enumDescriptions": [ |
| 1015 "For fields with unknown cardinality.", |
| 1016 "For optional fields.", |
| 1017 "For required fields. Proto2 syntax only.", |
| 1018 "For repeated fields." |
| 1019 ], |
| 1020 "type": "string" |
1413 } | 1021 } |
1414 }, | 1022 }, |
1415 "type": "object" | 1023 "type": "object" |
1416 }, | 1024 }, |
1417 "TestIamPermissionsRequest": { | 1025 "TestIamPermissionsRequest": { |
1418 "description": "Request message for `TestIamPermissions` method.", | 1026 "description": "Request message for `TestIamPermissions` method.", |
1419 "id": "TestIamPermissionsRequest", | 1027 "id": "TestIamPermissionsRequest", |
1420 "properties": { | 1028 "properties": { |
1421 "permissions": { | 1029 "permissions": { |
1422 "description": "The set of permissions to check for the `res
ource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed
. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/ov
erview#permissions).", | 1030 "description": "The set of permissions to check for the `res
ource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed
. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/ov
erview#permissions).", |
1423 "items": { | 1031 "items": { |
1424 "type": "string" | 1032 "type": "string" |
1425 }, | 1033 }, |
1426 "type": "array" | 1034 "type": "array" |
1427 } | 1035 } |
1428 }, | 1036 }, |
1429 "type": "object" | 1037 "type": "object" |
1430 }, | 1038 }, |
1431 "Enum": { | 1039 "Enum": { |
1432 "description": "Enum type definition.", | 1040 "description": "Enum type definition.", |
1433 "id": "Enum", | 1041 "id": "Enum", |
1434 "properties": { | 1042 "properties": { |
| 1043 "options": { |
| 1044 "description": "Protocol buffer options.", |
| 1045 "items": { |
| 1046 "$ref": "Option" |
| 1047 }, |
| 1048 "type": "array" |
| 1049 }, |
1435 "syntax": { | 1050 "syntax": { |
1436 "description": "The source syntax.", | 1051 "description": "The source syntax.", |
1437 "enum": [ | 1052 "enum": [ |
1438 "SYNTAX_PROTO2", | 1053 "SYNTAX_PROTO2", |
1439 "SYNTAX_PROTO3" | 1054 "SYNTAX_PROTO3" |
1440 ], | 1055 ], |
1441 "enumDescriptions": [ | 1056 "enumDescriptions": [ |
1442 "Syntax `proto2`.", | 1057 "Syntax `proto2`.", |
1443 "Syntax `proto3`." | 1058 "Syntax `proto3`." |
1444 ], | 1059 ], |
1445 "type": "string" | 1060 "type": "string" |
1446 }, | 1061 }, |
1447 "sourceContext": { | 1062 "sourceContext": { |
1448 "$ref": "SourceContext", | 1063 "$ref": "SourceContext", |
1449 "description": "The source context." | 1064 "description": "The source context." |
1450 }, | 1065 }, |
1451 "enumvalue": { | 1066 "enumvalue": { |
1452 "description": "Enum value definitions.", | 1067 "description": "Enum value definitions.", |
1453 "items": { | 1068 "items": { |
1454 "$ref": "EnumValue" | 1069 "$ref": "EnumValue" |
1455 }, | 1070 }, |
1456 "type": "array" | 1071 "type": "array" |
1457 }, | 1072 }, |
1458 "name": { | 1073 "name": { |
1459 "description": "Enum type name.", | 1074 "description": "Enum type name.", |
1460 "type": "string" | 1075 "type": "string" |
1461 }, | |
1462 "options": { | |
1463 "description": "Protocol buffer options.", | |
1464 "items": { | |
1465 "$ref": "Option" | |
1466 }, | |
1467 "type": "array" | |
1468 } | |
1469 }, | |
1470 "type": "object" | |
1471 }, | |
1472 "EnableServiceRequest": { | |
1473 "description": "Request message for EnableService method.", | |
1474 "id": "EnableServiceRequest", | |
1475 "properties": { | |
1476 "consumerId": { | |
1477 "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.", | |
1478 "type": "string" | |
1479 } | |
1480 }, | |
1481 "type": "object" | |
1482 }, | |
1483 "Diagnostic": { | |
1484 "description": "Represents a diagnostic message (error or warning)", | |
1485 "id": "Diagnostic", | |
1486 "properties": { | |
1487 "message": { | |
1488 "description": "Message describing the error or warning.", | |
1489 "type": "string" | |
1490 }, | |
1491 "location": { | |
1492 "description": "File name and line number of the error or wa
rning.", | |
1493 "type": "string" | |
1494 }, | |
1495 "kind": { | |
1496 "description": "The kind of diagnostic information provided.
", | |
1497 "enum": [ | |
1498 "WARNING", | |
1499 "ERROR" | |
1500 ], | |
1501 "enumDescriptions": [ | |
1502 "Warnings and errors", | |
1503 "Only errors" | |
1504 ], | |
1505 "type": "string" | |
1506 } | 1076 } |
1507 }, | 1077 }, |
1508 "type": "object" | 1078 "type": "object" |
1509 }, | 1079 }, |
1510 "LabelDescriptor": { | 1080 "LabelDescriptor": { |
1511 "description": "A description of a label.", | 1081 "description": "A description of a label.", |
1512 "id": "LabelDescriptor", | 1082 "id": "LabelDescriptor", |
1513 "properties": { | 1083 "properties": { |
| 1084 "key": { |
| 1085 "description": "The label key.", |
| 1086 "type": "string" |
| 1087 }, |
| 1088 "description": { |
| 1089 "description": "A human-readable description for the label."
, |
| 1090 "type": "string" |
| 1091 }, |
1514 "valueType": { | 1092 "valueType": { |
1515 "description": "The type of data that can be assigned to the
label.", | 1093 "description": "The type of data that can be assigned to the
label.", |
1516 "enum": [ | 1094 "enum": [ |
1517 "STRING", | 1095 "STRING", |
1518 "BOOL", | 1096 "BOOL", |
1519 "INT64" | 1097 "INT64" |
1520 ], | 1098 ], |
1521 "enumDescriptions": [ | 1099 "enumDescriptions": [ |
1522 "A variable-length string. This is the default.", | 1100 "A variable-length string. This is the default.", |
1523 "Boolean; true or false.", | 1101 "Boolean; true or false.", |
1524 "A 64-bit signed integer." | 1102 "A 64-bit signed integer." |
1525 ], | 1103 ], |
1526 "type": "string" | 1104 "type": "string" |
1527 }, | 1105 } |
1528 "key": { | 1106 }, |
1529 "description": "The label key.", | 1107 "type": "object" |
1530 "type": "string" | 1108 }, |
1531 }, | 1109 "Diagnostic": { |
1532 "description": { | 1110 "description": "Represents a diagnostic message (error or warning)", |
1533 "description": "A human-readable description for the label."
, | 1111 "id": "Diagnostic", |
1534 "type": "string" | 1112 "properties": { |
1535 } | 1113 "location": { |
1536 }, | 1114 "description": "File name and line number of the error or wa
rning.", |
1537 "type": "object" | 1115 "type": "string" |
1538 }, | 1116 }, |
1539 "GenerateConfigReportResponse": { | 1117 "kind": { |
1540 "description": "Response message for GenerateConfigReport method.", | 1118 "description": "The kind of diagnostic information provided.
", |
1541 "id": "GenerateConfigReportResponse", | 1119 "enum": [ |
1542 "properties": { | 1120 "WARNING", |
1543 "diagnostics": { | 1121 "ERROR" |
1544 "description": "Errors / Linter warnings associated with the
service definition this\nreport\nbelongs to.", | 1122 ], |
1545 "items": { | 1123 "enumDescriptions": [ |
1546 "$ref": "Diagnostic" | 1124 "Warnings and errors", |
1547 }, | 1125 "Only errors" |
1548 "type": "array" | 1126 ], |
1549 }, | 1127 "type": "string" |
1550 "serviceName": { | 1128 }, |
1551 "description": "Name of the service this report belongs to."
, | 1129 "message": { |
1552 "type": "string" | 1130 "description": "Message describing the error or warning.", |
1553 }, | 1131 "type": "string" |
1554 "changeReports": { | 1132 } |
1555 "description": "list of ChangeReport, each corresponding to
comparison between two\nservice configurations.", | 1133 }, |
1556 "items": { | 1134 "type": "object" |
1557 "$ref": "ChangeReport" | 1135 }, |
1558 }, | 1136 "EnableServiceRequest": { |
1559 "type": "array" | 1137 "description": "Request message for EnableService method.", |
1560 }, | 1138 "id": "EnableServiceRequest", |
1561 "id": { | 1139 "properties": { |
1562 "description": "ID of the service configuration this report
belongs to.", | 1140 "consumerId": { |
| 1141 "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.", |
1563 "type": "string" | 1142 "type": "string" |
1564 } | 1143 } |
1565 }, | 1144 }, |
1566 "type": "object" | 1145 "type": "object" |
1567 }, | 1146 }, |
1568 "Type": { | 1147 "Type": { |
1569 "description": "A protocol buffer message type.", | 1148 "description": "A protocol buffer message type.", |
1570 "id": "Type", | 1149 "id": "Type", |
1571 "properties": { | 1150 "properties": { |
1572 "options": { | 1151 "options": { |
(...skipping 14 matching lines...) Expand all Loading... |
1587 "description": "The fully qualified message name.", | 1166 "description": "The fully qualified message name.", |
1588 "type": "string" | 1167 "type": "string" |
1589 }, | 1168 }, |
1590 "oneofs": { | 1169 "oneofs": { |
1591 "description": "The list of types appearing in `oneof` defin
itions in this type.", | 1170 "description": "The list of types appearing in `oneof` defin
itions in this type.", |
1592 "items": { | 1171 "items": { |
1593 "type": "string" | 1172 "type": "string" |
1594 }, | 1173 }, |
1595 "type": "array" | 1174 "type": "array" |
1596 }, | 1175 }, |
| 1176 "sourceContext": { |
| 1177 "$ref": "SourceContext", |
| 1178 "description": "The source context." |
| 1179 }, |
1597 "syntax": { | 1180 "syntax": { |
1598 "description": "The source syntax.", | 1181 "description": "The source syntax.", |
1599 "enum": [ | 1182 "enum": [ |
1600 "SYNTAX_PROTO2", | 1183 "SYNTAX_PROTO2", |
1601 "SYNTAX_PROTO3" | 1184 "SYNTAX_PROTO3" |
1602 ], | 1185 ], |
1603 "enumDescriptions": [ | 1186 "enumDescriptions": [ |
1604 "Syntax `proto2`.", | 1187 "Syntax `proto2`.", |
1605 "Syntax `proto3`." | 1188 "Syntax `proto3`." |
1606 ], | 1189 ], |
1607 "type": "string" | 1190 "type": "string" |
1608 }, | 1191 } |
1609 "sourceContext": { | 1192 }, |
1610 "$ref": "SourceContext", | 1193 "type": "object" |
1611 "description": "The source context." | 1194 }, |
| 1195 "GenerateConfigReportResponse": { |
| 1196 "description": "Response message for GenerateConfigReport method.", |
| 1197 "id": "GenerateConfigReportResponse", |
| 1198 "properties": { |
| 1199 "diagnostics": { |
| 1200 "description": "Errors / Linter warnings associated with the
service definition this\nreport\nbelongs to.", |
| 1201 "items": { |
| 1202 "$ref": "Diagnostic" |
| 1203 }, |
| 1204 "type": "array" |
| 1205 }, |
| 1206 "serviceName": { |
| 1207 "description": "Name of the service this report belongs to."
, |
| 1208 "type": "string" |
| 1209 }, |
| 1210 "changeReports": { |
| 1211 "description": "list of ChangeReport, each corresponding to
comparison between two\nservice configurations.", |
| 1212 "items": { |
| 1213 "$ref": "ChangeReport" |
| 1214 }, |
| 1215 "type": "array" |
| 1216 }, |
| 1217 "id": { |
| 1218 "description": "ID of the service configuration this report
belongs to.", |
| 1219 "type": "string" |
| 1220 } |
| 1221 }, |
| 1222 "type": "object" |
| 1223 }, |
| 1224 "ListServiceConfigsResponse": { |
| 1225 "description": "Response message for ListServiceConfigs method.", |
| 1226 "id": "ListServiceConfigsResponse", |
| 1227 "properties": { |
| 1228 "serviceConfigs": { |
| 1229 "description": "The list of service configuration resources.
", |
| 1230 "items": { |
| 1231 "$ref": "Service" |
| 1232 }, |
| 1233 "type": "array" |
| 1234 }, |
| 1235 "nextPageToken": { |
| 1236 "description": "The token of the next page of results.", |
| 1237 "type": "string" |
1612 } | 1238 } |
1613 }, | 1239 }, |
1614 "type": "object" | 1240 "type": "object" |
1615 }, | 1241 }, |
1616 "Experimental": { | 1242 "Experimental": { |
1617 "description": "Experimental service configuration. These configurat
ion options can\nonly be used by whitelisted users.", | 1243 "description": "Experimental service configuration. These configurat
ion options can\nonly be used by whitelisted users.", |
1618 "id": "Experimental", | 1244 "id": "Experimental", |
1619 "properties": { | 1245 "properties": { |
1620 "authorization": { | 1246 "authorization": { |
1621 "$ref": "AuthorizationConfig", | 1247 "$ref": "AuthorizationConfig", |
1622 "description": "Authorization configuration." | 1248 "description": "Authorization configuration." |
1623 } | 1249 } |
1624 }, | 1250 }, |
1625 "type": "object" | 1251 "type": "object" |
1626 }, | 1252 }, |
1627 "ListServiceConfigsResponse": { | 1253 "Backend": { |
1628 "description": "Response message for ListServiceConfigs method.", | 1254 "description": "`Backend` defines the backend configuration for a se
rvice.", |
1629 "id": "ListServiceConfigsResponse", | 1255 "id": "Backend", |
1630 "properties": { | 1256 "properties": { |
1631 "serviceConfigs": { | 1257 "rules": { |
1632 "description": "The list of service configuration resources.
", | 1258 "description": "A list of API backend rules that apply to in
dividual API methods.\n\n**NOTE:** All service configuration rules follow \"last
one wins\" order.", |
1633 "items": { | 1259 "items": { |
1634 "$ref": "Service" | 1260 "$ref": "BackendRule" |
1635 }, | 1261 }, |
1636 "type": "array" | 1262 "type": "array" |
1637 }, | |
1638 "nextPageToken": { | |
1639 "description": "The token of the next page of results.", | |
1640 "type": "string" | |
1641 } | 1263 } |
1642 }, | 1264 }, |
1643 "type": "object" | 1265 "type": "object" |
1644 }, | 1266 }, |
1645 "AuditConfig": { | 1267 "AuditConfig": { |
1646 "description": "Specifies the audit configuration for a service.\nTh
e configuration determines which permission types are logged, and what\nidentiti
es, if any, are exempted from logging.\nAn AuditConfig must have one or more Aud
itLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific
service,\nthe union of the two AuditConfigs is used for that service: the log_t
ypes\nspecified in each AuditConfig are enabled, and the exempted_members in eac
h\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n
{\n \"audit_configs\": [\n {\n \"service\": \"allServices
\"\n \"audit_log_configs\": [\n {\n \"log_type\
": \"DATA_READ\",\n \"exempted_members\": [\n \"user
:foo@gmail.com\"\n ]\n },\n {\n
\"log_type\": \"DATA_WRITE\",\n },\n {\n \"lo
g_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n
\"service\": \"fooservice.googleapis.com\"\n \"audit_log_config
s\": [\n {\n \"log_type\": \"DATA_READ\",\n }
,\n {\n \"log_type\": \"DATA_WRITE\",\n \"e
xempted_members\": [\n \"user:bar@gmail.com\"\n ]\n
}\n ]\n }\n ]\n }\n\nFor fooservice, this pol
icy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@g
mail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", | 1268 "description": "Specifies the audit configuration for a service.\nTh
e configuration determines which permission types are logged, and what\nidentiti
es, if any, are exempted from logging.\nAn AuditConfig must have one or more Aud
itLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific
service,\nthe union of the two AuditConfigs is used for that service: the log_t
ypes\nspecified in each AuditConfig are enabled, and the exempted_members in eac
h\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n
{\n \"audit_configs\": [\n {\n \"service\": \"allServices
\"\n \"audit_log_configs\": [\n {\n \"log_type\
": \"DATA_READ\",\n \"exempted_members\": [\n \"user
:foo@gmail.com\"\n ]\n },\n {\n
\"log_type\": \"DATA_WRITE\",\n },\n {\n \"lo
g_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n
\"service\": \"fooservice.googleapis.com\"\n \"audit_log_config
s\": [\n {\n \"log_type\": \"DATA_READ\",\n }
,\n {\n \"log_type\": \"DATA_WRITE\",\n \"e
xempted_members\": [\n \"user:bar@gmail.com\"\n ]\n
}\n ]\n }\n ]\n }\n\nFor fooservice, this pol
icy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@g
mail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", |
1647 "id": "AuditConfig", | 1269 "id": "AuditConfig", |
1648 "properties": { | 1270 "properties": { |
1649 "exemptedMembers": { | |
1650 "items": { | |
1651 "type": "string" | |
1652 }, | |
1653 "type": "array" | |
1654 }, | |
1655 "service": { | 1271 "service": { |
1656 "description": "Specifies a service that will be enabled for
audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com
`.\n`allServices` is a special value that covers all services.", | 1272 "description": "Specifies a service that will be enabled for
audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com
`.\n`allServices` is a special value that covers all services.", |
1657 "type": "string" | 1273 "type": "string" |
1658 }, | 1274 }, |
1659 "auditLogConfigs": { | 1275 "auditLogConfigs": { |
1660 "description": "The configuration for logging of each type o
f permission.\nNext ID: 4", | 1276 "description": "The configuration for logging of each type o
f permission.\nNext ID: 4", |
1661 "items": { | 1277 "items": { |
1662 "$ref": "AuditLogConfig" | 1278 "$ref": "AuditLogConfig" |
1663 }, | 1279 }, |
1664 "type": "array" | 1280 "type": "array" |
1665 } | 1281 }, |
1666 }, | 1282 "exemptedMembers": { |
1667 "type": "object" | 1283 "items": { |
1668 }, | 1284 "type": "string" |
1669 "Backend": { | |
1670 "description": "`Backend` defines the backend configuration for a se
rvice.", | |
1671 "id": "Backend", | |
1672 "properties": { | |
1673 "rules": { | |
1674 "description": "A list of API backend rules that apply to in
dividual API methods.\n\n**NOTE:** All service configuration rules follow \"last
one wins\" order.", | |
1675 "items": { | |
1676 "$ref": "BackendRule" | |
1677 }, | 1285 }, |
1678 "type": "array" | 1286 "type": "array" |
1679 } | 1287 } |
1680 }, | 1288 }, |
1681 "type": "object" | 1289 "type": "object" |
1682 }, | 1290 }, |
1683 "SubmitConfigSourceRequest": { | 1291 "SubmitConfigSourceRequest": { |
1684 "description": "Request message for SubmitConfigSource method.", | 1292 "description": "Request message for SubmitConfigSource method.", |
1685 "id": "SubmitConfigSourceRequest", | 1293 "id": "SubmitConfigSourceRequest", |
1686 "properties": { | 1294 "properties": { |
1687 "configSource": { | 1295 "configSource": { |
1688 "$ref": "ConfigSource", | 1296 "$ref": "ConfigSource", |
1689 "description": "The source configuration for the service." | 1297 "description": "The source configuration for the service." |
1690 }, | 1298 }, |
1691 "validateOnly": { | 1299 "validateOnly": { |
1692 "description": "Optional. If set, this will result in the ge
neration of a\n`google.api.Service` configuration based on the `ConfigSource` pr
ovided,\nbut the generated config and the sources will NOT be persisted.", | 1300 "description": "Optional. If set, this will result in the ge
neration of a\n`google.api.Service` configuration based on the `ConfigSource` pr
ovided,\nbut the generated config and the sources will NOT be persisted.", |
1693 "type": "boolean" | 1301 "type": "boolean" |
1694 } | 1302 } |
1695 }, | 1303 }, |
1696 "type": "object" | 1304 "type": "object" |
1697 }, | 1305 }, |
| 1306 "DocumentationRule": { |
| 1307 "description": "A documentation rule provides information about indi
vidual API elements.", |
| 1308 "id": "DocumentationRule", |
| 1309 "properties": { |
| 1310 "description": { |
| 1311 "description": "Description of the selected API(s).", |
| 1312 "type": "string" |
| 1313 }, |
| 1314 "deprecationDescription": { |
| 1315 "description": "Deprecation description of the selected elem
ent(s). It can be provided if an\nelement is marked as `deprecated`.", |
| 1316 "type": "string" |
| 1317 }, |
| 1318 "selector": { |
| 1319 "description": "The selector is a comma-separated list of pa
tterns. Each pattern is a\nqualified name of the element which may end in \"*\",
indicating a wildcard.\nWildcards are only allowed at the end and for a whole c
omponent of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"f
oo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern
\"*\"\nis used.", |
| 1320 "type": "string" |
| 1321 } |
| 1322 }, |
| 1323 "type": "object" |
| 1324 }, |
1698 "AuthorizationConfig": { | 1325 "AuthorizationConfig": { |
1699 "description": "Configuration of authorization.\n\nThis section dete
rmines the authorization provider, if unspecified, then no\nauthorization check
will be done.\n\nExample:\n\n experimental:\n authorization:\n pr
ovider: firebaserules.googleapis.com", | 1326 "description": "Configuration of authorization.\n\nThis section dete
rmines the authorization provider, if unspecified, then no\nauthorization check
will be done.\n\nExample:\n\n experimental:\n authorization:\n pr
ovider: firebaserules.googleapis.com", |
1700 "id": "AuthorizationConfig", | 1327 "id": "AuthorizationConfig", |
1701 "properties": { | 1328 "properties": { |
1702 "provider": { | 1329 "provider": { |
1703 "description": "The name of the authorization provider, such
as\nfirebaserules.googleapis.com.", | 1330 "description": "The name of the authorization provider, such
as\nfirebaserules.googleapis.com.", |
1704 "type": "string" | 1331 "type": "string" |
1705 } | 1332 } |
1706 }, | 1333 }, |
1707 "type": "object" | 1334 "type": "object" |
1708 }, | 1335 }, |
1709 "DocumentationRule": { | 1336 "ContextRule": { |
1710 "description": "A documentation rule provides information about indi
vidual API elements.", | 1337 "description": "A context rule provides information about the contex
t for an individual API\nelement.", |
1711 "id": "DocumentationRule", | 1338 "id": "ContextRule", |
1712 "properties": { | 1339 "properties": { |
1713 "deprecationDescription": { | 1340 "provided": { |
1714 "description": "Deprecation description of the selected elem
ent(s). It can be provided if an\nelement is marked as `deprecated`.", | 1341 "description": "A list of full type names of provided contex
ts.", |
1715 "type": "string" | 1342 "items": { |
| 1343 "type": "string" |
| 1344 }, |
| 1345 "type": "array" |
| 1346 }, |
| 1347 "requested": { |
| 1348 "description": "A list of full type names of requested conte
xts.", |
| 1349 "items": { |
| 1350 "type": "string" |
| 1351 }, |
| 1352 "type": "array" |
1716 }, | 1353 }, |
1717 "selector": { | 1354 "selector": { |
1718 "description": "The selector is a comma-separated list of pa
tterns. Each pattern is a\nqualified name of the element which may end in \"*\",
indicating a wildcard.\nWildcards are only allowed at the end and for a whole c
omponent of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"f
oo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern
\"*\"\nis used.", | 1355 "description": "Selects the methods to which this rule appli
es.\n\nRefer to selector for syntax details.", |
1719 "type": "string" | |
1720 }, | |
1721 "description": { | |
1722 "description": "Description of the selected API(s).", | |
1723 "type": "string" | 1356 "type": "string" |
1724 } | 1357 } |
1725 }, | 1358 }, |
1726 "type": "object" | 1359 "type": "object" |
1727 }, | 1360 }, |
1728 "CloudAuditOptions": { | 1361 "CloudAuditOptions": { |
1729 "description": "Write a Cloud Audit log", | 1362 "description": "Write a Cloud Audit log", |
1730 "id": "CloudAuditOptions", | 1363 "id": "CloudAuditOptions", |
1731 "properties": { | 1364 "properties": { |
1732 "logName": { | 1365 "logName": { |
1733 "description": "The log_name to populate in the Cloud Audit
Record.", | 1366 "description": "The log_name to populate in the Cloud Audit
Record.", |
1734 "enum": [ | 1367 "enum": [ |
1735 "UNSPECIFIED_LOG_NAME", | 1368 "UNSPECIFIED_LOG_NAME", |
1736 "ADMIN_ACTIVITY", | 1369 "ADMIN_ACTIVITY", |
1737 "DATA_ACCESS" | 1370 "DATA_ACCESS" |
1738 ], | 1371 ], |
1739 "enumDescriptions": [ | 1372 "enumDescriptions": [ |
1740 "Default. Should not be used.", | 1373 "Default. Should not be used.", |
1741 "Corresponds to \"cloudaudit.googleapis.com/activity\"", | 1374 "Corresponds to \"cloudaudit.googleapis.com/activity\"", |
1742 "Corresponds to \"cloudaudit.googleapis.com/data_access\
"" | 1375 "Corresponds to \"cloudaudit.googleapis.com/data_access\
"" |
1743 ], | 1376 ], |
1744 "type": "string" | 1377 "type": "string" |
1745 }, | |
1746 "isReadPermissionType": { | |
1747 "description": "True if the log is for a permission of type
DATA_READ or ADMIN_READ.", | |
1748 "type": "boolean" | |
1749 } | |
1750 }, | |
1751 "type": "object" | |
1752 }, | |
1753 "ContextRule": { | |
1754 "description": "A context rule provides information about the contex
t for an individual API\nelement.", | |
1755 "id": "ContextRule", | |
1756 "properties": { | |
1757 "selector": { | |
1758 "description": "Selects the methods to which this rule appli
es.\n\nRefer to selector for syntax details.", | |
1759 "type": "string" | |
1760 }, | |
1761 "provided": { | |
1762 "description": "A list of full type names of provided contex
ts.", | |
1763 "items": { | |
1764 "type": "string" | |
1765 }, | |
1766 "type": "array" | |
1767 }, | |
1768 "requested": { | |
1769 "description": "A list of full type names of requested conte
xts.", | |
1770 "items": { | |
1771 "type": "string" | |
1772 }, | |
1773 "type": "array" | |
1774 } | 1378 } |
1775 }, | 1379 }, |
1776 "type": "object" | 1380 "type": "object" |
1777 }, | 1381 }, |
1778 "MetricDescriptor": { | 1382 "MetricDescriptor": { |
1779 "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.", | 1383 "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.", |
1780 "id": "MetricDescriptor", | 1384 "id": "MetricDescriptor", |
1781 "properties": { | 1385 "properties": { |
| 1386 "metricKind": { |
| 1387 "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.", |
| 1388 "enum": [ |
| 1389 "METRIC_KIND_UNSPECIFIED", |
| 1390 "GAUGE", |
| 1391 "DELTA", |
| 1392 "CUMULATIVE" |
| 1393 ], |
| 1394 "enumDescriptions": [ |
| 1395 "Do not use this default value.", |
| 1396 "An instantaneous measurement of a value.", |
| 1397 "The change in a value during a time interval.", |
| 1398 "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." |
| 1399 ], |
| 1400 "type": "string" |
| 1401 }, |
| 1402 "description": { |
| 1403 "description": "A detailed description of the metric, which
can be used in documentation.", |
| 1404 "type": "string" |
| 1405 }, |
| 1406 "displayName": { |
| 1407 "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\".", |
| 1408 "type": "string" |
| 1409 }, |
| 1410 "unit": { |
| 1411 "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 '}'.", |
| 1412 "type": "string" |
| 1413 }, |
| 1414 "labels": { |
| 1415 "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.", |
| 1416 "items": { |
| 1417 "$ref": "LabelDescriptor" |
| 1418 }, |
| 1419 "type": "array" |
| 1420 }, |
| 1421 "name": { |
| 1422 "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 `my-project-id`:\n\n \"projects/my-project-id/metricDescrip
tors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount\"", |
| 1423 "type": "string" |
| 1424 }, |
1782 "type": { | 1425 "type": { |
1783 "description": "The metric type, including its DNS name pref
ix. The type is not\nURL-encoded. All user-defined custom metric types have the
DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchi
cal\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"
\n \"appengine.googleapis.com/http/server/response_latencies\"", | 1426 "description": "The metric type, including its DNS name pref
ix. The type is not\nURL-encoded. All user-defined custom metric types have the
DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchi
cal\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"
\n \"appengine.googleapis.com/http/server/response_latencies\"", |
1784 "type": "string" | 1427 "type": "string" |
1785 }, | 1428 }, |
1786 "valueType": { | 1429 "valueType": { |
1787 "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.", | 1430 "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.", |
1788 "enum": [ | 1431 "enum": [ |
1789 "VALUE_TYPE_UNSPECIFIED", | 1432 "VALUE_TYPE_UNSPECIFIED", |
1790 "BOOL", | 1433 "BOOL", |
1791 "INT64", | 1434 "INT64", |
1792 "DOUBLE", | 1435 "DOUBLE", |
1793 "STRING", | 1436 "STRING", |
1794 "DISTRIBUTION", | 1437 "DISTRIBUTION", |
1795 "MONEY" | 1438 "MONEY" |
1796 ], | 1439 ], |
1797 "enumDescriptions": [ | 1440 "enumDescriptions": [ |
1798 "Do not use this default value.", | 1441 "Do not use this default value.", |
1799 "The value is a boolean.\nThis value type can be used on
ly if the metric kind is `GAUGE`.", | 1442 "The value is a boolean.\nThis value type can be used on
ly if the metric kind is `GAUGE`.", |
1800 "The value is a signed 64-bit integer.", | 1443 "The value is a signed 64-bit integer.", |
1801 "The value is a double precision floating point number."
, | 1444 "The value is a double precision floating point number."
, |
1802 "The value is a text string.\nThis value type can be use
d only if the metric kind is `GAUGE`.", | 1445 "The value is a text string.\nThis value type can be use
d only if the metric kind is `GAUGE`.", |
1803 "The value is a `Distribution`.", | 1446 "The value is a `Distribution`.", |
1804 "The value is money." | 1447 "The value is money." |
1805 ], | 1448 ], |
1806 "type": "string" | 1449 "type": "string" |
1807 }, | |
1808 "metricKind": { | |
1809 "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.", | |
1810 "enum": [ | |
1811 "METRIC_KIND_UNSPECIFIED", | |
1812 "GAUGE", | |
1813 "DELTA", | |
1814 "CUMULATIVE" | |
1815 ], | |
1816 "enumDescriptions": [ | |
1817 "Do not use this default value.", | |
1818 "An instantaneous measurement of a value.", | |
1819 "The change in a value during a time interval.", | |
1820 "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." | |
1821 ], | |
1822 "type": "string" | |
1823 }, | |
1824 "displayName": { | |
1825 "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\".", | |
1826 "type": "string" | |
1827 }, | |
1828 "description": { | |
1829 "description": "A detailed description of the metric, which
can be used in documentation.", | |
1830 "type": "string" | |
1831 }, | |
1832 "unit": { | |
1833 "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 '}'.", | |
1834 "type": "string" | |
1835 }, | |
1836 "labels": { | |
1837 "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.", | |
1838 "items": { | |
1839 "$ref": "LabelDescriptor" | |
1840 }, | |
1841 "type": "array" | |
1842 }, | |
1843 "name": { | |
1844 "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 `my-project-id`:\n\n \"projects/my-project-id/metricDescrip
tors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount\"", | |
1845 "type": "string" | |
1846 } | 1450 } |
1847 }, | 1451 }, |
1848 "type": "object" | 1452 "type": "object" |
1849 }, | 1453 }, |
1850 "SourceContext": { | 1454 "SourceContext": { |
1851 "description": "`SourceContext` represents information about the sou
rce of a\nprotobuf element, like the file in which it is defined.", | 1455 "description": "`SourceContext` represents information about the sou
rce of a\nprotobuf element, like the file in which it is defined.", |
1852 "id": "SourceContext", | 1456 "id": "SourceContext", |
1853 "properties": { | 1457 "properties": { |
1854 "fileName": { | 1458 "fileName": { |
1855 "description": "The path-qualified name of the .proto file t
hat contained the associated\nprotobuf element. For example: `\"google/protobuf
/source_context.proto\"`.", | 1459 "description": "The path-qualified name of the .proto file t
hat contained the associated\nprotobuf element. For example: `\"google/protobuf
/source_context.proto\"`.", |
(...skipping 65 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1921 "description": "Allowing\n[CORS](https://en.wikipedia.org/wi
ki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the ba
ckends served from this endpoint to\nreceive and respond to HTTP OPTIONS request
s. The response will be used by\nthe browser to determine whether the subsequent
cross-origin request is\nallowed to proceed.", | 1525 "description": "Allowing\n[CORS](https://en.wikipedia.org/wi
ki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the ba
ckends served from this endpoint to\nreceive and respond to HTTP OPTIONS request
s. The response will be used by\nthe browser to determine whether the subsequent
cross-origin request is\nallowed to proceed.", |
1922 "type": "boolean" | 1526 "type": "boolean" |
1923 }, | 1527 }, |
1924 "aliases": { | 1528 "aliases": { |
1925 "description": "DEPRECATED: This field is no longer supporte
d. Instead of using aliases,\nplease specify multiple google.api.Endpoint for ea
ch of the intented\nalias.\n\nAdditional names that this endpoint will be hosted
on.", | 1529 "description": "DEPRECATED: This field is no longer supporte
d. Instead of using aliases,\nplease specify multiple google.api.Endpoint for ea
ch of the intented\nalias.\n\nAdditional names that this endpoint will be hosted
on.", |
1926 "items": { | 1530 "items": { |
1927 "type": "string" | 1531 "type": "string" |
1928 }, | 1532 }, |
1929 "type": "array" | 1533 "type": "array" |
1930 }, | 1534 }, |
| 1535 "target": { |
| 1536 "description": "The specification of an Internet routable ad
dress of API frontend that will\nhandle requests to this [API Endpoint](https://
cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 addres
s or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.app
spot.com\".", |
| 1537 "type": "string" |
| 1538 }, |
1931 "name": { | 1539 "name": { |
1932 "description": "The canonical name of this endpoint.", | 1540 "description": "The canonical name of this endpoint.", |
1933 "type": "string" | 1541 "type": "string" |
1934 }, | |
1935 "target": { | |
1936 "description": "The specification of an Internet routable ad
dress of API frontend that will\nhandle requests to this [API Endpoint](https://
cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 addres
s or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.app
spot.com\".", | |
1937 "type": "string" | |
1938 } | 1542 } |
1939 }, | 1543 }, |
1940 "type": "object" | 1544 "type": "object" |
1941 }, | 1545 }, |
1942 "OAuthRequirements": { | 1546 "OAuthRequirements": { |
1943 "description": "OAuth scopes are a way to define data and permission
s on data. For example,\nthere are scopes defined for \"Read-only access to Goog
le Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope fo
r an application,\ngiving it permission to access that data on their behalf.\n\n
OAuth scope specifications should be fairly coarse grained; a user will need\nto
see and understand the text description of what your scope means.\n\nIn most ca
ses: use one or at most two OAuth scopes for an entire family of\nproducts. If y
our product has multiple APIs, you should probably be sharing\nthe OAuth scope a
cross all of those APIs.\n\nWhen you need finer grained OAuth consent screens: t
alk with your product\nmanagement about how developers will use them in practice
.\n\nPlease note that even though each of the canonical scopes is enough for a\n
request to be accepted and passed to the backend, a request can still fail\ndue
to the backend requiring additional scopes or permissions.", | 1547 "description": "OAuth scopes are a way to define data and permission
s on data. For example,\nthere are scopes defined for \"Read-only access to Goog
le Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope fo
r an application,\ngiving it permission to access that data on their behalf.\n\n
OAuth scope specifications should be fairly coarse grained; a user will need\nto
see and understand the text description of what your scope means.\n\nIn most ca
ses: use one or at most two OAuth scopes for an entire family of\nproducts. If y
our product has multiple APIs, you should probably be sharing\nthe OAuth scope a
cross all of those APIs.\n\nWhen you need finer grained OAuth consent screens: t
alk with your product\nmanagement about how developers will use them in practice
.\n\nPlease note that even though each of the canonical scopes is enough for a\n
request to be accepted and passed to the backend, a request can still fail\ndue
to the backend requiring additional scopes or permissions.", |
1944 "id": "OAuthRequirements", | 1548 "id": "OAuthRequirements", |
1945 "properties": { | 1549 "properties": { |
1946 "canonicalScopes": { | 1550 "canonicalScopes": { |
1947 "description": "The list of publicly documented OAuth scopes
that are allowed access. An\nOAuth token containing any of these scopes will be
accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth
/calendar,\n https://www.googleapis.com/auth/calendar.read
", | 1551 "description": "The list of publicly documented OAuth scopes
that are allowed access. An\nOAuth token containing any of these scopes will be
accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth
/calendar,\n https://www.googleapis.com/auth/calendar.read
", |
1948 "type": "string" | 1552 "type": "string" |
1949 } | 1553 } |
1950 }, | 1554 }, |
1951 "type": "object" | 1555 "type": "object" |
1952 }, | 1556 }, |
1953 "TestIamPermissionsResponse": { | 1557 "Usage": { |
1954 "description": "Response message for `TestIamPermissions` method.", | 1558 "description": "Configuration controlling usage of a service.", |
1955 "id": "TestIamPermissionsResponse", | 1559 "id": "Usage", |
1956 "properties": { | 1560 "properties": { |
1957 "permissions": { | 1561 "requirements": { |
1958 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is\nallowed.", | 1562 "description": "Requirements that must be satisfied before a
consumer project can use the\nservice. Each requirement is of the form <service
.name>/<requirement-id>;\nfor example 'serviceusage.googleapis.com/billing-enabl
ed'.", |
1959 "items": { | 1563 "items": { |
1960 "type": "string" | 1564 "type": "string" |
1961 }, | 1565 }, |
1962 "type": "array" | 1566 "type": "array" |
| 1567 }, |
| 1568 "producerNotificationChannel": { |
| 1569 "description": "The full resource name of a channel used for
sending notifications to the\nservice producer.\n\nGoogle Service Management cu
rrently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) a
s a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must
be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name fo
rmat\ndocumented in https://cloud.google.com/pubsub/docs/overview.", |
| 1570 "type": "string" |
| 1571 }, |
| 1572 "rules": { |
| 1573 "description": "A list of usage rules that apply to individu
al API methods.\n\n**NOTE:** All service configuration rules follow \"last one w
ins\" order.", |
| 1574 "items": { |
| 1575 "$ref": "UsageRule" |
| 1576 }, |
| 1577 "type": "array" |
1963 } | 1578 } |
1964 }, | 1579 }, |
1965 "type": "object" | 1580 "type": "object" |
1966 }, | 1581 }, |
1967 "GetIamPolicyRequest": { | 1582 "GetIamPolicyRequest": { |
1968 "description": "Request message for `GetIamPolicy` method.", | 1583 "description": "Request message for `GetIamPolicy` method.", |
1969 "id": "GetIamPolicyRequest", | 1584 "id": "GetIamPolicyRequest", |
1970 "properties": {}, | 1585 "properties": {}, |
1971 "type": "object" | 1586 "type": "object" |
1972 }, | 1587 }, |
1973 "Usage": { | 1588 "TestIamPermissionsResponse": { |
1974 "description": "Configuration controlling usage of a service.", | 1589 "description": "Response message for `TestIamPermissions` method.", |
1975 "id": "Usage", | 1590 "id": "TestIamPermissionsResponse", |
1976 "properties": { | 1591 "properties": { |
1977 "producerNotificationChannel": { | 1592 "permissions": { |
1978 "description": "The full resource name of a channel used for
sending notifications to the\nservice producer.\n\nGoogle Service Management cu
rrently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) a
s a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must
be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name fo
rmat\ndocumented in https://cloud.google.com/pubsub/docs/overview.", | 1593 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is\nallowed.", |
1979 "type": "string" | |
1980 }, | |
1981 "rules": { | |
1982 "description": "A list of usage rules that apply to individu
al API methods.\n\n**NOTE:** All service configuration rules follow \"last one w
ins\" order.", | |
1983 "items": { | |
1984 "$ref": "UsageRule" | |
1985 }, | |
1986 "type": "array" | |
1987 }, | |
1988 "requirements": { | |
1989 "description": "Requirements that must be satisfied before a
consumer project can use the\nservice. Each requirement is of the form <service
.name>/<requirement-id>;\nfor example 'serviceusage.googleapis.com/billing-enabl
ed'.", | |
1990 "items": { | 1594 "items": { |
1991 "type": "string" | 1595 "type": "string" |
1992 }, | 1596 }, |
1993 "type": "array" | 1597 "type": "array" |
1994 } | 1598 } |
1995 }, | 1599 }, |
1996 "type": "object" | 1600 "type": "object" |
1997 }, | 1601 }, |
1998 "Context": { | 1602 "Context": { |
1999 "description": "`Context` defines which contexts an API requests.\n\
nExample:\n\n context:\n rules:\n - selector: \"*\"\n reques
ted:\n - google.rpc.context.ProjectContext\n - google.rpc.context.
OriginContext\n\nThe above specifies that all methods in the API request\n`googl
e.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvaila
ble context types are defined in package\n`google.rpc.context`.", | 1603 "description": "`Context` defines which contexts an API requests.\n\
nExample:\n\n context:\n rules:\n - selector: \"*\"\n reques
ted:\n - google.rpc.context.ProjectContext\n - google.rpc.context.
OriginContext\n\nThe above specifies that all methods in the API request\n`googl
e.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvaila
ble context types are defined in package\n`google.rpc.context`.", |
2000 "id": "Context", | 1604 "id": "Context", |
2001 "properties": { | 1605 "properties": { |
2002 "rules": { | 1606 "rules": { |
2003 "description": "A list of RPC context rules that apply to in
dividual API methods.\n\n**NOTE:** All service configuration rules follow \"last
one wins\" order.", | 1607 "description": "A list of RPC context rules that apply to in
dividual API methods.\n\n**NOTE:** All service configuration rules follow \"last
one wins\" order.", |
2004 "items": { | 1608 "items": { |
2005 "$ref": "ContextRule" | 1609 "$ref": "ContextRule" |
2006 }, | 1610 }, |
2007 "type": "array" | 1611 "type": "array" |
2008 } | 1612 } |
2009 }, | 1613 }, |
2010 "type": "object" | 1614 "type": "object" |
2011 }, | 1615 }, |
2012 "Rule": { | 1616 "Rule": { |
2013 "description": "A rule to be applied in a Policy.", | 1617 "description": "A rule to be applied in a Policy.", |
2014 "id": "Rule", | 1618 "id": "Rule", |
2015 "properties": { | 1619 "properties": { |
| 1620 "notIn": { |
| 1621 "description": "If one or more 'not_in' clauses are specifie
d, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entri
es.\nThe format for in and not_in entries is the same as for members in a\nBindi
ng (see google/iam/v1/policy.proto).", |
| 1622 "items": { |
| 1623 "type": "string" |
| 1624 }, |
| 1625 "type": "array" |
| 1626 }, |
2016 "description": { | 1627 "description": { |
2017 "description": "Human-readable description of the rule.", | 1628 "description": "Human-readable description of the rule.", |
2018 "type": "string" | 1629 "type": "string" |
2019 }, | 1630 }, |
2020 "conditions": { | 1631 "conditions": { |
2021 "description": "Additional restrictions that must be met", | 1632 "description": "Additional restrictions that must be met", |
2022 "items": { | 1633 "items": { |
2023 "$ref": "Condition" | 1634 "$ref": "Condition" |
2024 }, | 1635 }, |
2025 "type": "array" | 1636 "type": "array" |
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2057 ], | 1668 ], |
2058 "enumDescriptions": [ | 1669 "enumDescriptions": [ |
2059 "Default no action.", | 1670 "Default no action.", |
2060 "Matching 'Entries' grant access.", | 1671 "Matching 'Entries' grant access.", |
2061 "Matching 'Entries' grant access and the caller promises
to log\nthe request per the returned log_configs.", | 1672 "Matching 'Entries' grant access and the caller promises
to log\nthe request per the returned log_configs.", |
2062 "Matching 'Entries' deny access.", | 1673 "Matching 'Entries' deny access.", |
2063 "Matching 'Entries' deny access and the caller promises
to log\nthe request per the returned log_configs.", | 1674 "Matching 'Entries' deny access and the caller promises
to log\nthe request per the returned log_configs.", |
2064 "Matching 'Entries' tell IAM.Check callers to generate l
ogs." | 1675 "Matching 'Entries' tell IAM.Check callers to generate l
ogs." |
2065 ], | 1676 ], |
2066 "type": "string" | 1677 "type": "string" |
2067 }, | |
2068 "notIn": { | |
2069 "description": "If one or more 'not_in' clauses are specifie
d, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entri
es.\nThe format for in and not_in entries is the same as for members in a\nBindi
ng (see google/iam/v1/policy.proto).", | |
2070 "items": { | |
2071 "type": "string" | |
2072 }, | |
2073 "type": "array" | |
2074 } | 1678 } |
2075 }, | 1679 }, |
2076 "type": "object" | 1680 "type": "object" |
2077 }, | 1681 }, |
2078 "LogConfig": { | 1682 "LogConfig": { |
2079 "description": "Specifies what kind of log the caller must write\nIn
crement a streamz counter with the specified metric and field names.\n\nMetric n
ames should start with a '/', generally be lowercase-only,\nand end in \"_count\
". Field names should not contain an initial slash.\nThe actual exported metric
names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM requ
est parameters and field values are\ntheir respective values.\n\nAt present the
only supported field names are\n - \"iam_principal\", corresponding to IAMCont
ext.principal;\n - \"\" (empty string), resulting in one aggretated counter wi
th no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \
"iam_principal\" }\n ==> increment counter /iam/policy/backend_debug_access_cou
nt\n {iam_principal=[value of IAMContext.principal]}\n\nA
t this time we do not support:\n* multiple field names (though this may be suppo
rted in the future)\n* decrementing the counter\n* incrementing it by anything o
ther than 1", | 1683 "description": "Specifies what kind of log the caller must write", |
2080 "id": "LogConfig", | 1684 "id": "LogConfig", |
2081 "properties": { | 1685 "properties": { |
| 1686 "dataAccess": { |
| 1687 "$ref": "DataAccessOptions", |
| 1688 "description": "Data access options." |
| 1689 }, |
2082 "cloudAudit": { | 1690 "cloudAudit": { |
2083 "$ref": "CloudAuditOptions", | 1691 "$ref": "CloudAuditOptions", |
2084 "description": "Cloud audit options." | 1692 "description": "Cloud audit options." |
2085 }, | 1693 }, |
2086 "counter": { | 1694 "counter": { |
2087 "$ref": "CounterOptions", | 1695 "$ref": "CounterOptions", |
2088 "description": "Counter options." | 1696 "description": "Counter options." |
2089 }, | |
2090 "dataAccess": { | |
2091 "$ref": "DataAccessOptions", | |
2092 "description": "Data access options." | |
2093 } | 1697 } |
2094 }, | 1698 }, |
2095 "type": "object" | 1699 "type": "object" |
2096 }, | 1700 }, |
2097 "LogDescriptor": { | 1701 "LogDescriptor": { |
2098 "description": "A description of a log type. Example in YAML format:
\n\n - name: library.googleapis.com/activity_history\n description: The
history of borrowing and returning library items.\n display_name: Activity\
n labels:\n - key: /customer_id\n description: Identifier of a
library customer", | 1702 "description": "A description of a log type. Example in YAML format:
\n\n - name: library.googleapis.com/activity_history\n description: The
history of borrowing and returning library items.\n display_name: Activity\
n labels:\n - key: /customer_id\n description: Identifier of a
library customer", |
2099 "id": "LogDescriptor", | 1703 "id": "LogDescriptor", |
2100 "properties": { | 1704 "properties": { |
| 1705 "displayName": { |
| 1706 "description": "The human-readable name for this log. This i
nformation appears on\nthe user interface and should be concise.", |
| 1707 "type": "string" |
| 1708 }, |
| 1709 "description": { |
| 1710 "description": "A human-readable description of this log. Th
is information appears in\nthe documentation and can contain details.", |
| 1711 "type": "string" |
| 1712 }, |
2101 "labels": { | 1713 "labels": { |
2102 "description": "The set of labels that are available to desc
ribe a specific log entry.\nRuntime requests that contain labels not specified h
ere are\nconsidered invalid.", | 1714 "description": "The set of labels that are available to desc
ribe a specific log entry.\nRuntime requests that contain labels not specified h
ere are\nconsidered invalid.", |
2103 "items": { | 1715 "items": { |
2104 "$ref": "LabelDescriptor" | 1716 "$ref": "LabelDescriptor" |
2105 }, | 1717 }, |
2106 "type": "array" | 1718 "type": "array" |
2107 }, | 1719 }, |
2108 "name": { | 1720 "name": { |
2109 "description": "The name of the log. It must be less than 51
2 characters long and can\ninclude the following characters: upper- and lower-ca
se alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\ns
lash, underscore, hyphen, period [/_-.].", | 1721 "description": "The name of the log. It must be less than 51
2 characters long and can\ninclude the following characters: upper- and lower-ca
se alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\ns
lash, underscore, hyphen, period [/_-.].", |
2110 "type": "string" | 1722 "type": "string" |
2111 }, | |
2112 "displayName": { | |
2113 "description": "The human-readable name for this log. This i
nformation appears on\nthe user interface and should be concise.", | |
2114 "type": "string" | |
2115 }, | |
2116 "description": { | |
2117 "description": "A human-readable description of this log. Th
is information appears in\nthe documentation and can contain details.", | |
2118 "type": "string" | |
2119 } | 1723 } |
2120 }, | 1724 }, |
2121 "type": "object" | 1725 "type": "object" |
2122 }, | 1726 }, |
2123 "ConfigFile": { | 1727 "ConfigFile": { |
2124 "description": "Generic specification of a source configuration file
", | 1728 "description": "Generic specification of a source configuration file
", |
2125 "id": "ConfigFile", | 1729 "id": "ConfigFile", |
2126 "properties": { | 1730 "properties": { |
| 1731 "fileContents": { |
| 1732 "description": "The bytes that constitute the file.", |
| 1733 "format": "byte", |
| 1734 "type": "string" |
| 1735 }, |
| 1736 "filePath": { |
| 1737 "description": "The file name of the configuration file (ful
l or relative path).", |
| 1738 "type": "string" |
| 1739 }, |
2127 "fileType": { | 1740 "fileType": { |
2128 "description": "The type of configuration file this represen
ts.", | 1741 "description": "The type of configuration file this represen
ts.", |
2129 "enum": [ | 1742 "enum": [ |
2130 "FILE_TYPE_UNSPECIFIED", | 1743 "FILE_TYPE_UNSPECIFIED", |
2131 "SERVICE_CONFIG_YAML", | 1744 "SERVICE_CONFIG_YAML", |
2132 "OPEN_API_JSON", | 1745 "OPEN_API_JSON", |
2133 "OPEN_API_YAML", | 1746 "OPEN_API_YAML", |
2134 "FILE_DESCRIPTOR_SET_PROTO" | 1747 "FILE_DESCRIPTOR_SET_PROTO" |
2135 ], | 1748 ], |
2136 "enumDescriptions": [ | 1749 "enumDescriptions": [ |
2137 "Unknown file type.", | 1750 "Unknown file type.", |
2138 "YAML-specification of service.", | 1751 "YAML-specification of service.", |
2139 "OpenAPI specification, serialized in JSON.", | 1752 "OpenAPI specification, serialized in JSON.", |
2140 "OpenAPI specification, serialized in YAML.", | 1753 "OpenAPI specification, serialized in YAML.", |
2141 "FileDescriptorSet, generated by protoc.\n\nTo generate,
use protoc with imports and source info included.\nFor an example test.proto fi
le, the following command would put the value\nin a new file named out.pb.\n\n$p
rotoc --include_imports --include_source_info test.proto -o out.pb" | 1754 "FileDescriptorSet, generated by protoc.\n\nTo generate,
use protoc with imports and source info included.\nFor an example test.proto fi
le, the following command would put the value\nin a new file named out.pb.\n\n$p
rotoc --include_imports --include_source_info test.proto -o out.pb" |
2142 ], | 1755 ], |
2143 "type": "string" | 1756 "type": "string" |
2144 }, | |
2145 "fileContents": { | |
2146 "description": "The bytes that constitute the file.", | |
2147 "format": "byte", | |
2148 "type": "string" | |
2149 }, | |
2150 "filePath": { | |
2151 "description": "The file name of the configuration file (ful
l or relative path).", | |
2152 "type": "string" | |
2153 } | 1757 } |
2154 }, | 1758 }, |
2155 "type": "object" | 1759 "type": "object" |
2156 }, | 1760 }, |
2157 "MonitoredResourceDescriptor": { | 1761 "MonitoredResourceDescriptor": { |
2158 "description": "An object that describes the schema of a MonitoredRe
source object using a\ntype name and a set of labels. For example, the monitore
d resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"
gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zo
ne\"` to identify particular VM instances.\n\nDifferent APIs can support differe
nt monitored resource types. APIs generally\nprovide a `list` method that return
s the monitored resource descriptors used\nby the API.", | 1762 "description": "An object that describes the schema of a MonitoredRe
source object using a\ntype name and a set of labels. For example, the monitore
d resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"
gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zo
ne\"` to identify particular VM instances.\n\nDifferent APIs can support differe
nt monitored resource types. APIs generally\nprovide a `list` method that return
s the monitored resource descriptors used\nby the API.", |
2159 "id": "MonitoredResourceDescriptor", | 1763 "id": "MonitoredResourceDescriptor", |
2160 "properties": { | 1764 "properties": { |
2161 "labels": { | 1765 "labels": { |
2162 "description": "Required. A set of labels used to describe i
nstances of this monitored\nresource type. For example, an individual Google Clo
ud SQL database is\nidentified by values for the labels `\"database_id\"` and `\
"zone\"`.", | 1766 "description": "Required. A set of labels used to describe i
nstances of this monitored\nresource type. For example, an individual Google Clo
ud SQL database is\nidentified by values for the labels `\"database_id\"` and `\
"zone\"`.", |
(...skipping 18 matching lines...) Expand all Loading... |
2181 "description": "Required. The monitored resource type. For e
xample, the type\n`\"cloudsql_database\"` represents databases in Google Cloud S
QL.\nThe maximum length of this value is 256 characters.", | 1785 "description": "Required. The monitored resource type. For e
xample, the type\n`\"cloudsql_database\"` represents databases in Google Cloud S
QL.\nThe maximum length of this value is 256 characters.", |
2182 "type": "string" | 1786 "type": "string" |
2183 } | 1787 } |
2184 }, | 1788 }, |
2185 "type": "object" | 1789 "type": "object" |
2186 }, | 1790 }, |
2187 "CustomErrorRule": { | 1791 "CustomErrorRule": { |
2188 "description": "A custom error rule.", | 1792 "description": "A custom error rule.", |
2189 "id": "CustomErrorRule", | 1793 "id": "CustomErrorRule", |
2190 "properties": { | 1794 "properties": { |
2191 "selector": { | |
2192 "description": "Selects messages to which this rule applies.
\n\nRefer to selector for syntax details.", | |
2193 "type": "string" | |
2194 }, | |
2195 "isErrorType": { | 1795 "isErrorType": { |
2196 "description": "Mark this message as possible payload in err
or response. Otherwise,\nobjects of this type will be filtered when they appear
in error payload.", | 1796 "description": "Mark this message as possible payload in err
or response. Otherwise,\nobjects of this type will be filtered when they appear
in error payload.", |
2197 "type": "boolean" | 1797 "type": "boolean" |
| 1798 }, |
| 1799 "selector": { |
| 1800 "description": "Selects messages to which this rule applies.
\n\nRefer to selector for syntax details.", |
| 1801 "type": "string" |
2198 } | 1802 } |
2199 }, | 1803 }, |
2200 "type": "object" | 1804 "type": "object" |
2201 }, | 1805 }, |
2202 "MediaDownload": { | 1806 "MediaDownload": { |
2203 "description": "Defines the Media configuration for a service in cas
e of a download.\nUse this only for Scotty Requests. Do not use this for media s
upport using\nBytestream, add instead [][google.bytestream.RestByteStream] as an
API to\nyour configuration for Bytestream methods.", | 1807 "description": "Defines the Media configuration for a service in cas
e of a download.\nUse this only for Scotty Requests. Do not use this for media s
upport using\nBytestream, add instead [][google.bytestream.RestByteStream] as an
API to\nyour configuration for Bytestream methods.", |
2204 "id": "MediaDownload", | 1808 "id": "MediaDownload", |
2205 "properties": { | 1809 "properties": { |
2206 "enabled": { | 1810 "enabled": { |
2207 "description": "Whether download is enabled.", | 1811 "description": "Whether download is enabled.", |
2208 "type": "boolean" | 1812 "type": "boolean" |
2209 }, | 1813 }, |
2210 "downloadService": { | 1814 "downloadService": { |
2211 "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS
WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for
download.", | 1815 "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS
WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for
download.", |
2212 "type": "string" | 1816 "type": "string" |
2213 }, | 1817 }, |
2214 "completeNotification": { | 1818 "completeNotification": { |
2215 "description": "A boolean that determines whether a notifica
tion for the completion of a\ndownload should be sent to the backend.", | 1819 "description": "A boolean that determines whether a notifica
tion for the completion of a\ndownload should be sent to the backend.", |
2216 "type": "boolean" | 1820 "type": "boolean" |
2217 }, | 1821 }, |
2218 "dropzone": { | |
2219 "description": "Name of the Scotty dropzone to use for the c
urrent API.", | |
2220 "type": "string" | |
2221 }, | |
2222 "maxDirectDownloadSize": { | 1822 "maxDirectDownloadSize": { |
2223 "description": "Optional maximum acceptable size for direct
download.\nThe size is specified in bytes.", | 1823 "description": "Optional maximum acceptable size for direct
download.\nThe size is specified in bytes.", |
2224 "format": "int64", | 1824 "format": "int64", |
2225 "type": "string" | 1825 "type": "string" |
2226 }, | 1826 }, |
| 1827 "dropzone": { |
| 1828 "description": "Name of the Scotty dropzone to use for the c
urrent API.", |
| 1829 "type": "string" |
| 1830 }, |
2227 "useDirectDownload": { | 1831 "useDirectDownload": { |
2228 "description": "A boolean that determines if direct download
from ESF should be used for\ndownload of this media.", | 1832 "description": "A boolean that determines if direct download
from ESF should be used for\ndownload of this media.", |
2229 "type": "boolean" | 1833 "type": "boolean" |
2230 } | 1834 } |
2231 }, | 1835 }, |
2232 "type": "object" | 1836 "type": "object" |
2233 }, | 1837 }, |
2234 "CustomAuthRequirements": { | 1838 "CustomAuthRequirements": { |
2235 "description": "Configuration for a custom authentication provider."
, | 1839 "description": "Configuration for a custom authentication provider."
, |
2236 "id": "CustomAuthRequirements", | 1840 "id": "CustomAuthRequirements", |
(...skipping 38 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2275 "$ref": "Service", | 1879 "$ref": "Service", |
2276 "description": "The generated service configuration." | 1880 "description": "The generated service configuration." |
2277 } | 1881 } |
2278 }, | 1882 }, |
2279 "type": "object" | 1883 "type": "object" |
2280 }, | 1884 }, |
2281 "MediaUpload": { | 1885 "MediaUpload": { |
2282 "description": "Defines the Media configuration for a service in cas
e of an upload.\nUse this only for Scotty Requests. Do not use this for media su
pport using\nBytestream, add instead [][google.bytestream.RestByteStream] as an
API to\nyour configuration for Bytestream methods.", | 1886 "description": "Defines the Media configuration for a service in cas
e of an upload.\nUse this only for Scotty Requests. Do not use this for media su
pport using\nBytestream, add instead [][google.bytestream.RestByteStream] as an
API to\nyour configuration for Bytestream methods.", |
2283 "id": "MediaUpload", | 1887 "id": "MediaUpload", |
2284 "properties": { | 1888 "properties": { |
| 1889 "completeNotification": { |
| 1890 "description": "A boolean that determines whether a notifica
tion for the completion of an\nupload should be sent to the backend. These notif
ications will not be seen\nby the client and will not consume quota.", |
| 1891 "type": "boolean" |
| 1892 }, |
| 1893 "progressNotification": { |
| 1894 "description": "Whether to receive a notification for progre
ss changes of media upload.", |
| 1895 "type": "boolean" |
| 1896 }, |
| 1897 "enabled": { |
| 1898 "description": "Whether upload is enabled.", |
| 1899 "type": "boolean" |
| 1900 }, |
| 1901 "dropzone": { |
| 1902 "description": "Name of the Scotty dropzone to use for the c
urrent API.", |
| 1903 "type": "string" |
| 1904 }, |
| 1905 "startNotification": { |
| 1906 "description": "Whether to receive a notification on the sta
rt of media upload.", |
| 1907 "type": "boolean" |
| 1908 }, |
| 1909 "uploadService": { |
| 1910 "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS
WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for up
load.", |
| 1911 "type": "string" |
| 1912 }, |
2285 "mimeTypes": { | 1913 "mimeTypes": { |
2286 "description": "An array of mimetype patterns. Esf will only
accept uploads that match one\nof the given patterns.", | 1914 "description": "An array of mimetype patterns. Esf will only
accept uploads that match one\nof the given patterns.", |
2287 "items": { | 1915 "items": { |
2288 "type": "string" | 1916 "type": "string" |
2289 }, | 1917 }, |
2290 "type": "array" | 1918 "type": "array" |
2291 }, | 1919 }, |
2292 "maxSize": { | 1920 "maxSize": { |
2293 "description": "Optional maximum acceptable size for an uplo
ad.\nThe size is specified in bytes.", | 1921 "description": "Optional maximum acceptable size for an uplo
ad.\nThe size is specified in bytes.", |
2294 "format": "int64", | 1922 "format": "int64", |
2295 "type": "string" | 1923 "type": "string" |
2296 }, | |
2297 "completeNotification": { | |
2298 "description": "A boolean that determines whether a notifica
tion for the completion of an\nupload should be sent to the backend. These notif
ications will not be seen\nby the client and will not consume quota.", | |
2299 "type": "boolean" | |
2300 }, | |
2301 "progressNotification": { | |
2302 "description": "Whether to receive a notification for progre
ss changes of media upload.", | |
2303 "type": "boolean" | |
2304 }, | |
2305 "enabled": { | |
2306 "description": "Whether upload is enabled.", | |
2307 "type": "boolean" | |
2308 }, | |
2309 "dropzone": { | |
2310 "description": "Name of the Scotty dropzone to use for the c
urrent API.", | |
2311 "type": "string" | |
2312 }, | |
2313 "startNotification": { | |
2314 "description": "Whether to receive a notification on the sta
rt of media upload.", | |
2315 "type": "boolean" | |
2316 }, | |
2317 "uploadService": { | |
2318 "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS
WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for up
load.", | |
2319 "type": "string" | |
2320 } | 1924 } |
2321 }, | 1925 }, |
2322 "type": "object" | 1926 "type": "object" |
2323 }, | 1927 }, |
2324 "Advice": { | 1928 "Advice": { |
2325 "description": "Generated advice about this change, used for providi
ng more\ninformation about how a change will affect the existing service.", | 1929 "description": "Generated advice about this change, used for providi
ng more\ninformation about how a change will affect the existing service.", |
2326 "id": "Advice", | 1930 "id": "Advice", |
2327 "properties": { | 1931 "properties": { |
2328 "description": { | 1932 "description": { |
2329 "description": "Useful description for why this advice was a
pplied and what actions should\nbe taken to mitigate any implied risks.", | 1933 "description": "Useful description for why this advice was a
pplied and what actions should\nbe taken to mitigate any implied risks.", |
2330 "type": "string" | 1934 "type": "string" |
2331 } | 1935 } |
2332 }, | 1936 }, |
2333 "type": "object" | 1937 "type": "object" |
2334 }, | 1938 }, |
2335 "ManagedService": { | 1939 "ManagedService": { |
2336 "description": "The full representation of a Service that is managed
by\nGoogle Service Management.", | 1940 "description": "The full representation of a Service that is managed
by\nGoogle Service Management.", |
2337 "id": "ManagedService", | 1941 "id": "ManagedService", |
2338 "properties": { | 1942 "properties": { |
| 1943 "producerProjectId": { |
| 1944 "description": "ID of the project that produces and owns thi
s service.", |
| 1945 "type": "string" |
| 1946 }, |
2339 "serviceName": { | 1947 "serviceName": { |
2340 "description": "The name of the service. See the [overview](
/service-management/overview)\nfor naming requirements.", | 1948 "description": "The name of the service. See the [overview](
/service-management/overview)\nfor naming requirements.", |
2341 "type": "string" | 1949 "type": "string" |
2342 }, | |
2343 "producerProjectId": { | |
2344 "description": "ID of the project that produces and owns thi
s service.", | |
2345 "type": "string" | |
2346 } | 1950 } |
2347 }, | 1951 }, |
2348 "type": "object" | 1952 "type": "object" |
2349 }, | 1953 }, |
2350 "UsageRule": { | 1954 "UsageRule": { |
2351 "description": "Usage configuration rules for the service.\n\nNOTE:
Under development.\n\n\nUse this rule to configure unregistered calls for the se
rvice. Unregistered\ncalls are calls that do not contain consumer project identi
ty.\n(Example: calls that do not contain an API key).\nBy default, API methods d
o not allow unregistered calls, and each method call\nmust be identified by a co
nsumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\
nExample of an API that wants to allow unregistered calls for entire service.\n\
n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_c
alls: true\n\nExample of a method that wants to allow unregistered calls.\n\n
usage:\n rules:\n - selector: \"google.example.library.v1.LibraryServ
ice.CreateBook\"\n allow_unregistered_calls: true", | 1955 "description": "Usage configuration rules for the service.\n\nNOTE:
Under development.\n\n\nUse this rule to configure unregistered calls for the se
rvice. Unregistered\ncalls are calls that do not contain consumer project identi
ty.\n(Example: calls that do not contain an API key).\nBy default, API methods d
o not allow unregistered calls, and each method call\nmust be identified by a co
nsumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\
nExample of an API that wants to allow unregistered calls for entire service.\n\
n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_c
alls: true\n\nExample of a method that wants to allow unregistered calls.\n\n
usage:\n rules:\n - selector: \"google.example.library.v1.LibraryServ
ice.CreateBook\"\n allow_unregistered_calls: true", |
2352 "id": "UsageRule", | 1956 "id": "UsageRule", |
2353 "properties": { | 1957 "properties": { |
2354 "selector": { | 1958 "selector": { |
2355 "description": "Selects the methods to which this rule appli
es. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for synta
x details.", | 1959 "description": "Selects the methods to which this rule appli
es. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for synta
x details.", |
2356 "type": "string" | 1960 "type": "string" |
2357 }, | 1961 }, |
2358 "skipServiceControl": { | 1962 "skipServiceControl": { |
2359 "description": "True, if the method should skip service cont
rol. If so, no control plane\nfeature (like quota and billing) will be enabled."
, | 1963 "description": "True, if the method should skip service cont
rol. If so, no control plane\nfeature (like quota and billing) will be enabled."
, |
2360 "type": "boolean" | 1964 "type": "boolean" |
2361 }, | 1965 }, |
2362 "allowUnregisteredCalls": { | 1966 "allowUnregisteredCalls": { |
2363 "description": "True, if the method allows unregistered call
s; false otherwise.", | 1967 "description": "True, if the method allows unregistered call
s; false otherwise.", |
2364 "type": "boolean" | 1968 "type": "boolean" |
2365 } | 1969 } |
2366 }, | 1970 }, |
2367 "type": "object" | 1971 "type": "object" |
2368 }, | 1972 }, |
| 1973 "AuthRequirement": { |
| 1974 "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).", |
| 1975 "id": "AuthRequirement", |
| 1976 "properties": { |
| 1977 "audiences": { |
| 1978 "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", |
| 1979 "type": "string" |
| 1980 }, |
| 1981 "providerId": { |
| 1982 "description": "id from authentication provider.\n\nExample:
\n\n provider_id: bookstore_auth", |
| 1983 "type": "string" |
| 1984 } |
| 1985 }, |
| 1986 "type": "object" |
| 1987 }, |
2369 "TrafficPercentStrategy": { | 1988 "TrafficPercentStrategy": { |
2370 "description": "Strategy that specifies how clients of Google Servic
e Controller want to\nsend traffic to use different config versions. This is gen
erally\nused by API proxy to split traffic based on your configured precentage f
or\neach config version.\n\nOne example of how to gradually rollout a new servic
e configuration using\nthis\nstrategy:\nDay 1\n\n Rollout {\n id: \"exam
ple.googleapis.com/rollout_20160206\"\n traffic_percent_strategy {\n
percentages: {\n \"example.googleapis.com/20160201\": 70.00\n
\"example.googleapis.com/20160206\": 30.00\n }\n }\n }\n\nDay 2\
n\n Rollout {\n id: \"example.googleapis.com/rollout_20160207\"\n t
raffic_percent_strategy: {\n percentages: {\n \"example.googleap
is.com/20160206\": 100.00\n }\n }\n }", | 1989 "description": "Strategy that specifies how clients of Google Servic
e Controller want to\nsend traffic to use different config versions. This is gen
erally\nused by API proxy to split traffic based on your configured precentage f
or\neach config version.\n\nOne example of how to gradually rollout a new servic
e configuration using\nthis\nstrategy:\nDay 1\n\n Rollout {\n id: \"exam
ple.googleapis.com/rollout_20160206\"\n traffic_percent_strategy {\n
percentages: {\n \"example.googleapis.com/20160201\": 70.00\n
\"example.googleapis.com/20160206\": 30.00\n }\n }\n }\n\nDay 2\
n\n Rollout {\n id: \"example.googleapis.com/rollout_20160207\"\n t
raffic_percent_strategy: {\n percentages: {\n \"example.googleap
is.com/20160206\": 100.00\n }\n }\n }", |
2371 "id": "TrafficPercentStrategy", | 1990 "id": "TrafficPercentStrategy", |
2372 "properties": { | 1991 "properties": { |
2373 "percentages": { | 1992 "percentages": { |
2374 "additionalProperties": { | 1993 "additionalProperties": { |
2375 "format": "double", | 1994 "format": "double", |
2376 "type": "number" | 1995 "type": "number" |
2377 }, | 1996 }, |
2378 "description": "Maps service configuration IDs to their corr
esponding traffic percentage.\nKey is the service configuration ID, Value is the
traffic percentage\nwhich must be greater than 0.0 and the sum must equal to 10
0.0.", | 1997 "description": "Maps service configuration IDs to their corr
esponding traffic percentage.\nKey is the service configuration ID, Value is the
traffic percentage\nwhich must be greater than 0.0 and the sum must equal to 10
0.0.", |
2379 "type": "object" | 1998 "type": "object" |
2380 } | 1999 } |
2381 }, | 2000 }, |
2382 "type": "object" | 2001 "type": "object" |
2383 }, | 2002 }, |
2384 "AuthRequirement": { | 2003 "Documentation": { |
2385 "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).", | 2004 "description": "`Documentation` provides the information for describ
ing a service.\n\nExample:\n<pre><code>documentation:\n summary: >\n The Goo
gle Calendar API gives access\n to most calendar features.\n pages:\n - nam
e: Overview\n content: (== include google/foo/overview.md ==)\n - na
me: Tutorial\n content: (== include google/foo/tutorial.md ==)\n s
ubpages;\n - name: Java\n content: (== include google/foo/tutorial_j
ava.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n descri
ption: >\n ...\n - selector: google.calendar.Calendar.Put\n description
: >\n ...\n</code></pre>\nDocumentation is provided in markdown syntax. In
addition to\nstandard markdown features, definition lists, tables and fenced\nco
de blocks are supported. Section headers can be provided and are\ninterpreted re
lative to the section nesting of the context where\na documentation fragment is
embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvi
a the config at normalization time, where documentation provided\nby config rule
s overrides IDL provided.\n\nA number of constructs specific to the API platform
are supported\nin documentation text.\n\nIn order to reference a proto element,
the following\nnotation can be used:\n<pre><code>[fully.qualified.proto.nam
e][]</code></pre>\nTo override the display text used for the link, this can
be used:\n<pre><code>[display text][fully.qualified.proto.name]</code></
pre>\nText can be excluded from doc using the following notation:\n<pre><code>&#
40;-- internal comment --)</code></pre>\nComments can be made conditional us
ing a visibility label. The below\ntext will be only rendered if the `BETA` labe
l is available:\n<pre><code>(--BETA: comment for BETA users --)</code></
pre>\nA few directives are available in documentation. Note that\ndirectives mus
t appear on a single line to be properly\nidentified. The `include` directive in
cludes a markdown file from\nan external source:\n<pre><code>(== include pat
h/to/file ==)</code></pre>\nThe `resource_for` directive marks a message to
be the resource of\na collection in REST view. If it is not specified, tools att
empt\nto infer the resource from the operations in a collection:\n<pre><code>
0;== resource_for v1.shelves.books ==)</code></pre>\nThe directive `suppress
_warning` does not directly affect documentation\nand is documented together wit
h service config validation.", |
2386 "id": "AuthRequirement", | 2005 "id": "Documentation", |
2387 "properties": { | 2006 "properties": { |
2388 "audiences": { | 2007 "summary": { |
2389 "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", | 2008 "description": "A short summary of what the service does. Ca
n only be provided by\nplain text.", |
2390 "type": "string" | 2009 "type": "string" |
2391 }, | 2010 }, |
2392 "providerId": { | 2011 "documentationRootUrl": { |
2393 "description": "id from authentication provider.\n\nExample:
\n\n provider_id: bookstore_auth", | 2012 "description": "The URL to the root of documentation.", |
2394 "type": "string" | 2013 "type": "string" |
| 2014 }, |
| 2015 "overview": { |
| 2016 "description": "Declares a single overview page. For example
:\n<pre><code>documentation:\n summary: ...\n overview: (== include overvi
ew.md ==)\n</code></pre>\nThis is a shortcut for the following declaration (
using pages style):\n<pre><code>documentation:\n summary: ...\n pages:\n - na
me: Overview\n content: (== include overview.md ==)\n</code></pre>\nN
ote: you cannot specify both `overview` field and `pages` field.", |
| 2017 "type": "string" |
| 2018 }, |
| 2019 "rules": { |
| 2020 "description": "A list of documentation rules that apply to
individual API elements.\n\n**NOTE:** All service configuration rules follow \"l
ast one wins\" order.", |
| 2021 "items": { |
| 2022 "$ref": "DocumentationRule" |
| 2023 }, |
| 2024 "type": "array" |
| 2025 }, |
| 2026 "pages": { |
| 2027 "description": "The top level pages for the documentation se
t.", |
| 2028 "items": { |
| 2029 "$ref": "Page" |
| 2030 }, |
| 2031 "type": "array" |
2395 } | 2032 } |
2396 }, | 2033 }, |
2397 "type": "object" | 2034 "type": "object" |
2398 }, | 2035 }, |
2399 "Condition": { | 2036 "Condition": { |
2400 "description": "A condition to be met.", | 2037 "description": "A condition to be met.", |
2401 "id": "Condition", | 2038 "id": "Condition", |
2402 "properties": { | 2039 "properties": { |
2403 "sys": { | |
2404 "description": "Trusted attributes supplied by any service t
hat owns resources and uses\nthe IAM system for access control.", | |
2405 "enum": [ | |
2406 "NO_ATTR", | |
2407 "REGION", | |
2408 "SERVICE", | |
2409 "NAME", | |
2410 "IP" | |
2411 ], | |
2412 "enumDescriptions": [ | |
2413 "Default non-attribute type", | |
2414 "Region of the resource", | |
2415 "Service name", | |
2416 "Resource name", | |
2417 "IP address of the caller" | |
2418 ], | |
2419 "type": "string" | |
2420 }, | |
2421 "value": { | |
2422 "description": "DEPRECATED. Use 'values' instead.", | |
2423 "type": "string" | |
2424 }, | |
2425 "values": { | |
2426 "description": "The objects of the condition. This is mutual
ly exclusive with 'value'.", | |
2427 "items": { | |
2428 "type": "string" | |
2429 }, | |
2430 "type": "array" | |
2431 }, | |
2432 "iam": { | |
2433 "description": "Trusted attributes supplied by the IAM syste
m.", | |
2434 "enum": [ | |
2435 "NO_ATTR", | |
2436 "AUTHORITY", | |
2437 "ATTRIBUTION", | |
2438 "APPROVER", | |
2439 "JUSTIFICATION_TYPE" | |
2440 ], | |
2441 "enumDescriptions": [ | |
2442 "Default non-attribute.", | |
2443 "Either principal or (if present) authority selector.", | |
2444 "The principal (even if an authority selector is present
), which\nmust only be used for attribution, not authorization.", | |
2445 "An approver (distinct from the requester) that has auth
orized this\nrequest.\nWhen used with IN, the condition indicates that one of th
e approvers\nassociated with the request matches the specified principal, or is
a\nmember of the specified group. Approvers can only grant additional\naccess, a
nd are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT
_IN).", | |
2446 "What types of justifications have been supplied with th
is request.\nString values should match enum names from tech.iam.JustificationTy
pe,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *
absence* of a justification, so justification conditions can only\nbe used in a
\"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications
, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported.
" | |
2447 ], | |
2448 "type": "string" | |
2449 }, | |
2450 "op": { | 2040 "op": { |
2451 "description": "An operator to apply the subject with.", | 2041 "description": "An operator to apply the subject with.", |
2452 "enum": [ | 2042 "enum": [ |
2453 "NO_OP", | 2043 "NO_OP", |
2454 "EQUALS", | 2044 "EQUALS", |
2455 "NOT_EQUALS", | 2045 "NOT_EQUALS", |
2456 "IN", | 2046 "IN", |
2457 "NOT_IN", | 2047 "NOT_IN", |
2458 "DISCHARGED" | 2048 "DISCHARGED" |
2459 ], | 2049 ], |
2460 "enumDescriptions": [ | 2050 "enumDescriptions": [ |
2461 "Default no-op.", | 2051 "Default no-op.", |
2462 "DEPRECATED. Use IN instead.", | 2052 "DEPRECATED. Use IN instead.", |
2463 "DEPRECATED. Use NOT_IN instead.", | 2053 "DEPRECATED. Use NOT_IN instead.", |
2464 "The condition is true if the subject (or any element of
it if it is\na set) matches any of the supplied values.", | 2054 "The condition is true if the subject (or any element of
it if it is\na set) matches any of the supplied values.", |
2465 "The condition is true if the subject (or every element
of it if it is\na set) matches none of the supplied values.", | 2055 "The condition is true if the subject (or every element
of it if it is\na set) matches none of the supplied values.", |
2466 "Subject is discharged" | 2056 "Subject is discharged" |
2467 ], | 2057 ], |
2468 "type": "string" | 2058 "type": "string" |
2469 }, | 2059 }, |
2470 "svc": { | 2060 "svc": { |
2471 "description": "Trusted attributes discharged by the service
.", | 2061 "description": "Trusted attributes discharged by the service
.", |
2472 "type": "string" | 2062 "type": "string" |
2473 } | 2063 }, |
2474 }, | 2064 "value": { |
2475 "type": "object" | 2065 "description": "DEPRECATED. Use 'values' instead.", |
2476 }, | 2066 "type": "string" |
2477 "Documentation": { | 2067 }, |
2478 "description": "`Documentation` provides the information for describ
ing a service.\n\nExample:\n<pre><code>documentation:\n summary: >\n The Goo
gle Calendar API gives access\n to most calendar features.\n pages:\n - nam
e: Overview\n content: (== include google/foo/overview.md ==)\n - na
me: Tutorial\n content: (== include google/foo/tutorial.md ==)\n s
ubpages;\n - name: Java\n content: (== include google/foo/tutorial_j
ava.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n descri
ption: >\n ...\n - selector: google.calendar.Calendar.Put\n description
: >\n ...\n</code></pre>\nDocumentation is provided in markdown syntax. In
addition to\nstandard markdown features, definition lists, tables and fenced\nco
de blocks are supported. Section headers can be provided and are\ninterpreted re
lative to the section nesting of the context where\na documentation fragment is
embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvi
a the config at normalization time, where documentation provided\nby config rule
s overrides IDL provided.\n\nA number of constructs specific to the API platform
are supported\nin documentation text.\n\nIn order to reference a proto element,
the following\nnotation can be used:\n<pre><code>[fully.qualified.proto.nam
e][]</code></pre>\nTo override the display text used for the link, this can
be used:\n<pre><code>[display text][fully.qualified.proto.name]</code></
pre>\nText can be excluded from doc using the following notation:\n<pre><code>&#
40;-- internal comment --)</code></pre>\nComments can be made conditional us
ing a visibility label. The below\ntext will be only rendered if the `BETA` labe
l is available:\n<pre><code>(--BETA: comment for BETA users --)</code></
pre>\nA few directives are available in documentation. Note that\ndirectives mus
t appear on a single line to be properly\nidentified. The `include` directive in
cludes a markdown file from\nan external source:\n<pre><code>(== include pat
h/to/file ==)</code></pre>\nThe `resource_for` directive marks a message to
be the resource of\na collection in REST view. If it is not specified, tools att
empt\nto infer the resource from the operations in a collection:\n<pre><code>
0;== resource_for v1.shelves.books ==)</code></pre>\nThe directive `suppress
_warning` does not directly affect documentation\nand is documented together wit
h service config validation.", | 2068 "sys": { |
2479 "id": "Documentation", | 2069 "description": "Trusted attributes supplied by any service t
hat owns resources and uses\nthe IAM system for access control.", |
2480 "properties": { | 2070 "enum": [ |
2481 "summary": { | 2071 "NO_ATTR", |
2482 "description": "A short summary of what the service does. Ca
n only be provided by\nplain text.", | 2072 "REGION", |
2483 "type": "string" | 2073 "SERVICE", |
2484 }, | 2074 "NAME", |
2485 "documentationRootUrl": { | 2075 "IP" |
2486 "description": "The URL to the root of documentation.", | 2076 ], |
2487 "type": "string" | 2077 "enumDescriptions": [ |
2488 }, | 2078 "Default non-attribute type", |
2489 "overview": { | 2079 "Region of the resource", |
2490 "description": "Declares a single overview page. For example
:\n<pre><code>documentation:\n summary: ...\n overview: (== include overvi
ew.md ==)\n</code></pre>\nThis is a shortcut for the following declaration (
using pages style):\n<pre><code>documentation:\n summary: ...\n pages:\n - na
me: Overview\n content: (== include overview.md ==)\n</code></pre>\nN
ote: you cannot specify both `overview` field and `pages` field.", | 2080 "Service name", |
2491 "type": "string" | 2081 "Resource name", |
2492 }, | 2082 "IP address of the caller" |
2493 "rules": { | 2083 ], |
2494 "description": "A list of documentation rules that apply to
individual API elements.\n\n**NOTE:** All service configuration rules follow \"l
ast one wins\" order.", | 2084 "type": "string" |
2495 "items": { | 2085 }, |
2496 "$ref": "DocumentationRule" | 2086 "iam": { |
2497 }, | 2087 "description": "Trusted attributes supplied by the IAM syste
m.", |
2498 "type": "array" | 2088 "enum": [ |
2499 }, | 2089 "NO_ATTR", |
2500 "pages": { | 2090 "AUTHORITY", |
2501 "description": "The top level pages for the documentation se
t.", | 2091 "ATTRIBUTION", |
2502 "items": { | 2092 "APPROVER", |
2503 "$ref": "Page" | 2093 "JUSTIFICATION_TYPE" |
| 2094 ], |
| 2095 "enumDescriptions": [ |
| 2096 "Default non-attribute.", |
| 2097 "Either principal or (if present) authority selector.", |
| 2098 "The principal (even if an authority selector is present
), which\nmust only be used for attribution, not authorization.", |
| 2099 "An approver (distinct from the requester) that has auth
orized this\nrequest.\nWhen used with IN, the condition indicates that one of th
e approvers\nassociated with the request matches the specified principal, or is
a\nmember of the specified group. Approvers can only grant additional\naccess, a
nd are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT
_IN).", |
| 2100 "What types of justifications have been supplied with th
is request.\nString values should match enum names from tech.iam.JustificationTy
pe,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *
absence* of a justification, so justification conditions can only\nbe used in a
\"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications
, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported.
" |
| 2101 ], |
| 2102 "type": "string" |
| 2103 }, |
| 2104 "values": { |
| 2105 "description": "The objects of the condition. This is mutual
ly exclusive with 'value'.", |
| 2106 "items": { |
| 2107 "type": "string" |
2504 }, | 2108 }, |
2505 "type": "array" | 2109 "type": "array" |
2506 } | 2110 } |
2507 }, | 2111 }, |
2508 "type": "object" | 2112 "type": "object" |
2509 }, | 2113 }, |
2510 "AuditLogConfig": { | 2114 "AuditLogConfig": { |
2511 "description": "Provides the configuration for logging a type of per
missions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n
\"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n
\"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type
\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and '
DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", | 2115 "description": "Provides the configuration for logging a type of per
missions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n
\"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n
\"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type
\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and '
DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", |
2512 "id": "AuditLogConfig", | 2116 "id": "AuditLogConfig", |
2513 "properties": { | 2117 "properties": { |
(...skipping 20 matching lines...) Expand all Loading... |
2534 }, | 2138 }, |
2535 "type": "array" | 2139 "type": "array" |
2536 } | 2140 } |
2537 }, | 2141 }, |
2538 "type": "object" | 2142 "type": "object" |
2539 }, | 2143 }, |
2540 "ConfigSource": { | 2144 "ConfigSource": { |
2541 "description": "Represents a source file which is used to generate t
he service configuration\ndefined by `google.api.Service`.", | 2145 "description": "Represents a source file which is used to generate t
he service configuration\ndefined by `google.api.Service`.", |
2542 "id": "ConfigSource", | 2146 "id": "ConfigSource", |
2543 "properties": { | 2147 "properties": { |
| 2148 "files": { |
| 2149 "description": "Set of source configuration files that are u
sed to generate a service\nconfiguration (`google.api.Service`).", |
| 2150 "items": { |
| 2151 "$ref": "ConfigFile" |
| 2152 }, |
| 2153 "type": "array" |
| 2154 }, |
2544 "id": { | 2155 "id": { |
2545 "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.", | 2156 "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.", |
2546 "type": "string" | 2157 "type": "string" |
2547 }, | 2158 } |
2548 "files": { | 2159 }, |
2549 "description": "Set of source configuration files that are u
sed to generate a service\nconfiguration (`google.api.Service`).", | 2160 "type": "object" |
2550 "items": { | 2161 }, |
2551 "$ref": "ConfigFile" | 2162 "AuthenticationRule": { |
2552 }, | 2163 "description": "Authentication rules for the service.\n\nBy default,
if a method has any authentication requirements, every request\nmust include a
valid credential matching one of the requirements.\nIt's an error to include mor
e than one kind of credential in a single\nrequest.\n\nIf a method doesn't have
any auth requirements, request credentials will be\nignored.", |
2553 "type": "array" | 2164 "id": "AuthenticationRule", |
| 2165 "properties": { |
| 2166 "requirements": { |
| 2167 "description": "Requirements for additional authentication p
roviders.", |
| 2168 "items": { |
| 2169 "$ref": "AuthRequirement" |
| 2170 }, |
| 2171 "type": "array" |
| 2172 }, |
| 2173 "allowWithoutCredential": { |
| 2174 "description": "Whether to allow requests without a credenti
al. The credential can be\nan OAuth token, Google cookies (first-party auth) or
EndUserCreds.\n\nFor requests without credentials, if the service control enviro
nment is\nspecified, each incoming request **must** be associated with a service
\nconsumer. This can be done by passing an API key that belongs to a consumer\np
roject.", |
| 2175 "type": "boolean" |
| 2176 }, |
| 2177 "selector": { |
| 2178 "description": "Selects the methods to which this rule appli
es.\n\nRefer to selector for syntax details.", |
| 2179 "type": "string" |
| 2180 }, |
| 2181 "customAuth": { |
| 2182 "$ref": "CustomAuthRequirements", |
| 2183 "description": "Configuration for custom authentication." |
| 2184 }, |
| 2185 "oauth": { |
| 2186 "$ref": "OAuthRequirements", |
| 2187 "description": "The requirements for OAuth credentials." |
2554 } | 2188 } |
2555 }, | 2189 }, |
2556 "type": "object" | 2190 "type": "object" |
2557 }, | 2191 }, |
2558 "BackendRule": { | 2192 "BackendRule": { |
2559 "description": "A backend rule provides configuration for an individ
ual API element.", | 2193 "description": "A backend rule provides configuration for an individ
ual API element.", |
2560 "id": "BackendRule", | 2194 "id": "BackendRule", |
2561 "properties": { | 2195 "properties": { |
2562 "selector": { | |
2563 "description": "Selects the methods to which this rule appli
es.\n\nRefer to selector for syntax details.", | |
2564 "type": "string" | |
2565 }, | |
2566 "deadline": { | 2196 "deadline": { |
2567 "description": "The number of seconds to wait for a response
from a request. The\ndefault depends on the deployment context.", | 2197 "description": "The number of seconds to wait for a response
from a request. The\ndefault depends on the deployment context.", |
2568 "format": "double", | 2198 "format": "double", |
2569 "type": "number" | 2199 "type": "number" |
2570 }, | 2200 }, |
2571 "minDeadline": { | 2201 "minDeadline": { |
2572 "description": "Minimum deadline in seconds needed for this
method. Calls having deadline\nvalue lower than this will be rejected.", | 2202 "description": "Minimum deadline in seconds needed for this
method. Calls having deadline\nvalue lower than this will be rejected.", |
2573 "format": "double", | 2203 "format": "double", |
2574 "type": "number" | 2204 "type": "number" |
2575 }, | 2205 }, |
2576 "address": { | 2206 "address": { |
2577 "description": "The address of the API backend.", | 2207 "description": "The address of the API backend.", |
2578 "type": "string" | 2208 "type": "string" |
2579 } | |
2580 }, | |
2581 "type": "object" | |
2582 }, | |
2583 "AuthenticationRule": { | |
2584 "description": "Authentication rules for the service.\n\nBy default,
if a method has any authentication requirements, every request\nmust include a
valid credential matching one of the requirements.\nIt's an error to include mor
e than one kind of credential in a single\nrequest.\n\nIf a method doesn't have
any auth requirements, request credentials will be\nignored.", | |
2585 "id": "AuthenticationRule", | |
2586 "properties": { | |
2587 "requirements": { | |
2588 "description": "Requirements for additional authentication p
roviders.", | |
2589 "items": { | |
2590 "$ref": "AuthRequirement" | |
2591 }, | |
2592 "type": "array" | |
2593 }, | |
2594 "allowWithoutCredential": { | |
2595 "description": "Whether to allow requests without a credenti
al. The credential can be\nan OAuth token, Google cookies (first-party auth) or
EndUserCreds.\n\nFor requests without credentials, if the service control enviro
nment is\nspecified, each incoming request **must** be associated with a service
\nconsumer. This can be done by passing an API key that belongs to a consumer\np
roject.", | |
2596 "type": "boolean" | |
2597 }, | 2209 }, |
2598 "selector": { | 2210 "selector": { |
2599 "description": "Selects the methods to which this rule appli
es.\n\nRefer to selector for syntax details.", | 2211 "description": "Selects the methods to which this rule appli
es.\n\nRefer to selector for syntax details.", |
2600 "type": "string" | 2212 "type": "string" |
2601 }, | |
2602 "customAuth": { | |
2603 "$ref": "CustomAuthRequirements", | |
2604 "description": "Configuration for custom authentication." | |
2605 }, | |
2606 "oauth": { | |
2607 "$ref": "OAuthRequirements", | |
2608 "description": "The requirements for OAuth credentials." | |
2609 } | |
2610 }, | |
2611 "type": "object" | |
2612 }, | |
2613 "UndeleteServiceResponse": { | |
2614 "description": "Response message for UndeleteService method.", | |
2615 "id": "UndeleteServiceResponse", | |
2616 "properties": { | |
2617 "service": { | |
2618 "$ref": "ManagedService", | |
2619 "description": "Revived service resource." | |
2620 } | 2213 } |
2621 }, | 2214 }, |
2622 "type": "object" | 2215 "type": "object" |
2623 }, | 2216 }, |
2624 "Policy": { | 2217 "Policy": { |
2625 "description": "Defines an Identity and Access Management (IAM) poli
cy. It is used to\nspecify access control policies for Cloud Platform resources.
\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n
`members` to a `role`, where the members can be user accounts, Google groups,\nG
oogle domains, and service accounts. A `role` is a named list of permissions\nde
fined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n
\"role\": \"roles/owner\",\n \"members\": [\n \"user:mike
@example.com\",\n \"group:admins@example.com\",\n \"domain
:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccoun
t.com\",\n ]\n },\n {\n \"role\": \"roles/viewer
\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n
}\n\nFor a description of IAM and its features, see the\n[IAM developer's guide
](https://cloud.google.com/iam).", | 2218 "description": "Defines an Identity and Access Management (IAM) poli
cy. It is used to\nspecify access control policies for Cloud Platform resources.
\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n
`members` to a `role`, where the members can be user accounts, Google groups,\nG
oogle domains, and service accounts. A `role` is a named list of permissions\nde
fined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n
\"role\": \"roles/owner\",\n \"members\": [\n \"user:mike
@example.com\",\n \"group:admins@example.com\",\n \"domain
:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccoun
t.com\",\n ]\n },\n {\n \"role\": \"roles/viewer
\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n
}\n\nFor a description of IAM and its features, see the\n[IAM developer's guide
](https://cloud.google.com/iam).", |
2626 "id": "Policy", | 2219 "id": "Policy", |
2627 "properties": { | 2220 "properties": { |
| 2221 "etag": { |
| 2222 "description": "`etag` is used for optimistic concurrency co
ntrol as a way to help\nprevent simultaneous updates of a policy from overwritin
g each other.\nIt is strongly suggested that systems make use of the `etag` in t
he\nread-modify-write cycle to perform policy updates in order to avoid race\nco
nditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems
are expected to put that etag in the request to `setIamPolicy` to\nensure that t
heir change will be applied to the same version of the policy.\n\nIf no `etag` i
s provided in the call to `setIamPolicy`, then the existing\npolicy is overwritt
en blindly.", |
| 2223 "format": "byte", |
| 2224 "type": "string" |
| 2225 }, |
2628 "iamOwned": { | 2226 "iamOwned": { |
2629 "type": "boolean" | 2227 "type": "boolean" |
2630 }, | 2228 }, |
2631 "rules": { | 2229 "rules": { |
2632 "description": "If more than one rule is specified, the rule
s are applied in the following\nmanner:\n- All matching LOG rules are always app
lied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Loggin
g will be applied if one or more matching rule requires logging.\n- Otherwise, i
f any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging wi
ll be applied if one or more matching rule requires logging.\n- Otherwise, if no
rule applies, permission is denied.", | 2230 "description": "If more than one rule is specified, the rule
s are applied in the following\nmanner:\n- All matching LOG rules are always app
lied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Loggin
g will be applied if one or more matching rule requires logging.\n- Otherwise, i
f any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging wi
ll be applied if one or more matching rule requires logging.\n- Otherwise, if no
rule applies, permission is denied.", |
2633 "items": { | 2231 "items": { |
2634 "$ref": "Rule" | 2232 "$ref": "Rule" |
2635 }, | 2233 }, |
2636 "type": "array" | 2234 "type": "array" |
2637 }, | 2235 }, |
2638 "version": { | 2236 "version": { |
2639 "description": "Version of the `Policy`. The default version
is 0.", | 2237 "description": "Version of the `Policy`. The default version
is 0.", |
2640 "format": "int32", | 2238 "format": "int32", |
2641 "type": "integer" | 2239 "type": "integer" |
2642 }, | 2240 }, |
2643 "auditConfigs": { | 2241 "auditConfigs": { |
2644 "description": "Specifies cloud audit logging configuration
for this policy.", | 2242 "description": "Specifies cloud audit logging configuration
for this policy.", |
2645 "items": { | 2243 "items": { |
2646 "$ref": "AuditConfig" | 2244 "$ref": "AuditConfig" |
2647 }, | 2245 }, |
2648 "type": "array" | 2246 "type": "array" |
2649 }, | 2247 }, |
2650 "bindings": { | 2248 "bindings": { |
2651 "description": "Associates a list of `members` to a `role`.\
n`bindings` with no members will result in an error.", | 2249 "description": "Associates a list of `members` to a `role`.\
n`bindings` with no members will result in an error.", |
2652 "items": { | 2250 "items": { |
2653 "$ref": "Binding" | 2251 "$ref": "Binding" |
2654 }, | 2252 }, |
2655 "type": "array" | 2253 "type": "array" |
2656 }, | 2254 } |
2657 "etag": { | 2255 }, |
2658 "description": "`etag` is used for optimistic concurrency co
ntrol as a way to help\nprevent simultaneous updates of a policy from overwritin
g each other.\nIt is strongly suggested that systems make use of the `etag` in t
he\nread-modify-write cycle to perform policy updates in order to avoid race\nco
nditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems
are expected to put that etag in the request to `setIamPolicy` to\nensure that t
heir change will be applied to the same version of the policy.\n\nIf no `etag` i
s provided in the call to `setIamPolicy`, then the existing\npolicy is overwritt
en blindly.", | 2256 "type": "object" |
2659 "format": "byte", | 2257 }, |
2660 "type": "string" | 2258 "UndeleteServiceResponse": { |
| 2259 "description": "Response message for UndeleteService method.", |
| 2260 "id": "UndeleteServiceResponse", |
| 2261 "properties": { |
| 2262 "service": { |
| 2263 "$ref": "ManagedService", |
| 2264 "description": "Revived service resource." |
2661 } | 2265 } |
2662 }, | 2266 }, |
2663 "type": "object" | 2267 "type": "object" |
2664 }, | 2268 }, |
2665 "Api": { | 2269 "Api": { |
2666 "description": "Api is a light-weight descriptor for a protocol buff
er service.", | 2270 "description": "Api is a light-weight descriptor for an API Interfac
e.\n\nInterfaces are also described as \"protocol buffer services\" in some cont
exts,\nsuch as by the \"service\" keyword in a .proto file, but they are differe
nt\nfrom API Services, which represent a concrete implementation of an interface
\nas opposed to simply a description of methods and bindings. They are also\nsom
etimes simply referred to as \"APIs\" in other contexts, such as the name of\nth
is message itself. See https://cloud.google.com/apis/design/glossary for\ndetail
ed terminology.", |
2667 "id": "Api", | 2271 "id": "Api", |
2668 "properties": { | 2272 "properties": { |
2669 "syntax": { | 2273 "syntax": { |
2670 "description": "The source syntax of the service.", | 2274 "description": "The source syntax of the service.", |
2671 "enum": [ | 2275 "enum": [ |
2672 "SYNTAX_PROTO2", | 2276 "SYNTAX_PROTO2", |
2673 "SYNTAX_PROTO3" | 2277 "SYNTAX_PROTO3" |
2674 ], | 2278 ], |
2675 "enumDescriptions": [ | 2279 "enumDescriptions": [ |
2676 "Syntax `proto2`.", | 2280 "Syntax `proto2`.", |
2677 "Syntax `proto3`." | 2281 "Syntax `proto3`." |
2678 ], | 2282 ], |
2679 "type": "string" | 2283 "type": "string" |
2680 }, | 2284 }, |
2681 "sourceContext": { | 2285 "sourceContext": { |
2682 "$ref": "SourceContext", | 2286 "$ref": "SourceContext", |
2683 "description": "Source context for the protocol buffer servi
ce represented by this\nmessage." | 2287 "description": "Source context for the protocol buffer servi
ce represented by this\nmessage." |
2684 }, | 2288 }, |
2685 "version": { | 2289 "version": { |
2686 "description": "A version string for this api. If specified,
must have the form\n`major-version.minor-version`, as in `1.10`. If the minor v
ersion\nis omitted, it defaults to zero. If the entire version field is\nempty,
the major version is derived from the package name, as\noutlined below. If the f
ield is not empty, the version in the\npackage name will be verified to be consi
stent with what is\nprovided here.\n\nThe versioning schema uses [semantic\nvers
ioning](http://semver.org) where the major version number\nindicates a breaking
change and the minor version an additive,\nnon-breaking change. Both version num
bers are signals to users\nwhat to expect from different versions, and should be
carefully\nchosen based on the product plan.\n\nThe major version is also refle
cted in the package name of the\nAPI, which must end in `v<major-version>`, as i
n\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted.
Zero major versions must only be used for\nexperimental, none-GA apis.\n", | 2290 "description": "A version string for this interface. If spec
ified, must have the form\n`major-version.minor-version`, as in `1.10`. If the m
inor version is\nomitted, it defaults to zero. If the entire version field is em
pty, the\nmajor version is derived from the package name, as outlined below. If
the\nfield is not empty, the version in the package name will be verified to be\
nconsistent with what is provided here.\n\nThe versioning schema uses [semantic\
nversioning](http://semver.org) where the major version number\nindicates a brea
king change and the minor version an additive,\nnon-breaking change. Both versio
n numbers are signals to users\nwhat to expect from different versions, and shou
ld be carefully\nchosen based on the product plan.\n\nThe major version is also
reflected in the package name of the\ninterface, which must end in `v<major-vers
ion>`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nb
e omitted. Zero major versions must only be used for\nexperimental, non-GA inter
faces.\n", |
2687 "type": "string" | 2291 "type": "string" |
2688 }, | 2292 }, |
2689 "mixins": { | 2293 "mixins": { |
2690 "description": "Included APIs. See Mixin.", | 2294 "description": "Included interfaces. See Mixin.", |
2691 "items": { | 2295 "items": { |
2692 "$ref": "Mixin" | 2296 "$ref": "Mixin" |
2693 }, | 2297 }, |
2694 "type": "array" | 2298 "type": "array" |
2695 }, | 2299 }, |
2696 "options": { | 2300 "options": { |
2697 "description": "Any metadata attached to the API.", | 2301 "description": "Any metadata attached to the interface.", |
2698 "items": { | 2302 "items": { |
2699 "$ref": "Option" | 2303 "$ref": "Option" |
2700 }, | 2304 }, |
2701 "type": "array" | 2305 "type": "array" |
2702 }, | 2306 }, |
2703 "methods": { | 2307 "methods": { |
2704 "description": "The methods of this api, in unspecified orde
r.", | 2308 "description": "The methods of this interface, in unspecifie
d order.", |
2705 "items": { | 2309 "items": { |
2706 "$ref": "Method" | 2310 "$ref": "Method" |
2707 }, | 2311 }, |
2708 "type": "array" | 2312 "type": "array" |
2709 }, | 2313 }, |
2710 "name": { | 2314 "name": { |
2711 "description": "The fully qualified name of this api, includ
ing package name\nfollowed by the api's simple name.", | 2315 "description": "The fully qualified name of this interface,
including package name\nfollowed by the interface's simple name.", |
2712 "type": "string" | 2316 "type": "string" |
2713 } | 2317 } |
2714 }, | 2318 }, |
2715 "type": "object" | |
2716 }, | |
2717 "DataAccessOptions": { | |
2718 "description": "Write a Data Access (Gin) log", | |
2719 "id": "DataAccessOptions", | |
2720 "properties": {}, | |
2721 "type": "object" | 2319 "type": "object" |
2722 }, | 2320 }, |
2723 "MetricRule": { | 2321 "MetricRule": { |
2724 "description": "Bind API methods to metrics. Binding a method to a m
etric causes that\nmetric's configured quota behaviors to apply to the method ca
ll.", | 2322 "description": "Bind API methods to metrics. Binding a method to a m
etric causes that\nmetric's configured quota behaviors to apply to the method ca
ll.", |
2725 "id": "MetricRule", | 2323 "id": "MetricRule", |
2726 "properties": { | 2324 "properties": { |
2727 "metricCosts": { | 2325 "metricCosts": { |
2728 "additionalProperties": { | 2326 "additionalProperties": { |
2729 "format": "int64", | 2327 "format": "int64", |
2730 "type": "string" | 2328 "type": "string" |
2731 }, | 2329 }, |
2732 "description": "Metrics to update when the selected methods
are called, and the associated\ncost applied to each metric.\n\nThe key of the m
ap is the metric name, and the values are the amount\nincreased for the metric a
gainst which the quota limits are defined.\nThe value must not be negative.", | 2330 "description": "Metrics to update when the selected methods
are called, and the associated\ncost applied to each metric.\n\nThe key of the m
ap is the metric name, and the values are the amount\nincreased for the metric a
gainst which the quota limits are defined.\nThe value must not be negative.", |
2733 "type": "object" | 2331 "type": "object" |
2734 }, | 2332 }, |
2735 "selector": { | 2333 "selector": { |
2736 "description": "Selects the methods to which this rule appli
es.\n\nRefer to selector for syntax details.", | 2334 "description": "Selects the methods to which this rule appli
es.\n\nRefer to selector for syntax details.", |
2737 "type": "string" | 2335 "type": "string" |
2738 } | 2336 } |
2739 }, | 2337 }, |
2740 "type": "object" | 2338 "type": "object" |
2741 }, | 2339 }, |
| 2340 "DataAccessOptions": { |
| 2341 "description": "Write a Data Access (Gin) log", |
| 2342 "id": "DataAccessOptions", |
| 2343 "properties": { |
| 2344 "logMode": { |
| 2345 "description": "Whether Gin logging should happen in a fail-
closed manner at the caller.\nThis is relevant only in the LocalIAM implementati
on, for now.", |
| 2346 "enum": [ |
| 2347 "LOG_MODE_UNSPECIFIED", |
| 2348 "LOG_FAIL_CLOSED" |
| 2349 ], |
| 2350 "enumDescriptions": [ |
| 2351 "Client is not required to write a partial Gin log immed
iately after\nthe authorization check. If client chooses to write one and it fai
ls,\nclient may either fail open (allow the operation to continue) or\nfail clos
ed (handle as a DENY outcome).", |
| 2352 "The application's operation in the context of which thi
s authorization\ncheck is being made may only be performed if it is successfully
logged\nto Gin. For instance, the authorization library may satisfy this\noblig
ation by emitting a partial log entry at authorization check time\nand only retu
rning ALLOW to the application if it succeeds.\n\nIf a matching Rule has this di
rective, but the client has not indicated\nthat it will honor such requirements,
then the IAM check will result in\nauthorization failure by setting CheckPolicy
Response.success=false." |
| 2353 ], |
| 2354 "type": "string" |
| 2355 } |
| 2356 }, |
| 2357 "type": "object" |
| 2358 }, |
2742 "Authentication": { | 2359 "Authentication": { |
2743 "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 providers:\n - id: goog
le_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n
issuer: https://securetoken.google.com\n rules:\n - selector:
\"*\"\n requirements:\n provider_id: google_calendar_auth", | 2360 "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 providers:\n - id: goog
le_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n
issuer: https://securetoken.google.com\n rules:\n - selector:
\"*\"\n requirements:\n provider_id: google_calendar_auth", |
2744 "id": "Authentication", | 2361 "id": "Authentication", |
2745 "properties": { | 2362 "properties": { |
2746 "rules": { | 2363 "rules": { |
2747 "description": "A list of authentication rules that apply to
individual API methods.\n\n**NOTE:** All service configuration rules follow \"l
ast one wins\" order.", | 2364 "description": "A list of authentication rules that apply to
individual API methods.\n\n**NOTE:** All service configuration rules follow \"l
ast one wins\" order.", |
2748 "items": { | 2365 "items": { |
2749 "$ref": "AuthenticationRule" | 2366 "$ref": "AuthenticationRule" |
2750 }, | 2367 }, |
2751 "type": "array" | 2368 "type": "array" |
(...skipping 62 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2814 "description": "The Markdown content of the page. You can us
e <code>(== include {path} ==)</code>\nto include content from a Markdow
n file.", | 2431 "description": "The Markdown content of the page. You can us
e <code>(== include {path} ==)</code>\nto include content from a Markdow
n file.", |
2815 "type": "string" | 2432 "type": "string" |
2816 } | 2433 } |
2817 }, | 2434 }, |
2818 "type": "object" | 2435 "type": "object" |
2819 }, | 2436 }, |
2820 "Status": { | 2437 "Status": { |
2821 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` that can be used for common error conditions.\n\n# Lang
uage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mess
age is\nexposed in different client libraries and different wire protocols, it c
an be\nmapped differently. For example, it will likely be mapped to some excepti
ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n
\nThe error model and the `Status` message can be used in a variety of\nenvironm
ents, either with or without APIs, to provide a\nconsistent developer experience
across different environments.\n\nExample uses of this error model include:\n\n
- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m
ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a
client uses batch request and batch response, the\n `Status` message should
be used directly inside batch response, one for\n each error sub-response.\n\
n- Asynchronous operations. If an API call embeds asynchronous operation\n re
sults in its response, the status of those operations should be\n represented
directly using the `Status` message.\n\n- Logging. If some API errors are store
d in logs, the message `Status` could\n be used directly after any stripping
needed for security/privacy reasons.", | 2438 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` that can be used for common error conditions.\n\n# Lang
uage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mess
age is\nexposed in different client libraries and different wire protocols, it c
an be\nmapped differently. For example, it will likely be mapped to some excepti
ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n
\nThe error model and the `Status` message can be used in a variety of\nenvironm
ents, either with or without APIs, to provide a\nconsistent developer experience
across different environments.\n\nExample uses of this error model include:\n\n
- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m
ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a
client uses batch request and batch response, the\n `Status` message should
be used directly inside batch response, one for\n each error sub-response.\n\
n- Asynchronous operations. If an API call embeds asynchronous operation\n re
sults in its response, the status of those operations should be\n represented
directly using the `Status` message.\n\n- Logging. If some API errors are store
d in logs, the message `Status` could\n be used directly after any stripping
needed for security/privacy reasons.", |
2822 "id": "Status", | 2439 "id": "Status", |
2823 "properties": { | 2440 "properties": { |
2824 "code": { | |
2825 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | |
2826 "format": "int32", | |
2827 "type": "integer" | |
2828 }, | |
2829 "message": { | |
2830 "description": "A developer-facing error message, which shou
ld be in English. Any\nuser-facing error message should be localized and sent in
the\ngoogle.rpc.Status.details field, or localized by the client.", | |
2831 "type": "string" | |
2832 }, | |
2833 "details": { | 2441 "details": { |
2834 "description": "A list of messages that carry the error deta
ils. There is a common set of\nmessage types for APIs to use.", | 2442 "description": "A list of messages that carry the error deta
ils. There is a common set of\nmessage types for APIs to use.", |
2835 "items": { | 2443 "items": { |
2836 "additionalProperties": { | 2444 "additionalProperties": { |
2837 "description": "Properties of the object. Contains f
ield @type with type URL.", | 2445 "description": "Properties of the object. Contains f
ield @type with type URL.", |
2838 "type": "any" | 2446 "type": "any" |
2839 }, | 2447 }, |
2840 "type": "object" | 2448 "type": "object" |
2841 }, | 2449 }, |
2842 "type": "array" | 2450 "type": "array" |
| 2451 }, |
| 2452 "code": { |
| 2453 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 2454 "format": "int32", |
| 2455 "type": "integer" |
| 2456 }, |
| 2457 "message": { |
| 2458 "description": "A developer-facing error message, which shou
ld be in English. Any\nuser-facing error message should be localized and sent in
the\ngoogle.rpc.Status.details field, or localized by the client.", |
| 2459 "type": "string" |
2843 } | 2460 } |
2844 }, | 2461 }, |
2845 "type": "object" | 2462 "type": "object" |
2846 }, | 2463 }, |
2847 "Binding": { | 2464 "Binding": { |
2848 "description": "Associates `members` with a `role`.", | 2465 "description": "Associates `members` with a `role`.", |
2849 "id": "Binding", | 2466 "id": "Binding", |
2850 "properties": { | 2467 "properties": { |
| 2468 "members": { |
| 2469 "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\n* `domain:{domain}`: A Google Apps domain name that repre
sents all the\n users of that domain. For example, `google.com` or `example.co
m`.\n\n", |
| 2470 "items": { |
| 2471 "type": "string" |
| 2472 }, |
| 2473 "type": "array" |
| 2474 }, |
| 2475 "role": { |
| 2476 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", |
| 2477 "type": "string" |
| 2478 }, |
2851 "condition": { | 2479 "condition": { |
2852 "$ref": "Expr", | 2480 "$ref": "Expr", |
2853 "description": "The condition that is associated with this b
inding.\nNOTE: an unsatisfied condition will not allow user access via current\n
binding. Different bindings, including their conditions, are examined\nindepende
ntly.\nThis field is GOOGLE_INTERNAL." | 2481 "description": "The condition that is associated with this b
inding.\nNOTE: an unsatisfied condition will not allow user access via current\n
binding. Different bindings, including their conditions, are examined\nindepende
ntly.\nThis field is GOOGLE_INTERNAL." |
2854 }, | |
2855 "members": { | |
2856 "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\n* `domain:{domain}`: A Google Apps domain name that repre
sents all the\n users of that domain. For example, `google.com` or `example.co
m`.\n\n", | |
2857 "items": { | |
2858 "type": "string" | |
2859 }, | |
2860 "type": "array" | |
2861 }, | |
2862 "role": { | |
2863 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", | |
2864 "type": "string" | |
2865 } | 2482 } |
2866 }, | 2483 }, |
2867 "type": "object" | 2484 "type": "object" |
2868 }, | 2485 }, |
2869 "AuthProvider": { | 2486 "AuthProvider": { |
2870 "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).", | 2487 "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).", |
2871 "id": "AuthProvider", | 2488 "id": "AuthProvider", |
2872 "properties": { | 2489 "properties": { |
| 2490 "audiences": { |
| 2491 "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", |
| 2492 "type": "string" |
| 2493 }, |
| 2494 "authorizationUrl": { |
| 2495 "description": "Redirect URL if JWT token is required but no
present or is expired.\nImplement authorizationUrl of securityDefinitions in Op
enAPI spec.", |
| 2496 "type": "string" |
| 2497 }, |
| 2498 "issuer": { |
| 2499 "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", |
| 2500 "type": "string" |
| 2501 }, |
| 2502 "id": { |
| 2503 "description": "The unique identifier of the auth provider.
It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstor
e_auth\".", |
| 2504 "type": "string" |
| 2505 }, |
2873 "jwksUri": { | 2506 "jwksUri": { |
2874 "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", | 2507 "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", |
2875 "type": "string" | 2508 "type": "string" |
2876 }, | |
2877 "audiences": { | |
2878 "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", | |
2879 "type": "string" | |
2880 }, | |
2881 "issuer": { | |
2882 "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", | |
2883 "type": "string" | |
2884 }, | |
2885 "id": { | |
2886 "description": "The unique identifier of the auth provider.
It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstor
e_auth\".", | |
2887 "type": "string" | |
2888 } | 2509 } |
2889 }, | 2510 }, |
2890 "type": "object" | 2511 "type": "object" |
2891 }, | 2512 }, |
2892 "EnumValue": { | 2513 "EnumValue": { |
2893 "description": "Enum value definition.", | 2514 "description": "Enum value definition.", |
2894 "id": "EnumValue", | 2515 "id": "EnumValue", |
2895 "properties": { | 2516 "properties": { |
2896 "name": { | 2517 "name": { |
2897 "description": "Enum value name.", | 2518 "description": "Enum value name.", |
(...skipping 11 matching lines...) Expand all Loading... |
2909 "format": "int32", | 2530 "format": "int32", |
2910 "type": "integer" | 2531 "type": "integer" |
2911 } | 2532 } |
2912 }, | 2533 }, |
2913 "type": "object" | 2534 "type": "object" |
2914 }, | 2535 }, |
2915 "Service": { | 2536 "Service": { |
2916 "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 authentication:\n providers:\n - id: google_ca
lendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n
issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"
\n requirements:\n provider_id: google_calendar_auth", | 2537 "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 authentication:\n providers:\n - id: google_ca
lendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n
issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"
\n requirements:\n provider_id: google_calendar_auth", |
2917 "id": "Service", | 2538 "id": "Service", |
2918 "properties": { | 2539 "properties": { |
| 2540 "logging": { |
| 2541 "$ref": "Logging", |
| 2542 "description": "Logging configuration." |
| 2543 }, |
| 2544 "monitoredResources": { |
| 2545 "description": "Defines the monitored resources used by this
service. This is required\nby the Service.monitoring and Service.logging config
urations.", |
| 2546 "items": { |
| 2547 "$ref": "MonitoredResourceDescriptor" |
| 2548 }, |
| 2549 "type": "array" |
| 2550 }, |
| 2551 "context": { |
| 2552 "$ref": "Context", |
| 2553 "description": "Context configuration." |
| 2554 }, |
| 2555 "enums": { |
| 2556 "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", |
| 2557 "items": { |
| 2558 "$ref": "Enum" |
| 2559 }, |
| 2560 "type": "array" |
| 2561 }, |
| 2562 "id": { |
| 2563 "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.", |
| 2564 "type": "string" |
| 2565 }, |
| 2566 "usage": { |
| 2567 "$ref": "Usage", |
| 2568 "description": "Configuration controlling usage of this serv
ice." |
| 2569 }, |
| 2570 "metrics": { |
| 2571 "description": "Defines the metrics used by this service.", |
| 2572 "items": { |
| 2573 "$ref": "MetricDescriptor" |
| 2574 }, |
| 2575 "type": "array" |
| 2576 }, |
| 2577 "authentication": { |
| 2578 "$ref": "Authentication", |
| 2579 "description": "Auth configuration." |
| 2580 }, |
| 2581 "experimental": { |
| 2582 "$ref": "Experimental", |
| 2583 "description": "Experimental configuration." |
| 2584 }, |
| 2585 "control": { |
| 2586 "$ref": "Control", |
| 2587 "description": "Configuration for the service control plane.
" |
| 2588 }, |
| 2589 "configVersion": { |
| 2590 "description": "The semantic version of the service configur
ation. The config version\naffects the interpretation of the service configurati
on. For example,\ncertain features are enabled by default for certain config ver
sions.\nThe latest config version is `3`.", |
| 2591 "format": "uint32", |
| 2592 "type": "integer" |
| 2593 }, |
2919 "monitoring": { | 2594 "monitoring": { |
2920 "$ref": "Monitoring", | 2595 "$ref": "Monitoring", |
2921 "description": "Monitoring configuration." | 2596 "description": "Monitoring configuration." |
2922 }, | 2597 }, |
2923 "systemTypes": { | 2598 "systemTypes": { |
2924 "description": "A list of all proto message types included i
n this API service.\nIt serves similar purpose as [google.api.Service.types], ex
cept that\nthese types are not needed by user-defined APIs. Therefore, they will
not\nshow up in the generated discovery doc. This field should only be used\nto
define system APIs in ESF.", | 2599 "description": "A list of all proto message types included i
n this API service.\nIt serves similar purpose as [google.api.Service.types], ex
cept that\nthese types are not needed by user-defined APIs. Therefore, they will
not\nshow up in the generated discovery doc. This field should only be used\nto
define system APIs in ESF.", |
2925 "items": { | 2600 "items": { |
2926 "$ref": "Type" | 2601 "$ref": "Type" |
2927 }, | 2602 }, |
2928 "type": "array" | 2603 "type": "array" |
(...skipping 62 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2991 "$ref": "SystemParameters", | 2666 "$ref": "SystemParameters", |
2992 "description": "System parameter configuration." | 2667 "description": "System parameter configuration." |
2993 }, | 2668 }, |
2994 "backend": { | 2669 "backend": { |
2995 "$ref": "Backend", | 2670 "$ref": "Backend", |
2996 "description": "API backend configuration." | 2671 "description": "API backend configuration." |
2997 }, | 2672 }, |
2998 "documentation": { | 2673 "documentation": { |
2999 "$ref": "Documentation", | 2674 "$ref": "Documentation", |
3000 "description": "Additional API documentation." | 2675 "description": "Additional API documentation." |
3001 }, | |
3002 "logging": { | |
3003 "$ref": "Logging", | |
3004 "description": "Logging configuration." | |
3005 }, | |
3006 "monitoredResources": { | |
3007 "description": "Defines the monitored resources used by this
service. This is required\nby the Service.monitoring and Service.logging config
urations.", | |
3008 "items": { | |
3009 "$ref": "MonitoredResourceDescriptor" | |
3010 }, | |
3011 "type": "array" | |
3012 }, | |
3013 "context": { | |
3014 "$ref": "Context", | |
3015 "description": "Context configuration." | |
3016 }, | |
3017 "enums": { | |
3018 "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", | |
3019 "items": { | |
3020 "$ref": "Enum" | |
3021 }, | |
3022 "type": "array" | |
3023 }, | |
3024 "id": { | |
3025 "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.", | |
3026 "type": "string" | |
3027 }, | |
3028 "usage": { | |
3029 "$ref": "Usage", | |
3030 "description": "Configuration controlling usage of this serv
ice." | |
3031 }, | |
3032 "metrics": { | |
3033 "description": "Defines the metrics used by this service.", | |
3034 "items": { | |
3035 "$ref": "MetricDescriptor" | |
3036 }, | |
3037 "type": "array" | |
3038 }, | |
3039 "authentication": { | |
3040 "$ref": "Authentication", | |
3041 "description": "Auth configuration." | |
3042 }, | |
3043 "experimental": { | |
3044 "$ref": "Experimental", | |
3045 "description": "Experimental configuration." | |
3046 }, | |
3047 "control": { | |
3048 "$ref": "Control", | |
3049 "description": "Configuration for the service control plane.
" | |
3050 }, | |
3051 "configVersion": { | |
3052 "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`.", | |
3053 "format": "uint32", | |
3054 "type": "integer" | |
3055 } | 2676 } |
3056 }, | 2677 }, |
3057 "type": "object" | 2678 "type": "object" |
3058 }, | 2679 }, |
3059 "ListOperationsResponse": { | 2680 "ListOperationsResponse": { |
3060 "description": "The response message for Operations.ListOperations."
, | 2681 "description": "The response message for Operations.ListOperations."
, |
3061 "id": "ListOperationsResponse", | 2682 "id": "ListOperationsResponse", |
3062 "properties": { | 2683 "properties": { |
3063 "nextPageToken": { | 2684 "nextPageToken": { |
3064 "description": "The standard List next-page token.", | 2685 "description": "The standard List next-page token.", |
3065 "type": "string" | 2686 "type": "string" |
3066 }, | 2687 }, |
3067 "operations": { | 2688 "operations": { |
3068 "description": "A list of operations that matches the specif
ied filter in the request.", | 2689 "description": "A list of operations that matches the specif
ied filter in the request.", |
3069 "items": { | 2690 "items": { |
3070 "$ref": "Operation" | 2691 "$ref": "Operation" |
3071 }, | 2692 }, |
3072 "type": "array" | 2693 "type": "array" |
3073 } | 2694 } |
3074 }, | 2695 }, |
3075 "type": "object" | 2696 "type": "object" |
3076 }, | 2697 }, |
3077 "OperationMetadata": { | 2698 "OperationMetadata": { |
3078 "description": "The metadata associated with a long running operatio
n resource.", | 2699 "description": "The metadata associated with a long running operatio
n resource.", |
3079 "id": "OperationMetadata", | 2700 "id": "OperationMetadata", |
3080 "properties": { | 2701 "properties": { |
3081 "startTime": { | |
3082 "description": "The start time of the operation.", | |
3083 "format": "google-datetime", | |
3084 "type": "string" | |
3085 }, | |
3086 "steps": { | 2702 "steps": { |
3087 "description": "Detailed status information for each step. T
he order is undetermined.", | 2703 "description": "Detailed status information for each step. T
he order is undetermined.", |
3088 "items": { | 2704 "items": { |
3089 "$ref": "Step" | 2705 "$ref": "Step" |
3090 }, | 2706 }, |
3091 "type": "array" | 2707 "type": "array" |
3092 }, | 2708 }, |
3093 "resourceNames": { | 2709 "resourceNames": { |
3094 "description": "The full name of the resources that this ope
ration is directly\nassociated with.", | 2710 "description": "The full name of the resources that this ope
ration is directly\nassociated with.", |
3095 "items": { | 2711 "items": { |
3096 "type": "string" | 2712 "type": "string" |
3097 }, | 2713 }, |
3098 "type": "array" | 2714 "type": "array" |
3099 }, | 2715 }, |
3100 "progressPercentage": { | 2716 "progressPercentage": { |
3101 "description": "Percentage of completion of this operation,
ranging from 0 to 100.", | 2717 "description": "Percentage of completion of this operation,
ranging from 0 to 100.", |
3102 "format": "int32", | 2718 "format": "int32", |
3103 "type": "integer" | 2719 "type": "integer" |
| 2720 }, |
| 2721 "startTime": { |
| 2722 "description": "The start time of the operation.", |
| 2723 "format": "google-datetime", |
| 2724 "type": "string" |
3104 } | 2725 } |
3105 }, | 2726 }, |
3106 "type": "object" | 2727 "type": "object" |
3107 }, | 2728 }, |
3108 "CustomHttpPattern": { | 2729 "CustomHttpPattern": { |
3109 "description": "A custom pattern is used for defining custom HTTP ve
rb.", | 2730 "description": "A custom pattern is used for defining custom HTTP ve
rb.", |
3110 "id": "CustomHttpPattern", | 2731 "id": "CustomHttpPattern", |
3111 "properties": { | 2732 "properties": { |
3112 "kind": { | 2733 "kind": { |
3113 "description": "The name of this custom HTTP verb.", | 2734 "description": "The name of this custom HTTP verb.", |
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3150 "description": "Selects methods, messages, fields, enums, et
c. to which this rule applies.\n\nRefer to selector for syntax details.", | 2771 "description": "Selects methods, messages, fields, enums, et
c. to which this rule applies.\n\nRefer to selector for syntax details.", |
3151 "type": "string" | 2772 "type": "string" |
3152 } | 2773 } |
3153 }, | 2774 }, |
3154 "type": "object" | 2775 "type": "object" |
3155 }, | 2776 }, |
3156 "HttpRule": { | 2777 "HttpRule": { |
3157 "description": "`HttpRule` defines the mapping of an RPC method to o
ne or more HTTP\nREST API methods. The mapping specifies how different portions
of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nH
TTP request body. The mapping is typically specified as an\n`google.api.http` an
notation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n
\nThe mapping consists of a field specifying the path template and\nmethod kind.
The path template can refer to fields in the request\nmessage, as in the examp
le below which describes a REST GET\noperation on a resource collection of messa
ges:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) retur
ns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_i
d}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n mes
sage SubMessage {\n string subfield = 1;\n }\n string message_i
d = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is u
rl-mapped\n }\n message Message {\n string text = 1; // content of th
e resource\n }\n\nThe same http annotation can alternatively be expressed ins
ide the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n
- selector: <proto_package_name>.Messaging.GetMessage\n get: /v1/messa
ges/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrect
ional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v
1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(sub
field: \"foo\"))`\n\nIn general, not only fields but also field paths can be ref
erenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepea
ted and must have a primitive (non-message) type.\n\nAny fields in the request m
essage which are not bound by the path\npattern automatically become (optional)
HTTP query\nparameters. Assume the following definition of the request message:\
n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (M
essage) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";
\n }\n }\n message 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 s
ub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP
JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123
456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision:
2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to H
TTP parameters must have a\nprimitive type or a repeated primitive type. Message
types are not\nallowed. In the case of a repeated type, the parameter can be\nr
epeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which
allow a request body, the `body` field\nspecifies the mapping. Consider a REST u
pdate method on the\nmessage resource collection:\n\n\n service Messaging {\n
rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n optio
n (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n
body: \"message\"\n };\n }\n }\n message UpdateMessageRequest
{\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 service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\
n option (google.api.http) = {\n put: \"/v1/messages/{message_id
}\"\n body: \"*\"\n };\n }\n }\n message Message {\n
string message_id = 1;\n string text = 2;\n }\n\n\nThe following HT
TP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages
/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"H
i!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nh
ave 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 commo
n usage of `*` is in custom methods\nwhich don't use the URL at all for transfer
ring data.\n\nIt is possible to define multiple HTTP methods for one RPC by usin
g\nthe `additional_bindings` option. Example:\n\n service Messaging {\n
rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.ap
i.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_
bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n
}\n };\n }\n }\n message GetMessageRequest {\n stri
ng message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the follo
wing two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GE
T /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me
/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Ru
les for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and b
ody fields\nto the request message are as follows:\n\n1. The `body` field specif
ies either `*` or a field path, or is\n omitted. If omitted, it indicates ther
e is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messag
es in the\n request) can be classified into three types:\n (a) Matched in t
he URL template.\n (b) Covered by body (if body is `*`, everything except (a)
fields;\n else everything under the body field)\n (c) All other field
s.\n3. URL 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 synta
x of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ]
;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | L
ITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n
FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe s
yntax `*` matches a single path segment. The syntax `**` matches zero\nor more p
ath segments, which must be the last part of the path except the\n`Verb`. The sy
ntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matche
s part of the URL path as specified by its\ntemplate. A variable template must n
ot contain other variables. If a variable\nmatches a single path segment, its te
mplate may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variabl
e contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when
such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-
zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as
`{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=f
oo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, a
ll\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nsh
ow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment v
ariable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570
) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not*
* match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\
ndoes not expand special characters like `?` and `#`, which would lead\nto inval
id URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer
to\nrepeated fields or map fields.", | 2778 "description": "`HttpRule` defines the mapping of an RPC method to o
ne or more HTTP\nREST API methods. The mapping specifies how different portions
of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nH
TTP request body. The mapping is typically specified as an\n`google.api.http` an
notation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n
\nThe mapping consists of a field specifying the path template and\nmethod kind.
The path template can refer to fields in the request\nmessage, as in the examp
le below which describes a REST GET\noperation on a resource collection of messa
ges:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) retur
ns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_i
d}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n mes
sage SubMessage {\n string subfield = 1;\n }\n string message_i
d = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is u
rl-mapped\n }\n message Message {\n string text = 1; // content of th
e resource\n }\n\nThe same http annotation can alternatively be expressed ins
ide the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n
- selector: <proto_package_name>.Messaging.GetMessage\n get: /v1/messa
ges/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrect
ional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v
1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(sub
field: \"foo\"))`\n\nIn general, not only fields but also field paths can be ref
erenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepea
ted and must have a primitive (non-message) type.\n\nAny fields in the request m
essage which are not bound by the path\npattern automatically become (optional)
HTTP query\nparameters. Assume the following definition of the request message:\
n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (M
essage) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";
\n }\n }\n message 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 s
ub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP
JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123
456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision:
2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to H
TTP parameters must have a\nprimitive type or a repeated primitive type. Message
types are not\nallowed. In the case of a repeated type, the parameter can be\nr
epeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which
allow a request body, the `body` field\nspecifies the mapping. Consider a REST u
pdate method on the\nmessage resource collection:\n\n\n service Messaging {\n
rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n optio
n (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n
body: \"message\"\n };\n }\n }\n message UpdateMessageRequest
{\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 service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\
n option (google.api.http) = {\n put: \"/v1/messages/{message_id
}\"\n body: \"*\"\n };\n }\n }\n message Message {\n
string message_id = 1;\n string text = 2;\n }\n\n\nThe following HT
TP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages
/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"H
i!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nh
ave 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 commo
n usage of `*` is in custom methods\nwhich don't use the URL at all for transfer
ring data.\n\nIt is possible to define multiple HTTP methods for one RPC by usin
g\nthe `additional_bindings` option. Example:\n\n service Messaging {\n
rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.ap
i.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_
bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n
}\n };\n }\n }\n message GetMessageRequest {\n stri
ng message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the follo
wing two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GE
T /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me
/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Ru
les for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and b
ody fields\nto the request message are as follows:\n\n1. The `body` field specif
ies either `*` or a field path, or is\n omitted. If omitted, it indicates ther
e is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messag
es in the\n request) can be classified into three types:\n (a) Matched in t
he URL template.\n (b) Covered by body (if body is `*`, everything except (a)
fields;\n else everything under the body field)\n (c) All other field
s.\n3. URL 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 synta
x of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ]
;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | L
ITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n
FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe s
yntax `*` matches a single path segment. The syntax `**` matches zero\nor more p
ath segments, which must be the last part of the path except the\n`Verb`. The sy
ntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matche
s part of the URL path as specified by its\ntemplate. A variable template must n
ot contain other variables. If a variable\nmatches a single path segment, its te
mplate may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variabl
e contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when
such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-
zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as
`{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=f
oo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, a
ll\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nsh
ow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment v
ariable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570
) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not*
* match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\
ndoes not expand special characters like `?` and `#`, which would lead\nto inval
id URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer
to\nrepeated fields or map fields.", |
3158 "id": "HttpRule", | 2779 "id": "HttpRule", |
3159 "properties": { | 2780 "properties": { |
| 2781 "custom": { |
| 2782 "$ref": "CustomHttpPattern", |
| 2783 "description": "The custom pattern is used for specifying an
HTTP method that is not\nincluded in the `pattern` field, such as HEAD, or \"*\
" to leave the\nHTTP method unspecified for this rule. The wild-card rule is use
ful\nfor services that provide content to Web (HTML) clients." |
| 2784 }, |
| 2785 "get": { |
| 2786 "description": "Used for listing and getting information abo
ut resources.", |
| 2787 "type": "string" |
| 2788 }, |
| 2789 "patch": { |
| 2790 "description": "Used for updating a resource.", |
| 2791 "type": "string" |
| 2792 }, |
| 2793 "put": { |
| 2794 "description": "Used for updating a resource.", |
| 2795 "type": "string" |
| 2796 }, |
| 2797 "delete": { |
| 2798 "description": "Used for deleting a resource.", |
| 2799 "type": "string" |
| 2800 }, |
| 2801 "body": { |
| 2802 "description": "The name of the request field whose value is
mapped to the HTTP body, or\n`*` for mapping all fields not captured by the pat
h pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated fie
ld and must be\npresent at the top-level of request message type.", |
| 2803 "type": "string" |
| 2804 }, |
| 2805 "post": { |
| 2806 "description": "Used for creating a resource.", |
| 2807 "type": "string" |
| 2808 }, |
| 2809 "mediaDownload": { |
| 2810 "$ref": "MediaDownload", |
| 2811 "description": "Use this only for Scotty Requests. Do not us
e this for bytestream methods.\nFor media support, add instead [][google.bytestr
eam.RestByteStream] as an\nAPI to your configuration." |
| 2812 }, |
3160 "additionalBindings": { | 2813 "additionalBindings": { |
3161 "description": "Additional HTTP bindings for the selector. N
ested bindings must\nnot contain an `additional_bindings` field themselves (that
is,\nthe nesting may only be one level deep).", | 2814 "description": "Additional HTTP bindings for the selector. N
ested bindings must\nnot contain an `additional_bindings` field themselves (that
is,\nthe nesting may only be one level deep).", |
3162 "items": { | 2815 "items": { |
3163 "$ref": "HttpRule" | 2816 "$ref": "HttpRule" |
3164 }, | 2817 }, |
3165 "type": "array" | 2818 "type": "array" |
3166 }, | 2819 }, |
3167 "restCollection": { | |
3168 "description": "Optional. The REST collection name is by def
ault derived from the URL\npattern. If specified, this field overrides the defau
lt collection name.\nExample:\n\n rpc AddressesAggregatedList(AddressesAggreg
atedListRequest)\n returns (AddressesAggregatedListResponse) {\n opt
ion (google.api.http) = {\n get: \"/v1/projects/{project_id}/aggregated/a
ddresses\"\n rest_collection: \"projects.addresses\"\n };\n }\n\n
This method has the automatically derived collection name\n\"projects.aggregated
\". Because, semantically, this rpc is actually an\noperation on the \"projects.
addresses\" collection, the `rest_collection`\nfield is configured to override t
he derived collection name.", | |
3169 "type": "string" | |
3170 }, | |
3171 "responseBody": { | 2820 "responseBody": { |
3172 "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.", | 2821 "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.", |
3173 "type": "string" | 2822 "type": "string" |
3174 }, | 2823 }, |
3175 "mediaUpload": { | 2824 "mediaUpload": { |
3176 "$ref": "MediaUpload", | 2825 "$ref": "MediaUpload", |
3177 "description": "Use this only for Scotty Requests. Do not us
e this for media support using\nBytestream, add instead\n[][google.bytestream.Re
stByteStream] as an API to your\nconfiguration for Bytestream methods." | 2826 "description": "Use this only for Scotty Requests. Do not us
e this for media support using\nBytestream, add instead\n[][google.bytestream.Re
stByteStream] as an API to your\nconfiguration for Bytestream methods." |
3178 }, | 2827 }, |
3179 "selector": { | 2828 "selector": { |
3180 "description": "Selects methods to which this rule applies.\
n\nRefer to selector for syntax details.", | 2829 "description": "Selects methods to which this rule applies.\
n\nRefer to selector for syntax details.", |
3181 "type": "string" | 2830 "type": "string" |
3182 }, | |
3183 "custom": { | |
3184 "$ref": "CustomHttpPattern", | |
3185 "description": "The custom pattern is used for specifying an
HTTP method that is not\nincluded in the `pattern` field, such as HEAD, or \"*\
" to leave the\nHTTP method unspecified for this rule. The wild-card rule is use
ful\nfor services that provide content to Web (HTML) clients." | |
3186 }, | |
3187 "patch": { | |
3188 "description": "Used for updating a resource.", | |
3189 "type": "string" | |
3190 }, | |
3191 "get": { | |
3192 "description": "Used for listing and getting information abo
ut resources.", | |
3193 "type": "string" | |
3194 }, | |
3195 "put": { | |
3196 "description": "Used for updating a resource.", | |
3197 "type": "string" | |
3198 }, | |
3199 "delete": { | |
3200 "description": "Used for deleting a resource.", | |
3201 "type": "string" | |
3202 }, | |
3203 "body": { | |
3204 "description": "The name of the request field whose value is
mapped to the HTTP body, or\n`*` for mapping all fields not captured by the pat
h pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated fie
ld and must be\npresent at the top-level of request message type.", | |
3205 "type": "string" | |
3206 }, | |
3207 "mediaDownload": { | |
3208 "$ref": "MediaDownload", | |
3209 "description": "Use this only for Scotty Requests. Do not us
e this for bytestream methods.\nFor media support, add instead [][google.bytestr
eam.RestByteStream] as an\nAPI to your configuration." | |
3210 }, | |
3211 "post": { | |
3212 "description": "Used for creating a resource.", | |
3213 "type": "string" | |
3214 }, | |
3215 "restMethodName": { | |
3216 "description": "Optional. The rest method name is by default
derived from the URL\npattern. If specified, this field overrides the default m
ethod name.\nExample:\n\n rpc CreateResource(CreateResourceRequest)\n
returns (CreateResourceResponse) {\n option (google.api.http) = {\n
post: \"/v1/resources\",\n body: \"resource\",\n rest_method_name:
\"insert\"\n };\n }\n\nThis method has the automatically derived rest m
ethod name \"create\", but\n for backwards compatability with apiary, it is spec
ified as insert.", | |
3217 "type": "string" | |
3218 } | 2831 } |
3219 }, | 2832 }, |
3220 "type": "object" | 2833 "type": "object" |
3221 }, | 2834 }, |
3222 "MonitoringDestination": { | 2835 "MonitoringDestination": { |
3223 "description": "Configuration of a specific monitoring destination (
the producer project\nor the consumer project).", | 2836 "description": "Configuration of a specific monitoring destination (
the producer project\nor the consumer project).", |
3224 "id": "MonitoringDestination", | 2837 "id": "MonitoringDestination", |
3225 "properties": { | 2838 "properties": { |
3226 "monitoredResource": { | 2839 "monitoredResource": { |
3227 "description": "The monitored resource type. The type must b
e defined in\nService.monitored_resources section.", | 2840 "description": "The monitored resource type. The type must b
e defined in\nService.monitored_resources section.", |
(...skipping 20 matching lines...) Expand all Loading... |
3248 }, | 2861 }, |
3249 "type": "array" | 2862 "type": "array" |
3250 } | 2863 } |
3251 }, | 2864 }, |
3252 "type": "object" | 2865 "type": "object" |
3253 }, | 2866 }, |
3254 "ConfigChange": { | 2867 "ConfigChange": { |
3255 "description": "Output generated from semantically comparing two ver
sions of a service\nconfiguration.\n\nIncludes detailed information about a fiel
d that have changed with\napplicable advice about potential consequences for the
change, such as\nbackwards-incompatibility.", | 2868 "description": "Output generated from semantically comparing two ver
sions of a service\nconfiguration.\n\nIncludes detailed information about a fiel
d that have changed with\napplicable advice about potential consequences for the
change, such as\nbackwards-incompatibility.", |
3256 "id": "ConfigChange", | 2869 "id": "ConfigChange", |
3257 "properties": { | 2870 "properties": { |
3258 "newValue": { | |
3259 "description": "Value of the changed object in the new Servi
ce configuration,\nin JSON format. This field will not be populated if ChangeTyp
e == REMOVED.", | |
3260 "type": "string" | |
3261 }, | |
3262 "changeType": { | 2871 "changeType": { |
3263 "description": "The type for this change, either ADDED, REMO
VED, or MODIFIED.", | 2872 "description": "The type for this change, either ADDED, REMO
VED, or MODIFIED.", |
3264 "enum": [ | 2873 "enum": [ |
3265 "CHANGE_TYPE_UNSPECIFIED", | 2874 "CHANGE_TYPE_UNSPECIFIED", |
3266 "ADDED", | 2875 "ADDED", |
3267 "REMOVED", | 2876 "REMOVED", |
3268 "MODIFIED" | 2877 "MODIFIED" |
3269 ], | 2878 ], |
3270 "enumDescriptions": [ | 2879 "enumDescriptions": [ |
3271 "No value was provided.", | 2880 "No value was provided.", |
(...skipping 10 matching lines...) Expand all Loading... |
3282 "advices": { | 2891 "advices": { |
3283 "description": "Collection of advice provided for this chang
e, useful for determining the\npossible impact of this change.", | 2892 "description": "Collection of advice provided for this chang
e, useful for determining the\npossible impact of this change.", |
3284 "items": { | 2893 "items": { |
3285 "$ref": "Advice" | 2894 "$ref": "Advice" |
3286 }, | 2895 }, |
3287 "type": "array" | 2896 "type": "array" |
3288 }, | 2897 }, |
3289 "oldValue": { | 2898 "oldValue": { |
3290 "description": "Value of the changed object in the old Servi
ce configuration,\nin JSON format. This field will not be populated if ChangeTyp
e == ADDED.", | 2899 "description": "Value of the changed object in the old Servi
ce configuration,\nin JSON format. This field will not be populated if ChangeTyp
e == ADDED.", |
3291 "type": "string" | 2900 "type": "string" |
| 2901 }, |
| 2902 "newValue": { |
| 2903 "description": "Value of the changed object in the new Servi
ce configuration,\nin JSON format. This field will not be populated if ChangeTyp
e == REMOVED.", |
| 2904 "type": "string" |
3292 } | 2905 } |
3293 }, | 2906 }, |
3294 "type": "object" | 2907 "type": "object" |
3295 }, | 2908 }, |
3296 "SystemParameters": { | 2909 "SystemParameters": { |
3297 "description": "### System parameter configuration\n\nA system param
eter is a special kind of parameter defined by the API\nsystem, not by an indivi
dual API. It is typically mapped to an HTTP header\nand/or a URL query parameter
. This configuration specifies which methods\nchange the names of the system par
ameters.", | 2910 "description": "### System parameter configuration\n\nA system param
eter is a special kind of parameter defined by the API\nsystem, not by an indivi
dual API. It is typically mapped to an HTTP header\nand/or a URL query parameter
. This configuration specifies which methods\nchange the names of the system par
ameters.", |
3298 "id": "SystemParameters", | 2911 "id": "SystemParameters", |
3299 "properties": { | 2912 "properties": { |
3300 "rules": { | 2913 "rules": { |
3301 "description": "Define system parameters.\n\nThe parameters
defined here will override the default parameters\nimplemented by the system. If
this field is missing from the service\nconfig, default system parameters will
be used. Default system parameters\nand names is implementation-dependent.\n\nEx
ample: define api key for all methods\n\n system_parameters\n rules:\n
- selector: \"*\"\n parameters:\n - name: api_key\n
url_query_parameter: api_key\n\n\nExample: define 2 api key names for
a specific method.\n\n system_parameters\n rules:\n - selector:
\"/ListShelves\"\n parameters:\n - name: api_key\n
http_header: Api-Key1\n - name: api_key\n http_heade
r: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\
" order.", | 2914 "description": "Define system parameters.\n\nThe parameters
defined here will override the default parameters\nimplemented by the system. If
this field is missing from the service\nconfig, default system parameters will
be used. Default system parameters\nand names is implementation-dependent.\n\nEx
ample: define api key for all methods\n\n system_parameters\n rules:\n
- selector: \"*\"\n parameters:\n - name: api_key\n
url_query_parameter: api_key\n\n\nExample: define 2 api key names for
a specific method.\n\n system_parameters\n rules:\n - selector:
\"/ListShelves\"\n parameters:\n - name: api_key\n
http_header: Api-Key1\n - name: api_key\n http_heade
r: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\
" order.", |
3302 "items": { | 2915 "items": { |
3303 "$ref": "SystemParameterRule" | 2916 "$ref": "SystemParameterRule" |
3304 }, | 2917 }, |
3305 "type": "array" | 2918 "type": "array" |
3306 } | 2919 } |
3307 }, | 2920 }, |
3308 "type": "object" | 2921 "type": "object" |
3309 }, | 2922 }, |
3310 "Rollout": { | 2923 "Rollout": { |
3311 "description": "A rollout resource that defines how service configur
ation versions are pushed\nto control plane systems. Typically, you create a new
version of the\nservice config, and then create a Rollout to push the service c
onfig.", | 2924 "description": "A rollout resource that defines how service configur
ation versions are pushed\nto control plane systems. Typically, you create a new
version of the\nservice config, and then create a Rollout to push the service c
onfig.", |
3312 "id": "Rollout", | 2925 "id": "Rollout", |
3313 "properties": { | 2926 "properties": { |
3314 "createdBy": { | |
3315 "description": "The user who created the Rollout. Readonly."
, | |
3316 "type": "string" | |
3317 }, | |
3318 "trafficPercentStrategy": { | |
3319 "$ref": "TrafficPercentStrategy", | |
3320 "description": "Google Service Control selects service confi
gurations based on\ntraffic percentage." | |
3321 }, | |
3322 "rolloutId": { | 2927 "rolloutId": { |
3323 "description": "Optional unique identifier of this Rollout.
Only lower case letters, digits\n and '-' are allowed.\n\nIf not specified by cl
ient, the server will generate one. The generated id\nwill have the form of <dat
e><revision number>, where \"date\" is the create\ndate in ISO 8601 format. \"r
evision number\" is a monotonically increasing\npositive number that is reset ev
ery day for each service.\nAn example of the generated rollout_id is '2016-02-16
r1'", | 2928 "description": "Optional unique identifier of this Rollout.
Only lower case letters, digits\n and '-' are allowed.\n\nIf not specified by cl
ient, the server will generate one. The generated id\nwill have the form of <dat
e><revision number>, where \"date\" is the create\ndate in ISO 8601 format. \"r
evision number\" is a monotonically increasing\npositive number that is reset ev
ery day for each service.\nAn example of the generated rollout_id is '2016-02-16
r1'", |
3324 "type": "string" | 2929 "type": "string" |
3325 }, | 2930 }, |
3326 "deleteServiceStrategy": { | 2931 "deleteServiceStrategy": { |
3327 "$ref": "DeleteServiceStrategy", | 2932 "$ref": "DeleteServiceStrategy", |
3328 "description": "The strategy associated with a rollout to de
lete a `ManagedService`.\nReadonly." | 2933 "description": "The strategy associated with a rollout to de
lete a `ManagedService`.\nReadonly." |
3329 }, | 2934 }, |
3330 "createTime": { | 2935 "createTime": { |
3331 "description": "Creation time of the rollout. Readonly.", | 2936 "description": "Creation time of the rollout. Readonly.", |
(...skipping 18 matching lines...) Expand all Loading... |
3350 "The Rollout has been cancelled. This can happen if you
have overlapping\nRollout pushes, and the previous ones will be cancelled.", | 2955 "The Rollout has been cancelled. This can happen if you
have overlapping\nRollout pushes, and the previous ones will be cancelled.", |
3351 "The Rollout has failed and the rollback attempt has fai
led too.", | 2956 "The Rollout has failed and the rollback attempt has fai
led too.", |
3352 "The Rollout has not started yet and is pending for exec
ution.", | 2957 "The Rollout has not started yet and is pending for exec
ution.", |
3353 "The Rollout has failed and rolled back to the previous
successful\nRollout." | 2958 "The Rollout has failed and rolled back to the previous
successful\nRollout." |
3354 ], | 2959 ], |
3355 "type": "string" | 2960 "type": "string" |
3356 }, | 2961 }, |
3357 "serviceName": { | 2962 "serviceName": { |
3358 "description": "The name of the service associated with this
Rollout.", | 2963 "description": "The name of the service associated with this
Rollout.", |
3359 "type": "string" | 2964 "type": "string" |
| 2965 }, |
| 2966 "createdBy": { |
| 2967 "description": "The user who created the Rollout. Readonly."
, |
| 2968 "type": "string" |
| 2969 }, |
| 2970 "trafficPercentStrategy": { |
| 2971 "$ref": "TrafficPercentStrategy", |
| 2972 "description": "Google Service Control selects service confi
gurations based on\ntraffic percentage." |
3360 } | 2973 } |
3361 }, | 2974 }, |
3362 "type": "object" | 2975 "type": "object" |
3363 }, | 2976 }, |
3364 "Quota": { | 2977 "Quota": { |
3365 "description": "Quota configuration helps to achieve fairness and bu
dgeting in service\nusage.\n\nThe quota configuration works this way:\n- The ser
vice configuration defines a set of metrics.\n- For API calls, the quota.metric_
rules maps methods to metrics with\n corresponding costs.\n- The quota.limits d
efines limits on the metrics, which will be used for\n quota checks at runtime.
\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name:
apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n
unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n
STANDARD: 10000\n\n\n # The metric rules bind all methods to the re
ad_calls metric,\n # except for the UpdateBook and DeleteBook methods. These
two methods\n # are mapped to the write_calls metric, with the UpdateBook m
ethod\n # consuming at twice rate as the DeleteBook method.\n metric_rul
es:\n - selector: \"*\"\n metric_costs:\n library.googleapis.c
om/read_calls: 1\n - selector: google.example.library.v1.LibraryService.Upda
teBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n
- selector: google.example.library.v1.LibraryService.DeleteBook\n metri
c_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metri
c definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n
display_name: Read requests\n metric_kind: DELTA\n value_type
: INT64\n\n - name: library.googleapis.com/write_calls\n display_name:
Write requests\n metric_kind: DELTA\n value_type: INT64", | 2978 "description": "Quota configuration helps to achieve fairness and bu
dgeting in service\nusage.\n\nThe quota configuration works this way:\n- The ser
vice configuration defines a set of metrics.\n- For API calls, the quota.metric_
rules maps methods to metrics with\n corresponding costs.\n- The quota.limits d
efines limits on the metrics, which will be used for\n quota checks at runtime.
\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name:
apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n
unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n
STANDARD: 10000\n\n\n # The metric rules bind all methods to the re
ad_calls metric,\n # except for the UpdateBook and DeleteBook methods. These
two methods\n # are mapped to the write_calls metric, with the UpdateBook m
ethod\n # consuming at twice rate as the DeleteBook method.\n metric_rul
es:\n - selector: \"*\"\n metric_costs:\n library.googleapis.c
om/read_calls: 1\n - selector: google.example.library.v1.LibraryService.Upda
teBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n
- selector: google.example.library.v1.LibraryService.DeleteBook\n metri
c_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metri
c definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n
display_name: Read requests\n metric_kind: DELTA\n value_type
: INT64\n\n - name: library.googleapis.com/write_calls\n display_name:
Write requests\n metric_kind: DELTA\n value_type: INT64", |
3366 "id": "Quota", | 2979 "id": "Quota", |
3367 "properties": { | 2980 "properties": { |
3368 "limits": { | 2981 "limits": { |
3369 "description": "List of `QuotaLimit` definitions for the ser
vice.", | 2982 "description": "List of `QuotaLimit` definitions for the ser
vice.", |
3370 "items": { | 2983 "items": { |
3371 "$ref": "QuotaLimit" | 2984 "$ref": "QuotaLimit" |
3372 }, | 2985 }, |
3373 "type": "array" | 2986 "type": "array" |
3374 }, | 2987 }, |
3375 "metricRules": { | 2988 "metricRules": { |
3376 "description": "List of `MetricRule` definitions, each one m
apping a selected method to one\nor more metrics.", | 2989 "description": "List of `MetricRule` definitions, each one m
apping a selected method to one\nor more metrics.", |
3377 "items": { | 2990 "items": { |
3378 "$ref": "MetricRule" | 2991 "$ref": "MetricRule" |
3379 }, | 2992 }, |
3380 "type": "array" | 2993 "type": "array" |
3381 } | 2994 } |
| 2995 }, |
| 2996 "type": "object" |
| 2997 }, |
| 2998 "GenerateConfigReportRequest": { |
| 2999 "description": "Request message for GenerateConfigReport method.", |
| 3000 "id": "GenerateConfigReportRequest", |
| 3001 "properties": { |
| 3002 "oldConfig": { |
| 3003 "additionalProperties": { |
| 3004 "description": "Properties of the object. Contains field
@type with type URL.", |
| 3005 "type": "any" |
| 3006 }, |
| 3007 "description": "Service configuration against which the comp
arison will be done.\nFor this version of API, the supported types are\ngoogle.a
pi.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource
,\nand google.api.Service", |
| 3008 "type": "object" |
| 3009 }, |
| 3010 "newConfig": { |
| 3011 "additionalProperties": { |
| 3012 "description": "Properties of the object. Contains field
@type with type URL.", |
| 3013 "type": "any" |
| 3014 }, |
| 3015 "description": "Service configuration for which we want to g
enerate the report.\nFor this version of API, the supported types are\ngoogle.ap
i.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,
\nand google.api.Service", |
| 3016 "type": "object" |
| 3017 } |
| 3018 }, |
| 3019 "type": "object" |
| 3020 }, |
| 3021 "SetIamPolicyRequest": { |
| 3022 "description": "Request message for `SetIamPolicy` method.", |
| 3023 "id": "SetIamPolicyRequest", |
| 3024 "properties": { |
| 3025 "updateMask": { |
| 3026 "description": "OPTIONAL: A FieldMask specifying which field
s of the policy to modify. Only\nthe fields in the mask will be modified. If no
mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\
"\nThis field is only used by Cloud IAM.", |
| 3027 "format": "google-fieldmask", |
| 3028 "type": "string" |
| 3029 }, |
| 3030 "policy": { |
| 3031 "$ref": "Policy", |
| 3032 "description": "REQUIRED: The complete policy to be applied
to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An emp
ty policy is a\nvalid policy but certain Cloud Platform services (such as Projec
ts)\nmight reject them." |
| 3033 } |
| 3034 }, |
| 3035 "type": "object" |
| 3036 }, |
| 3037 "Step": { |
| 3038 "description": "Represents the status of one operation step.", |
| 3039 "id": "Step", |
| 3040 "properties": { |
| 3041 "status": { |
| 3042 "description": "The status code.", |
| 3043 "enum": [ |
| 3044 "STATUS_UNSPECIFIED", |
| 3045 "DONE", |
| 3046 "NOT_STARTED", |
| 3047 "IN_PROGRESS", |
| 3048 "FAILED", |
| 3049 "CANCELLED" |
| 3050 ], |
| 3051 "enumDescriptions": [ |
| 3052 "Unspecifed code.", |
| 3053 "The operation or step has completed without errors.", |
| 3054 "The operation or step has not started yet.", |
| 3055 "The operation or step is in progress.", |
| 3056 "The operation or step has completed with errors. If the
operation is\nrollbackable, the rollback completed with errors too.", |
| 3057 "The operation or step has completed with cancellation." |
| 3058 ], |
| 3059 "type": "string" |
| 3060 }, |
| 3061 "description": { |
| 3062 "description": "The short description of the step.", |
| 3063 "type": "string" |
| 3064 } |
| 3065 }, |
| 3066 "type": "object" |
| 3067 }, |
| 3068 "DeleteServiceStrategy": { |
| 3069 "description": "Strategy used to delete a service. This strategy is
a placeholder only\nused by the system generated rollout to delete a service.", |
| 3070 "id": "DeleteServiceStrategy", |
| 3071 "properties": {}, |
| 3072 "type": "object" |
| 3073 }, |
| 3074 "LoggingDestination": { |
| 3075 "description": "Configuration of a specific logging destination (the
producer project\nor the consumer project).", |
| 3076 "id": "LoggingDestination", |
| 3077 "properties": { |
| 3078 "logs": { |
| 3079 "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 \"/\".", |
| 3080 "items": { |
| 3081 "type": "string" |
| 3082 }, |
| 3083 "type": "array" |
| 3084 }, |
| 3085 "monitoredResource": { |
| 3086 "description": "The monitored resource type. The type must b
e defined in the\nService.monitored_resources section.", |
| 3087 "type": "string" |
| 3088 } |
| 3089 }, |
| 3090 "type": "object" |
| 3091 }, |
| 3092 "Option": { |
| 3093 "description": "A protocol buffer option, which can be attached to a
message, field,\nenumeration, etc.", |
| 3094 "id": "Option", |
| 3095 "properties": { |
| 3096 "name": { |
| 3097 "description": "The option's name. For protobuf built-in opt
ions (options defined in\ndescriptor.proto), this is the short name. For example
, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. F
or example,\n`\"google.api.http\"`.", |
| 3098 "type": "string" |
| 3099 }, |
| 3100 "value": { |
| 3101 "additionalProperties": { |
| 3102 "description": "Properties of the object. Contains field
@type with type URL.", |
| 3103 "type": "any" |
| 3104 }, |
| 3105 "description": "The option's value packed in an Any message.
If the value is a primitive,\nthe corresponding wrapper type defined in google/
protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be s
tored as an int32\nvalue using the google.protobuf.Int32Value type.", |
| 3106 "type": "object" |
| 3107 } |
| 3108 }, |
| 3109 "type": "object" |
| 3110 }, |
| 3111 "Logging": { |
| 3112 "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", |
| 3113 "id": "Logging", |
| 3114 "properties": { |
| 3115 "consumerDestinations": { |
| 3116 "description": "Logging configurations for sending logs to t
he consumer project.\nThere can be multiple consumer destinations, each one must
have a\ndifferent monitored resource type. A log can be used in at most\none co
nsumer destination.", |
| 3117 "items": { |
| 3118 "$ref": "LoggingDestination" |
| 3119 }, |
| 3120 "type": "array" |
| 3121 }, |
| 3122 "producerDestinations": { |
| 3123 "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.", |
| 3124 "items": { |
| 3125 "$ref": "LoggingDestination" |
| 3126 }, |
| 3127 "type": "array" |
| 3128 } |
| 3129 }, |
| 3130 "type": "object" |
| 3131 }, |
| 3132 "QuotaLimit": { |
| 3133 "description": "`QuotaLimit` defines a specific limit that applies o
ver a specified duration\nfor a limit type. There can be at most one limit for a
duration and limit\ntype combination defined within a `QuotaGroup`.", |
| 3134 "id": "QuotaLimit", |
| 3135 "properties": { |
| 3136 "freeTier": { |
| 3137 "description": "Free tier value displayed in the Developers
Console for this limit.\nThe free tier is the number of tokens that will be subt
racted from the\nbilled amount when billing is enabled.\nThis field can only be
set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any
other limit. If this field is not set, it\ndefaults to 0, indicating that there
is no free tier for this service.\n\nUsed by group-based quotas only.", |
| 3138 "format": "int64", |
| 3139 "type": "string" |
| 3140 }, |
| 3141 "duration": { |
| 3142 "description": "Duration of this limit in textual notation.
Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multip
le of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additiona
l support will be added in\nthe future. \"0\" indicates indefinite duration.\n\n
Used by group-based quotas only.", |
| 3143 "type": "string" |
| 3144 }, |
| 3145 "defaultLimit": { |
| 3146 "description": "Default number of tokens that can be consume
d during the specified\nduration. This is the number of tokens assigned when a c
lient\napplication developer activates the service for his/her project.\n\nSpeci
fying a value of 0 will block all requests. This can be used if you\nare provisi
oning quota to selected consumers and blocking others.\nSimilarly, a value of -1
will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUse
d by group-based quotas only.", |
| 3147 "format": "int64", |
| 3148 "type": "string" |
| 3149 }, |
| 3150 "description": { |
| 3151 "description": "Optional. User-visible, extended description
for this quota limit.\nShould be used only when more context is needed to under
stand this limit\nthan provided by the limit's display name (see: `display_name`
).", |
| 3152 "type": "string" |
| 3153 }, |
| 3154 "metric": { |
| 3155 "description": "The name of the metric this quota limit appl
ies to. The quota limits with\nthe same metric will be checked together during r
untime. The metric must be\ndefined within the service config.\n\nUsed by metric
-based quotas only.", |
| 3156 "type": "string" |
| 3157 }, |
| 3158 "displayName": { |
| 3159 "description": "User-visible display name for this limit.\nO
ptional. If not set, the UI will provide a default display name based on\nthe qu
ota configuration. This field can be used to override the default\ndisplay name
generated from the configuration.", |
| 3160 "type": "string" |
| 3161 }, |
| 3162 "values": { |
| 3163 "additionalProperties": { |
| 3164 "format": "int64", |
| 3165 "type": "string" |
| 3166 }, |
| 3167 "description": "Tiered limit values, currently only STANDARD
is supported.", |
| 3168 "type": "object" |
| 3169 }, |
| 3170 "unit": { |
| 3171 "description": "Specify the unit of the quota limit. It uses
the same syntax as\nMetric.unit. The supported unit kinds are determined by the
quota\nbackend system.\n\nThe [Google Service Control](https://cloud.google.com
/service-control)\nsupports the following unit components:\n* One of the time in
tevals:\n * \"/min\" for quota every minute.\n * \"/d\" for quota every 24 h
ours, starting 00:00 US Pacific Time.\n * Otherwise the quota won't be reset by
time, such as storage limit.\n* One and only one of the granted containers:\n
* \"/{project}\" quota for a project\n\nHere are some examples:\n* \"1/min/{proj
ect}\" for quota per minute per project.\n\nNote: the order of unit components i
s insignificant.\nThe \"1\" at the beginning is required to follow the metric un
it syntax.\n\nUsed by metric-based quotas only.", |
| 3172 "type": "string" |
| 3173 }, |
| 3174 "maxLimit": { |
| 3175 "description": "Maximum number of tokens that can be consume
d during the specified\nduration. Client application developers can override the
default limit up\nto this maximum. If specified, this value cannot be set to a
value less\nthan the default limit. If not specified, it is set to the default l
imit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1
,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.", |
| 3176 "format": "int64", |
| 3177 "type": "string" |
| 3178 }, |
| 3179 "name": { |
| 3180 "description": "Name of the quota limit. The name is used to
refer to the limit when\noverriding the default limit on per-consumer basis.\n\
nFor metric-based quota limits, the name must be provided, and it must be\nuniqu
e within the service. The name can only include alphanumeric\ncharacters as well
as '-'.\n\nThe maximum length of the limit name is 64 characters.\n\nThe name o
f a limit is used as a unique identifier for this limit.\nTherefore, once a limi
t has been put into use, its name should be\nimmutable. You can use the display_
name field to provide a user-friendly\nname for the limit. The display name can
be evolved over time without\naffecting the identity of the limit.", |
| 3181 "type": "string" |
| 3182 } |
| 3183 }, |
| 3184 "type": "object" |
| 3185 }, |
| 3186 "Method": { |
| 3187 "description": "Method represents a method of an API interface.", |
| 3188 "id": "Method", |
| 3189 "properties": { |
| 3190 "responseStreaming": { |
| 3191 "description": "If true, the response is streamed.", |
| 3192 "type": "boolean" |
| 3193 }, |
| 3194 "name": { |
| 3195 "description": "The simple name of this method.", |
| 3196 "type": "string" |
| 3197 }, |
| 3198 "requestTypeUrl": { |
| 3199 "description": "A URL of the input message type.", |
| 3200 "type": "string" |
| 3201 }, |
| 3202 "requestStreaming": { |
| 3203 "description": "If true, the request is streamed.", |
| 3204 "type": "boolean" |
| 3205 }, |
| 3206 "syntax": { |
| 3207 "description": "The source syntax of this method.", |
| 3208 "enum": [ |
| 3209 "SYNTAX_PROTO2", |
| 3210 "SYNTAX_PROTO3" |
| 3211 ], |
| 3212 "enumDescriptions": [ |
| 3213 "Syntax `proto2`.", |
| 3214 "Syntax `proto3`." |
| 3215 ], |
| 3216 "type": "string" |
| 3217 }, |
| 3218 "responseTypeUrl": { |
| 3219 "description": "The URL of the output message type.", |
| 3220 "type": "string" |
| 3221 }, |
| 3222 "options": { |
| 3223 "description": "Any metadata attached to the method.", |
| 3224 "items": { |
| 3225 "$ref": "Option" |
| 3226 }, |
| 3227 "type": "array" |
| 3228 } |
| 3229 }, |
| 3230 "type": "object" |
| 3231 }, |
| 3232 "ListServiceRolloutsResponse": { |
| 3233 "description": "Response message for ListServiceRollouts method.", |
| 3234 "id": "ListServiceRolloutsResponse", |
| 3235 "properties": { |
| 3236 "nextPageToken": { |
| 3237 "description": "The token of the next page of results.", |
| 3238 "type": "string" |
| 3239 }, |
| 3240 "rollouts": { |
| 3241 "description": "The list of rollout resources.", |
| 3242 "items": { |
| 3243 "$ref": "Rollout" |
| 3244 }, |
| 3245 "type": "array" |
| 3246 } |
| 3247 }, |
| 3248 "type": "object" |
| 3249 }, |
| 3250 "ConfigRef": { |
| 3251 "description": "Represents a service configuration with its name and
id.", |
| 3252 "id": "ConfigRef", |
| 3253 "properties": { |
| 3254 "name": { |
| 3255 "description": "Resource name of a service config. It must h
ave the following\nformat: \"services/{service name}/configs/{config id}\".", |
| 3256 "type": "string" |
| 3257 } |
| 3258 }, |
| 3259 "type": "object" |
| 3260 }, |
| 3261 "Mixin": { |
| 3262 "description": "Declares an API Interface to be included in this int
erface. The including\ninterface must redeclare all the methods from the include
d interface, but\ndocumentation and options are inherited as follows:\n\n- If af
ter comment and whitespace stripping, the documentation\n string of the redecla
red method is empty, it will be inherited\n from the original method.\n\n- Each
annotation belonging to the service config (http,\n visibility) which is not s
et in the redeclared method will be\n inherited.\n\n- If an http annotation is
inherited, the path pattern will be\n modified as follows. Any version prefix w
ill be replaced by the\n version of the including interface plus the root path
if\n specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n
service AccessControl {\n // Get the underlying ACL object.\n rpc Ge
tAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v
1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n
service Storage {\n // rpc GetAcl(GetAclRequest) returns (Acl);\n\n
// Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n
option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\
nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.S
torage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin co
nstruct implies that all methods in `AccessControl` are\nalso declared with same
name and request/response types in\n`Storage`. A documentation generator or ann
otation processor will\nsee the effective `Storage.GetAcl` method after inhertin
g\ndocumentation and annotations as follows:\n\n service Storage {\n //
Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\
n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n
...\n }\n\nNote how the version in the path pattern changed from `v1` t
o `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelati
ve path under which inherited HTTP paths are placed. Example:\n\n apis:\n
- name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.Ac
cessControl\n root: acls\n\nThis implies the following inherited HTTP ann
otation:\n\n service Storage {\n // Get the underlying ACL object.\n
rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).ge
t = \"/v2/acls/{resource=**}:getAcl\";\n }\n ...\n }", |
| 3263 "id": "Mixin", |
| 3264 "properties": { |
| 3265 "root": { |
| 3266 "description": "If non-empty specifies a path under which in
herited HTTP paths\nare rooted.", |
| 3267 "type": "string" |
| 3268 }, |
| 3269 "name": { |
| 3270 "description": "The fully qualified name of the interface wh
ich is included.", |
| 3271 "type": "string" |
| 3272 } |
| 3273 }, |
| 3274 "type": "object" |
| 3275 }, |
| 3276 "FlowOperationMetadata": { |
| 3277 "description": "The metadata associated with a long running operatio
n resource.", |
| 3278 "id": "FlowOperationMetadata", |
| 3279 "properties": { |
| 3280 "deadline": { |
| 3281 "description": "Deadline for the flow to complete, to preven
t orphaned Operations.\n\nIf the flow has not completed by this time, it may be
terminated by\nthe engine, or force-failed by Operation lookup.\n\nNote that thi
s is not a hard deadline after which the Flow will\ndefinitely be failed, rather
it is a deadline after which it is reasonable\nto suspect a problem and other p
arts of the system may kill operation\nto ensure we don't have orphans.\nsee als
o: go/prevent-orphaned-operations", |
| 3282 "format": "google-datetime", |
| 3283 "type": "string" |
| 3284 }, |
| 3285 "cancelState": { |
| 3286 "description": "The state of the operation with respect to c
ancellation.", |
| 3287 "enum": [ |
| 3288 "RUNNING", |
| 3289 "UNCANCELLABLE", |
| 3290 "CANCELLED" |
| 3291 ], |
| 3292 "enumDescriptions": [ |
| 3293 "Default state, cancellable but not cancelled.", |
| 3294 "The operation has proceeded past the point of no return
and cannot\nbe cancelled.", |
| 3295 "The operation has been cancelled, work should cease\nan
d any needed rollback steps executed." |
| 3296 ], |
| 3297 "type": "string" |
| 3298 }, |
| 3299 "startTime": { |
| 3300 "description": "The start time of the operation.", |
| 3301 "format": "google-datetime", |
| 3302 "type": "string" |
| 3303 }, |
| 3304 "resourceNames": { |
| 3305 "description": "The full name of the resources that this flo
w is directly associated with.", |
| 3306 "items": { |
| 3307 "type": "string" |
| 3308 }, |
| 3309 "type": "array" |
| 3310 }, |
| 3311 "flowName": { |
| 3312 "description": "The name of the top-level flow corresponding
to this operation.\nMust be equal to the \"name\" field for a FlowName enum.", |
| 3313 "type": "string" |
| 3314 } |
| 3315 }, |
| 3316 "type": "object" |
| 3317 }, |
| 3318 "CustomError": { |
| 3319 "description": "Customize service error responses. For example, lis
t any service\nspecific protobuf types that can appear in error detail lists of\
nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google
.foo.v1.CustomError\n - google.foo.v1.AnotherError", |
| 3320 "id": "CustomError", |
| 3321 "properties": { |
| 3322 "types": { |
| 3323 "description": "The list of custom error detail types, e.g.
'google.foo.v1.CustomError'.", |
| 3324 "items": { |
| 3325 "type": "string" |
| 3326 }, |
| 3327 "type": "array" |
| 3328 }, |
| 3329 "rules": { |
| 3330 "description": "The list of custom error rules that apply to
individual API messages.\n\n**NOTE:** All service configuration rules follow \"
last one wins\" order.", |
| 3331 "items": { |
| 3332 "$ref": "CustomErrorRule" |
| 3333 }, |
| 3334 "type": "array" |
| 3335 } |
| 3336 }, |
| 3337 "type": "object" |
| 3338 }, |
| 3339 "CounterOptions": { |
| 3340 "description": "Increment a streamz counter with the specified metri
c and field names.\n\nMetric names should start with a '/', generally be lowerca
se-only,\nand end in \"_count\". Field names should not contain an initial slash
.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nFiel
d names correspond to IAM request parameters and field values are\ntheir respect
ive values.\n\nAt present the only supported field names are\n - \"iam_princip
al\", corresponding to IAMContext.principal;\n - \"\" (empty string), resultin
g in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/
debug_access_count\" field: \"iam_principal\" }\n ==> increment counter /iam/p
olicy/backend_debug_access_count\n {iam_principal=[value
of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field n
ames (though this may be supported in the future)\n* decrementing the counter\n*
incrementing it by anything other than 1", |
| 3341 "id": "CounterOptions", |
| 3342 "properties": { |
| 3343 "field": { |
| 3344 "description": "The field value to attribute.", |
| 3345 "type": "string" |
| 3346 }, |
| 3347 "metric": { |
| 3348 "description": "The metric to update.", |
| 3349 "type": "string" |
| 3350 } |
| 3351 }, |
| 3352 "type": "object" |
| 3353 }, |
| 3354 "Http": { |
| 3355 "description": "Defines the HTTP configuration for an API service. I
t contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto
one or more HTTP REST API methods.", |
| 3356 "id": "Http", |
| 3357 "properties": { |
| 3358 "fullyDecodeReservedExpansion": { |
| 3359 "description": "When set to true, URL path parmeters will be
fully URI-decoded except in\ncases of single segment matches in reserved expans
ion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not deco
de RFC 6570 reserved characters in multi\nsegment matches.", |
| 3360 "type": "boolean" |
| 3361 }, |
| 3362 "rules": { |
| 3363 "description": "A list of HTTP configuration rules that appl
y to individual API methods.\n\n**NOTE:** All service configuration rules follow
\"last one wins\" order.", |
| 3364 "items": { |
| 3365 "$ref": "HttpRule" |
| 3366 }, |
| 3367 "type": "array" |
| 3368 } |
| 3369 }, |
| 3370 "type": "object" |
| 3371 }, |
| 3372 "SourceInfo": { |
| 3373 "description": "Source information used to create a Service Config", |
| 3374 "id": "SourceInfo", |
| 3375 "properties": { |
| 3376 "sourceFiles": { |
| 3377 "description": "All files used during config generation.", |
| 3378 "items": { |
| 3379 "additionalProperties": { |
| 3380 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 3381 "type": "any" |
| 3382 }, |
| 3383 "type": "object" |
| 3384 }, |
| 3385 "type": "array" |
| 3386 } |
3382 }, | 3387 }, |
3383 "type": "object" | 3388 "type": "object" |
3384 } | 3389 } |
3385 }, | 3390 }, |
3386 "servicePath": "", | 3391 "servicePath": "", |
3387 "title": "Google Service Management API", | 3392 "title": "Google Service Management API", |
3388 "version": "v1" | 3393 "version": "v1" |
3389 } | 3394 } |
OLD | NEW |