Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(471)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis/servicemanagement__v1.json

Issue 2987103002: Api-Roll 52: 2017-07-31 (Closed)
Patch Set: Created 3 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/servicecontrol__v1.json ('k') | discovery/googleapis/serviceuser__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/service.management": { 5 "https://www.googleapis.com/auth/service.management": {
6 "description": "Manage your Google API service configuration " 6 "description": "Manage your Google API service configuration "
7 }, 7 },
8 "https://www.googleapis.com/auth/service.management.readonly": { 8 "https://www.googleapis.com/auth/service.management.readonly": {
9 "description": "View your Google API service configuration" 9 "description": "View your Google API service configuration"
10 }, 10 },
(...skipping 27 matching lines...) Expand all
38 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 38 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
39 "location": "query", 39 "location": "query",
40 "type": "string" 40 "type": "string"
41 }, 41 },
42 "prettyPrint": { 42 "prettyPrint": {
43 "default": "true", 43 "default": "true",
44 "description": "Returns response with indentations and line breaks." , 44 "description": "Returns response with indentations and line breaks." ,
45 "location": "query", 45 "location": "query",
46 "type": "boolean" 46 "type": "boolean"
47 }, 47 },
48 "fields": {
49 "description": "Selector specifying which fields to include in a par tial response.",
50 "location": "query",
51 "type": "string"
52 },
48 "uploadType": { 53 "uploadType": {
49 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 54 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
50 "location": "query", 55 "location": "query",
51 "type": "string" 56 "type": "string"
52 }, 57 },
53 "fields": {
54 "description": "Selector specifying which fields to include in a par tial response.",
55 "location": "query",
56 "type": "string"
57 },
58 "callback": {
59 "description": "JSONP",
60 "location": "query",
61 "type": "string"
62 },
63 "$.xgafv": { 58 "$.xgafv": {
64 "description": "V1 error format.", 59 "description": "V1 error format.",
65 "enum": [ 60 "enum": [
66 "1", 61 "1",
67 "2" 62 "2"
68 ], 63 ],
69 "enumDescriptions": [ 64 "enumDescriptions": [
70 "v1 error format", 65 "v1 error format",
71 "v2 error format" 66 "v2 error format"
72 ], 67 ],
73 "location": "query", 68 "location": "query",
74 "type": "string" 69 "type": "string"
75 }, 70 },
71 "callback": {
72 "description": "JSONP",
73 "location": "query",
74 "type": "string"
75 },
76 "alt": { 76 "alt": {
77 "default": "json", 77 "default": "json",
78 "description": "Data format for response.", 78 "description": "Data format for response.",
79 "enum": [ 79 "enum": [
80 "json", 80 "json",
81 "media", 81 "media",
82 "proto" 82 "proto"
83 ], 83 ],
84 "enumDescriptions": [ 84 "enumDescriptions": [
85 "Responses with Content-Type of application/json", 85 "Responses with Content-Type of application/json",
86 "Media download with context-dependent Content-Type", 86 "Media download with context-dependent Content-Type",
87 "Responses with Content-Type of application/x-protobuf" 87 "Responses with Content-Type of application/x-protobuf"
88 ], 88 ],
89 "location": "query", 89 "location": "query",
90 "type": "string" 90 "type": "string"
91 }, 91 },
92 "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.",
94 "location": "query",
95 "type": "string"
96 },
92 "access_token": { 97 "access_token": {
93 "description": "OAuth access token.", 98 "description": "OAuth access token.",
94 "location": "query", 99 "location": "query",
95 "type": "string" 100 "type": "string"
96 }, 101 },
97 "key": {
98 "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.",
99 "location": "query",
100 "type": "string"
101 },
102 "quotaUser": { 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.", 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", 104 "location": "query",
105 "type": "string" 105 "type": "string"
106 }, 106 },
107 "pp": { 107 "pp": {
108 "default": "true", 108 "default": "true",
109 "description": "Pretty-print response.", 109 "description": "Pretty-print response.",
110 "location": "query", 110 "location": "query",
111 "type": "boolean" 111 "type": "boolean"
112 }, 112 },
113 "bearer_token": {
114 "description": "OAuth bearer token.",
115 "location": "query",
116 "type": "string"
117 },
113 "oauth_token": { 118 "oauth_token": {
114 "description": "OAuth 2.0 token for the current user.", 119 "description": "OAuth 2.0 token for the current user.",
115 "location": "query", 120 "location": "query",
116 "type": "string" 121 "type": "string"
117 },
118 "bearer_token": {
119 "description": "OAuth bearer token.",
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
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 "filter": {
160 "description": "A string for filtering Operations.\n The following filter fields are supported&#58;\n\n * serviceName&#58; Require d. Only `=` operator is allowed.\n * startTime&#58; The time this job was start ed, in ISO 8601 format.\n Allowed operators are `>=`, `>`, `<=`, and `<`.\n * status&#58; 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&#58;\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",
162 "type": "string"
163 },
159 "pageToken": { 164 "pageToken": {
160 "description": "The standard list page token.", 165 "description": "The standard list page token.",
161 "location": "query", 166 "location": "query",
162 "type": "string" 167 "type": "string"
163 }, 168 },
164 "name": { 169 "name": {
165 "description": "Not used.", 170 "description": "Not used.",
166 "location": "query", 171 "location": "query",
167 "type": "string" 172 "type": "string"
168 }, 173 },
169 "pageSize": { 174 "pageSize": {
170 "description": "The maximum number of operations to return. If unspecified, defaults to\n50. The maximum value is 100.", 175 "description": "The maximum number of operations to return. If unspecified, defaults to\n50. The maximum value is 100.",
171 "format": "int32", 176 "format": "int32",
172 "location": "query", 177 "location": "query",
173 "type": "integer" 178 "type": "integer"
174 },
175 "filter": {
176 "description": "A string for filtering Operations.\n The following filter fields are supported&#58;\n\n * serviceName&#58; Require d. Only `=` operator is allowed.\n * startTime&#58; The time this job was start ed, in ISO 8601 format.\n Allowed operators are `>=`, `>`, `<=`, and `<`.\n * status&#58; 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&#58;\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\")`",
177 "location": "query",
178 "type": "string"
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 ]
189 } 189 }
190 } 190 }
191 }, 191 },
192 "services": { 192 "services": {
193 "methods": { 193 "methods": {
194 "get": {
195 "description": "Gets a managed service. Authentication is re quired unless the service is\npublic.",
196 "httpMethod": "GET",
197 "id": "servicemanagement.services.get",
198 "parameterOrder": [
199 "serviceName"
200 ],
201 "parameters": {
202 "serviceName": {
203 "description": "The name of the service. See the `S erviceManager` overview for naming\nrequirements. For example: `example.googlea pis.com`.",
204 "location": "path",
205 "required": true,
206 "type": "string"
207 }
208 },
209 "path": "v1/services/{serviceName}",
210 "response": {
211 "$ref": "ManagedService"
212 },
213 "scopes": [
214 "https://www.googleapis.com/auth/cloud-platform",
215 "https://www.googleapis.com/auth/cloud-platform.read-onl y",
216 "https://www.googleapis.com/auth/service.management",
217 "https://www.googleapis.com/auth/service.management.read only"
218 ]
219 },
220 "testIamPermissions": {
221 "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for au thorization checking. This operation\nmay \"fail open\" without warning.",
222 "httpMethod": "POST",
223 "id": "servicemanagement.services.testIamPermissions",
224 "parameterOrder": [
225 "resource"
226 ],
227 "parameters": {
228 "resource": {
229 "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appr opriate value for this field.",
230 "location": "path",
231 "pattern": "^services/[^/]+$",
232 "required": true,
233 "type": "string"
234 }
235 },
236 "path": "v1/{+resource}:testIamPermissions",
237 "request": {
238 "$ref": "TestIamPermissionsRequest"
239 },
240 "response": {
241 "$ref": "TestIamPermissionsResponse"
242 },
243 "scopes": [
244 "https://www.googleapis.com/auth/cloud-platform",
245 "https://www.googleapis.com/auth/cloud-platform.read-onl y",
246 "https://www.googleapis.com/auth/service.management",
247 "https://www.googleapis.com/auth/service.management.read only"
248 ]
249 },
250 "getConfig": {
251 "description": "Gets a service configuration (version) for a managed service.",
252 "httpMethod": "GET",
253 "id": "servicemanagement.services.getConfig",
254 "parameterOrder": [
255 "serviceName"
256 ],
257 "parameters": {
258 "view": {
259 "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
260 "enum": [
261 "BASIC",
262 "FULL"
263 ],
264 "location": "query",
265 "type": "string"
266 },
267 "serviceName": {
268 "description": "The name of the service. See the [o verview](/service-management/overview)\nfor naming requirements. For example: ` example.googleapis.com`.",
269 "location": "path",
270 "required": true,
271 "type": "string"
272 },
273 "configId": {
274 "description": "The id of the service configuration resource.",
275 "location": "query",
276 "type": "string"
277 }
278 },
279 "path": "v1/services/{serviceName}/config",
280 "response": {
281 "$ref": "Service"
282 },
283 "scopes": [
284 "https://www.googleapis.com/auth/cloud-platform",
285 "https://www.googleapis.com/auth/cloud-platform.read-onl y",
286 "https://www.googleapis.com/auth/service.management",
287 "https://www.googleapis.com/auth/service.management.read only"
288 ]
289 },
290 "delete": {
291 "description": "Deletes a managed service. This method will change the service to the\n`Soft-Delete` state for 30 days. Within this period, service producers may\ncall UndeleteService to restore the service.\nAfter 30 da ys, the service will be permanently deleted.\n\nOperation<response: google.proto buf.Empty>",
292 "httpMethod": "DELETE",
293 "id": "servicemanagement.services.delete",
294 "parameterOrder": [
295 "serviceName"
296 ],
297 "parameters": {
298 "serviceName": {
299 "description": "The name of the service. See the [o verview](/service-management/overview)\nfor naming requirements. For example: ` example.googleapis.com`.",
300 "location": "path",
301 "required": true,
302 "type": "string"
303 }
304 },
305 "path": "v1/services/{serviceName}",
306 "response": {
307 "$ref": "Operation"
308 },
309 "scopes": [
310 "https://www.googleapis.com/auth/cloud-platform",
311 "https://www.googleapis.com/auth/service.management"
312 ]
313 },
314 "enable": {
315 "description": "Enables a service for a project, so it can b e used\nfor the project. See\n[Cloud Auth Guide](https://cloud.google.com/docs/a uthentication) for\nmore information.\n\nOperation<response: EnableServiceRespon se>",
316 "httpMethod": "POST",
317 "id": "servicemanagement.services.enable",
318 "parameterOrder": [
319 "serviceName"
320 ],
321 "parameters": {
322 "serviceName": {
323 "description": "Name of the service to enable. Speci fying an unknown service name will\ncause the request to fail.",
324 "location": "path",
325 "required": true,
326 "type": "string"
327 }
328 },
329 "path": "v1/services/{serviceName}:enable",
330 "request": {
331 "$ref": "EnableServiceRequest"
332 },
333 "response": {
334 "$ref": "Operation"
335 },
336 "scopes": [
337 "https://www.googleapis.com/auth/cloud-platform",
338 "https://www.googleapis.com/auth/service.management"
339 ]
340 },
341 "setIamPolicy": { 194 "setIamPolicy": {
342 "description": "Sets the access control policy on the specif ied resource. Replaces any\nexisting policy.", 195 "description": "Sets the access control policy on the specif ied resource. Replaces any\nexisting policy.",
343 "httpMethod": "POST", 196 "httpMethod": "POST",
344 "id": "servicemanagement.services.setIamPolicy", 197 "id": "servicemanagement.services.setIamPolicy",
345 "parameterOrder": [ 198 "parameterOrder": [
346 "resource" 199 "resource"
347 ], 200 ],
348 "parameters": { 201 "parameters": {
349 "resource": { 202 "resource": {
350 "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", 203 "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
(...skipping 163 matching lines...) Expand 10 before | Expand all | Expand 10 after
514 "request": { 367 "request": {
515 "$ref": "GenerateConfigReportRequest" 368 "$ref": "GenerateConfigReportRequest"
516 }, 369 },
517 "response": { 370 "response": {
518 "$ref": "GenerateConfigReportResponse" 371 "$ref": "GenerateConfigReportResponse"
519 }, 372 },
520 "scopes": [ 373 "scopes": [
521 "https://www.googleapis.com/auth/cloud-platform", 374 "https://www.googleapis.com/auth/cloud-platform",
522 "https://www.googleapis.com/auth/service.management" 375 "https://www.googleapis.com/auth/service.management"
523 ] 376 ]
377 },
378 "get": {
379 "description": "Gets a managed service. Authentication is re quired unless the service is\npublic.",
380 "httpMethod": "GET",
381 "id": "servicemanagement.services.get",
382 "parameterOrder": [
383 "serviceName"
384 ],
385 "parameters": {
386 "serviceName": {
387 "description": "The name of the service. See the `S erviceManager` overview for naming\nrequirements. For example: `example.googlea pis.com`.",
388 "location": "path",
389 "required": true,
390 "type": "string"
391 }
392 },
393 "path": "v1/services/{serviceName}",
394 "response": {
395 "$ref": "ManagedService"
396 },
397 "scopes": [
398 "https://www.googleapis.com/auth/cloud-platform",
399 "https://www.googleapis.com/auth/cloud-platform.read-onl y",
400 "https://www.googleapis.com/auth/service.management",
401 "https://www.googleapis.com/auth/service.management.read only"
402 ]
403 },
404 "testIamPermissions": {
405 "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for au thorization checking. This operation\nmay \"fail open\" without warning.",
406 "httpMethod": "POST",
407 "id": "servicemanagement.services.testIamPermissions",
408 "parameterOrder": [
409 "resource"
410 ],
411 "parameters": {
412 "resource": {
413 "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appr opriate value for this field.",
414 "location": "path",
415 "pattern": "^services/[^/]+$",
416 "required": true,
417 "type": "string"
418 }
419 },
420 "path": "v1/{+resource}:testIamPermissions",
421 "request": {
422 "$ref": "TestIamPermissionsRequest"
423 },
424 "response": {
425 "$ref": "TestIamPermissionsResponse"
426 },
427 "scopes": [
428 "https://www.googleapis.com/auth/cloud-platform",
429 "https://www.googleapis.com/auth/cloud-platform.read-onl y",
430 "https://www.googleapis.com/auth/service.management",
431 "https://www.googleapis.com/auth/service.management.read only"
432 ]
433 },
434 "getConfig": {
435 "description": "Gets a service configuration (version) for a managed service.",
436 "httpMethod": "GET",
437 "id": "servicemanagement.services.getConfig",
438 "parameterOrder": [
439 "serviceName"
440 ],
441 "parameters": {
442 "serviceName": {
443 "description": "The name of the service. See the [o verview](/service-management/overview)\nfor naming requirements. For example: ` example.googleapis.com`.",
444 "location": "path",
445 "required": true,
446 "type": "string"
447 },
448 "configId": {
449 "description": "The id of the service configuration resource.",
450 "location": "query",
451 "type": "string"
452 },
453 "view": {
454 "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
455 "enum": [
456 "BASIC",
457 "FULL"
458 ],
459 "location": "query",
460 "type": "string"
461 }
462 },
463 "path": "v1/services/{serviceName}/config",
464 "response": {
465 "$ref": "Service"
466 },
467 "scopes": [
468 "https://www.googleapis.com/auth/cloud-platform",
469 "https://www.googleapis.com/auth/cloud-platform.read-onl y",
470 "https://www.googleapis.com/auth/service.management",
471 "https://www.googleapis.com/auth/service.management.read only"
472 ]
473 },
474 "enable": {
475 "description": "Enables a service for a project, so it can b e used\nfor the project. See\n[Cloud Auth Guide](https://cloud.google.com/docs/a uthentication) for\nmore information.\n\nOperation<response: EnableServiceRespon se>",
476 "httpMethod": "POST",
477 "id": "servicemanagement.services.enable",
478 "parameterOrder": [
479 "serviceName"
480 ],
481 "parameters": {
482 "serviceName": {
483 "description": "Name of the service to enable. Speci fying an unknown service name will\ncause the request to fail.",
484 "location": "path",
485 "required": true,
486 "type": "string"
487 }
488 },
489 "path": "v1/services/{serviceName}:enable",
490 "request": {
491 "$ref": "EnableServiceRequest"
492 },
493 "response": {
494 "$ref": "Operation"
495 },
496 "scopes": [
497 "https://www.googleapis.com/auth/cloud-platform",
498 "https://www.googleapis.com/auth/service.management"
499 ]
500 },
501 "delete": {
502 "description": "Deletes a managed service. This method will change the service to the\n`Soft-Delete` state for 30 days. Within this period, service producers may\ncall UndeleteService to restore the service.\nAfter 30 da ys, the service will be permanently deleted.\n\nOperation<response: google.proto buf.Empty>",
503 "httpMethod": "DELETE",
504 "id": "servicemanagement.services.delete",
505 "parameterOrder": [
506 "serviceName"
507 ],
508 "parameters": {
509 "serviceName": {
510 "description": "The name of the service. See the [o verview](/service-management/overview)\nfor naming requirements. For example: ` example.googleapis.com`.",
511 "location": "path",
512 "required": true,
513 "type": "string"
514 }
515 },
516 "path": "v1/services/{serviceName}",
517 "response": {
518 "$ref": "Operation"
519 },
520 "scopes": [
521 "https://www.googleapis.com/auth/cloud-platform",
522 "https://www.googleapis.com/auth/service.management"
523 ]
524 } 524 }
525 }, 525 },
526 "resources": { 526 "resources": {
527 "configs": { 527 "configs": {
528 "methods": { 528 "methods": {
529 "get": {
530 "description": "Gets a service configuration (versio n) for a managed service.",
531 "httpMethod": "GET",
532 "id": "servicemanagement.services.configs.get",
533 "parameterOrder": [
534 "serviceName",
535 "configId"
536 ],
537 "parameters": {
538 "serviceName": {
539 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.",
540 "location": "path",
541 "required": true,
542 "type": "string"
543 },
544 "configId": {
545 "description": "The id of the service config uration resource.",
546 "location": "path",
547 "required": true,
548 "type": "string"
549 },
550 "view": {
551 "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
552 "enum": [
553 "BASIC",
554 "FULL"
555 ],
556 "location": "query",
557 "type": "string"
558 }
559 },
560 "path": "v1/services/{serviceName}/configs/{configId }",
561 "response": {
562 "$ref": "Service"
563 },
564 "scopes": [
565 "https://www.googleapis.com/auth/cloud-platform" ,
566 "https://www.googleapis.com/auth/cloud-platform. read-only",
567 "https://www.googleapis.com/auth/service.managem ent",
568 "https://www.googleapis.com/auth/service.managem ent.readonly"
569 ]
570 },
571 "list": {
572 "description": "Lists the history of the service con figuration for a managed service,\nfrom the newest to the oldest.",
573 "httpMethod": "GET",
574 "id": "servicemanagement.services.configs.list",
575 "parameterOrder": [
576 "serviceName"
577 ],
578 "parameters": {
579 "serviceName": {
580 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.",
581 "location": "path",
582 "required": true,
583 "type": "string"
584 },
585 "pageToken": {
586 "description": "The token of the page to ret rieve.",
587 "location": "query",
588 "type": "string"
589 },
590 "pageSize": {
591 "description": "The max number of items to i nclude in the response list.",
592 "format": "int32",
593 "location": "query",
594 "type": "integer"
595 }
596 },
597 "path": "v1/services/{serviceName}/configs",
598 "response": {
599 "$ref": "ListServiceConfigsResponse"
600 },
601 "scopes": [
602 "https://www.googleapis.com/auth/cloud-platform" ,
603 "https://www.googleapis.com/auth/cloud-platform. read-only",
604 "https://www.googleapis.com/auth/service.managem ent",
605 "https://www.googleapis.com/auth/service.managem ent.readonly"
606 ]
607 },
608 "create": { 529 "create": {
609 "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": "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.",
610 "httpMethod": "POST", 531 "httpMethod": "POST",
611 "id": "servicemanagement.services.configs.create", 532 "id": "servicemanagement.services.configs.create",
612 "parameterOrder": [ 533 "parameterOrder": [
613 "serviceName" 534 "serviceName"
614 ], 535 ],
615 "parameters": { 536 "parameters": {
616 "serviceName": { 537 "serviceName": {
617 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.", 538 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.",
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after
651 "request": { 572 "request": {
652 "$ref": "SubmitConfigSourceRequest" 573 "$ref": "SubmitConfigSourceRequest"
653 }, 574 },
654 "response": { 575 "response": {
655 "$ref": "Operation" 576 "$ref": "Operation"
656 }, 577 },
657 "scopes": [ 578 "scopes": [
658 "https://www.googleapis.com/auth/cloud-platform" , 579 "https://www.googleapis.com/auth/cloud-platform" ,
659 "https://www.googleapis.com/auth/service.managem ent" 580 "https://www.googleapis.com/auth/service.managem ent"
660 ] 581 ]
582 },
583 "get": {
584 "description": "Gets a service configuration (versio n) for a managed service.",
585 "httpMethod": "GET",
586 "id": "servicemanagement.services.configs.get",
587 "parameterOrder": [
588 "serviceName",
589 "configId"
590 ],
591 "parameters": {
592 "view": {
593 "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
594 "enum": [
595 "BASIC",
596 "FULL"
597 ],
598 "location": "query",
599 "type": "string"
600 },
601 "serviceName": {
602 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.",
603 "location": "path",
604 "required": true,
605 "type": "string"
606 },
607 "configId": {
608 "description": "The id of the service config uration resource.",
609 "location": "path",
610 "required": true,
611 "type": "string"
612 }
613 },
614 "path": "v1/services/{serviceName}/configs/{configId }",
615 "response": {
616 "$ref": "Service"
617 },
618 "scopes": [
619 "https://www.googleapis.com/auth/cloud-platform" ,
620 "https://www.googleapis.com/auth/cloud-platform. read-only",
621 "https://www.googleapis.com/auth/service.managem ent",
622 "https://www.googleapis.com/auth/service.managem ent.readonly"
623 ]
624 },
625 "list": {
626 "description": "Lists the history of the service con figuration for a managed service,\nfrom the newest to the oldest.",
627 "httpMethod": "GET",
628 "id": "servicemanagement.services.configs.list",
629 "parameterOrder": [
630 "serviceName"
631 ],
632 "parameters": {
633 "serviceName": {
634 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.",
635 "location": "path",
636 "required": true,
637 "type": "string"
638 },
639 "pageToken": {
640 "description": "The token of the page to ret rieve.",
641 "location": "query",
642 "type": "string"
643 },
644 "pageSize": {
645 "description": "The max number of items to i nclude in the response list.",
646 "format": "int32",
647 "location": "query",
648 "type": "integer"
649 }
650 },
651 "path": "v1/services/{serviceName}/configs",
652 "response": {
653 "$ref": "ListServiceConfigsResponse"
654 },
655 "scopes": [
656 "https://www.googleapis.com/auth/cloud-platform" ,
657 "https://www.googleapis.com/auth/cloud-platform. read-only",
658 "https://www.googleapis.com/auth/service.managem ent",
659 "https://www.googleapis.com/auth/service.managem ent.readonly"
660 ]
661 } 661 }
662 } 662 }
663 }, 663 },
664 "consumers": { 664 "consumers": {
665 "methods": { 665 "methods": {
666 "getIamPolicy": { 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.", 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", 668 "httpMethod": "POST",
669 "id": "servicemanagement.services.consumers.getIamPo licy", 669 "id": "servicemanagement.services.consumers.getIamPo licy",
670 "parameterOrder": [ 670 "parameterOrder": [
(...skipping 118 matching lines...) Expand 10 before | Expand all | Expand 10 after
789 ] 789 ]
790 }, 790 },
791 "list": { 791 "list": {
792 "description": "Lists the history of the service con figuration rollouts for a managed\nservice, from the newest to the oldest.", 792 "description": "Lists the history of the service con figuration rollouts for a managed\nservice, from the newest to the oldest.",
793 "httpMethod": "GET", 793 "httpMethod": "GET",
794 "id": "servicemanagement.services.rollouts.list", 794 "id": "servicemanagement.services.rollouts.list",
795 "parameterOrder": [ 795 "parameterOrder": [
796 "serviceName" 796 "serviceName"
797 ], 797 ],
798 "parameters": { 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 },
799 "serviceName": { 804 "serviceName": {
800 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.", 805 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.",
801 "location": "path", 806 "location": "path",
802 "required": true, 807 "required": true,
803 "type": "string" 808 "type": "string"
804 }, 809 },
805 "pageToken": { 810 "pageToken": {
806 "description": "The token of the page to ret rieve.", 811 "description": "The token of the page to ret rieve.",
807 "location": "query", 812 "location": "query",
808 "type": "string" 813 "type": "string"
809 }, 814 },
810 "pageSize": { 815 "pageSize": {
811 "description": "The max number of items to i nclude in the response list.", 816 "description": "The max number of items to i nclude in the response list.",
812 "format": "int32", 817 "format": "int32",
813 "location": "query", 818 "location": "query",
814 "type": "integer" 819 "type": "integer"
815 },
816 "filter": {
817 "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'",
818 "location": "query",
819 "type": "string"
820 } 820 }
821 }, 821 },
822 "path": "v1/services/{serviceName}/rollouts", 822 "path": "v1/services/{serviceName}/rollouts",
823 "response": { 823 "response": {
824 "$ref": "ListServiceRolloutsResponse" 824 "$ref": "ListServiceRolloutsResponse"
825 }, 825 },
826 "scopes": [ 826 "scopes": [
827 "https://www.googleapis.com/auth/cloud-platform" , 827 "https://www.googleapis.com/auth/cloud-platform" ,
828 "https://www.googleapis.com/auth/cloud-platform. read-only", 828 "https://www.googleapis.com/auth/cloud-platform. read-only",
829 "https://www.googleapis.com/auth/service.managem ent", 829 "https://www.googleapis.com/auth/service.managem ent",
(...skipping 25 matching lines...) Expand all
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": "20170626", 865 "revision": "20170717",
866 "rootUrl": "https://servicemanagement.googleapis.com/", 866 "rootUrl": "https://servicemanagement.googleapis.com/",
867 "schemas": { 867 "schemas": {
868 "ConfigFile": { 868 "GenerateConfigReportRequest": {
869 "description": "Generic specification of a source configuration file ", 869 "description": "Request message for GenerateConfigReport method.",
870 "id": "ConfigFile", 870 "id": "GenerateConfigReportRequest",
871 "properties": { 871 "properties": {
872 "filePath": { 872 "newConfig": {
873 "description": "The file name of the configuration file (ful l or relative path).", 873 "additionalProperties": {
874 "type": "string" 874 "description": "Properties of the object. Contains field @type with type URL.",
875 }, 875 "type": "any"
876 "fileType": { 876 },
877 "description": "The type of configuration file this represen ts.", 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.",
878 "enum": [ 913 "enum": [
879 "FILE_TYPE_UNSPECIFIED", 914 "STATUS_UNSPECIFIED",
880 "SERVICE_CONFIG_YAML", 915 "DONE",
881 "OPEN_API_JSON", 916 "NOT_STARTED",
882 "OPEN_API_YAML", 917 "IN_PROGRESS",
883 "FILE_DESCRIPTOR_SET_PROTO" 918 "FAILED",
919 "CANCELLED"
884 ], 920 ],
885 "enumDescriptions": [ 921 "enumDescriptions": [
886 "Unknown file type.", 922 "Unspecifed code.",
887 "YAML-specification of service.", 923 "The operation or step has completed without errors.",
888 "OpenAPI specification, serialized in JSON.", 924 "The operation or step has not started yet.",
889 "OpenAPI specification, serialized in YAML.", 925 "The operation or step is in progress.",
890 "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" 926 "The operation or step has completed with errors. If the operation is\nrollbackable, the rollback completed with errors too.",
891 ], 927 "The operation or step has completed with cancellation."
892 "type": "string" 928 ],
893 }, 929 "type": "string"
894 "fileContents": { 930 },
895 "description": "The bytes that constitute the file.", 931 "description": {
896 "format": "byte", 932 "description": "The short description of the step.",
897 "type": "string" 933 "type": "string"
898 } 934 }
899 }, 935 },
900 "type": "object" 936 "type": "object"
901 }, 937 },
902 "MonitoredResourceDescriptor": { 938 "DeleteServiceStrategy": {
903 "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.", 939 "description": "Strategy used to delete a service. This strategy is a placeholder only\nused by the system generated rollout to delete a service.",
904 "id": "MonitoredResourceDescriptor", 940 "id": "DeleteServiceStrategy",
905 "properties": { 941 "properties": {},
906 "labels": { 942 "type": "object"
907 "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\"`.", 943 },
908 "items": { 944 "LoggingDestination": {
909 "$ref": "LabelDescriptor" 945 "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
910 }, 946 "id": "LoggingDestination",
911 "type": "array" 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"
912 }, 973 },
913 "name": { 974 "name": {
914 "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{ty pe}\"` where\n{type} is the value of the `type` field in this object and\n{proje ct_id} is a project ID that provides API-specific context for\naccessing the typ e. APIs that do not use project information can use the\nresource name format ` \"monitoredResourceDescriptors/{type}\"`.", 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\"`.",
915 "type": "string" 976 "type": "string"
916 }, 977 }
917 "description": { 978 },
918 "description": "Optional. A detailed description of the moni tored resource type that might\nbe used in documentation.", 979 "type": "object"
919 "type": "string" 980 },
920 }, 981 "Logging": {
921 "displayName": { 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",
922 "description": "Optional. A concise name for the monitored r esource type that might be\ndisplayed in user interfaces. It should be a Title C ased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Go ogle Cloud SQL Database\"`.", 983 "id": "Logging",
923 "type": "string" 984 "properties": {
924 }, 985 "producerDestinations": {
925 "type": { 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.",
926 "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.", 987 "items": {
927 "type": "string" 988 "$ref": "LoggingDestination"
928 } 989 },
929 }, 990 "type": "array"
930 "type": "object" 991 },
931 }, 992 "consumerDestinations": {
932 "CustomErrorRule": { 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.",
933 "description": "A custom error rule.", 994 "items": {
934 "id": "CustomErrorRule", 995 "$ref": "LoggingDestination"
935 "properties": { 996 },
936 "isErrorType": { 997 "type": "array"
937 "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.", 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.",
938 "type": "boolean" 1016 "type": "boolean"
939 }, 1017 },
940 "selector": {
941 "description": "Selects messages to which this rule applies. \n\nRefer to selector for syntax details.",
942 "type": "string"
943 }
944 },
945 "type": "object"
946 },
947 "MediaDownload": {
948 "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.",
949 "id": "MediaDownload",
950 "properties": {
951 "enabled": {
952 "description": "Whether download is enabled.",
953 "type": "boolean"
954 },
955 "downloadService": {
956 "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.",
957 "type": "string"
958 },
959 "completeNotification": {
960 "description": "A boolean that determines whether a notifica tion for the completion of a\ndownload should be sent to the backend.",
961 "type": "boolean"
962 },
963 "maxDirectDownloadSize": {
964 "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
965 "format": "int64",
966 "type": "string"
967 },
968 "dropzone": {
969 "description": "Name of the Scotty dropzone to use for the c urrent API.",
970 "type": "string"
971 },
972 "useDirectDownload": {
973 "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
974 "type": "boolean"
975 }
976 },
977 "type": "object"
978 },
979 "CustomAuthRequirements": {
980 "description": "Configuration for a custom authentication provider." ,
981 "id": "CustomAuthRequirements",
982 "properties": {
983 "provider": {
984 "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartSer vice string\n(go/smartservice).",
985 "type": "string"
986 }
987 },
988 "type": "object"
989 },
990 "ChangeReport": {
991 "description": "Change report associated with a particular service c onfiguration.\n\nIt contains a list of ConfigChanges based on the comparison bet ween\ntwo service configurations.",
992 "id": "ChangeReport",
993 "properties": {
994 "configChanges": {
995 "description": "List of changes between two service configur ations.\nThe changes will be alphabetically sorted based on the identifier\nof e ach change.\nA ConfigChange identifier is a dot separated path to the configurat ion.\nExample: visibility.rules[selector='LibraryService.CreateBook'].restrictio n",
996 "items": {
997 "$ref": "ConfigChange"
998 },
999 "type": "array"
1000 }
1001 },
1002 "type": "object"
1003 },
1004 "DisableServiceRequest": {
1005 "description": "Request message for DisableService method.",
1006 "id": "DisableServiceRequest",
1007 "properties": {
1008 "consumerId": {
1009 "description": "The identity of consumer resource which serv ice disablement will be\napplied to.\n\nThe Google Service Management implementa tion accepts the following\nforms:\n- \"project:<project_id>\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
1010 "type": "string"
1011 }
1012 },
1013 "type": "object"
1014 },
1015 "SubmitConfigSourceResponse": {
1016 "description": "Response message for SubmitConfigSource method.",
1017 "id": "SubmitConfigSourceResponse",
1018 "properties": {
1019 "serviceConfig": {
1020 "$ref": "Service",
1021 "description": "The generated service configuration."
1022 }
1023 },
1024 "type": "object"
1025 },
1026 "MediaUpload": {
1027 "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.",
1028 "id": "MediaUpload",
1029 "properties": {
1030 "startNotification": {
1031 "description": "Whether to receive a notification on the sta rt of media upload.",
1032 "type": "boolean"
1033 },
1034 "uploadService": {
1035 "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.",
1036 "type": "string"
1037 },
1038 "maxSize": {
1039 "description": "Optional maximum acceptable size for an uplo ad.\nThe size is specified in bytes.",
1040 "format": "int64",
1041 "type": "string"
1042 },
1043 "mimeTypes": {
1044 "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.",
1045 "items": {
1046 "type": "string"
1047 },
1048 "type": "array"
1049 },
1050 "completeNotification": {
1051 "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.",
1052 "type": "boolean"
1053 },
1054 "progressNotification": {
1055 "description": "Whether to receive a notification for progre ss changes of media upload.",
1056 "type": "boolean"
1057 },
1058 "enabled": {
1059 "description": "Whether upload is enabled.",
1060 "type": "boolean"
1061 },
1062 "dropzone": {
1063 "description": "Name of the Scotty dropzone to use for the c urrent API.",
1064 "type": "string"
1065 }
1066 },
1067 "type": "object"
1068 },
1069 "Advice": {
1070 "description": "Generated advice about this change, used for providi ng more\ninformation about how a change will affect the existing service.",
1071 "id": "Advice",
1072 "properties": {
1073 "description": {
1074 "description": "Useful description for why this advice was a pplied and what actions should\nbe taken to mitigate any implied risks.",
1075 "type": "string"
1076 }
1077 },
1078 "type": "object"
1079 },
1080 "ManagedService": {
1081 "description": "The full representation of a Service that is managed by\nGoogle Service Management.",
1082 "id": "ManagedService",
1083 "properties": {
1084 "serviceName": {
1085 "description": "The name of the service. See the [overview]( /service-management/overview)\nfor naming requirements.",
1086 "type": "string"
1087 },
1088 "producerProjectId": {
1089 "description": "ID of the project that produces and owns thi s service.",
1090 "type": "string"
1091 }
1092 },
1093 "type": "object"
1094 },
1095 "UsageRule": {
1096 "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",
1097 "id": "UsageRule",
1098 "properties": {
1099 "selector": {
1100 "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.",
1101 "type": "string"
1102 },
1103 "skipServiceControl": {
1104 "description": "True, if the method should skip service cont rol. If so, no control plane\nfeature (like quota and billing) will be enabled." ,
1105 "type": "boolean"
1106 },
1107 "allowUnregisteredCalls": {
1108 "description": "True, if the method allows unregistered call s; false otherwise.",
1109 "type": "boolean"
1110 }
1111 },
1112 "type": "object"
1113 },
1114 "TrafficPercentStrategy": {
1115 "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 }",
1116 "id": "TrafficPercentStrategy",
1117 "properties": {
1118 "percentages": {
1119 "additionalProperties": {
1120 "format": "double",
1121 "type": "number"
1122 },
1123 "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.",
1124 "type": "object"
1125 }
1126 },
1127 "type": "object"
1128 },
1129 "AuthRequirement": {
1130 "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).",
1131 "id": "AuthRequirement",
1132 "properties": {
1133 "providerId": {
1134 "description": "id from authentication provider.\n\nExample: \n\n provider_id: bookstore_auth",
1135 "type": "string"
1136 },
1137 "audiences": {
1138 "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",
1139 "type": "string"
1140 }
1141 },
1142 "type": "object"
1143 },
1144 "Documentation": {
1145 "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: &#40;== include google/foo/overview.md ==&#41;\n - na me: Tutorial\n content: &#40;== include google/foo/tutorial.md ==&#41;\n s ubpages;\n - name: Java\n content: &#40;== include google/foo/tutorial_j ava.md ==&#41;\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>&#91;fully.qualified.proto.nam e]&#91;]</code></pre>\nTo override the display text used for the link, this can be used:\n<pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></ pre>\nText can be excluded from doc using the following notation:\n<pre><code>&# 40;-- internal comment --&#41;</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>&#40;--BETA: comment for BETA users --&#41;</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>&#40;== include pat h/to/file ==&#41;</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>&#4 0;== resource_for v1.shelves.books ==&#41;</code></pre>\nThe directive `suppress _warning` does not directly affect documentation\nand is documented together wit h service config validation.",
1146 "id": "Documentation",
1147 "properties": {
1148 "summary": {
1149 "description": "A short summary of what the service does. Ca n only be provided by\nplain text.",
1150 "type": "string"
1151 },
1152 "documentationRootUrl": {
1153 "description": "The URL to the root of documentation.",
1154 "type": "string"
1155 },
1156 "overview": {
1157 "description": "Declares a single overview page. For example :\n<pre><code>documentation:\n summary: ...\n overview: &#40;== include overvi ew.md ==&#41;\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: &#40;== include overview.md ==&#41;\n</code></pre>\nN ote: you cannot specify both `overview` field and `pages` field.",
1158 "type": "string"
1159 },
1160 "rules": {
1161 "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.",
1162 "items": {
1163 "$ref": "DocumentationRule"
1164 },
1165 "type": "array"
1166 },
1167 "pages": {
1168 "description": "The top level pages for the documentation se t.",
1169 "items": {
1170 "$ref": "Page"
1171 },
1172 "type": "array"
1173 }
1174 },
1175 "type": "object"
1176 },
1177 "Condition": {
1178 "description": "A condition to be met.",
1179 "id": "Condition",
1180 "properties": {
1181 "svc": {
1182 "description": "Trusted attributes discharged by the service .",
1183 "type": "string"
1184 },
1185 "sys": {
1186 "description": "Trusted attributes supplied by any service t hat owns resources and uses\nthe IAM system for access control.",
1187 "enum": [
1188 "NO_ATTR",
1189 "REGION",
1190 "SERVICE",
1191 "NAME",
1192 "IP"
1193 ],
1194 "enumDescriptions": [
1195 "Default non-attribute type",
1196 "Region of the resource",
1197 "Service name",
1198 "Resource name",
1199 "IP address of the caller"
1200 ],
1201 "type": "string"
1202 },
1203 "value": {
1204 "description": "DEPRECATED. Use 'values' instead.",
1205 "type": "string"
1206 },
1207 "iam": {
1208 "description": "Trusted attributes supplied by the IAM syste m.",
1209 "enum": [
1210 "NO_ATTR",
1211 "AUTHORITY",
1212 "ATTRIBUTION",
1213 "APPROVER",
1214 "JUSTIFICATION_TYPE"
1215 ],
1216 "enumDescriptions": [
1217 "Default non-attribute.",
1218 "Either principal or (if present) authority selector.",
1219 "The principal (even if an authority selector is present ), which\nmust only be used for attribution, not authorization.",
1220 "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).",
1221 "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. "
1222 ],
1223 "type": "string"
1224 },
1225 "values": {
1226 "description": "The objects of the condition. This is mutual ly exclusive with 'value'.",
1227 "items": {
1228 "type": "string"
1229 },
1230 "type": "array"
1231 },
1232 "op": {
1233 "description": "An operator to apply the subject with.",
1234 "enum": [
1235 "NO_OP",
1236 "EQUALS",
1237 "NOT_EQUALS",
1238 "IN",
1239 "NOT_IN",
1240 "DISCHARGED"
1241 ],
1242 "enumDescriptions": [
1243 "Default no-op.",
1244 "DEPRECATED. Use IN instead.",
1245 "DEPRECATED. Use NOT_IN instead.",
1246 "The condition is true if the subject (or any element of it if it is\na set) matches any of the supplied values.",
1247 "The condition is true if the subject (or every element of it if it is\na set) matches none of the supplied values.",
1248 "Subject is discharged"
1249 ],
1250 "type": "string"
1251 }
1252 },
1253 "type": "object"
1254 },
1255 "AuditLogConfig": {
1256 "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.",
1257 "id": "AuditLogConfig",
1258 "properties": {
1259 "exemptedMembers": {
1260 "description": "Specifies the identities that do not cause l ogging for this type of\npermission.\nFollows the same format of Binding.members .",
1261 "items": {
1262 "type": "string"
1263 },
1264 "type": "array"
1265 },
1266 "logType": {
1267 "description": "The log type that this config enables.",
1268 "enum": [
1269 "LOG_TYPE_UNSPECIFIED",
1270 "ADMIN_READ",
1271 "DATA_WRITE",
1272 "DATA_READ"
1273 ],
1274 "enumDescriptions": [
1275 "Default case. Should never be this.",
1276 "Admin reads. Example: CloudIAM getIamPolicy",
1277 "Data writes. Example: CloudSQL Users create",
1278 "Data reads. Example: CloudSQL Users list"
1279 ],
1280 "type": "string"
1281 }
1282 },
1283 "type": "object"
1284 },
1285 "ConfigSource": {
1286 "description": "Represents a source file which is used to generate t he service configuration\ndefined by `google.api.Service`.",
1287 "id": "ConfigSource",
1288 "properties": {
1289 "id": {
1290 "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.",
1291 "type": "string"
1292 },
1293 "files": {
1294 "description": "Set of source configuration files that are u sed to generate a service\nconfiguration (`google.api.Service`).",
1295 "items": {
1296 "$ref": "ConfigFile"
1297 },
1298 "type": "array"
1299 }
1300 },
1301 "type": "object"
1302 },
1303 "AuthenticationRule": {
1304 "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.",
1305 "id": "AuthenticationRule",
1306 "properties": {
1307 "customAuth": {
1308 "$ref": "CustomAuthRequirements",
1309 "description": "Configuration for custom authentication."
1310 },
1311 "oauth": {
1312 "$ref": "OAuthRequirements",
1313 "description": "The requirements for OAuth credentials."
1314 },
1315 "requirements": {
1316 "description": "Requirements for additional authentication p roviders.",
1317 "items": {
1318 "$ref": "AuthRequirement"
1319 },
1320 "type": "array"
1321 },
1322 "allowWithoutCredential": {
1323 "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.",
1324 "type": "boolean"
1325 },
1326 "selector": {
1327 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
1328 "type": "string"
1329 }
1330 },
1331 "type": "object"
1332 },
1333 "BackendRule": {
1334 "description": "A backend rule provides configuration for an individ ual API element.",
1335 "id": "BackendRule",
1336 "properties": {
1337 "minDeadline": {
1338 "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.",
1339 "format": "double",
1340 "type": "number"
1341 },
1342 "address": {
1343 "description": "The address of the API backend.",
1344 "type": "string"
1345 },
1346 "selector": {
1347 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
1348 "type": "string"
1349 },
1350 "deadline": {
1351 "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
1352 "format": "double",
1353 "type": "number"
1354 }
1355 },
1356 "type": "object"
1357 },
1358 "UndeleteServiceResponse": {
1359 "description": "Response message for UndeleteService method.",
1360 "id": "UndeleteServiceResponse",
1361 "properties": {
1362 "service": {
1363 "$ref": "ManagedService",
1364 "description": "Revived service resource."
1365 }
1366 },
1367 "type": "object"
1368 },
1369 "Policy": {
1370 "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).",
1371 "id": "Policy",
1372 "properties": {
1373 "etag": {
1374 "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.",
1375 "format": "byte",
1376 "type": "string"
1377 },
1378 "iamOwned": {
1379 "type": "boolean"
1380 },
1381 "rules": {
1382 "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.",
1383 "items": {
1384 "$ref": "Rule"
1385 },
1386 "type": "array"
1387 },
1388 "version": {
1389 "description": "Version of the `Policy`. The default version is 0.",
1390 "format": "int32",
1391 "type": "integer"
1392 },
1393 "auditConfigs": {
1394 "description": "Specifies cloud audit logging configuration for this policy.",
1395 "items": {
1396 "$ref": "AuditConfig"
1397 },
1398 "type": "array"
1399 },
1400 "bindings": {
1401 "description": "Associates a list of `members` to a `role`.\ n`bindings` with no members will result in an error.",
1402 "items": {
1403 "$ref": "Binding"
1404 },
1405 "type": "array"
1406 }
1407 },
1408 "type": "object"
1409 },
1410 "Api": {
1411 "description": "Api is a light-weight descriptor for a protocol buff er service.",
1412 "id": "Api",
1413 "properties": {
1414 "name": {
1415 "description": "The fully qualified name of this api, includ ing package name\nfollowed by the api's simple name.",
1416 "type": "string"
1417 },
1418 "syntax": { 1018 "syntax": {
1419 "description": "The source syntax of the service.", 1019 "description": "The source syntax of this method.",
1420 "enum": [ 1020 "enum": [
1421 "SYNTAX_PROTO2", 1021 "SYNTAX_PROTO2",
1422 "SYNTAX_PROTO3" 1022 "SYNTAX_PROTO3"
1423 ], 1023 ],
1424 "enumDescriptions": [ 1024 "enumDescriptions": [
1425 "Syntax `proto2`.", 1025 "Syntax `proto2`.",
1426 "Syntax `proto3`." 1026 "Syntax `proto3`."
1427 ], 1027 ],
1428 "type": "string" 1028 "type": "string"
1429 }, 1029 },
1430 "sourceContext": { 1030 "responseTypeUrl": {
1431 "$ref": "SourceContext", 1031 "description": "The URL of the output message type.",
1432 "description": "Source context for the protocol buffer servi ce represented by this\nmessage." 1032 "type": "string"
1433 },
1434 "version": {
1435 "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",
1436 "type": "string"
1437 },
1438 "mixins": {
1439 "description": "Included APIs. See Mixin.",
1440 "items": {
1441 "$ref": "Mixin"
1442 },
1443 "type": "array"
1444 }, 1033 },
1445 "options": { 1034 "options": {
1446 "description": "Any metadata attached to the API.", 1035 "description": "Any metadata attached to the method.",
1447 "items": { 1036 "items": {
1448 "$ref": "Option" 1037 "$ref": "Option"
1449 }, 1038 },
1450 "type": "array" 1039 "type": "array"
1451 }, 1040 },
1452 "methods": { 1041 "responseStreaming": {
1453 "description": "The methods of this api, in unspecified orde r.", 1042 "description": "If true, the response is streamed.",
1454 "items": { 1043 "type": "boolean"
1455 "$ref": "Method" 1044 }
1456 }, 1045 },
1457 "type": "array" 1046 "type": "object"
1458 } 1047 },
1459 }, 1048 "QuotaLimit": {
1460 "type": "object" 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`.",
1461 }, 1050 "id": "QuotaLimit",
1462 "DataAccessOptions": { 1051 "properties": {
1463 "description": "Write a Data Access (Gin) log", 1052 "unit": {
1464 "id": "DataAccessOptions", 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.",
1465 "properties": {}, 1054 "type": "string"
1466 "type": "object" 1055 },
1467 }, 1056 "maxLimit": {
1468 "MetricRule": { 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.",
1469 "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.", 1058 "format": "int64",
1470 "id": "MetricRule", 1059 "type": "string"
1471 "properties": { 1060 },
1472 "metricCosts": { 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": {
1473 "additionalProperties": { 1092 "additionalProperties": {
1474 "format": "int64", 1093 "format": "int64",
1475 "type": "string" 1094 "type": "string"
1476 }, 1095 },
1477 "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.", 1096 "description": "Tiered limit values, currently only STANDARD is supported.",
1478 "type": "object" 1097 "type": "object"
1479 }, 1098 }
1480 "selector": { 1099 },
1481 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.", 1100 "type": "object"
1482 "type": "string" 1101 },
1483 } 1102 "ConfigRef": {
1484 }, 1103 "description": "Represents a service configuration with its name and id.",
1485 "type": "object" 1104 "id": "ConfigRef",
1486 }, 1105 "properties": {
1487 "Authentication": { 1106 "name": {
1488 "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", 1107 "description": "Resource name of a service config. It must h ave the following\nformat: \"services/{service name}/configs/{config id}\".",
1489 "id": "Authentication", 1108 "type": "string"
1490 "properties": { 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 },
1491 "rules": { 1199 "rules": {
1492 "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.", 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.",
1493 "items": { 1201 "items": {
1494 "$ref": "AuthenticationRule" 1202 "$ref": "CustomErrorRule"
1495 }, 1203 },
1496 "type": "array" 1204 "type": "array"
1497 }, 1205 }
1498 "providers": { 1206 },
1499 "description": "Defines a set of authentication providers th at a service supports.", 1207 "type": "object"
1500 "items": { 1208 },
1501 "$ref": "AuthProvider" 1209 "CounterOptions": {
1502 }, 1210 "description": "Options for counters",
1503 "type": "array" 1211 "id": "CounterOptions",
1504 } 1212 "properties": {
1505 }, 1213 "field": {
1506 "type": "object" 1214 "description": "The field value to attribute.",
1507 }, 1215 "type": "string"
1508 "Operation": { 1216 },
1509 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.", 1217 "metric": {
1510 "id": "Operation", 1218 "description": "The metric to update.",
1511 "properties": { 1219 "type": "string"
1512 "done": { 1220 }
1513 "description": "If the value is `false`, it means the operat ion is still in progress.\nIf true, the operation is completed, and either `erro r` or `response` is\navailable.", 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.",
1514 "type": "boolean" 1237 "type": "boolean"
1515 }, 1238 }
1516 "response": { 1239 },
1517 "additionalProperties": { 1240 "type": "object"
1518 "description": "Properties of the object. Contains field @type with type URL.", 1241 },
1519 "type": "any" 1242 "SourceInfo": {
1520 }, 1243 "description": "Source information used to create a Service Config",
1521 "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delet e`, the response is\n`google.protobuf.Empty`. If the original method is standar d\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmet hods, the response should have the type `XxxResponse`, where `Xxx`\nis the origi nal method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", 1244 "id": "SourceInfo",
1522 "type": "object" 1245 "properties": {
1523 }, 1246 "sourceFiles": {
1524 "name": { 1247 "description": "All files used during config generation.",
1525 "description": "The server-assigned name, which is only uniq ue within the same service that\noriginally returns it. If you use the default H TTP mapping, the\n`name` should have the format of `operations/some/unique/name` .",
1526 "type": "string"
1527 },
1528 "error": {
1529 "$ref": "Status",
1530 "description": "The error result of the operation in case of failure or cancellation."
1531 },
1532 "metadata": {
1533 "additionalProperties": {
1534 "description": "Properties of the object. Contains field @type with type URL.",
1535 "type": "any"
1536 },
1537 "description": "Service-specific metadata associated with th e operation. It typically\ncontains progress information and common metadata su ch as create time.\nSome services might not provide such metadata. Any method t hat returns a\nlong-running operation should document the metadata type, if any. ",
1538 "type": "object"
1539 }
1540 },
1541 "type": "object"
1542 },
1543 "Page": {
1544 "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
1545 "id": "Page",
1546 "properties": {
1547 "content": {
1548 "description": "The Markdown content of the page. You can us e <code>&#40;== include {path} ==&#41;</code>\nto include content from a Markdow n file.",
1549 "type": "string"
1550 },
1551 "subpages": {
1552 "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
1553 "items": {
1554 "$ref": "Page"
1555 },
1556 "type": "array"
1557 },
1558 "name": {
1559 "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocum entation. For example:\n<pre><code>pages:\n- name: Tutorial\n content: &#40;== include tutorial.md ==&#41;\n subpages:\n - name: Java\n content: &#40;== i nclude tutorial_java.md ==&#41;\n</code></pre>\nYou can reference `Java` page us ing Markdown reference link syntax:\n`Java`.",
1560 "type": "string"
1561 }
1562 },
1563 "type": "object"
1564 },
1565 "Status": {
1566 "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.",
1567 "id": "Status",
1568 "properties": {
1569 "message": {
1570 "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.",
1571 "type": "string"
1572 },
1573 "details": {
1574 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.",
1575 "items": { 1248 "items": {
1576 "additionalProperties": { 1249 "additionalProperties": {
1577 "description": "Properties of the object. Contains f ield @type with type URL.", 1250 "description": "Properties of the object. Contains f ield @type with type URL.",
1578 "type": "any" 1251 "type": "any"
1579 }, 1252 },
1580 "type": "object" 1253 "type": "object"
1581 }, 1254 },
1582 "type": "array" 1255 "type": "array"
1583 }, 1256 }
1584 "code": { 1257 },
1585 "description": "The status code, which should be an enum val ue of google.rpc.Code.", 1258 "type": "object"
1259 },
1260 "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.",
1262 "id": "Control",
1263 "properties": {
1264 "environment": {
1265 "description": "The service control environment to use. If e mpty, no control plane\nfeature (like quota and billing) will be enabled.",
1266 "type": "string"
1267 }
1268 },
1269 "type": "object"
1270 },
1271 "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.",
1273 "id": "SystemParameter",
1274 "properties": {
1275 "urlQueryParameter": {
1276 "description": "Define the URL query parameter name to use f or the parameter. It is case\nsensitive.",
1277 "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 }
1287 },
1288 "type": "object"
1289 },
1290 "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",
1292 "id": "Monitoring",
1293 "properties": {
1294 "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.",
1296 "items": {
1297 "$ref": "MonitoringDestination"
1298 },
1299 "type": "array"
1300 },
1301 "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.",
1303 "items": {
1304 "$ref": "MonitoringDestination"
1305 },
1306 "type": "array"
1307 }
1308 },
1309 "type": "object"
1310 },
1311 "Field": {
1312 "description": "A single field of a message type.",
1313 "id": "Field",
1314 "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": {
1336 "description": "The string value of the default value of thi s field. Proto2 syntax only.",
1337 "type": "string"
1338 },
1339 "name": {
1340 "description": "The field name.",
1341 "type": "string"
1342 },
1343 "typeUrl": {
1344 "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.T imestamp\"`.",
1345 "type": "string"
1346 },
1347 "number": {
1348 "description": "The field number.",
1586 "format": "int32", 1349 "format": "int32",
1587 "type": "integer" 1350 "type": "integer"
1588 } 1351 },
1589 }, 1352 "kind": {
1590 "type": "object" 1353 "description": "The field type.",
1591 }, 1354 "enum": [
1592 "Binding": { 1355 "TYPE_UNKNOWN",
1593 "description": "Associates `members` with a `role`.", 1356 "TYPE_DOUBLE",
1594 "id": "Binding", 1357 "TYPE_FLOAT",
1595 "properties": { 1358 "TYPE_INT64",
1596 "condition": { 1359 "TYPE_UINT64",
1597 "$ref": "Expr", 1360 "TYPE_INT32",
1598 "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." 1361 "TYPE_FIXED64",
1599 }, 1362 "TYPE_FIXED32",
1600 "members": { 1363 "TYPE_BOOL",
1601 "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", 1364 "TYPE_STRING",
1602 "items": { 1365 "TYPE_GROUP",
1603 "type": "string" 1366 "TYPE_MESSAGE",
1604 }, 1367 "TYPE_BYTES",
1605 "type": "array" 1368 "TYPE_UINT32",
1606 }, 1369 "TYPE_ENUM",
1607 "role": { 1370 "TYPE_SFIXED32",
1608 "description": "Role that is assigned to `members`.\nFor exa mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", 1371 "TYPE_SFIXED64",
1609 "type": "string" 1372 "TYPE_SINT32",
1610 } 1373 "TYPE_SINT64"
1611 }, 1374 ],
1612 "type": "object" 1375 "enumDescriptions": [
1613 }, 1376 "Field type unknown.",
1614 "AuthProvider": { 1377 "Field type double.",
1615 "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).", 1378 "Field type float.",
1616 "id": "AuthProvider", 1379 "Field type int64.",
1617 "properties": { 1380 "Field type uint64.",
1618 "issuer": { 1381 "Field type int32.",
1619 "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", 1382 "Field type fixed64.",
1620 "type": "string" 1383 "Field type fixed32.",
1621 }, 1384 "Field type bool.",
1622 "id": { 1385 "Field type string.",
1623 "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstor e_auth\".", 1386 "Field type group. Proto2 syntax only, and deprecated.",
1624 "type": "string" 1387 "Field type message.",
1625 }, 1388 "Field type bytes.",
1626 "jwksUri": { 1389 "Field type uint32.",
1627 "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", 1390 "Field type enum.",
1628 "type": "string" 1391 "Field type sfixed32.",
1629 }, 1392 "Field type sfixed64.",
1630 "audiences": { 1393 "Field type sint32.",
1631 "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", 1394 "Field type sint64."
1632 "type": "string" 1395 ],
1633 } 1396 "type": "string"
1634 }, 1397 },
1635 "type": "object" 1398 "jsonName": {
1636 }, 1399 "description": "The field JSON name.",
1637 "Service": { 1400 "type": "string"
1638 "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", 1401 },
1639 "id": "Service", 1402 "options": {
1640 "properties": { 1403 "description": "The protocol buffer options.",
1641 "control": { 1404 "items": {
1642 "$ref": "Control", 1405 "$ref": "Option"
1643 "description": "Configuration for the service control plane. " 1406 },
1644 }, 1407 "type": "array"
1645 "configVersion": { 1408 },
1646 "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`.", 1409 "oneofIndex": {
1647 "format": "uint32", 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.",
1648 "type": "integer"
1649 },
1650 "monitoring": {
1651 "$ref": "Monitoring",
1652 "description": "Monitoring configuration."
1653 },
1654 "producerProjectId": {
1655 "description": "The Google project that owns this service.",
1656 "type": "string"
1657 },
1658 "systemTypes": {
1659 "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.",
1660 "items": {
1661 "$ref": "Type"
1662 },
1663 "type": "array"
1664 },
1665 "visibility": {
1666 "$ref": "Visibility",
1667 "description": "API visibility configuration."
1668 },
1669 "quota": {
1670 "$ref": "Quota",
1671 "description": "Quota configuration."
1672 },
1673 "name": {
1674 "description": "The DNS address at which this service is ava ilable,\ne.g. `calendar.googleapis.com`.",
1675 "type": "string"
1676 },
1677 "customError": {
1678 "$ref": "CustomError",
1679 "description": "Custom error configuration."
1680 },
1681 "title": {
1682 "description": "The product title for this service.",
1683 "type": "string"
1684 },
1685 "endpoints": {
1686 "description": "Configuration for network endpoints. If thi s is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.",
1687 "items": {
1688 "$ref": "Endpoint"
1689 },
1690 "type": "array"
1691 },
1692 "apis": {
1693 "description": "A list of API interfaces exported by this se rvice. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface h ere\nwhich cannot be resolved against the associated IDL files.",
1694 "items": {
1695 "$ref": "Api"
1696 },
1697 "type": "array"
1698 },
1699 "logs": {
1700 "description": "Defines the logs used by this service.",
1701 "items": {
1702 "$ref": "LogDescriptor"
1703 },
1704 "type": "array"
1705 },
1706 "types": {
1707 "description": "A list of all proto message types included i n this API service.\nTypes referenced directly or indirectly by the `apis` are\n automatically included. Messages which are not referenced but\nshall be include d, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32",
1708 "items": {
1709 "$ref": "Type"
1710 },
1711 "type": "array"
1712 },
1713 "sourceInfo": {
1714 "$ref": "SourceInfo",
1715 "description": "Output only. The source information for this configuration if available."
1716 },
1717 "http": {
1718 "$ref": "Http",
1719 "description": "HTTP configuration."
1720 },
1721 "systemParameters": {
1722 "$ref": "SystemParameters",
1723 "description": "System parameter configuration."
1724 },
1725 "backend": {
1726 "$ref": "Backend",
1727 "description": "API backend configuration."
1728 },
1729 "documentation": {
1730 "$ref": "Documentation",
1731 "description": "Additional API documentation."
1732 },
1733 "logging": {
1734 "$ref": "Logging",
1735 "description": "Logging configuration."
1736 },
1737 "monitoredResources": {
1738 "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging config urations.",
1739 "items": {
1740 "$ref": "MonitoredResourceDescriptor"
1741 },
1742 "type": "array"
1743 },
1744 "context": {
1745 "$ref": "Context",
1746 "description": "Context configuration."
1747 },
1748 "enums": {
1749 "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",
1750 "items": {
1751 "$ref": "Enum"
1752 },
1753 "type": "array"
1754 },
1755 "id": {
1756 "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.",
1757 "type": "string"
1758 },
1759 "usage": {
1760 "$ref": "Usage",
1761 "description": "Configuration controlling usage of this serv ice."
1762 },
1763 "metrics": {
1764 "description": "Defines the metrics used by this service.",
1765 "items": {
1766 "$ref": "MetricDescriptor"
1767 },
1768 "type": "array"
1769 },
1770 "authentication": {
1771 "$ref": "Authentication",
1772 "description": "Auth configuration."
1773 },
1774 "experimental": {
1775 "$ref": "Experimental",
1776 "description": "Experimental configuration."
1777 }
1778 },
1779 "type": "object"
1780 },
1781 "EnumValue": {
1782 "description": "Enum value definition.",
1783 "id": "EnumValue",
1784 "properties": {
1785 "number": {
1786 "description": "Enum value number.",
1787 "format": "int32", 1411 "format": "int32",
1788 "type": "integer" 1412 "type": "integer"
1413 }
1414 },
1415 "type": "object"
1416 },
1417 "TestIamPermissionsRequest": {
1418 "description": "Request message for `TestIamPermissions` method.",
1419 "id": "TestIamPermissionsRequest",
1420 "properties": {
1421 "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).",
1423 "items": {
1424 "type": "string"
1425 },
1426 "type": "array"
1427 }
1428 },
1429 "type": "object"
1430 },
1431 "Enum": {
1432 "description": "Enum type definition.",
1433 "id": "Enum",
1434 "properties": {
1435 "syntax": {
1436 "description": "The source syntax.",
1437 "enum": [
1438 "SYNTAX_PROTO2",
1439 "SYNTAX_PROTO3"
1440 ],
1441 "enumDescriptions": [
1442 "Syntax `proto2`.",
1443 "Syntax `proto3`."
1444 ],
1445 "type": "string"
1446 },
1447 "sourceContext": {
1448 "$ref": "SourceContext",
1449 "description": "The source context."
1450 },
1451 "enumvalue": {
1452 "description": "Enum value definitions.",
1453 "items": {
1454 "$ref": "EnumValue"
1455 },
1456 "type": "array"
1789 }, 1457 },
1790 "name": { 1458 "name": {
1791 "description": "Enum value name.", 1459 "description": "Enum type name.",
1792 "type": "string" 1460 "type": "string"
1793 }, 1461 },
1794 "options": { 1462 "options": {
1795 "description": "Protocol buffer options.", 1463 "description": "Protocol buffer options.",
1796 "items": { 1464 "items": {
1797 "$ref": "Option" 1465 "$ref": "Option"
1798 }, 1466 },
1799 "type": "array" 1467 "type": "array"
1800 } 1468 }
1801 }, 1469 },
1802 "type": "object" 1470 "type": "object"
1803 }, 1471 },
1804 "ListOperationsResponse": { 1472 "EnableServiceRequest": {
1805 "description": "The response message for Operations.ListOperations." , 1473 "description": "Request message for EnableService method.",
1806 "id": "ListOperationsResponse", 1474 "id": "EnableServiceRequest",
1807 "properties": { 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 }
1507 },
1508 "type": "object"
1509 },
1510 "LabelDescriptor": {
1511 "description": "A description of a label.",
1512 "id": "LabelDescriptor",
1513 "properties": {
1514 "valueType": {
1515 "description": "The type of data that can be assigned to the label.",
1516 "enum": [
1517 "STRING",
1518 "BOOL",
1519 "INT64"
1520 ],
1521 "enumDescriptions": [
1522 "A variable-length string. This is the default.",
1523 "Boolean; true or false.",
1524 "A 64-bit signed integer."
1525 ],
1526 "type": "string"
1527 },
1528 "key": {
1529 "description": "The label key.",
1530 "type": "string"
1531 },
1532 "description": {
1533 "description": "A human-readable description for the label." ,
1534 "type": "string"
1535 }
1536 },
1537 "type": "object"
1538 },
1539 "GenerateConfigReportResponse": {
1540 "description": "Response message for GenerateConfigReport method.",
1541 "id": "GenerateConfigReportResponse",
1542 "properties": {
1543 "diagnostics": {
1544 "description": "Errors / Linter warnings associated with the service definition this\nreport\nbelongs to.",
1545 "items": {
1546 "$ref": "Diagnostic"
1547 },
1548 "type": "array"
1549 },
1550 "serviceName": {
1551 "description": "Name of the service this report belongs to." ,
1552 "type": "string"
1553 },
1554 "changeReports": {
1555 "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations.",
1556 "items": {
1557 "$ref": "ChangeReport"
1558 },
1559 "type": "array"
1560 },
1561 "id": {
1562 "description": "ID of the service configuration this report belongs to.",
1563 "type": "string"
1564 }
1565 },
1566 "type": "object"
1567 },
1568 "Type": {
1569 "description": "A protocol buffer message type.",
1570 "id": "Type",
1571 "properties": {
1572 "options": {
1573 "description": "The protocol buffer options.",
1574 "items": {
1575 "$ref": "Option"
1576 },
1577 "type": "array"
1578 },
1579 "fields": {
1580 "description": "The list of fields.",
1581 "items": {
1582 "$ref": "Field"
1583 },
1584 "type": "array"
1585 },
1586 "name": {
1587 "description": "The fully qualified message name.",
1588 "type": "string"
1589 },
1590 "oneofs": {
1591 "description": "The list of types appearing in `oneof` defin itions in this type.",
1592 "items": {
1593 "type": "string"
1594 },
1595 "type": "array"
1596 },
1597 "syntax": {
1598 "description": "The source syntax.",
1599 "enum": [
1600 "SYNTAX_PROTO2",
1601 "SYNTAX_PROTO3"
1602 ],
1603 "enumDescriptions": [
1604 "Syntax `proto2`.",
1605 "Syntax `proto3`."
1606 ],
1607 "type": "string"
1608 },
1609 "sourceContext": {
1610 "$ref": "SourceContext",
1611 "description": "The source context."
1612 }
1613 },
1614 "type": "object"
1615 },
1616 "Experimental": {
1617 "description": "Experimental service configuration. These configurat ion options can\nonly be used by whitelisted users.",
1618 "id": "Experimental",
1619 "properties": {
1620 "authorization": {
1621 "$ref": "AuthorizationConfig",
1622 "description": "Authorization configuration."
1623 }
1624 },
1625 "type": "object"
1626 },
1627 "ListServiceConfigsResponse": {
1628 "description": "Response message for ListServiceConfigs method.",
1629 "id": "ListServiceConfigsResponse",
1630 "properties": {
1631 "serviceConfigs": {
1632 "description": "The list of service configuration resources. ",
1633 "items": {
1634 "$ref": "Service"
1635 },
1636 "type": "array"
1637 },
1808 "nextPageToken": { 1638 "nextPageToken": {
1809 "description": "The standard List next-page token.", 1639 "description": "The token of the next page of results.",
1810 "type": "string" 1640 "type": "string"
1811 }, 1641 }
1812 "operations": { 1642 },
1813 "description": "A list of operations that matches the specif ied filter in the request.", 1643 "type": "object"
1814 "items": { 1644 },
1815 "$ref": "Operation" 1645 "AuditConfig": {
1816 }, 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.",
1817 "type": "array" 1647 "id": "AuditConfig",
1818 } 1648 "properties": {
1819 }, 1649 "exemptedMembers": {
1820 "type": "object" 1650 "items": {
1821 }, 1651 "type": "string"
1822 "OperationMetadata": { 1652 },
1823 "description": "The metadata associated with a long running operatio n resource.", 1653 "type": "array"
1824 "id": "OperationMetadata", 1654 },
1825 "properties": { 1655 "service": {
1826 "startTime": { 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.",
1827 "description": "The start time of the operation.", 1657 "type": "string"
1828 "format": "google-datetime", 1658 },
1829 "type": "string" 1659 "auditLogConfigs": {
1830 }, 1660 "description": "The configuration for logging of each type o f permission.\nNext ID: 4",
1831 "steps": { 1661 "items": {
1832 "description": "Detailed status information for each step. T he order is undetermined.", 1662 "$ref": "AuditLogConfig"
1833 "items": { 1663 },
1834 "$ref": "Step" 1664 "type": "array"
1835 }, 1665 }
1836 "type": "array" 1666 },
1837 }, 1667 "type": "object"
1838 "resourceNames": { 1668 },
1839 "description": "The full name of the resources that this ope ration is directly\nassociated with.", 1669 "Backend": {
1840 "items": { 1670 "description": "`Backend` defines the backend configuration for a se rvice.",
1841 "type": "string" 1671 "id": "Backend",
1842 }, 1672 "properties": {
1843 "type": "array" 1673 "rules": {
1844 }, 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.",
1845 "progressPercentage": { 1675 "items": {
1846 "description": "Percentage of completion of this operation, ranging from 0 to 100.", 1676 "$ref": "BackendRule"
1847 "format": "int32", 1677 },
1848 "type": "integer" 1678 "type": "array"
1849 } 1679 }
1850 }, 1680 },
1851 "type": "object" 1681 "type": "object"
1852 }, 1682 },
1853 "CustomHttpPattern": { 1683 "SubmitConfigSourceRequest": {
1854 "description": "A custom pattern is used for defining custom HTTP ve rb.", 1684 "description": "Request message for SubmitConfigSource method.",
1855 "id": "CustomHttpPattern", 1685 "id": "SubmitConfigSourceRequest",
1856 "properties": { 1686 "properties": {
1857 "kind": { 1687 "configSource": {
1858 "description": "The name of this custom HTTP verb.", 1688 "$ref": "ConfigSource",
1859 "type": "string" 1689 "description": "The source configuration for the service."
1860 }, 1690 },
1861 "path": { 1691 "validateOnly": {
1862 "description": "The path matched by this custom verb.", 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.",
1863 "type": "string" 1693 "type": "boolean"
1864 } 1694 }
1865 }, 1695 },
1866 "type": "object" 1696 "type": "object"
1867 }, 1697 },
1868 "SystemParameterRule": { 1698 "AuthorizationConfig": {
1869 "description": "Define a system parameter rule mapping system parame ter definitions to\nmethods.", 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",
1870 "id": "SystemParameterRule", 1700 "id": "AuthorizationConfig",
1871 "properties": { 1701 "properties": {
1702 "provider": {
1703 "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
1704 "type": "string"
1705 }
1706 },
1707 "type": "object"
1708 },
1709 "DocumentationRule": {
1710 "description": "A documentation rule provides information about indi vidual API elements.",
1711 "id": "DocumentationRule",
1712 "properties": {
1713 "deprecationDescription": {
1714 "description": "Deprecation description of the selected elem ent(s). It can be provided if an\nelement is marked as `deprecated`.",
1715 "type": "string"
1716 },
1872 "selector": { 1717 "selector": {
1873 "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.", 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.",
1874 "type": "string" 1719 "type": "string"
1875 }, 1720 },
1876 "parameters": { 1721 "description": {
1877 "description": "Define parameters. Multiple names may be def ined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.", 1722 "description": "Description of the selected API(s).",
1878 "items": { 1723 "type": "string"
1879 "$ref": "SystemParameter" 1724 }
1880 }, 1725 },
1881 "type": "array" 1726 "type": "object"
1882 } 1727 },
1883 }, 1728 "CloudAuditOptions": {
1884 "type": "object" 1729 "description": "Write a Cloud Audit log",
1885 }, 1730 "id": "CloudAuditOptions",
1886 "VisibilityRule": { 1731 "properties": {
1887 "description": "A visibility rule provides visibility configuration for an individual API\nelement.", 1732 "logName": {
1888 "id": "VisibilityRule", 1733 "description": "The log_name to populate in the Cloud Audit Record.",
1889 "properties": { 1734 "enum": [
1890 "restriction": { 1735 "UNSPECIFIED_LOG_NAME",
1891 "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but no t all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restrictio n will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.", 1736 "ADMIN_ACTIVITY",
1892 "type": "string" 1737 "DATA_ACCESS"
1893 }, 1738 ],
1739 "enumDescriptions": [
1740 "Default. Should not be used.",
1741 "Corresponds to \"cloudaudit.googleapis.com/activity\"",
1742 "Corresponds to \"cloudaudit.googleapis.com/data_access\ ""
1743 ],
1744 "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": {
1894 "selector": { 1757 "selector": {
1895 "description": "Selects methods, messages, fields, enums, et c. to which this rule applies.\n\nRefer to selector for syntax details.", 1758 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
1896 "type": "string" 1759 "type": "string"
1897 } 1760 },
1898 }, 1761 "provided": {
1899 "type": "object" 1762 "description": "A list of full type names of provided contex ts.",
1900 }, 1763 "items": {
1901 "HttpRule": { 1764 "type": "string"
1902 "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&param=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.", 1765 },
1903 "id": "HttpRule", 1766 "type": "array"
1904 "properties": { 1767 },
1905 "delete": { 1768 "requested": {
1906 "description": "Used for deleting a resource.", 1769 "description": "A list of full type names of requested conte xts.",
1907 "type": "string" 1770 "items": {
1908 }, 1771 "type": "string"
1909 "body": { 1772 },
1910 "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.", 1773 "type": "array"
1911 "type": "string" 1774 }
1912 }, 1775 },
1913 "mediaDownload": { 1776 "type": "object"
1914 "$ref": "MediaDownload", 1777 },
1915 "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." 1778 "MetricDescriptor": {
1916 }, 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.",
1917 "post": { 1780 "id": "MetricDescriptor",
1918 "description": "Used for creating a resource.", 1781 "properties": {
1919 "type": "string" 1782 "type": {
1920 }, 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\"",
1921 "restMethodName": { 1784 "type": "string"
1922 "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.", 1785 },
1923 "type": "string" 1786 "valueType": {
1924 }, 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.",
1925 "additionalBindings": { 1788 "enum": [
1926 "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).", 1789 "VALUE_TYPE_UNSPECIFIED",
1927 "items": { 1790 "BOOL",
1928 "$ref": "HttpRule" 1791 "INT64",
1929 }, 1792 "DOUBLE",
1930 "type": "array" 1793 "STRING",
1931 }, 1794 "DISTRIBUTION",
1932 "responseBody": { 1795 "MONEY"
1933 "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.", 1796 ],
1934 "type": "string" 1797 "enumDescriptions": [
1935 }, 1798 "Do not use this default value.",
1936 "restCollection": { 1799 "The value is a boolean.\nThis value type can be used on ly if the metric kind is `GAUGE`.",
1937 "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.", 1800 "The value is a signed 64-bit integer.",
1938 "type": "string" 1801 "The value is a double precision floating point number." ,
1939 }, 1802 "The value is a text string.\nThis value type can be use d only if the metric kind is `GAUGE`.",
1940 "mediaUpload": { 1803 "The value is a `Distribution`.",
1941 "$ref": "MediaUpload", 1804 "The value is money."
1942 "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." 1805 ],
1943 }, 1806 "type": "string"
1944 "selector": { 1807 },
1945 "description": "Selects methods to which this rule applies.\ n\nRefer to selector for syntax details.", 1808 "metricKind": {
1946 "type": "string" 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.",
1947 }, 1810 "enum": [
1948 "custom": { 1811 "METRIC_KIND_UNSPECIFIED",
1949 "$ref": "CustomHttpPattern", 1812 "GAUGE",
1950 "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." 1813 "DELTA",
1951 }, 1814 "CUMULATIVE"
1952 "patch": { 1815 ],
1953 "description": "Used for updating a resource.", 1816 "enumDescriptions": [
1954 "type": "string" 1817 "Do not use this default value.",
1955 }, 1818 "An instantaneous measurement of a value.",
1956 "get": { 1819 "The change in a value during a time interval.",
1957 "description": "Used for listing and getting information abo ut resources.", 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."
1958 "type": "string" 1821 ],
1959 }, 1822 "type": "string"
1960 "put": { 1823 },
1961 "description": "Used for updating a resource.", 1824 "displayName": {
1962 "type": "string" 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\".",
1963 } 1826 "type": "string"
1964 }, 1827 },
1965 "type": "object" 1828 "description": {
1966 }, 1829 "description": "A detailed description of the metric, which can be used in documentation.",
1967 "MonitoringDestination": { 1830 "type": "string"
1968 "description": "Configuration of a specific monitoring destination ( the producer project\nor the consumer project).", 1831 },
1969 "id": "MonitoringDestination", 1832 "unit": {
1970 "properties": { 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 '}'.",
1971 "monitoredResource": { 1834 "type": "string"
1972 "description": "The monitored resource type. The type must b e defined in\nService.monitored_resources section.", 1835 },
1973 "type": "string" 1836 "labels": {
1974 }, 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.",
1975 "metrics": { 1838 "items": {
1976 "description": "Names of the metrics to report to this monit oring destination.\nEach name must be defined in Service.metrics section.", 1839 "$ref": "LabelDescriptor"
1977 "items": { 1840 },
1978 "type": "string" 1841 "type": "array"
1979 }, 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 }
1847 },
1848 "type": "object"
1849 },
1850 "SourceContext": {
1851 "description": "`SourceContext` represents information about the sou rce of a\nprotobuf element, like the file in which it is defined.",
1852 "id": "SourceContext",
1853 "properties": {
1854 "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\"`.",
1856 "type": "string"
1857 }
1858 },
1859 "type": "object"
1860 },
1861 "Expr": {
1862 "description": "Represents an expression text. Example:\n\n title : \"User account presence\"\n description: \"Determines whether the request h as a user account\"\n expression: \"size(request.user) > 0\"",
1863 "id": "Expr",
1864 "properties": {
1865 "description": {
1866 "description": "An optional description of the expression. T his is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
1867 "type": "string"
1868 },
1869 "expression": {
1870 "description": "Textual representation of an expression in\n Common Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
1871 "type": "string"
1872 },
1873 "location": {
1874 "description": "An optional string indicating the location o f the expression for error\nreporting, e.g. a file name and a position in the fi le.",
1875 "type": "string"
1876 },
1877 "title": {
1878 "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
1879 "type": "string"
1880 }
1881 },
1882 "type": "object"
1883 },
1884 "ListServicesResponse": {
1885 "description": "Response message for `ListServices` method.",
1886 "id": "ListServicesResponse",
1887 "properties": {
1888 "nextPageToken": {
1889 "description": "Token that can be passed to `ListServices` t o resume a paginated query.",
1890 "type": "string"
1891 },
1892 "services": {
1893 "description": "The returned services will only have the nam e field set.",
1894 "items": {
1895 "$ref": "ManagedService"
1896 },
1897 "type": "array"
1898 }
1899 },
1900 "type": "object"
1901 },
1902 "Endpoint": {
1903 "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitorin g\nconfiguration.\n\nExample service configuration:\n\n name: library-example .googleapis.com\n endpoints:\n # Below entry makes 'google.example.libra ry.v1.Library'\n # API be served from endpoint address library-example.goog leapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backe nd, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n all ow_cors: true",
1904 "id": "Endpoint",
1905 "properties": {
1906 "features": {
1907 "description": "The list of features enabled on this endpoin t.",
1908 "items": {
1909 "type": "string"
1910 },
1911 "type": "array"
1912 },
1913 "apis": {
1914 "description": "The list of APIs served by this endpoint.\n\ nIf no APIs are specified this translates to \"all APIs\" exported by the\nservi ce, as defined in the top-level service configuration.",
1915 "items": {
1916 "type": "string"
1917 },
1918 "type": "array"
1919 },
1920 "allowCors": {
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.",
1922 "type": "boolean"
1923 },
1924 "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.",
1926 "items": {
1927 "type": "string"
1928 },
1929 "type": "array"
1930 },
1931 "name": {
1932 "description": "The canonical name of this endpoint.",
1933 "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 }
1939 },
1940 "type": "object"
1941 },
1942 "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.",
1944 "id": "OAuthRequirements",
1945 "properties": {
1946 "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 ",
1948 "type": "string"
1949 }
1950 },
1951 "type": "object"
1952 },
1953 "TestIamPermissionsResponse": {
1954 "description": "Response message for `TestIamPermissions` method.",
1955 "id": "TestIamPermissionsResponse",
1956 "properties": {
1957 "permissions": {
1958 "description": "A subset of `TestPermissionsRequest.permissi ons` that the caller is\nallowed.",
1959 "items": {
1960 "type": "string"
1961 },
1980 "type": "array" 1962 "type": "array"
1981 } 1963 }
1982 }, 1964 },
1983 "type": "object" 1965 "type": "object"
1984 }, 1966 },
1985 "Visibility": { 1967 "GetIamPolicyRequest": {
1986 "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g ., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visi bility for multiple labels is the union of each label's\nelements, plus any unre stricted elements.\n\nIf an element and its parents have no restrictions, visibi lity is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n res triction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for t he restricted methods\nEnhancedSearch and Delegate.", 1968 "description": "Request message for `GetIamPolicy` method.",
1987 "id": "Visibility", 1969 "id": "GetIamPolicyRequest",
1988 "properties": { 1970 "properties": {},
1971 "type": "object"
1972 },
1973 "Usage": {
1974 "description": "Configuration controlling usage of a service.",
1975 "id": "Usage",
1976 "properties": {
1977 "producerNotificationChannel": {
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.",
1979 "type": "string"
1980 },
1989 "rules": { 1981 "rules": {
1990 "description": "A list of visibility rules that apply to ind ividual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", 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.",
1991 "items": { 1983 "items": {
1992 "$ref": "VisibilityRule" 1984 "$ref": "UsageRule"
1993 }, 1985 },
1994 "type": "array" 1986 "type": "array"
1995 } 1987 },
1996 }, 1988 "requirements": {
1997 "type": "object" 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'.",
1998 }, 1990 "items": {
1999 "SystemParameters": { 1991 "type": "string"
2000 "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.", 1992 },
2001 "id": "SystemParameters", 1993 "type": "array"
1994 }
1995 },
1996 "type": "object"
1997 },
1998 "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`.",
2000 "id": "Context",
2002 "properties": { 2001 "properties": {
2003 "rules": { 2002 "rules": {
2004 "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.", 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.",
2005 "items": { 2004 "items": {
2006 "$ref": "SystemParameterRule" 2005 "$ref": "ContextRule"
2007 }, 2006 },
2008 "type": "array" 2007 "type": "array"
2009 } 2008 }
2010 }, 2009 },
2011 "type": "object" 2010 "type": "object"
2012 }, 2011 },
2013 "ConfigChange": { 2012 "Rule": {
2014 "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.", 2013 "description": "A rule to be applied in a Policy.",
2015 "id": "ConfigChange", 2014 "id": "Rule",
2016 "properties": { 2015 "properties": {
2017 "element": { 2016 "description": {
2018 "description": "Object hierarchy path to the change, with le vels separated by a '.'\ncharacter. For repeated fields, an applicable unique id entifier field is\nused for the index (usually selector, name, or id). For maps, the term\n'key' is used. If the field has no unique identifier, the numeric ind ex\nis used.\nExamples:\n- visibility.rules[selector==\"google.LibraryService.Cr eateBook\"].restriction\n- quota.metric_rules[selector==\"google\"].metric_costs [key==\"reads\"].value\n- logging.producer_destinations[0]", 2017 "description": "Human-readable description of the rule.",
2019 "type": "string" 2018 "type": "string"
2020 }, 2019 },
2021 "advices": { 2020 "conditions": {
2022 "description": "Collection of advice provided for this chang e, useful for determining the\npossible impact of this change.", 2021 "description": "Additional restrictions that must be met",
2023 "items": { 2022 "items": {
2024 "$ref": "Advice" 2023 "$ref": "Condition"
2025 }, 2024 },
2026 "type": "array" 2025 "type": "array"
2027 }, 2026 },
2028 "oldValue": { 2027 "logConfig": {
2029 "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.", 2028 "description": "The config returned to callers of tech.iam.I AM.CheckPolicy for any entries\nthat match the LOG action.",
2030 "type": "string" 2029 "items": {
2031 }, 2030 "$ref": "LogConfig"
2032 "newValue": { 2031 },
2033 "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.", 2032 "type": "array"
2034 "type": "string" 2033 },
2035 }, 2034 "in": {
2036 "changeType": { 2035 "description": "If one or more 'in' clauses are specified, t he rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.",
2037 "description": "The type for this change, either ADDED, REMO VED, or MODIFIED.", 2036 "items": {
2037 "type": "string"
2038 },
2039 "type": "array"
2040 },
2041 "permissions": {
2042 "description": "A permission is a string of form '<service>. <resource type>.<verb>'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
2043 "items": {
2044 "type": "string"
2045 },
2046 "type": "array"
2047 },
2048 "action": {
2049 "description": "Required",
2038 "enum": [ 2050 "enum": [
2039 "CHANGE_TYPE_UNSPECIFIED", 2051 "NO_ACTION",
2040 "ADDED", 2052 "ALLOW",
2041 "REMOVED", 2053 "ALLOW_WITH_LOG",
2042 "MODIFIED" 2054 "DENY",
2055 "DENY_WITH_LOG",
2056 "LOG"
2043 ], 2057 ],
2044 "enumDescriptions": [ 2058 "enumDescriptions": [
2045 "No value was provided.", 2059 "Default no action.",
2046 "The changed object exists in the 'new' service configur ation, but not\nin the 'old' service configuration.", 2060 "Matching 'Entries' grant access.",
2047 "The changed object exists in the 'old' service configur ation, but not\nin the 'new' service configuration.", 2061 "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",
2048 "The changed object exists in both service configuration s, but its value\nis different." 2062 "Matching 'Entries' deny access.",
2049 ], 2063 "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
2050 "type": "string" 2064 "Matching 'Entries' tell IAM.Check callers to generate l ogs."
2051 } 2065 ],
2052 }, 2066 "type": "string"
2053 "type": "object" 2067 },
2054 }, 2068 "notIn": {
2055 "Quota": { 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).",
2056 "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", 2070 "items": {
2057 "id": "Quota", 2071 "type": "string"
2058 "properties": { 2072 },
2059 "limits": { 2073 "type": "array"
2060 "description": "List of `QuotaLimit` definitions for the ser vice.", 2074 }
2061 "items": { 2075 },
2062 "$ref": "QuotaLimit" 2076 "type": "object"
2063 }, 2077 },
2064 "type": "array" 2078 "LogConfig": {
2065 }, 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",
2066 "metricRules": { 2080 "id": "LogConfig",
2067 "description": "List of `MetricRule` definitions, each one m apping a selected method to one\nor more metrics.", 2081 "properties": {
2068 "items": { 2082 "cloudAudit": {
2069 "$ref": "MetricRule" 2083 "$ref": "CloudAuditOptions",
2070 }, 2084 "description": "Cloud audit options."
2071 "type": "array" 2085 },
2072 } 2086 "counter": {
2073 }, 2087 "$ref": "CounterOptions",
2074 "type": "object" 2088 "description": "Counter options."
2075 }, 2089 },
2076 "Rollout": { 2090 "dataAccess": {
2077 "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.", 2091 "$ref": "DataAccessOptions",
2078 "id": "Rollout", 2092 "description": "Data access options."
2079 "properties": { 2093 }
2080 "createTime": { 2094 },
2081 "description": "Creation time of the rollout. Readonly.", 2095 "type": "object"
2082 "format": "google-datetime", 2096 },
2083 "type": "string" 2097 "LogDescriptor": {
2084 }, 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",
2085 "status": { 2099 "id": "LogDescriptor",
2086 "description": "The status of this rollout. Readonly. In cas e of a failed rollout,\nthe system will automatically rollback to the current Ro llout\nversion. Readonly.", 2100 "properties": {
2101 "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.",
2103 "items": {
2104 "$ref": "LabelDescriptor"
2105 },
2106 "type": "array"
2107 },
2108 "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 [/_-.].",
2110 "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 }
2120 },
2121 "type": "object"
2122 },
2123 "ConfigFile": {
2124 "description": "Generic specification of a source configuration file ",
2125 "id": "ConfigFile",
2126 "properties": {
2127 "fileType": {
2128 "description": "The type of configuration file this represen ts.",
2087 "enum": [ 2129 "enum": [
2088 "ROLLOUT_STATUS_UNSPECIFIED", 2130 "FILE_TYPE_UNSPECIFIED",
2089 "IN_PROGRESS", 2131 "SERVICE_CONFIG_YAML",
2090 "SUCCESS", 2132 "OPEN_API_JSON",
2091 "CANCELLED", 2133 "OPEN_API_YAML",
2092 "FAILED", 2134 "FILE_DESCRIPTOR_SET_PROTO"
2093 "PENDING",
2094 "FAILED_ROLLED_BACK"
2095 ], 2135 ],
2096 "enumDescriptions": [ 2136 "enumDescriptions": [
2097 "No status specified.", 2137 "Unknown file type.",
2098 "The Rollout is in progress.", 2138 "YAML-specification of service.",
2099 "The Rollout has completed successfully.", 2139 "OpenAPI specification, serialized in JSON.",
2100 "The Rollout has been cancelled. This can happen if you have overlapping\nRollout pushes, and the previous ones will be cancelled.", 2140 "OpenAPI specification, serialized in YAML.",
2101 "The Rollout has failed and the rollback attempt has fai led too.", 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"
2102 "The Rollout has not started yet and is pending for exec ution.", 2142 ],
2103 "The Rollout has failed and rolled back to the previous successful\nRollout." 2143 "type": "string"
2104 ], 2144 },
2105 "type": "string" 2145 "fileContents": {
2106 }, 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 }
2154 },
2155 "type": "object"
2156 },
2157 "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.",
2159 "id": "MonitoredResourceDescriptor",
2160 "properties": {
2161 "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\"`.",
2163 "items": {
2164 "$ref": "LabelDescriptor"
2165 },
2166 "type": "array"
2167 },
2168 "name": {
2169 "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{ty pe}\"` where\n{type} is the value of the `type` field in this object and\n{proje ct_id} is a project ID that provides API-specific context for\naccessing the typ e. APIs that do not use project information can use the\nresource name format ` \"monitoredResourceDescriptors/{type}\"`.",
2170 "type": "string"
2171 },
2172 "description": {
2173 "description": "Optional. A detailed description of the moni tored resource type that might\nbe used in documentation.",
2174 "type": "string"
2175 },
2176 "displayName": {
2177 "description": "Optional. A concise name for the monitored r esource type that might be\ndisplayed in user interfaces. It should be a Title C ased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Go ogle Cloud SQL Database\"`.",
2178 "type": "string"
2179 },
2180 "type": {
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.",
2182 "type": "string"
2183 }
2184 },
2185 "type": "object"
2186 },
2187 "CustomErrorRule": {
2188 "description": "A custom error rule.",
2189 "id": "CustomErrorRule",
2190 "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": {
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.",
2197 "type": "boolean"
2198 }
2199 },
2200 "type": "object"
2201 },
2202 "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.",
2204 "id": "MediaDownload",
2205 "properties": {
2206 "enabled": {
2207 "description": "Whether download is enabled.",
2208 "type": "boolean"
2209 },
2210 "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.",
2212 "type": "string"
2213 },
2214 "completeNotification": {
2215 "description": "A boolean that determines whether a notifica tion for the completion of a\ndownload should be sent to the backend.",
2216 "type": "boolean"
2217 },
2218 "dropzone": {
2219 "description": "Name of the Scotty dropzone to use for the c urrent API.",
2220 "type": "string"
2221 },
2222 "maxDirectDownloadSize": {
2223 "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
2224 "format": "int64",
2225 "type": "string"
2226 },
2227 "useDirectDownload": {
2228 "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
2229 "type": "boolean"
2230 }
2231 },
2232 "type": "object"
2233 },
2234 "CustomAuthRequirements": {
2235 "description": "Configuration for a custom authentication provider." ,
2236 "id": "CustomAuthRequirements",
2237 "properties": {
2238 "provider": {
2239 "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartSer vice string\n(go/smartservice).",
2240 "type": "string"
2241 }
2242 },
2243 "type": "object"
2244 },
2245 "ChangeReport": {
2246 "description": "Change report associated with a particular service c onfiguration.\n\nIt contains a list of ConfigChanges based on the comparison bet ween\ntwo service configurations.",
2247 "id": "ChangeReport",
2248 "properties": {
2249 "configChanges": {
2250 "description": "List of changes between two service configur ations.\nThe changes will be alphabetically sorted based on the identifier\nof e ach change.\nA ConfigChange identifier is a dot separated path to the configurat ion.\nExample: visibility.rules[selector='LibraryService.CreateBook'].restrictio n",
2251 "items": {
2252 "$ref": "ConfigChange"
2253 },
2254 "type": "array"
2255 }
2256 },
2257 "type": "object"
2258 },
2259 "DisableServiceRequest": {
2260 "description": "Request message for DisableService method.",
2261 "id": "DisableServiceRequest",
2262 "properties": {
2263 "consumerId": {
2264 "description": "The identity of consumer resource which serv ice disablement will be\napplied to.\n\nThe Google Service Management implementa tion accepts the following\nforms:\n- \"project:<project_id>\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
2265 "type": "string"
2266 }
2267 },
2268 "type": "object"
2269 },
2270 "SubmitConfigSourceResponse": {
2271 "description": "Response message for SubmitConfigSource method.",
2272 "id": "SubmitConfigSourceResponse",
2273 "properties": {
2274 "serviceConfig": {
2275 "$ref": "Service",
2276 "description": "The generated service configuration."
2277 }
2278 },
2279 "type": "object"
2280 },
2281 "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.",
2283 "id": "MediaUpload",
2284 "properties": {
2285 "mimeTypes": {
2286 "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.",
2287 "items": {
2288 "type": "string"
2289 },
2290 "type": "array"
2291 },
2292 "maxSize": {
2293 "description": "Optional maximum acceptable size for an uplo ad.\nThe size is specified in bytes.",
2294 "format": "int64",
2295 "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 }
2321 },
2322 "type": "object"
2323 },
2324 "Advice": {
2325 "description": "Generated advice about this change, used for providi ng more\ninformation about how a change will affect the existing service.",
2326 "id": "Advice",
2327 "properties": {
2328 "description": {
2329 "description": "Useful description for why this advice was a pplied and what actions should\nbe taken to mitigate any implied risks.",
2330 "type": "string"
2331 }
2332 },
2333 "type": "object"
2334 },
2335 "ManagedService": {
2336 "description": "The full representation of a Service that is managed by\nGoogle Service Management.",
2337 "id": "ManagedService",
2338 "properties": {
2107 "serviceName": { 2339 "serviceName": {
2108 "description": "The name of the service associated with this Rollout.", 2340 "description": "The name of the service. See the [overview]( /service-management/overview)\nfor naming requirements.",
2109 "type": "string" 2341 "type": "string"
2110 }, 2342 },
2111 "trafficPercentStrategy": { 2343 "producerProjectId": {
2112 "$ref": "TrafficPercentStrategy", 2344 "description": "ID of the project that produces and owns thi s service.",
2113 "description": "Google Service Control selects service confi gurations based on\ntraffic percentage." 2345 "type": "string"
2114 }, 2346 }
2115 "createdBy": { 2347 },
2116 "description": "The user who created the Rollout. Readonly." , 2348 "type": "object"
2117 "type": "string" 2349 },
2118 }, 2350 "UsageRule": {
2119 "rolloutId": { 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",
2120 "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'", 2352 "id": "UsageRule",
2121 "type": "string" 2353 "properties": {
2122 }, 2354 "selector": {
2123 "deleteServiceStrategy": { 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.",
2124 "$ref": "DeleteServiceStrategy", 2356 "type": "string"
2125 "description": "The strategy associated with a rollout to de lete a `ManagedService`.\nReadonly." 2357 },
2126 } 2358 "skipServiceControl": {
2127 }, 2359 "description": "True, if the method should skip service cont rol. If so, no control plane\nfeature (like quota and billing) will be enabled." ,
2128 "type": "object" 2360 "type": "boolean"
2129 }, 2361 },
2130 "GenerateConfigReportRequest": { 2362 "allowUnregisteredCalls": {
2131 "description": "Request message for GenerateConfigReport method.", 2363 "description": "True, if the method allows unregistered call s; false otherwise.",
2132 "id": "GenerateConfigReportRequest", 2364 "type": "boolean"
2133 "properties": { 2365 }
2134 "oldConfig": { 2366 },
2367 "type": "object"
2368 },
2369 "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 }",
2371 "id": "TrafficPercentStrategy",
2372 "properties": {
2373 "percentages": {
2135 "additionalProperties": { 2374 "additionalProperties": {
2136 "description": "Properties of the object. Contains field @type with type URL.", 2375 "format": "double",
2137 "type": "any" 2376 "type": "number"
2138 }, 2377 },
2139 "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", 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.",
2140 "type": "object" 2379 "type": "object"
2141 }, 2380 }
2142 "newConfig": { 2381 },
2143 "additionalProperties": { 2382 "type": "object"
2144 "description": "Properties of the object. Contains field @type with type URL.", 2383 },
2145 "type": "any" 2384 "AuthRequirement": {
2146 }, 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).",
2147 "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", 2386 "id": "AuthRequirement",
2148 "type": "object" 2387 "properties": {
2149 } 2388 "audiences": {
2150 }, 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",
2151 "type": "object" 2390 "type": "string"
2152 }, 2391 },
2153 "SetIamPolicyRequest": { 2392 "providerId": {
2154 "description": "Request message for `SetIamPolicy` method.", 2393 "description": "id from authentication provider.\n\nExample: \n\n provider_id: bookstore_auth",
2155 "id": "SetIamPolicyRequest", 2394 "type": "string"
2156 "properties": { 2395 }
2157 "policy": { 2396 },
2158 "$ref": "Policy", 2397 "type": "object"
2159 "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." 2398 },
2160 }, 2399 "Condition": {
2161 "updateMask": { 2400 "description": "A condition to be met.",
2162 "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.", 2401 "id": "Condition",
2163 "format": "google-fieldmask", 2402 "properties": {
2164 "type": "string" 2403 "sys": {
2165 } 2404 "description": "Trusted attributes supplied by any service t hat owns resources and uses\nthe IAM system for access control.",
2166 },
2167 "type": "object"
2168 },
2169 "DeleteServiceStrategy": {
2170 "description": "Strategy used to delete a service. This strategy is a placeholder only\nused by the system generated rollout to delete a service.",
2171 "id": "DeleteServiceStrategy",
2172 "properties": {},
2173 "type": "object"
2174 },
2175 "Step": {
2176 "description": "Represents the status of one operation step.",
2177 "id": "Step",
2178 "properties": {
2179 "description": {
2180 "description": "The short description of the step.",
2181 "type": "string"
2182 },
2183 "status": {
2184 "description": "The status code.",
2185 "enum": [ 2405 "enum": [
2186 "STATUS_UNSPECIFIED", 2406 "NO_ATTR",
2187 "DONE", 2407 "REGION",
2188 "NOT_STARTED", 2408 "SERVICE",
2189 "IN_PROGRESS", 2409 "NAME",
2190 "FAILED", 2410 "IP"
2191 "CANCELLED"
2192 ], 2411 ],
2193 "enumDescriptions": [ 2412 "enumDescriptions": [
2194 "Unspecifed code.", 2413 "Default non-attribute type",
2195 "The operation or step has completed without errors.", 2414 "Region of the resource",
2196 "The operation or step has not started yet.", 2415 "Service name",
2197 "The operation or step is in progress.", 2416 "Resource name",
2198 "The operation or step has completed with errors. If the operation is\nrollbackable, the rollback completed with errors too.", 2417 "IP address of the caller"
2199 "The operation or step has completed with cancellation." 2418 ],
2200 ], 2419 "type": "string"
2201 "type": "string" 2420 },
2202 } 2421 "value": {
2203 }, 2422 "description": "DEPRECATED. Use 'values' instead.",
2204 "type": "object" 2423 "type": "string"
2205 }, 2424 },
2206 "LoggingDestination": { 2425 "values": {
2207 "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).", 2426 "description": "The objects of the condition. This is mutual ly exclusive with 'value'.",
2208 "id": "LoggingDestination",
2209 "properties": {
2210 "logs": {
2211 "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 \"/\".",
2212 "items": { 2427 "items": {
2213 "type": "string" 2428 "type": "string"
2214 }, 2429 },
2215 "type": "array" 2430 "type": "array"
2216 }, 2431 },
2217 "monitoredResource": { 2432 "iam": {
2218 "description": "The monitored resource type. The type must b e defined in the\nService.monitored_resources section.", 2433 "description": "Trusted attributes supplied by the IAM syste m.",
2219 "type": "string" 2434 "enum": [
2220 } 2435 "NO_ATTR",
2221 }, 2436 "AUTHORITY",
2222 "type": "object" 2437 "ATTRIBUTION",
2223 }, 2438 "APPROVER",
2224 "Option": { 2439 "JUSTIFICATION_TYPE"
2225 "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.", 2440 ],
2226 "id": "Option", 2441 "enumDescriptions": [
2227 "properties": { 2442 "Default non-attribute.",
2228 "name": { 2443 "Either principal or (if present) authority selector.",
2229 "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\"`.", 2444 "The principal (even if an authority selector is present ), which\nmust only be used for attribution, not authorization.",
2230 "type": "string" 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).",
2231 }, 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. "
2232 "value": { 2447 ],
2233 "additionalProperties": { 2448 "type": "string"
2234 "description": "Properties of the object. Contains field @type with type URL.", 2449 },
2235 "type": "any" 2450 "op": {
2236 }, 2451 "description": "An operator to apply the subject with.",
2237 "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.", 2452 "enum": [
2238 "type": "object" 2453 "NO_OP",
2239 } 2454 "EQUALS",
2240 }, 2455 "NOT_EQUALS",
2241 "type": "object" 2456 "IN",
2242 }, 2457 "NOT_IN",
2243 "Logging": { 2458 "DISCHARGED"
2244 "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", 2459 ],
2245 "id": "Logging", 2460 "enumDescriptions": [
2246 "properties": { 2461 "Default no-op.",
2247 "consumerDestinations": { 2462 "DEPRECATED. Use IN instead.",
2248 "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.", 2463 "DEPRECATED. Use NOT_IN instead.",
2249 "items": { 2464 "The condition is true if the subject (or any element of it if it is\na set) matches any of the supplied values.",
2250 "$ref": "LoggingDestination" 2465 "The condition is true if the subject (or every element of it if it is\na set) matches none of the supplied values.",
2251 }, 2466 "Subject is discharged"
2252 "type": "array" 2467 ],
2253 }, 2468 "type": "string"
2254 "producerDestinations": { 2469 },
2255 "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.", 2470 "svc": {
2256 "items": { 2471 "description": "Trusted attributes discharged by the service .",
2257 "$ref": "LoggingDestination" 2472 "type": "string"
2258 }, 2473 }
2259 "type": "array" 2474 },
2260 } 2475 "type": "object"
2261 }, 2476 },
2262 "type": "object" 2477 "Documentation": {
2263 }, 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: &#40;== include google/foo/overview.md ==&#41;\n - na me: Tutorial\n content: &#40;== include google/foo/tutorial.md ==&#41;\n s ubpages;\n - name: Java\n content: &#40;== include google/foo/tutorial_j ava.md ==&#41;\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>&#91;fully.qualified.proto.nam e]&#91;]</code></pre>\nTo override the display text used for the link, this can be used:\n<pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></ pre>\nText can be excluded from doc using the following notation:\n<pre><code>&# 40;-- internal comment --&#41;</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>&#40;--BETA: comment for BETA users --&#41;</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>&#40;== include pat h/to/file ==&#41;</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>&#4 0;== resource_for v1.shelves.books ==&#41;</code></pre>\nThe directive `suppress _warning` does not directly affect documentation\nand is documented together wit h service config validation.",
2264 "Method": { 2479 "id": "Documentation",
2265 "description": "Method represents a method of an api.", 2480 "properties": {
2266 "id": "Method", 2481 "summary": {
2267 "properties": { 2482 "description": "A short summary of what the service does. Ca n only be provided by\nplain text.",
2268 "responseTypeUrl": { 2483 "type": "string"
2269 "description": "The URL of the output message type.", 2484 },
2270 "type": "string" 2485 "documentationRootUrl": {
2271 }, 2486 "description": "The URL to the root of documentation.",
2272 "options": { 2487 "type": "string"
2273 "description": "Any metadata attached to the method.", 2488 },
2274 "items": { 2489 "overview": {
2275 "$ref": "Option" 2490 "description": "Declares a single overview page. For example :\n<pre><code>documentation:\n summary: ...\n overview: &#40;== include overvi ew.md ==&#41;\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: &#40;== include overview.md ==&#41;\n</code></pre>\nN ote: you cannot specify both `overview` field and `pages` field.",
2276 }, 2491 "type": "string"
2277 "type": "array" 2492 },
2278 }, 2493 "rules": {
2279 "responseStreaming": { 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.",
2280 "description": "If true, the response is streamed.", 2495 "items": {
2281 "type": "boolean" 2496 "$ref": "DocumentationRule"
2282 }, 2497 },
2283 "name": { 2498 "type": "array"
2284 "description": "The simple name of this method.", 2499 },
2285 "type": "string" 2500 "pages": {
2286 }, 2501 "description": "The top level pages for the documentation se t.",
2287 "requestTypeUrl": { 2502 "items": {
2288 "description": "A URL of the input message type.", 2503 "$ref": "Page"
2289 "type": "string" 2504 },
2290 }, 2505 "type": "array"
2291 "requestStreaming": { 2506 }
2292 "description": "If true, the request is streamed.", 2507 },
2293 "type": "boolean" 2508 "type": "object"
2294 }, 2509 },
2510 "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.",
2512 "id": "AuditLogConfig",
2513 "properties": {
2514 "logType": {
2515 "description": "The log type that this config enables.",
2516 "enum": [
2517 "LOG_TYPE_UNSPECIFIED",
2518 "ADMIN_READ",
2519 "DATA_WRITE",
2520 "DATA_READ"
2521 ],
2522 "enumDescriptions": [
2523 "Default case. Should never be this.",
2524 "Admin reads. Example: CloudIAM getIamPolicy",
2525 "Data writes. Example: CloudSQL Users create",
2526 "Data reads. Example: CloudSQL Users list"
2527 ],
2528 "type": "string"
2529 },
2530 "exemptedMembers": {
2531 "description": "Specifies the identities that do not cause l ogging for this type of\npermission.\nFollows the same format of Binding.members .",
2532 "items": {
2533 "type": "string"
2534 },
2535 "type": "array"
2536 }
2537 },
2538 "type": "object"
2539 },
2540 "ConfigSource": {
2541 "description": "Represents a source file which is used to generate t he service configuration\ndefined by `google.api.Service`.",
2542 "id": "ConfigSource",
2543 "properties": {
2544 "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.",
2546 "type": "string"
2547 },
2548 "files": {
2549 "description": "Set of source configuration files that are u sed to generate a service\nconfiguration (`google.api.Service`).",
2550 "items": {
2551 "$ref": "ConfigFile"
2552 },
2553 "type": "array"
2554 }
2555 },
2556 "type": "object"
2557 },
2558 "BackendRule": {
2559 "description": "A backend rule provides configuration for an individ ual API element.",
2560 "id": "BackendRule",
2561 "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": {
2567 "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
2568 "format": "double",
2569 "type": "number"
2570 },
2571 "minDeadline": {
2572 "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.",
2573 "format": "double",
2574 "type": "number"
2575 },
2576 "address": {
2577 "description": "The address of the API backend.",
2578 "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 },
2598 "selector": {
2599 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
2600 "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 }
2621 },
2622 "type": "object"
2623 },
2624 "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).",
2626 "id": "Policy",
2627 "properties": {
2628 "iamOwned": {
2629 "type": "boolean"
2630 },
2631 "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.",
2633 "items": {
2634 "$ref": "Rule"
2635 },
2636 "type": "array"
2637 },
2638 "version": {
2639 "description": "Version of the `Policy`. The default version is 0.",
2640 "format": "int32",
2641 "type": "integer"
2642 },
2643 "auditConfigs": {
2644 "description": "Specifies cloud audit logging configuration for this policy.",
2645 "items": {
2646 "$ref": "AuditConfig"
2647 },
2648 "type": "array"
2649 },
2650 "bindings": {
2651 "description": "Associates a list of `members` to a `role`.\ n`bindings` with no members will result in an error.",
2652 "items": {
2653 "$ref": "Binding"
2654 },
2655 "type": "array"
2656 },
2657 "etag": {
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.",
2659 "format": "byte",
2660 "type": "string"
2661 }
2662 },
2663 "type": "object"
2664 },
2665 "Api": {
2666 "description": "Api is a light-weight descriptor for a protocol buff er service.",
2667 "id": "Api",
2668 "properties": {
2295 "syntax": { 2669 "syntax": {
2296 "description": "The source syntax of this method.", 2670 "description": "The source syntax of the service.",
2297 "enum": [ 2671 "enum": [
2298 "SYNTAX_PROTO2", 2672 "SYNTAX_PROTO2",
2299 "SYNTAX_PROTO3" 2673 "SYNTAX_PROTO3"
2300 ],
2301 "enumDescriptions": [
2302 "Syntax `proto2`.",
2303 "Syntax `proto3`."
2304 ],
2305 "type": "string"
2306 }
2307 },
2308 "type": "object"
2309 },
2310 "QuotaLimit": {
2311 "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`.",
2312 "id": "QuotaLimit",
2313 "properties": {
2314 "duration": {
2315 "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.",
2316 "type": "string"
2317 },
2318 "freeTier": {
2319 "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.",
2320 "format": "int64",
2321 "type": "string"
2322 },
2323 "defaultLimit": {
2324 "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.",
2325 "format": "int64",
2326 "type": "string"
2327 },
2328 "displayName": {
2329 "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.",
2330 "type": "string"
2331 },
2332 "description": {
2333 "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` ).",
2334 "type": "string"
2335 },
2336 "metric": {
2337 "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.",
2338 "type": "string"
2339 },
2340 "values": {
2341 "additionalProperties": {
2342 "format": "int64",
2343 "type": "string"
2344 },
2345 "description": "Tiered limit values, currently only STANDARD is supported.",
2346 "type": "object"
2347 },
2348 "unit": {
2349 "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.",
2350 "type": "string"
2351 },
2352 "maxLimit": {
2353 "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.",
2354 "format": "int64",
2355 "type": "string"
2356 },
2357 "name": {
2358 "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.",
2359 "type": "string"
2360 }
2361 },
2362 "type": "object"
2363 },
2364 "ConfigRef": {
2365 "description": "Represents a service configuration with its name and id.",
2366 "id": "ConfigRef",
2367 "properties": {
2368 "name": {
2369 "description": "Resource name of a service config. It must h ave the following\nformat: \"services/{service name}/configs/{config id}\".",
2370 "type": "string"
2371 }
2372 },
2373 "type": "object"
2374 },
2375 "ListServiceRolloutsResponse": {
2376 "description": "Response message for ListServiceRollouts method.",
2377 "id": "ListServiceRolloutsResponse",
2378 "properties": {
2379 "nextPageToken": {
2380 "description": "The token of the next page of results.",
2381 "type": "string"
2382 },
2383 "rollouts": {
2384 "description": "The list of rollout resources.",
2385 "items": {
2386 "$ref": "Rollout"
2387 },
2388 "type": "array"
2389 }
2390 },
2391 "type": "object"
2392 },
2393 "Mixin": {
2394 "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 }",
2395 "id": "Mixin",
2396 "properties": {
2397 "name": {
2398 "description": "The fully qualified name of the API which is included.",
2399 "type": "string"
2400 },
2401 "root": {
2402 "description": "If non-empty specifies a path under which in herited HTTP paths\nare rooted.",
2403 "type": "string"
2404 }
2405 },
2406 "type": "object"
2407 },
2408 "FlowOperationMetadata": {
2409 "description": "The metadata associated with a long running operatio n resource.",
2410 "id": "FlowOperationMetadata",
2411 "properties": {
2412 "resourceNames": {
2413 "description": "The full name of the resources that this flo w is directly associated with.",
2414 "items": {
2415 "type": "string"
2416 },
2417 "type": "array"
2418 },
2419 "flowName": {
2420 "description": "The name of the top-level flow corresponding to this operation.\nMust be equal to the \"name\" field for a FlowName enum.",
2421 "type": "string"
2422 },
2423 "deadline": {
2424 "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",
2425 "format": "google-datetime",
2426 "type": "string"
2427 },
2428 "cancelState": {
2429 "description": "The state of the operation with respect to c ancellation.",
2430 "enum": [
2431 "RUNNING",
2432 "UNCANCELLABLE",
2433 "CANCELLED"
2434 ],
2435 "enumDescriptions": [
2436 "Default state, cancellable but not cancelled.",
2437 "The operation has proceeded past the point of no return and cannot\nbe cancelled.",
2438 "The operation has been cancelled, work should cease\nan d any needed rollback steps executed."
2439 ],
2440 "type": "string"
2441 },
2442 "startTime": {
2443 "description": "The start time of the operation.",
2444 "format": "google-datetime",
2445 "type": "string"
2446 }
2447 },
2448 "type": "object"
2449 },
2450 "CustomError": {
2451 "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",
2452 "id": "CustomError",
2453 "properties": {
2454 "types": {
2455 "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
2456 "items": {
2457 "type": "string"
2458 },
2459 "type": "array"
2460 },
2461 "rules": {
2462 "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.",
2463 "items": {
2464 "$ref": "CustomErrorRule"
2465 },
2466 "type": "array"
2467 }
2468 },
2469 "type": "object"
2470 },
2471 "CounterOptions": {
2472 "description": "Options for counters",
2473 "id": "CounterOptions",
2474 "properties": {
2475 "field": {
2476 "description": "The field value to attribute.",
2477 "type": "string"
2478 },
2479 "metric": {
2480 "description": "The metric to update.",
2481 "type": "string"
2482 }
2483 },
2484 "type": "object"
2485 },
2486 "Http": {
2487 "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.",
2488 "id": "Http",
2489 "properties": {
2490 "fullyDecodeReservedExpansion": {
2491 "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.",
2492 "type": "boolean"
2493 },
2494 "rules": {
2495 "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.",
2496 "items": {
2497 "$ref": "HttpRule"
2498 },
2499 "type": "array"
2500 }
2501 },
2502 "type": "object"
2503 },
2504 "SourceInfo": {
2505 "description": "Source information used to create a Service Config",
2506 "id": "SourceInfo",
2507 "properties": {
2508 "sourceFiles": {
2509 "description": "All files used during config generation.",
2510 "items": {
2511 "additionalProperties": {
2512 "description": "Properties of the object. Contains f ield @type with type URL.",
2513 "type": "any"
2514 },
2515 "type": "object"
2516 },
2517 "type": "array"
2518 }
2519 },
2520 "type": "object"
2521 },
2522 "Control": {
2523 "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.",
2524 "id": "Control",
2525 "properties": {
2526 "environment": {
2527 "description": "The service control environment to use. If e mpty, no control plane\nfeature (like quota and billing) will be enabled.",
2528 "type": "string"
2529 }
2530 },
2531 "type": "object"
2532 },
2533 "SystemParameter": {
2534 "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.",
2535 "id": "SystemParameter",
2536 "properties": {
2537 "name": {
2538 "description": "Define the name of the parameter, such as \" api_key\" . It is case sensitive.",
2539 "type": "string"
2540 },
2541 "urlQueryParameter": {
2542 "description": "Define the URL query parameter name to use f or the parameter. It is case\nsensitive.",
2543 "type": "string"
2544 },
2545 "httpHeader": {
2546 "description": "Define the HTTP header name to use for the p arameter. It is case\ninsensitive.",
2547 "type": "string"
2548 }
2549 },
2550 "type": "object"
2551 },
2552 "Field": {
2553 "description": "A single field of a message type.",
2554 "id": "Field",
2555 "properties": {
2556 "jsonName": {
2557 "description": "The field JSON name.",
2558 "type": "string"
2559 },
2560 "kind": {
2561 "description": "The field type.",
2562 "enum": [
2563 "TYPE_UNKNOWN",
2564 "TYPE_DOUBLE",
2565 "TYPE_FLOAT",
2566 "TYPE_INT64",
2567 "TYPE_UINT64",
2568 "TYPE_INT32",
2569 "TYPE_FIXED64",
2570 "TYPE_FIXED32",
2571 "TYPE_BOOL",
2572 "TYPE_STRING",
2573 "TYPE_GROUP",
2574 "TYPE_MESSAGE",
2575 "TYPE_BYTES",
2576 "TYPE_UINT32",
2577 "TYPE_ENUM",
2578 "TYPE_SFIXED32",
2579 "TYPE_SFIXED64",
2580 "TYPE_SINT32",
2581 "TYPE_SINT64"
2582 ],
2583 "enumDescriptions": [
2584 "Field type unknown.",
2585 "Field type double.",
2586 "Field type float.",
2587 "Field type int64.",
2588 "Field type uint64.",
2589 "Field type int32.",
2590 "Field type fixed64.",
2591 "Field type fixed32.",
2592 "Field type bool.",
2593 "Field type string.",
2594 "Field type group. Proto2 syntax only, and deprecated.",
2595 "Field type message.",
2596 "Field type bytes.",
2597 "Field type uint32.",
2598 "Field type enum.",
2599 "Field type sfixed32.",
2600 "Field type sfixed64.",
2601 "Field type sint32.",
2602 "Field type sint64."
2603 ],
2604 "type": "string"
2605 },
2606 "options": {
2607 "description": "The protocol buffer options.",
2608 "items": {
2609 "$ref": "Option"
2610 },
2611 "type": "array"
2612 },
2613 "oneofIndex": {
2614 "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.",
2615 "format": "int32",
2616 "type": "integer"
2617 },
2618 "packed": {
2619 "description": "Whether to use alternative packed wire repre sentation.",
2620 "type": "boolean"
2621 },
2622 "cardinality": {
2623 "description": "The field cardinality.",
2624 "enum": [
2625 "CARDINALITY_UNKNOWN",
2626 "CARDINALITY_OPTIONAL",
2627 "CARDINALITY_REQUIRED",
2628 "CARDINALITY_REPEATED"
2629 ],
2630 "enumDescriptions": [
2631 "For fields with unknown cardinality.",
2632 "For optional fields.",
2633 "For required fields. Proto2 syntax only.",
2634 "For repeated fields."
2635 ],
2636 "type": "string"
2637 },
2638 "defaultValue": {
2639 "description": "The string value of the default value of thi s field. Proto2 syntax only.",
2640 "type": "string"
2641 },
2642 "name": {
2643 "description": "The field name.",
2644 "type": "string"
2645 },
2646 "typeUrl": {
2647 "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.T imestamp\"`.",
2648 "type": "string"
2649 },
2650 "number": {
2651 "description": "The field number.",
2652 "format": "int32",
2653 "type": "integer"
2654 }
2655 },
2656 "type": "object"
2657 },
2658 "Monitoring": {
2659 "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",
2660 "id": "Monitoring",
2661 "properties": {
2662 "consumerDestinations": {
2663 "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.",
2664 "items": {
2665 "$ref": "MonitoringDestination"
2666 },
2667 "type": "array"
2668 },
2669 "producerDestinations": {
2670 "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.",
2671 "items": {
2672 "$ref": "MonitoringDestination"
2673 },
2674 "type": "array"
2675 }
2676 },
2677 "type": "object"
2678 },
2679 "TestIamPermissionsRequest": {
2680 "description": "Request message for `TestIamPermissions` method.",
2681 "id": "TestIamPermissionsRequest",
2682 "properties": {
2683 "permissions": {
2684 "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).",
2685 "items": {
2686 "type": "string"
2687 },
2688 "type": "array"
2689 }
2690 },
2691 "type": "object"
2692 },
2693 "Enum": {
2694 "description": "Enum type definition.",
2695 "id": "Enum",
2696 "properties": {
2697 "enumvalue": {
2698 "description": "Enum value definitions.",
2699 "items": {
2700 "$ref": "EnumValue"
2701 },
2702 "type": "array"
2703 },
2704 "name": {
2705 "description": "Enum type name.",
2706 "type": "string"
2707 },
2708 "options": {
2709 "description": "Protocol buffer options.",
2710 "items": {
2711 "$ref": "Option"
2712 },
2713 "type": "array"
2714 },
2715 "syntax": {
2716 "description": "The source syntax.",
2717 "enum": [
2718 "SYNTAX_PROTO2",
2719 "SYNTAX_PROTO3"
2720 ], 2674 ],
2721 "enumDescriptions": [ 2675 "enumDescriptions": [
2722 "Syntax `proto2`.", 2676 "Syntax `proto2`.",
2723 "Syntax `proto3`." 2677 "Syntax `proto3`."
2724 ], 2678 ],
2725 "type": "string" 2679 "type": "string"
2726 }, 2680 },
2727 "sourceContext": { 2681 "sourceContext": {
2728 "$ref": "SourceContext", 2682 "$ref": "SourceContext",
2729 "description": "The source context." 2683 "description": "Source context for the protocol buffer servi ce represented by this\nmessage."
2730 } 2684 },
2731 }, 2685 "version": {
2732 "type": "object" 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",
2733 }, 2687 "type": "string"
2734 "LabelDescriptor": { 2688 },
2735 "description": "A description of a label.", 2689 "mixins": {
2736 "id": "LabelDescriptor", 2690 "description": "Included APIs. See Mixin.",
2737 "properties": { 2691 "items": {
2738 "description": { 2692 "$ref": "Mixin"
2739 "description": "A human-readable description for the label." , 2693 },
2740 "type": "string" 2694 "type": "array"
2741 }, 2695 },
2742 "valueType": {
2743 "description": "The type of data that can be assigned to the label.",
2744 "enum": [
2745 "STRING",
2746 "BOOL",
2747 "INT64"
2748 ],
2749 "enumDescriptions": [
2750 "A variable-length string. This is the default.",
2751 "Boolean; true or false.",
2752 "A 64-bit signed integer."
2753 ],
2754 "type": "string"
2755 },
2756 "key": {
2757 "description": "The label key.",
2758 "type": "string"
2759 }
2760 },
2761 "type": "object"
2762 },
2763 "Diagnostic": {
2764 "description": "Represents a diagnostic message (error or warning)",
2765 "id": "Diagnostic",
2766 "properties": {
2767 "kind": {
2768 "description": "The kind of diagnostic information provided. ",
2769 "enum": [
2770 "WARNING",
2771 "ERROR"
2772 ],
2773 "enumDescriptions": [
2774 "Warnings and errors",
2775 "Only errors"
2776 ],
2777 "type": "string"
2778 },
2779 "message": {
2780 "description": "Message describing the error or warning.",
2781 "type": "string"
2782 },
2783 "location": {
2784 "description": "File name and line number of the error or wa rning.",
2785 "type": "string"
2786 }
2787 },
2788 "type": "object"
2789 },
2790 "EnableServiceRequest": {
2791 "description": "Request message for EnableService method.",
2792 "id": "EnableServiceRequest",
2793 "properties": {
2794 "consumerId": {
2795 "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.",
2796 "type": "string"
2797 }
2798 },
2799 "type": "object"
2800 },
2801 "Type": {
2802 "description": "A protocol buffer message type.",
2803 "id": "Type",
2804 "properties": {
2805 "options": { 2696 "options": {
2806 "description": "The protocol buffer options.", 2697 "description": "Any metadata attached to the API.",
2807 "items": { 2698 "items": {
2808 "$ref": "Option" 2699 "$ref": "Option"
2809 }, 2700 },
2810 "type": "array" 2701 "type": "array"
2811 }, 2702 },
2812 "fields": { 2703 "methods": {
2813 "description": "The list of fields.", 2704 "description": "The methods of this api, in unspecified orde r.",
2814 "items": { 2705 "items": {
2815 "$ref": "Field" 2706 "$ref": "Method"
2816 }, 2707 },
2817 "type": "array" 2708 "type": "array"
2818 }, 2709 },
2819 "name": { 2710 "name": {
2820 "description": "The fully qualified message name.", 2711 "description": "The fully qualified name of this api, includ ing package name\nfollowed by the api's simple name.",
2821 "type": "string" 2712 "type": "string"
2822 }, 2713 }
2823 "oneofs": { 2714 },
2824 "description": "The list of types appearing in `oneof` defin itions in this type.", 2715 "type": "object"
2825 "items": { 2716 },
2717 "DataAccessOptions": {
2718 "description": "Write a Data Access (Gin) log",
2719 "id": "DataAccessOptions",
2720 "properties": {},
2721 "type": "object"
2722 },
2723 "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.",
2725 "id": "MetricRule",
2726 "properties": {
2727 "metricCosts": {
2728 "additionalProperties": {
2729 "format": "int64",
2826 "type": "string" 2730 "type": "string"
2827 }, 2731 },
2828 "type": "array" 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.",
2829 }, 2733 "type": "object"
2830 "sourceContext": {
2831 "$ref": "SourceContext",
2832 "description": "The source context."
2833 },
2834 "syntax": {
2835 "description": "The source syntax.",
2836 "enum": [
2837 "SYNTAX_PROTO2",
2838 "SYNTAX_PROTO3"
2839 ],
2840 "enumDescriptions": [
2841 "Syntax `proto2`.",
2842 "Syntax `proto3`."
2843 ],
2844 "type": "string"
2845 }
2846 },
2847 "type": "object"
2848 },
2849 "GenerateConfigReportResponse": {
2850 "description": "Response message for GenerateConfigReport method.",
2851 "id": "GenerateConfigReportResponse",
2852 "properties": {
2853 "serviceName": {
2854 "description": "Name of the service this report belongs to." ,
2855 "type": "string"
2856 },
2857 "changeReports": {
2858 "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations.",
2859 "items": {
2860 "$ref": "ChangeReport"
2861 },
2862 "type": "array"
2863 },
2864 "id": {
2865 "description": "ID of the service configuration this report belongs to.",
2866 "type": "string"
2867 },
2868 "diagnostics": {
2869 "description": "Errors / Linter warnings associated with the service definition this\nreport\nbelongs to.",
2870 "items": {
2871 "$ref": "Diagnostic"
2872 },
2873 "type": "array"
2874 }
2875 },
2876 "type": "object"
2877 },
2878 "ListServiceConfigsResponse": {
2879 "description": "Response message for ListServiceConfigs method.",
2880 "id": "ListServiceConfigsResponse",
2881 "properties": {
2882 "serviceConfigs": {
2883 "description": "The list of service configuration resources. ",
2884 "items": {
2885 "$ref": "Service"
2886 },
2887 "type": "array"
2888 },
2889 "nextPageToken": {
2890 "description": "The token of the next page of results.",
2891 "type": "string"
2892 }
2893 },
2894 "type": "object"
2895 },
2896 "Experimental": {
2897 "description": "Experimental service configuration. These configurat ion options can\nonly be used by whitelisted users.",
2898 "id": "Experimental",
2899 "properties": {
2900 "authorization": {
2901 "$ref": "AuthorizationConfig",
2902 "description": "Authorization configuration."
2903 }
2904 },
2905 "type": "object"
2906 },
2907 "AuditConfig": {
2908 "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.",
2909 "id": "AuditConfig",
2910 "properties": {
2911 "exemptedMembers": {
2912 "items": {
2913 "type": "string"
2914 },
2915 "type": "array"
2916 },
2917 "service": {
2918 "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.",
2919 "type": "string"
2920 },
2921 "auditLogConfigs": {
2922 "description": "The configuration for logging of each type o f permission.\nNext ID: 4",
2923 "items": {
2924 "$ref": "AuditLogConfig"
2925 },
2926 "type": "array"
2927 }
2928 },
2929 "type": "object"
2930 },
2931 "Backend": {
2932 "description": "`Backend` defines the backend configuration for a se rvice.",
2933 "id": "Backend",
2934 "properties": {
2935 "rules": {
2936 "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.",
2937 "items": {
2938 "$ref": "BackendRule"
2939 },
2940 "type": "array"
2941 }
2942 },
2943 "type": "object"
2944 },
2945 "SubmitConfigSourceRequest": {
2946 "description": "Request message for SubmitConfigSource method.",
2947 "id": "SubmitConfigSourceRequest",
2948 "properties": {
2949 "configSource": {
2950 "$ref": "ConfigSource",
2951 "description": "The source configuration for the service."
2952 },
2953 "validateOnly": {
2954 "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.",
2955 "type": "boolean"
2956 }
2957 },
2958 "type": "object"
2959 },
2960 "AuthorizationConfig": {
2961 "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",
2962 "id": "AuthorizationConfig",
2963 "properties": {
2964 "provider": {
2965 "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
2966 "type": "string"
2967 }
2968 },
2969 "type": "object"
2970 },
2971 "DocumentationRule": {
2972 "description": "A documentation rule provides information about indi vidual API elements.",
2973 "id": "DocumentationRule",
2974 "properties": {
2975 "description": {
2976 "description": "Description of the selected API(s).",
2977 "type": "string"
2978 },
2979 "deprecationDescription": {
2980 "description": "Deprecation description of the selected elem ent(s). It can be provided if an\nelement is marked as `deprecated`.",
2981 "type": "string"
2982 },
2983 "selector": {
2984 "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.",
2985 "type": "string"
2986 }
2987 },
2988 "type": "object"
2989 },
2990 "CloudAuditOptions": {
2991 "description": "Write a Cloud Audit log",
2992 "id": "CloudAuditOptions",
2993 "properties": {
2994 "logName": {
2995 "description": "The log_name to populate in the Cloud Audit Record.",
2996 "enum": [
2997 "UNSPECIFIED_LOG_NAME",
2998 "ADMIN_ACTIVITY",
2999 "DATA_ACCESS"
3000 ],
3001 "enumDescriptions": [
3002 "Default. Should not be used.",
3003 "Corresponds to \"cloudaudit.googleapis.com/activity\"",
3004 "Corresponds to \"cloudaudit.googleapis.com/data_access\ ""
3005 ],
3006 "type": "string"
3007 }
3008 },
3009 "type": "object"
3010 },
3011 "ContextRule": {
3012 "description": "A context rule provides information about the contex t for an individual API\nelement.",
3013 "id": "ContextRule",
3014 "properties": {
3015 "requested": {
3016 "description": "A list of full type names of requested conte xts.",
3017 "items": {
3018 "type": "string"
3019 },
3020 "type": "array"
3021 }, 2734 },
3022 "selector": { 2735 "selector": {
3023 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.", 2736 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
3024 "type": "string" 2737 "type": "string"
3025 }, 2738 }
3026 "provided": { 2739 },
3027 "description": "A list of full type names of provided contex ts.", 2740 "type": "object"
2741 },
2742 "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",
2744 "id": "Authentication",
2745 "properties": {
2746 "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.",
2748 "items": {
2749 "$ref": "AuthenticationRule"
2750 },
2751 "type": "array"
2752 },
2753 "providers": {
2754 "description": "Defines a set of authentication providers th at a service supports.",
2755 "items": {
2756 "$ref": "AuthProvider"
2757 },
2758 "type": "array"
2759 }
2760 },
2761 "type": "object"
2762 },
2763 "Operation": {
2764 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.",
2765 "id": "Operation",
2766 "properties": {
2767 "done": {
2768 "description": "If the value is `false`, it means the operat ion is still in progress.\nIf true, the operation is completed, and either `erro r` or `response` is\navailable.",
2769 "type": "boolean"
2770 },
2771 "response": {
2772 "additionalProperties": {
2773 "description": "Properties of the object. Contains field @type with type URL.",
2774 "type": "any"
2775 },
2776 "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delet e`, the response is\n`google.protobuf.Empty`. If the original method is standar d\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmet hods, the response should have the type `XxxResponse`, where `Xxx`\nis the origi nal method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
2777 "type": "object"
2778 },
2779 "name": {
2780 "description": "The server-assigned name, which is only uniq ue within the same service that\noriginally returns it. If you use the default H TTP mapping, the\n`name` should have the format of `operations/some/unique/name` .",
2781 "type": "string"
2782 },
2783 "error": {
2784 "$ref": "Status",
2785 "description": "The error result of the operation in case of failure or cancellation."
2786 },
2787 "metadata": {
2788 "additionalProperties": {
2789 "description": "Properties of the object. Contains field @type with type URL.",
2790 "type": "any"
2791 },
2792 "description": "Service-specific metadata associated with th e operation. It typically\ncontains progress information and common metadata su ch as create time.\nSome services might not provide such metadata. Any method t hat returns a\nlong-running operation should document the metadata type, if any. ",
2793 "type": "object"
2794 }
2795 },
2796 "type": "object"
2797 },
2798 "Page": {
2799 "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
2800 "id": "Page",
2801 "properties": {
2802 "subpages": {
2803 "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
2804 "items": {
2805 "$ref": "Page"
2806 },
2807 "type": "array"
2808 },
2809 "name": {
2810 "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocum entation. For example:\n<pre><code>pages:\n- name: Tutorial\n content: &#40;== include tutorial.md ==&#41;\n subpages:\n - name: Java\n content: &#40;== i nclude tutorial_java.md ==&#41;\n</code></pre>\nYou can reference `Java` page us ing Markdown reference link syntax:\n`Java`.",
2811 "type": "string"
2812 },
2813 "content": {
2814 "description": "The Markdown content of the page. You can us e <code>&#40;== include {path} ==&#41;</code>\nto include content from a Markdow n file.",
2815 "type": "string"
2816 }
2817 },
2818 "type": "object"
2819 },
2820 "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.",
2822 "id": "Status",
2823 "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": {
2834 "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": {
2836 "additionalProperties": {
2837 "description": "Properties of the object. Contains f ield @type with type URL.",
2838 "type": "any"
2839 },
2840 "type": "object"
2841 },
2842 "type": "array"
2843 }
2844 },
2845 "type": "object"
2846 },
2847 "Binding": {
2848 "description": "Associates `members` with a `role`.",
2849 "id": "Binding",
2850 "properties": {
2851 "condition": {
2852 "$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."
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",
3028 "items": { 2857 "items": {
3029 "type": "string" 2858 "type": "string"
3030 }, 2859 },
3031 "type": "array" 2860 "type": "array"
3032 } 2861 },
3033 }, 2862 "role": {
3034 "type": "object" 2863 "description": "Role that is assigned to `members`.\nFor exa mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
3035 }, 2864 "type": "string"
3036 "MetricDescriptor": { 2865 }
3037 "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.", 2866 },
3038 "id": "MetricDescriptor", 2867 "type": "object"
2868 },
2869 "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).",
2871 "id": "AuthProvider",
2872 "properties": {
2873 "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",
2875 "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 }
2889 },
2890 "type": "object"
2891 },
2892 "EnumValue": {
2893 "description": "Enum value definition.",
2894 "id": "EnumValue",
3039 "properties": { 2895 "properties": {
3040 "name": { 2896 "name": {
3041 "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\"", 2897 "description": "Enum value name.",
3042 "type": "string" 2898 "type": "string"
3043 }, 2899 },
3044 "type": { 2900 "options": {
3045 "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\"", 2901 "description": "Protocol buffer options.",
3046 "type": "string" 2902 "items": {
3047 }, 2903 "$ref": "Option"
3048 "valueType": { 2904 },
3049 "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.", 2905 "type": "array"
3050 "enum": [ 2906 },
3051 "VALUE_TYPE_UNSPECIFIED", 2907 "number": {
3052 "BOOL", 2908 "description": "Enum value number.",
3053 "INT64", 2909 "format": "int32",
3054 "DOUBLE", 2910 "type": "integer"
3055 "STRING", 2911 }
3056 "DISTRIBUTION", 2912 },
3057 "MONEY" 2913 "type": "object"
3058 ], 2914 },
3059 "enumDescriptions": [ 2915 "Service": {
3060 "Do not use this default value.", 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",
3061 "The value is a boolean.\nThis value type can be used on ly if the metric kind is `GAUGE`.", 2917 "id": "Service",
3062 "The value is a signed 64-bit integer.", 2918 "properties": {
3063 "The value is a double precision floating point number." , 2919 "monitoring": {
3064 "The value is a text string.\nThis value type can be use d only if the metric kind is `GAUGE`.", 2920 "$ref": "Monitoring",
3065 "The value is a `Distribution`.", 2921 "description": "Monitoring configuration."
3066 "The value is money." 2922 },
3067 ], 2923 "systemTypes": {
3068 "type": "string" 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.",
3069 }, 2925 "items": {
3070 "metricKind": { 2926 "$ref": "Type"
3071 "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.", 2927 },
3072 "enum": [ 2928 "type": "array"
3073 "METRIC_KIND_UNSPECIFIED", 2929 },
3074 "GAUGE", 2930 "producerProjectId": {
3075 "DELTA", 2931 "description": "The Google project that owns this service.",
3076 "CUMULATIVE" 2932 "type": "string"
3077 ], 2933 },
3078 "enumDescriptions": [ 2934 "visibility": {
3079 "Do not use this default value.", 2935 "$ref": "Visibility",
3080 "An instantaneous measurement of a value.", 2936 "description": "API visibility configuration."
3081 "The change in a value during a time interval.", 2937 },
3082 "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." 2938 "quota": {
3083 ], 2939 "$ref": "Quota",
3084 "type": "string" 2940 "description": "Quota configuration."
3085 }, 2941 },
3086 "description": { 2942 "name": {
3087 "description": "A detailed description of the metric, which can be used in documentation.", 2943 "description": "The DNS address at which this service is ava ilable,\ne.g. `calendar.googleapis.com`.",
3088 "type": "string" 2944 "type": "string"
3089 }, 2945 },
3090 "displayName": { 2946 "customError": {
3091 "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\".", 2947 "$ref": "CustomError",
3092 "type": "string" 2948 "description": "Custom error configuration."
3093 },
3094 "unit": {
3095 "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 '}'.",
3096 "type": "string"
3097 },
3098 "labels": {
3099 "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.",
3100 "items": {
3101 "$ref": "LabelDescriptor"
3102 },
3103 "type": "array"
3104 }
3105 },
3106 "type": "object"
3107 },
3108 "SourceContext": {
3109 "description": "`SourceContext` represents information about the sou rce of a\nprotobuf element, like the file in which it is defined.",
3110 "id": "SourceContext",
3111 "properties": {
3112 "fileName": {
3113 "description": "The path-qualified name of the .proto file t hat contained the associated\nprotobuf element. For example: `\"google/protobuf /source_context.proto\"`.",
3114 "type": "string"
3115 }
3116 },
3117 "type": "object"
3118 },
3119 "Expr": {
3120 "description": "Represents an expression text. Example:\n\n title : \"User account presence\"\n description: \"Determines whether the request h as a user account\"\n expression: \"size(request.user) > 0\"",
3121 "id": "Expr",
3122 "properties": {
3123 "description": {
3124 "description": "An optional description of the expression. T his is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
3125 "type": "string"
3126 },
3127 "expression": {
3128 "description": "Textual representation of an expression in\n Common Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
3129 "type": "string"
3130 },
3131 "location": {
3132 "description": "An optional string indicating the location o f the expression for error\nreporting, e.g. a file name and a position in the fi le.",
3133 "type": "string"
3134 }, 2949 },
3135 "title": { 2950 "title": {
3136 "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.", 2951 "description": "The product title for this service.",
3137 "type": "string" 2952 "type": "string"
3138 } 2953 },
3139 }, 2954 "endpoints": {
3140 "type": "object" 2955 "description": "Configuration for network endpoints. If thi s is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.",
3141 }, 2956 "items": {
3142 "ListServicesResponse": { 2957 "$ref": "Endpoint"
3143 "description": "Response message for `ListServices` method.", 2958 },
3144 "id": "ListServicesResponse", 2959 "type": "array"
2960 },
2961 "logs": {
2962 "description": "Defines the logs used by this service.",
2963 "items": {
2964 "$ref": "LogDescriptor"
2965 },
2966 "type": "array"
2967 },
2968 "apis": {
2969 "description": "A list of API interfaces exported by this se rvice. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface h ere\nwhich cannot be resolved against the associated IDL files.",
2970 "items": {
2971 "$ref": "Api"
2972 },
2973 "type": "array"
2974 },
2975 "types": {
2976 "description": "A list of all proto message types included i n this API service.\nTypes referenced directly or indirectly by the `apis` are\n automatically included. Messages which are not referenced but\nshall be include d, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32",
2977 "items": {
2978 "$ref": "Type"
2979 },
2980 "type": "array"
2981 },
2982 "sourceInfo": {
2983 "$ref": "SourceInfo",
2984 "description": "Output only. The source information for this configuration if available."
2985 },
2986 "http": {
2987 "$ref": "Http",
2988 "description": "HTTP configuration."
2989 },
2990 "systemParameters": {
2991 "$ref": "SystemParameters",
2992 "description": "System parameter configuration."
2993 },
2994 "backend": {
2995 "$ref": "Backend",
2996 "description": "API backend configuration."
2997 },
2998 "documentation": {
2999 "$ref": "Documentation",
3000 "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 }
3056 },
3057 "type": "object"
3058 },
3059 "ListOperationsResponse": {
3060 "description": "The response message for Operations.ListOperations." ,
3061 "id": "ListOperationsResponse",
3145 "properties": { 3062 "properties": {
3146 "nextPageToken": { 3063 "nextPageToken": {
3147 "description": "Token that can be passed to `ListServices` t o resume a paginated query.", 3064 "description": "The standard List next-page token.",
3148 "type": "string" 3065 "type": "string"
3149 }, 3066 },
3150 "services": { 3067 "operations": {
3151 "description": "The returned services will only have the nam e field set.", 3068 "description": "A list of operations that matches the specif ied filter in the request.",
3152 "items": { 3069 "items": {
3153 "$ref": "ManagedService" 3070 "$ref": "Operation"
3154 }, 3071 },
3155 "type": "array" 3072 "type": "array"
3156 } 3073 }
3157 }, 3074 },
3158 "type": "object" 3075 "type": "object"
3159 }, 3076 },
3160 "Endpoint": { 3077 "OperationMetadata": {
3161 "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitorin g\nconfiguration.\n\nExample service configuration:\n\n name: library-example .googleapis.com\n endpoints:\n # Below entry makes 'google.example.libra ry.v1.Library'\n # API be served from endpoint address library-example.goog leapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backe nd, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n all ow_cors: true", 3078 "description": "The metadata associated with a long running operatio n resource.",
3162 "id": "Endpoint", 3079 "id": "OperationMetadata",
3163 "properties": { 3080 "properties": {
3164 "apis": { 3081 "startTime": {
3165 "description": "The list of APIs served by this endpoint.\n\ nIf no APIs are specified this translates to \"all APIs\" exported by the\nservi ce, as defined in the top-level service configuration.", 3082 "description": "The start time of the operation.",
3083 "format": "google-datetime",
3084 "type": "string"
3085 },
3086 "steps": {
3087 "description": "Detailed status information for each step. T he order is undetermined.",
3088 "items": {
3089 "$ref": "Step"
3090 },
3091 "type": "array"
3092 },
3093 "resourceNames": {
3094 "description": "The full name of the resources that this ope ration is directly\nassociated with.",
3166 "items": { 3095 "items": {
3167 "type": "string" 3096 "type": "string"
3168 }, 3097 },
3169 "type": "array" 3098 "type": "array"
3170 }, 3099 },
3171 "allowCors": { 3100 "progressPercentage": {
3172 "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.", 3101 "description": "Percentage of completion of this operation, ranging from 0 to 100.",
3173 "type": "boolean" 3102 "format": "int32",
3174 }, 3103 "type": "integer"
3175 "aliases": { 3104 }
3176 "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.", 3105 },
3106 "type": "object"
3107 },
3108 "CustomHttpPattern": {
3109 "description": "A custom pattern is used for defining custom HTTP ve rb.",
3110 "id": "CustomHttpPattern",
3111 "properties": {
3112 "kind": {
3113 "description": "The name of this custom HTTP verb.",
3114 "type": "string"
3115 },
3116 "path": {
3117 "description": "The path matched by this custom verb.",
3118 "type": "string"
3119 }
3120 },
3121 "type": "object"
3122 },
3123 "SystemParameterRule": {
3124 "description": "Define a system parameter rule mapping system parame ter definitions to\nmethods.",
3125 "id": "SystemParameterRule",
3126 "properties": {
3127 "selector": {
3128 "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.",
3129 "type": "string"
3130 },
3131 "parameters": {
3132 "description": "Define parameters. Multiple names may be def ined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.",
3133 "items": {
3134 "$ref": "SystemParameter"
3135 },
3136 "type": "array"
3137 }
3138 },
3139 "type": "object"
3140 },
3141 "VisibilityRule": {
3142 "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
3143 "id": "VisibilityRule",
3144 "properties": {
3145 "restriction": {
3146 "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but no t all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restrictio n will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
3147 "type": "string"
3148 },
3149 "selector": {
3150 "description": "Selects methods, messages, fields, enums, et c. to which this rule applies.\n\nRefer to selector for syntax details.",
3151 "type": "string"
3152 }
3153 },
3154 "type": "object"
3155 },
3156 "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&param=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",
3159 "properties": {
3160 "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).",
3162 "items": {
3163 "$ref": "HttpRule"
3164 },
3165 "type": "array"
3166 },
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": {
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.",
3173 "type": "string"
3174 },
3175 "mediaUpload": {
3176 "$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."
3178 },
3179 "selector": {
3180 "description": "Selects methods to which this rule applies.\ n\nRefer to selector for syntax details.",
3181 "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 }
3219 },
3220 "type": "object"
3221 },
3222 "MonitoringDestination": {
3223 "description": "Configuration of a specific monitoring destination ( the producer project\nor the consumer project).",
3224 "id": "MonitoringDestination",
3225 "properties": {
3226 "monitoredResource": {
3227 "description": "The monitored resource type. The type must b e defined in\nService.monitored_resources section.",
3228 "type": "string"
3229 },
3230 "metrics": {
3231 "description": "Names of the metrics to report to this monit oring destination.\nEach name must be defined in Service.metrics section.",
3177 "items": { 3232 "items": {
3178 "type": "string" 3233 "type": "string"
3179 }, 3234 },
3180 "type": "array"
3181 },
3182 "name": {
3183 "description": "The canonical name of this endpoint.",
3184 "type": "string"
3185 },
3186 "target": {
3187 "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\".",
3188 "type": "string"
3189 },
3190 "features": {
3191 "description": "The list of features enabled on this endpoin t.",
3192 "items": {
3193 "type": "string"
3194 },
3195 "type": "array"
3196 }
3197 },
3198 "type": "object"
3199 },
3200 "OAuthRequirements": {
3201 "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.",
3202 "id": "OAuthRequirements",
3203 "properties": {
3204 "canonicalScopes": {
3205 "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 ",
3206 "type": "string"
3207 }
3208 },
3209 "type": "object"
3210 },
3211 "TestIamPermissionsResponse": {
3212 "description": "Response message for `TestIamPermissions` method.",
3213 "id": "TestIamPermissionsResponse",
3214 "properties": {
3215 "permissions": {
3216 "description": "A subset of `TestPermissionsRequest.permissi ons` that the caller is\nallowed.",
3217 "items": {
3218 "type": "string"
3219 },
3220 "type": "array"
3221 }
3222 },
3223 "type": "object"
3224 },
3225 "GetIamPolicyRequest": {
3226 "description": "Request message for `GetIamPolicy` method.",
3227 "id": "GetIamPolicyRequest",
3228 "properties": {},
3229 "type": "object"
3230 },
3231 "Usage": {
3232 "description": "Configuration controlling usage of a service.",
3233 "id": "Usage",
3234 "properties": {
3235 "producerNotificationChannel": {
3236 "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.",
3237 "type": "string"
3238 },
3239 "rules": {
3240 "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.",
3241 "items": {
3242 "$ref": "UsageRule"
3243 },
3244 "type": "array"
3245 },
3246 "requirements": {
3247 "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'.",
3248 "items": {
3249 "type": "string"
3250 },
3251 "type": "array" 3235 "type": "array"
3252 } 3236 }
3253 }, 3237 },
3254 "type": "object" 3238 "type": "object"
3255 }, 3239 },
3256 "Context": { 3240 "Visibility": {
3257 "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`.", 3241 "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g ., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visi bility for multiple labels is the union of each label's\nelements, plus any unre stricted elements.\n\nIf an element and its parents have no restrictions, visibi lity is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n res triction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for t he restricted methods\nEnhancedSearch and Delegate.",
3258 "id": "Context", 3242 "id": "Visibility",
3259 "properties": { 3243 "properties": {
3260 "rules": { 3244 "rules": {
3261 "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.", 3245 "description": "A list of visibility rules that apply to ind ividual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
3262 "items": { 3246 "items": {
3263 "$ref": "ContextRule" 3247 "$ref": "VisibilityRule"
3264 }, 3248 },
3265 "type": "array" 3249 "type": "array"
3266 } 3250 }
3267 }, 3251 },
3268 "type": "object" 3252 "type": "object"
3269 }, 3253 },
3270 "Rule": { 3254 "ConfigChange": {
3271 "description": "A rule to be applied in a Policy.", 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.",
3272 "id": "Rule", 3256 "id": "ConfigChange",
3273 "properties": { 3257 "properties": {
3274 "action": { 3258 "newValue": {
3275 "description": "Required", 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": {
3263 "description": "The type for this change, either ADDED, REMO VED, or MODIFIED.",
3276 "enum": [ 3264 "enum": [
3277 "NO_ACTION", 3265 "CHANGE_TYPE_UNSPECIFIED",
3278 "ALLOW", 3266 "ADDED",
3279 "ALLOW_WITH_LOG", 3267 "REMOVED",
3280 "DENY", 3268 "MODIFIED"
3281 "DENY_WITH_LOG",
3282 "LOG"
3283 ], 3269 ],
3284 "enumDescriptions": [ 3270 "enumDescriptions": [
3285 "Default no action.", 3271 "No value was provided.",
3286 "Matching 'Entries' grant access.", 3272 "The changed object exists in the 'new' service configur ation, but not\nin the 'old' service configuration.",
3287 "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.", 3273 "The changed object exists in the 'old' service configur ation, but not\nin the 'new' service configuration.",
3288 "Matching 'Entries' deny access.", 3274 "The changed object exists in both service configuration s, but its value\nis different."
3289 "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
3290 "Matching 'Entries' tell IAM.Check callers to generate l ogs."
3291 ], 3275 ],
3292 "type": "string" 3276 "type": "string"
3293 }, 3277 },
3294 "notIn": { 3278 "element": {
3295 "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).", 3279 "description": "Object hierarchy path to the change, with le vels separated by a '.'\ncharacter. For repeated fields, an applicable unique id entifier field is\nused for the index (usually selector, name, or id). For maps, the term\n'key' is used. If the field has no unique identifier, the numeric ind ex\nis used.\nExamples:\n- visibility.rules[selector==\"google.LibraryService.Cr eateBook\"].restriction\n- quota.metric_rules[selector==\"google\"].metric_costs [key==\"reads\"].value\n- logging.producer_destinations[0]",
3280 "type": "string"
3281 },
3282 "advices": {
3283 "description": "Collection of advice provided for this chang e, useful for determining the\npossible impact of this change.",
3296 "items": { 3284 "items": {
3297 "type": "string" 3285 "$ref": "Advice"
3298 }, 3286 },
3299 "type": "array" 3287 "type": "array"
3300 }, 3288 },
3301 "description": { 3289 "oldValue": {
3302 "description": "Human-readable description of the rule.", 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.",
3303 "type": "string" 3291 "type": "string"
3304 }, 3292 }
3305 "conditions": { 3293 },
3306 "description": "Additional restrictions that must be met", 3294 "type": "object"
3295 },
3296 "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.",
3298 "id": "SystemParameters",
3299 "properties": {
3300 "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.",
3307 "items": { 3302 "items": {
3308 "$ref": "Condition" 3303 "$ref": "SystemParameterRule"
3309 },
3310 "type": "array"
3311 },
3312 "logConfig": {
3313 "description": "The config returned to callers of tech.iam.I AM.CheckPolicy for any entries\nthat match the LOG action.",
3314 "items": {
3315 "$ref": "LogConfig"
3316 },
3317 "type": "array"
3318 },
3319 "in": {
3320 "description": "If one or more 'in' clauses are specified, t he rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.",
3321 "items": {
3322 "type": "string"
3323 },
3324 "type": "array"
3325 },
3326 "permissions": {
3327 "description": "A permission is a string of form '<service>. <resource type>.<verb>'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
3328 "items": {
3329 "type": "string"
3330 }, 3304 },
3331 "type": "array" 3305 "type": "array"
3332 } 3306 }
3333 }, 3307 },
3334 "type": "object" 3308 "type": "object"
3335 }, 3309 },
3336 "LogConfig": { 3310 "Rollout": {
3337 "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", 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.",
3338 "id": "LogConfig", 3312 "id": "Rollout",
3339 "properties": { 3313 "properties": {
3340 "cloudAudit": { 3314 "createdBy": {
3341 "$ref": "CloudAuditOptions", 3315 "description": "The user who created the Rollout. Readonly." ,
3342 "description": "Cloud audit options." 3316 "type": "string"
3343 }, 3317 },
3344 "counter": { 3318 "trafficPercentStrategy": {
3345 "$ref": "CounterOptions", 3319 "$ref": "TrafficPercentStrategy",
3346 "description": "Counter options." 3320 "description": "Google Service Control selects service confi gurations based on\ntraffic percentage."
3347 }, 3321 },
3348 "dataAccess": { 3322 "rolloutId": {
3349 "$ref": "DataAccessOptions", 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'",
3350 "description": "Data access options." 3324 "type": "string"
3325 },
3326 "deleteServiceStrategy": {
3327 "$ref": "DeleteServiceStrategy",
3328 "description": "The strategy associated with a rollout to de lete a `ManagedService`.\nReadonly."
3329 },
3330 "createTime": {
3331 "description": "Creation time of the rollout. Readonly.",
3332 "format": "google-datetime",
3333 "type": "string"
3334 },
3335 "status": {
3336 "description": "The status of this rollout. Readonly. In cas e of a failed rollout,\nthe system will automatically rollback to the current Ro llout\nversion. Readonly.",
3337 "enum": [
3338 "ROLLOUT_STATUS_UNSPECIFIED",
3339 "IN_PROGRESS",
3340 "SUCCESS",
3341 "CANCELLED",
3342 "FAILED",
3343 "PENDING",
3344 "FAILED_ROLLED_BACK"
3345 ],
3346 "enumDescriptions": [
3347 "No status specified.",
3348 "The Rollout is in progress.",
3349 "The Rollout has completed successfully.",
3350 "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.",
3352 "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."
3354 ],
3355 "type": "string"
3356 },
3357 "serviceName": {
3358 "description": "The name of the service associated with this Rollout.",
3359 "type": "string"
3351 } 3360 }
3352 }, 3361 },
3353 "type": "object" 3362 "type": "object"
3354 }, 3363 },
3355 "LogDescriptor": { 3364 "Quota": {
3356 "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", 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",
3357 "id": "LogDescriptor", 3366 "id": "Quota",
3358 "properties": { 3367 "properties": {
3359 "name": { 3368 "limits": {
3360 "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 [/_-.].", 3369 "description": "List of `QuotaLimit` definitions for the ser vice.",
3361 "type": "string" 3370 "items": {
3371 "$ref": "QuotaLimit"
3372 },
3373 "type": "array"
3362 }, 3374 },
3363 "displayName": { 3375 "metricRules": {
3364 "description": "The human-readable name for this log. This i nformation appears on\nthe user interface and should be concise.", 3376 "description": "List of `MetricRule` definitions, each one m apping a selected method to one\nor more metrics.",
3365 "type": "string"
3366 },
3367 "description": {
3368 "description": "A human-readable description of this log. Th is information appears in\nthe documentation and can contain details.",
3369 "type": "string"
3370 },
3371 "labels": {
3372 "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.",
3373 "items": { 3377 "items": {
3374 "$ref": "LabelDescriptor" 3378 "$ref": "MetricRule"
3375 }, 3379 },
3376 "type": "array" 3380 "type": "array"
3377 } 3381 }
3378 }, 3382 },
3379 "type": "object" 3383 "type": "object"
3380 } 3384 }
3381 }, 3385 },
3382 "servicePath": "", 3386 "servicePath": "",
3383 "title": "Google Service Management API", 3387 "title": "Google Service Management API",
3384 "version": "v1" 3388 "version": "v1"
3385 } 3389 }
OLDNEW
« no previous file with comments | « discovery/googleapis/servicecontrol__v1.json ('k') | discovery/googleapis/serviceuser__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698