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

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

Issue 2695743002: Api-roll 45: 2017-02-13 (Closed)
Patch Set: reverted local changes to pubspec file Created 3 years, 10 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/cloud-platform": { 5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "View and manage your data across Google Clou d Platform services" 6 "description": "View and manage your data across Google Clou d Platform services"
7 }, 7 },
8 "https://www.googleapis.com/auth/service.management": { 8 "https://www.googleapis.com/auth/service.management": {
9 "description": "Manage your Google API service configuration " 9 "description": "Manage your Google API service configuration "
10 }, 10 },
(...skipping 16 matching lines...) Expand all
27 "icons": { 27 "icons": {
28 "x16": "http://www.google.com/images/icons/product/search-16.gif", 28 "x16": "http://www.google.com/images/icons/product/search-16.gif",
29 "x32": "http://www.google.com/images/icons/product/search-32.gif" 29 "x32": "http://www.google.com/images/icons/product/search-32.gif"
30 }, 30 },
31 "id": "servicemanagement:v1", 31 "id": "servicemanagement:v1",
32 "kind": "discovery#restDescription", 32 "kind": "discovery#restDescription",
33 "name": "servicemanagement", 33 "name": "servicemanagement",
34 "ownerDomain": "google.com", 34 "ownerDomain": "google.com",
35 "ownerName": "Google", 35 "ownerName": "Google",
36 "parameters": { 36 "parameters": {
37 "quotaUser": {
38 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
39 "location": "query",
40 "type": "string"
41 },
42 "pp": {
43 "default": "true",
44 "description": "Pretty-print response.",
45 "location": "query",
46 "type": "boolean"
47 },
48 "bearer_token": {
49 "description": "OAuth bearer token.",
50 "location": "query",
51 "type": "string"
52 },
53 "oauth_token": {
54 "description": "OAuth 2.0 token for the current user.",
55 "location": "query",
56 "type": "string"
57 },
58 "upload_protocol": { 37 "upload_protocol": {
59 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 38 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
60 "location": "query", 39 "location": "query",
61 "type": "string" 40 "type": "string"
62 }, 41 },
63 "prettyPrint": { 42 "prettyPrint": {
64 "default": "true", 43 "default": "true",
65 "description": "Returns response with indentations and line breaks." , 44 "description": "Returns response with indentations and line breaks." ,
66 "location": "query", 45 "location": "query",
67 "type": "boolean" 46 "type": "boolean"
68 }, 47 },
48 "uploadType": {
49 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
50 "location": "query",
51 "type": "string"
52 },
69 "fields": { 53 "fields": {
70 "description": "Selector specifying which fields to include in a par tial response.", 54 "description": "Selector specifying which fields to include in a par tial response.",
71 "location": "query", 55 "location": "query",
72 "type": "string" 56 "type": "string"
73 }, 57 },
74 "uploadType": {
75 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
76 "location": "query",
77 "type": "string"
78 },
79 "callback": { 58 "callback": {
80 "description": "JSONP", 59 "description": "JSONP",
81 "location": "query", 60 "location": "query",
82 "type": "string" 61 "type": "string"
83 }, 62 },
84 "$.xgafv": { 63 "$.xgafv": {
85 "description": "V1 error format.", 64 "description": "V1 error format.",
86 "enum": [ 65 "enum": [
87 "1", 66 "1",
88 "2" 67 "2"
(...skipping 14 matching lines...) Expand all
103 "proto" 82 "proto"
104 ], 83 ],
105 "enumDescriptions": [ 84 "enumDescriptions": [
106 "Responses with Content-Type of application/json", 85 "Responses with Content-Type of application/json",
107 "Media download with context-dependent Content-Type", 86 "Media download with context-dependent Content-Type",
108 "Responses with Content-Type of application/x-protobuf" 87 "Responses with Content-Type of application/x-protobuf"
109 ], 88 ],
110 "location": "query", 89 "location": "query",
111 "type": "string" 90 "type": "string"
112 }, 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 },
113 "access_token": { 97 "access_token": {
114 "description": "OAuth access token.", 98 "description": "OAuth access token.",
115 "location": "query", 99 "location": "query",
116 "type": "string" 100 "type": "string"
117 }, 101 },
118 "key": { 102 "quotaUser": {
119 "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.", 103 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
104 "location": "query",
105 "type": "string"
106 },
107 "pp": {
108 "default": "true",
109 "description": "Pretty-print response.",
110 "location": "query",
111 "type": "boolean"
112 },
113 "bearer_token": {
114 "description": "OAuth bearer token.",
115 "location": "query",
116 "type": "string"
117 },
118 "oauth_token": {
119 "description": "OAuth 2.0 token for the current user.",
120 "location": "query", 120 "location": "query",
121 "type": "string" 121 "type": "string"
122 } 122 }
123 }, 123 },
124 "protocol": "rest", 124 "protocol": "rest",
125 "resources": { 125 "resources": {
126 "services": { 126 "services": {
127 "methods": { 127 "methods": {
128 "setIamPolicy": {
129 "description": "Sets the access control policy on the specif ied resource. Replaces any\nexisting policy.",
130 "httpMethod": "POST",
131 "id": "servicemanagement.services.setIamPolicy",
132 "parameterOrder": [
133 "resource"
134 ],
135 "parameters": {
136 "resource": {
137 "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For exam ple, a Project\nresource is specified as `projects/{project}`.",
138 "location": "path",
139 "pattern": "^services/[^/]+$",
140 "required": true,
141 "type": "string"
142 }
143 },
144 "path": "v1/{+resource}:setIamPolicy",
145 "request": {
146 "$ref": "SetIamPolicyRequest"
147 },
148 "response": {
149 "$ref": "Policy"
150 },
151 "scopes": [
152 "https://www.googleapis.com/auth/cloud-platform",
153 "https://www.googleapis.com/auth/service.management"
154 ]
155 },
156 "disable": { 128 "disable": {
157 "description": "Disable a managed service for a project.\n\n Operation<response: DisableServiceResponse>", 129 "description": "Disable a managed service for a project.\n\n Operation<response: DisableServiceResponse>",
158 "httpMethod": "POST", 130 "httpMethod": "POST",
159 "id": "servicemanagement.services.disable", 131 "id": "servicemanagement.services.disable",
160 "parameterOrder": [ 132 "parameterOrder": [
161 "serviceName" 133 "serviceName"
162 ], 134 ],
163 "parameters": { 135 "parameters": {
164 "serviceName": { 136 "serviceName": {
165 "description": "Name of the service to disable. Spec ifying an unknown service name\nwill cause the request to fail.", 137 "description": "Name of the service to disable. Spec ifying an unknown service name\nwill cause the request to fail.",
(...skipping 269 matching lines...) Expand 10 before | Expand all | Expand 10 after
435 } 407 }
436 }, 408 },
437 "path": "v1/services/{serviceName}", 409 "path": "v1/services/{serviceName}",
438 "response": { 410 "response": {
439 "$ref": "Operation" 411 "$ref": "Operation"
440 }, 412 },
441 "scopes": [ 413 "scopes": [
442 "https://www.googleapis.com/auth/cloud-platform", 414 "https://www.googleapis.com/auth/cloud-platform",
443 "https://www.googleapis.com/auth/service.management" 415 "https://www.googleapis.com/auth/service.management"
444 ] 416 ]
417 },
418 "setIamPolicy": {
419 "description": "Sets the access control policy on the specif ied resource. Replaces any\nexisting policy.",
420 "httpMethod": "POST",
421 "id": "servicemanagement.services.setIamPolicy",
422 "parameterOrder": [
423 "resource"
424 ],
425 "parameters": {
426 "resource": {
427 "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For exam ple, a Project\nresource is specified as `projects/{project}`.",
428 "location": "path",
429 "pattern": "^services/[^/]+$",
430 "required": true,
431 "type": "string"
432 }
433 },
434 "path": "v1/{+resource}:setIamPolicy",
435 "request": {
436 "$ref": "SetIamPolicyRequest"
437 },
438 "response": {
439 "$ref": "Policy"
440 },
441 "scopes": [
442 "https://www.googleapis.com/auth/cloud-platform",
443 "https://www.googleapis.com/auth/service.management"
444 ]
445 } 445 }
446 }, 446 },
447 "resources": { 447 "resources": {
448 "configs": { 448 "configs": {
449 "methods": { 449 "methods": {
450 "create": {
451 "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.",
452 "httpMethod": "POST",
453 "id": "servicemanagement.services.configs.create",
454 "parameterOrder": [
455 "serviceName"
456 ],
457 "parameters": {
458 "serviceName": {
459 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.",
460 "location": "path",
461 "required": true,
462 "type": "string"
463 }
464 },
465 "path": "v1/services/{serviceName}/configs",
466 "request": {
467 "$ref": "Service"
468 },
469 "response": {
470 "$ref": "Service"
471 },
472 "scopes": [
473 "https://www.googleapis.com/auth/cloud-platform" ,
474 "https://www.googleapis.com/auth/service.managem ent"
475 ]
476 },
477 "submit": {
478 "description": "Creates a new service configuration (version) for a managed service based\non\nuser-supplied configuration source fi les (for example: OpenAPI\nSpecification). This method stores the source configu rations as well as the\ngenerated service configuration. To rollout the service configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperatio n<response: SubmitConfigSourceResponse>",
479 "httpMethod": "POST",
480 "id": "servicemanagement.services.configs.submit",
481 "parameterOrder": [
482 "serviceName"
483 ],
484 "parameters": {
485 "serviceName": {
486 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.",
487 "location": "path",
488 "required": true,
489 "type": "string"
490 }
491 },
492 "path": "v1/services/{serviceName}/configs:submit",
493 "request": {
494 "$ref": "SubmitConfigSourceRequest"
495 },
496 "response": {
497 "$ref": "Operation"
498 },
499 "scopes": [
500 "https://www.googleapis.com/auth/cloud-platform" ,
501 "https://www.googleapis.com/auth/service.managem ent"
502 ]
503 },
504 "list": { 450 "list": {
505 "description": "Lists the history of the service con figuration for a managed service,\nfrom the newest to the oldest.", 451 "description": "Lists the history of the service con figuration for a managed service,\nfrom the newest to the oldest.",
506 "httpMethod": "GET", 452 "httpMethod": "GET",
507 "id": "servicemanagement.services.configs.list", 453 "id": "servicemanagement.services.configs.list",
508 "parameterOrder": [ 454 "parameterOrder": [
509 "serviceName" 455 "serviceName"
510 ], 456 ],
511 "parameters": { 457 "parameters": {
512 "serviceName": { 458 "serviceName": {
513 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.", 459 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.",
(...skipping 49 matching lines...) Expand 10 before | Expand all | Expand 10 after
563 "path": "v1/services/{serviceName}/configs/{configId }", 509 "path": "v1/services/{serviceName}/configs/{configId }",
564 "response": { 510 "response": {
565 "$ref": "Service" 511 "$ref": "Service"
566 }, 512 },
567 "scopes": [ 513 "scopes": [
568 "https://www.googleapis.com/auth/cloud-platform" , 514 "https://www.googleapis.com/auth/cloud-platform" ,
569 "https://www.googleapis.com/auth/cloud-platform. read-only", 515 "https://www.googleapis.com/auth/cloud-platform. read-only",
570 "https://www.googleapis.com/auth/service.managem ent", 516 "https://www.googleapis.com/auth/service.managem ent",
571 "https://www.googleapis.com/auth/service.managem ent.readonly" 517 "https://www.googleapis.com/auth/service.managem ent.readonly"
572 ] 518 ]
573 } 519 },
574 }
575 },
576 "rollouts": {
577 "methods": {
578 "create": { 520 "create": {
579 "description": "Creates a new service configuration rollout. Based on rollout, the\nGoogle Service Management will roll out the serv ice configurations to\ndifferent backend services. For example, the logging conf iguration will be\npushed to Google Cloud Logging.\n\nPlease note that any previ ous pending and running Rollouts and associated\nOperations will be automaticall y cancelled so that the latest Rollout will\nnot be blocked by previous Rollouts .\n\nOperation<response: Rollout>", 521 "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.",
580 "httpMethod": "POST", 522 "httpMethod": "POST",
581 "id": "servicemanagement.services.rollouts.create", 523 "id": "servicemanagement.services.configs.create",
582 "parameterOrder": [ 524 "parameterOrder": [
583 "serviceName" 525 "serviceName"
584 ], 526 ],
585 "parameters": { 527 "parameters": {
586 "serviceName": { 528 "serviceName": {
587 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.", 529 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.",
588 "location": "path", 530 "location": "path",
589 "required": true, 531 "required": true,
590 "type": "string" 532 "type": "string"
591 } 533 }
592 }, 534 },
593 "path": "v1/services/{serviceName}/rollouts", 535 "path": "v1/services/{serviceName}/configs",
594 "request": { 536 "request": {
595 "$ref": "Rollout" 537 "$ref": "Service"
596 }, 538 },
597 "response": { 539 "response": {
598 "$ref": "Operation" 540 "$ref": "Service"
599 }, 541 },
600 "scopes": [ 542 "scopes": [
601 "https://www.googleapis.com/auth/cloud-platform" , 543 "https://www.googleapis.com/auth/cloud-platform" ,
602 "https://www.googleapis.com/auth/service.managem ent" 544 "https://www.googleapis.com/auth/service.managem ent"
603 ] 545 ]
604 }, 546 },
605 "list": { 547 "submit": {
606 "description": "Lists the history of the service con figuration rollouts for a managed\nservice, from the newest to the oldest.", 548 "description": "Creates a new service configuration (version) for a managed service based\non\nuser-supplied configuration source fi les (for example: OpenAPI\nSpecification). This method stores the source configu rations as well as the\ngenerated service configuration. To rollout the service configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperatio n<response: SubmitConfigSourceResponse>",
607 "httpMethod": "GET", 549 "httpMethod": "POST",
608 "id": "servicemanagement.services.rollouts.list", 550 "id": "servicemanagement.services.configs.submit",
609 "parameterOrder": [ 551 "parameterOrder": [
610 "serviceName" 552 "serviceName"
611 ], 553 ],
612 "parameters": { 554 "parameters": {
613 "serviceName": { 555 "serviceName": {
614 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.", 556 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.",
615 "location": "path", 557 "location": "path",
616 "required": true, 558 "required": true,
617 "type": "string" 559 "type": "string"
618 }, 560 }
561 },
562 "path": "v1/services/{serviceName}/configs:submit",
563 "request": {
564 "$ref": "SubmitConfigSourceRequest"
565 },
566 "response": {
567 "$ref": "Operation"
568 },
569 "scopes": [
570 "https://www.googleapis.com/auth/cloud-platform" ,
571 "https://www.googleapis.com/auth/service.managem ent"
572 ]
573 }
574 }
575 },
576 "rollouts": {
577 "methods": {
578 "list": {
579 "description": "Lists the history of the service con figuration rollouts for a managed\nservice, from the newest to the oldest.",
580 "httpMethod": "GET",
581 "id": "servicemanagement.services.rollouts.list",
582 "parameterOrder": [
583 "serviceName"
584 ],
585 "parameters": {
619 "pageToken": { 586 "pageToken": {
620 "description": "The token of the page to ret rieve.", 587 "description": "The token of the page to ret rieve.",
621 "location": "query", 588 "location": "query",
622 "type": "string" 589 "type": "string"
623 }, 590 },
624 "pageSize": { 591 "pageSize": {
625 "description": "The max number of items to i nclude in the response list.", 592 "description": "The max number of items to i nclude in the response list.",
626 "format": "int32", 593 "format": "int32",
627 "location": "query", 594 "location": "query",
628 "type": "integer" 595 "type": "integer"
596 },
597 "serviceName": {
598 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.",
599 "location": "path",
600 "required": true,
601 "type": "string"
629 } 602 }
630 }, 603 },
631 "path": "v1/services/{serviceName}/rollouts", 604 "path": "v1/services/{serviceName}/rollouts",
632 "response": { 605 "response": {
633 "$ref": "ListServiceRolloutsResponse" 606 "$ref": "ListServiceRolloutsResponse"
634 }, 607 },
635 "scopes": [ 608 "scopes": [
636 "https://www.googleapis.com/auth/cloud-platform" , 609 "https://www.googleapis.com/auth/cloud-platform" ,
637 "https://www.googleapis.com/auth/cloud-platform. read-only", 610 "https://www.googleapis.com/auth/cloud-platform. read-only",
638 "https://www.googleapis.com/auth/service.managem ent", 611 "https://www.googleapis.com/auth/service.managem ent",
639 "https://www.googleapis.com/auth/service.managem ent.readonly" 612 "https://www.googleapis.com/auth/service.managem ent.readonly"
640 ] 613 ]
641 }, 614 },
642 "get": { 615 "get": {
643 "description": "Gets a service configuration rollout .", 616 "description": "Gets a service configuration rollout .",
644 "httpMethod": "GET", 617 "httpMethod": "GET",
645 "id": "servicemanagement.services.rollouts.get", 618 "id": "servicemanagement.services.rollouts.get",
646 "parameterOrder": [ 619 "parameterOrder": [
647 "serviceName", 620 "serviceName",
648 "rolloutId" 621 "rolloutId"
649 ], 622 ],
650 "parameters": { 623 "parameters": {
624 "rolloutId": {
625 "description": "The id of the rollout resour ce.",
626 "location": "path",
627 "required": true,
628 "type": "string"
629 },
651 "serviceName": { 630 "serviceName": {
652 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.", 631 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.",
653 "location": "path", 632 "location": "path",
654 "required": true, 633 "required": true,
655 "type": "string" 634 "type": "string"
656 },
657 "rolloutId": {
658 "description": "The id of the rollout resour ce.",
659 "location": "path",
660 "required": true,
661 "type": "string"
662 } 635 }
663 }, 636 },
664 "path": "v1/services/{serviceName}/rollouts/{rollout Id}", 637 "path": "v1/services/{serviceName}/rollouts/{rollout Id}",
665 "response": { 638 "response": {
666 "$ref": "Rollout" 639 "$ref": "Rollout"
667 }, 640 },
668 "scopes": [ 641 "scopes": [
669 "https://www.googleapis.com/auth/cloud-platform" , 642 "https://www.googleapis.com/auth/cloud-platform" ,
670 "https://www.googleapis.com/auth/cloud-platform. read-only", 643 "https://www.googleapis.com/auth/cloud-platform. read-only",
671 "https://www.googleapis.com/auth/service.managem ent", 644 "https://www.googleapis.com/auth/service.managem ent",
672 "https://www.googleapis.com/auth/service.managem ent.readonly" 645 "https://www.googleapis.com/auth/service.managem ent.readonly"
673 ] 646 ]
647 },
648 "create": {
649 "description": "Creates a new service configuration rollout. Based on rollout, the\nGoogle Service Management will roll out the serv ice configurations to\ndifferent backend services. For example, the logging conf iguration will be\npushed to Google Cloud Logging.\n\nPlease note that any previ ous pending and running Rollouts and associated\nOperations will be automaticall y cancelled so that the latest Rollout will\nnot be blocked by previous Rollouts .\n\nOperation<response: Rollout>",
650 "httpMethod": "POST",
651 "id": "servicemanagement.services.rollouts.create",
652 "parameterOrder": [
653 "serviceName"
654 ],
655 "parameters": {
656 "serviceName": {
657 "description": "The name of the service. Se e the [overview](/service-management/overview)\nfor naming requirements. For ex ample: `example.googleapis.com`.",
658 "location": "path",
659 "required": true,
660 "type": "string"
661 }
662 },
663 "path": "v1/services/{serviceName}/rollouts",
664 "request": {
665 "$ref": "Rollout"
666 },
667 "response": {
668 "$ref": "Operation"
669 },
670 "scopes": [
671 "https://www.googleapis.com/auth/cloud-platform" ,
672 "https://www.googleapis.com/auth/service.managem ent"
673 ]
674 } 674 }
675 } 675 }
676 } 676 }
677 } 677 }
678 }, 678 },
679 "operations": { 679 "operations": {
680 "methods": { 680 "methods": {
681 "get": { 681 "get": {
682 "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.", 682 "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.",
683 "httpMethod": "GET", 683 "httpMethod": "GET",
(...skipping 15 matching lines...) Expand all
699 "$ref": "Operation" 699 "$ref": "Operation"
700 }, 700 },
701 "scopes": [ 701 "scopes": [
702 "https://www.googleapis.com/auth/cloud-platform", 702 "https://www.googleapis.com/auth/cloud-platform",
703 "https://www.googleapis.com/auth/service.management" 703 "https://www.googleapis.com/auth/service.management"
704 ] 704 ]
705 } 705 }
706 } 706 }
707 } 707 }
708 }, 708 },
709 "revision": "20170117", 709 "revision": "20170209",
710 "rootUrl": "https://servicemanagement.googleapis.com/", 710 "rootUrl": "https://servicemanagement.googleapis.com/",
711 "schemas": { 711 "schemas": {
712 "DisableServiceRequest": {
713 "description": "Request message for DisableService method.",
714 "id": "DisableServiceRequest",
715 "properties": {
716 "consumerId": {
717 "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.",
718 "type": "string"
719 }
720 },
721 "type": "object"
722 },
723 "SubmitConfigSourceResponse": {
724 "description": "Response message for SubmitConfigSource method.",
725 "id": "SubmitConfigSourceResponse",
726 "properties": {
727 "serviceConfig": {
728 "$ref": "Service",
729 "description": "The generated service configuration."
730 }
731 },
732 "type": "object"
733 },
734 "MediaUpload": { 712 "MediaUpload": {
735 "description": "Do not use this. For media support, add instead\n[][ google.bytestream.RestByteStream] as an API to your\nconfiguration.", 713 "description": "Do not use this. For media support, add instead\n[][ google.bytestream.RestByteStream] as an API to your\nconfiguration.",
736 "id": "MediaUpload", 714 "id": "MediaUpload",
737 "properties": { 715 "properties": {
738 "enabled": { 716 "enabled": {
739 "description": "Whether upload is enabled.", 717 "description": "Whether upload is enabled.",
740 "type": "boolean" 718 "type": "boolean"
741 } 719 }
742 }, 720 },
743 "type": "object" 721 "type": "object"
(...skipping 21 matching lines...) Expand all
765 "description": "ID of the project that produces and owns thi s service.", 743 "description": "ID of the project that produces and owns thi s service.",
766 "type": "string" 744 "type": "string"
767 } 745 }
768 }, 746 },
769 "type": "object" 747 "type": "object"
770 }, 748 },
771 "UsageRule": { 749 "UsageRule": {
772 "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", 750 "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",
773 "id": "UsageRule", 751 "id": "UsageRule",
774 "properties": { 752 "properties": {
753 "selector": {
754 "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.",
755 "type": "string"
756 },
775 "allowUnregisteredCalls": { 757 "allowUnregisteredCalls": {
776 "description": "True, if the method allows unregistered call s; false otherwise.", 758 "description": "True, if the method allows unregistered call s; false otherwise.",
777 "type": "boolean" 759 "type": "boolean"
760 }
761 },
762 "type": "object"
763 },
764 "AuthRequirement": {
765 "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).",
766 "id": "AuthRequirement",
767 "properties": {
768 "audiences": {
769 "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",
770 "type": "string"
778 }, 771 },
779 "selector": { 772 "providerId": {
780 "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.", 773 "description": "id from authentication provider.\n\nExample: \n\n provider_id: bookstore_auth",
781 "type": "string" 774 "type": "string"
782 } 775 }
783 }, 776 },
784 "type": "object" 777 "type": "object"
785 }, 778 },
786 "TrafficPercentStrategy": { 779 "TrafficPercentStrategy": {
787 "description": "Strategy that specifies how Google Service Control s hould select\ndifferent\nversions of service configurations based on traffic per centage.\n\nOne example of how to gradually rollout a new service configuration using\nthis\nstrategy:\nDay 1\n\n Rollout {\n id: \"example.googleapis.c om/rollout_20160206\"\n traffic_percent_strategy {\n percentages: {\ n \"example.googleapis.com/20160201\": 70.00\n \"example.googl eapis.com/20160206\": 30.00\n }\n }\n }\n\nDay 2\n\n Rollout { \n id: \"example.googleapis.com/rollout_20160207\"\n traffic_percent_s trategy: {\n percentages: {\n \"example.googleapis.com/20160206\ ": 100.00\n }\n }\n }", 780 "description": "Strategy that specifies how Google Service Control s hould select\ndifferent\nversions of service configurations based on traffic per centage.\n\nOne example of how to gradually rollout a new service configuration using\nthis\nstrategy:\nDay 1\n\n Rollout {\n id: \"example.googleapis.c om/rollout_20160206\"\n traffic_percent_strategy {\n percentages: {\ n \"example.googleapis.com/20160201\": 70.00\n \"example.googl eapis.com/20160206\": 30.00\n }\n }\n }\n\nDay 2\n\n Rollout { \n id: \"example.googleapis.com/rollout_20160207\"\n traffic_percent_s trategy: {\n percentages: {\n \"example.googleapis.com/20160206\ ": 100.00\n }\n }\n }",
788 "id": "TrafficPercentStrategy", 781 "id": "TrafficPercentStrategy",
789 "properties": { 782 "properties": {
790 "percentages": { 783 "percentages": {
791 "additionalProperties": { 784 "additionalProperties": {
792 "format": "double", 785 "format": "double",
793 "type": "number" 786 "type": "number"
794 }, 787 },
795 "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.", 788 "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.",
796 "type": "object" 789 "type": "object"
797 } 790 }
798 }, 791 },
799 "type": "object" 792 "type": "object"
800 }, 793 },
801 "AuthRequirement": {
802 "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).",
803 "id": "AuthRequirement",
804 "properties": {
805 "audiences": {
806 "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",
807 "type": "string"
808 },
809 "providerId": {
810 "description": "id from authentication provider.\n\nExample: \n\n provider_id: bookstore_auth",
811 "type": "string"
812 }
813 },
814 "type": "object"
815 },
816 "Condition": { 794 "Condition": {
817 "description": "A condition to be met.", 795 "description": "A condition to be met.",
818 "id": "Condition", 796 "id": "Condition",
819 "properties": { 797 "properties": {
820 "value": {
821 "description": "DEPRECATED. Use 'values' instead.",
822 "type": "string"
823 },
824 "sys": { 798 "sys": {
825 "description": "Trusted attributes supplied by any service t hat owns resources and uses\nthe IAM system for access control.", 799 "description": "Trusted attributes supplied by any service t hat owns resources and uses\nthe IAM system for access control.",
826 "enum": [ 800 "enum": [
827 "NO_ATTR", 801 "NO_ATTR",
828 "REGION", 802 "REGION",
829 "SERVICE", 803 "SERVICE",
830 "NAME", 804 "NAME",
831 "IP" 805 "IP"
832 ], 806 ],
833 "enumDescriptions": [ 807 "enumDescriptions": [
834 "Default non-attribute type", 808 "Default non-attribute type",
835 "Region of the resource", 809 "Region of the resource",
836 "Service name", 810 "Service name",
837 "Resource name", 811 "Resource name",
838 "IP address of the caller" 812 "IP address of the caller"
839 ], 813 ],
840 "type": "string" 814 "type": "string"
841 }, 815 },
816 "value": {
817 "description": "DEPRECATED. Use 'values' instead.",
818 "type": "string"
819 },
842 "values": { 820 "values": {
843 "description": "The objects of the condition. This is mutual ly exclusive with 'value'.", 821 "description": "The objects of the condition. This is mutual ly exclusive with 'value'.",
844 "items": { 822 "items": {
845 "type": "string" 823 "type": "string"
846 }, 824 },
847 "type": "array" 825 "type": "array"
848 }, 826 },
849 "iam": { 827 "iam": {
850 "description": "Trusted attributes supplied by the IAM syste m.", 828 "description": "Trusted attributes supplied by the IAM syste m.",
851 "enum": [ 829 "enum": [
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after
884 "description": "Trusted attributes discharged by the service .", 862 "description": "Trusted attributes discharged by the service .",
885 "type": "string" 863 "type": "string"
886 } 864 }
887 }, 865 },
888 "type": "object" 866 "type": "object"
889 }, 867 },
890 "Documentation": { 868 "Documentation": {
891 "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.", 869 "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.",
892 "id": "Documentation", 870 "id": "Documentation",
893 "properties": { 871 "properties": {
872 "summary": {
873 "description": "A short summary of what the service does. Ca n only be provided by\nplain text.",
874 "type": "string"
875 },
894 "documentationRootUrl": { 876 "documentationRootUrl": {
895 "description": "The URL to the root of documentation.", 877 "description": "The URL to the root of documentation.",
896 "type": "string" 878 "type": "string"
897 }, 879 },
898 "rules": { 880 "rules": {
899 "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.", 881 "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.",
900 "items": { 882 "items": {
901 "$ref": "DocumentationRule" 883 "$ref": "DocumentationRule"
902 }, 884 },
903 "type": "array" 885 "type": "array"
904 }, 886 },
905 "overview": { 887 "overview": {
906 "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.", 888 "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.",
907 "type": "string" 889 "type": "string"
908 }, 890 },
909 "pages": { 891 "pages": {
910 "description": "The top level pages for the documentation se t.", 892 "description": "The top level pages for the documentation se t.",
911 "items": { 893 "items": {
912 "$ref": "Page" 894 "$ref": "Page"
913 }, 895 },
914 "type": "array" 896 "type": "array"
915 },
916 "summary": {
917 "description": "A short summary of what the service does. Ca n only be provided by\nplain text.",
918 "type": "string"
919 } 897 }
920 }, 898 },
921 "type": "object" 899 "type": "object"
922 }, 900 },
923 "AuditLogConfig": { 901 "AuditLogConfig": {
924 "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.", 902 "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.",
925 "id": "AuditLogConfig", 903 "id": "AuditLogConfig",
926 "properties": { 904 "properties": {
927 "exemptedMembers": { 905 "exemptedMembers": {
928 "description": "Specifies the identities that do not cause l ogging for this type of\npermission.\nFollows the same format of Binding.members .", 906 "description": "Specifies the identities that do not cause l ogging for this type of\npermission.\nFollows the same format of Binding.members .",
(...skipping 18 matching lines...) Expand all
947 ], 925 ],
948 "type": "string" 926 "type": "string"
949 } 927 }
950 }, 928 },
951 "type": "object" 929 "type": "object"
952 }, 930 },
953 "ConfigSource": { 931 "ConfigSource": {
954 "description": "Represents a source file which is used to generate t he service configuration\ndefined by `google.api.Service`.", 932 "description": "Represents a source file which is used to generate t he service configuration\ndefined by `google.api.Service`.",
955 "id": "ConfigSource", 933 "id": "ConfigSource",
956 "properties": { 934 "properties": {
935 "id": {
936 "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.",
937 "type": "string"
938 },
957 "files": { 939 "files": {
958 "description": "Set of source configuration files that are u sed to generate a service\nconfiguration (`google.api.Service`).", 940 "description": "Set of source configuration files that are u sed to generate a service\nconfiguration (`google.api.Service`).",
959 "items": { 941 "items": {
960 "$ref": "ConfigFile" 942 "$ref": "ConfigFile"
961 }, 943 },
962 "type": "array" 944 "type": "array"
963 },
964 "id": {
965 "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.",
966 "type": "string"
967 } 945 }
968 }, 946 },
969 "type": "object" 947 "type": "object"
970 }, 948 },
971 "BackendRule": { 949 "BackendRule": {
972 "description": "A backend rule provides configuration for an individ ual API element.", 950 "description": "A backend rule provides configuration for an individ ual API element.",
973 "id": "BackendRule", 951 "id": "BackendRule",
974 "properties": { 952 "properties": {
975 "address": { 953 "address": {
976 "description": "The address of the API backend.", 954 "description": "The address of the API backend.",
977 "type": "string" 955 "type": "string"
978 }, 956 },
979 "selector": { 957 "selector": {
980 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.", 958 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
981 "type": "string" 959 "type": "string"
982 }, 960 },
983 "deadline": { 961 "deadline": {
984 "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.", 962 "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
985 "format": "double", 963 "format": "double",
986 "type": "number" 964 "type": "number"
987 } 965 }
988 }, 966 },
989 "type": "object" 967 "type": "object"
990 }, 968 },
991 "AuthenticationRule": { 969 "AuthenticationRule": {
992 "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.", 970 "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.",
993 "id": "AuthenticationRule", 971 "id": "AuthenticationRule",
994 "properties": { 972 "properties": {
995 "selector": {
996 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
997 "type": "string"
998 },
999 "allowWithoutCredential": {
1000 "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.",
1001 "type": "boolean"
1002 },
1003 "oauth": { 973 "oauth": {
1004 "$ref": "OAuthRequirements", 974 "$ref": "OAuthRequirements",
1005 "description": "The requirements for OAuth credentials." 975 "description": "The requirements for OAuth credentials."
1006 }, 976 },
1007 "requirements": { 977 "requirements": {
1008 "description": "Requirements for additional authentication p roviders.", 978 "description": "Requirements for additional authentication p roviders.",
1009 "items": { 979 "items": {
1010 "$ref": "AuthRequirement" 980 "$ref": "AuthRequirement"
1011 }, 981 },
1012 "type": "array" 982 "type": "array"
983 },
984 "selector": {
985 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
986 "type": "string"
987 },
988 "allowWithoutCredential": {
989 "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.",
990 "type": "boolean"
1013 } 991 }
1014 }, 992 },
1015 "type": "object" 993 "type": "object"
1016 },
1017 "UndeleteServiceResponse": {
1018 "description": "Response message for UndeleteService method.",
1019 "id": "UndeleteServiceResponse",
1020 "properties": {
1021 "service": {
1022 "$ref": "ManagedService",
1023 "description": "Revived service resource."
1024 }
1025 },
1026 "type": "object"
1027 }, 994 },
1028 "Policy": { 995 "Policy": {
1029 "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).", 996 "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).",
1030 "id": "Policy", 997 "id": "Policy",
1031 "properties": { 998 "properties": {
1032 "version": {
1033 "description": "Version of the `Policy`. The default version is 0.",
1034 "format": "int32",
1035 "type": "integer"
1036 },
1037 "auditConfigs": { 999 "auditConfigs": {
1038 "description": "Specifies cloud audit logging configuration for this policy.", 1000 "description": "Specifies cloud audit logging configuration for this policy.",
1039 "items": { 1001 "items": {
1040 "$ref": "AuditConfig" 1002 "$ref": "AuditConfig"
1041 }, 1003 },
1042 "type": "array" 1004 "type": "array"
1043 }, 1005 },
1044 "bindings": { 1006 "bindings": {
1045 "description": "Associates a list of `members` to a `role`.\ nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.", 1007 "description": "Associates a list of `members` to a `role`.\ nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
1046 "items": { 1008 "items": {
1047 "$ref": "Binding" 1009 "$ref": "Binding"
1048 }, 1010 },
1049 "type": "array" 1011 "type": "array"
1050 }, 1012 },
1051 "etag": { 1013 "etag": {
1052 "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.", 1014 "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.",
1053 "format": "byte", 1015 "format": "byte",
1054 "type": "string" 1016 "type": "string"
1055 }, 1017 },
1056 "iamOwned": { 1018 "iamOwned": {
1057 "type": "boolean" 1019 "type": "boolean"
1058 }, 1020 },
1059 "rules": { 1021 "rules": {
1060 "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.", 1022 "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.",
1061 "items": { 1023 "items": {
1062 "$ref": "Rule" 1024 "$ref": "Rule"
1063 }, 1025 },
1064 "type": "array" 1026 "type": "array"
1027 },
1028 "version": {
1029 "description": "Version of the `Policy`. The default version is 0.",
1030 "format": "int32",
1031 "type": "integer"
1065 } 1032 }
1066 }, 1033 },
1067 "type": "object" 1034 "type": "object"
1035 },
1036 "UndeleteServiceResponse": {
1037 "description": "Response message for UndeleteService method.",
1038 "id": "UndeleteServiceResponse",
1039 "properties": {
1040 "service": {
1041 "$ref": "ManagedService",
1042 "description": "Revived service resource."
1043 }
1044 },
1045 "type": "object"
1068 }, 1046 },
1069 "Api": { 1047 "Api": {
1070 "description": "Api is a light-weight descriptor for a protocol buff er service.", 1048 "description": "Api is a light-weight descriptor for a protocol buff er service.",
1071 "id": "Api", 1049 "id": "Api",
1072 "properties": { 1050 "properties": {
1073 "methods": { 1051 "methods": {
1074 "description": "The methods of this api, in unspecified orde r.", 1052 "description": "The methods of this api, in unspecified orde r.",
1075 "items": { 1053 "items": {
1076 "$ref": "Method" 1054 "$ref": "Method"
1077 }, 1055 },
(...skipping 64 matching lines...) Expand 10 before | Expand all | Expand 10 after
1142 }, 1120 },
1143 "type": "array" 1121 "type": "array"
1144 } 1122 }
1145 }, 1123 },
1146 "type": "object" 1124 "type": "object"
1147 }, 1125 },
1148 "Operation": { 1126 "Operation": {
1149 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.", 1127 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.",
1150 "id": "Operation", 1128 "id": "Operation",
1151 "properties": { 1129 "properties": {
1130 "metadata": {
1131 "additionalProperties": {
1132 "description": "Properties of the object. Contains field @type with type URL.",
1133 "type": "any"
1134 },
1135 "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. ",
1136 "type": "object"
1137 },
1138 "done": {
1139 "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.",
1140 "type": "boolean"
1141 },
1152 "response": { 1142 "response": {
1153 "additionalProperties": { 1143 "additionalProperties": {
1154 "description": "Properties of the object. Contains field @type with type URL.", 1144 "description": "Properties of the object. Contains field @type with type URL.",
1155 "type": "any" 1145 "type": "any"
1156 }, 1146 },
1157 "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`.", 1147 "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`.",
1158 "type": "object" 1148 "type": "object"
1159 }, 1149 },
1160 "name": { 1150 "name": {
1161 "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` .", 1151 "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` .",
1162 "type": "string" 1152 "type": "string"
1163 }, 1153 },
1164 "error": { 1154 "error": {
1165 "$ref": "Status", 1155 "$ref": "Status",
1166 "description": "The error result of the operation in case of failure or cancellation." 1156 "description": "The error result of the operation in case of failure or cancellation."
1167 },
1168 "metadata": {
1169 "additionalProperties": {
1170 "description": "Properties of the object. Contains field @type with type URL.",
1171 "type": "any"
1172 },
1173 "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. ",
1174 "type": "object"
1175 },
1176 "done": {
1177 "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.",
1178 "type": "boolean"
1179 } 1157 }
1180 }, 1158 },
1181 "type": "object" 1159 "type": "object"
1182 }, 1160 },
1183 "Page": { 1161 "Page": {
1184 "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.", 1162 "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
1185 "id": "Page", 1163 "id": "Page",
1186 "properties": { 1164 "properties": {
1187 "subpages": {
1188 "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
1189 "items": {
1190 "$ref": "Page"
1191 },
1192 "type": "array"
1193 },
1194 "name": { 1165 "name": {
1195 "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`.", 1166 "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`.",
1196 "type": "string" 1167 "type": "string"
1197 }, 1168 },
1198 "content": { 1169 "content": {
1199 "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.", 1170 "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.",
1200 "type": "string" 1171 "type": "string"
1172 },
1173 "subpages": {
1174 "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
1175 "items": {
1176 "$ref": "Page"
1177 },
1178 "type": "array"
1201 } 1179 }
1202 }, 1180 },
1203 "type": "object" 1181 "type": "object"
1204 }, 1182 },
1205 "Status": { 1183 "Status": {
1206 "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` which can be used for common error conditions.\n\n# Lan guage 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` mes sage is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some except ions\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\nenviron ments, either with or without APIs, to provide a\nconsistent developer experienc e 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 may\n have a `Status` message for error reporting purpose.\n\n- Batch operati ons. If a client uses batch request and batch response, the\n `Status` messag e should be used directly inside batch response, one for\n each error sub-res ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio n\n results in its response, the status of those operations should be\n re presented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any s tripping needed for security/privacy reasons.", 1184 "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` which can be used for common error conditions.\n\n# Lan guage 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` mes sage is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some except ions\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\nenviron ments, either with or without APIs, to provide a\nconsistent developer experienc e 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 may\n have a `Status` message for error reporting purpose.\n\n- Batch operati ons. If a client uses batch request and batch response, the\n `Status` messag e should be used directly inside batch response, one for\n each error sub-res ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio n\n results in its response, the status of those operations should be\n re presented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any s tripping needed for security/privacy reasons.",
1207 "id": "Status", 1185 "id": "Status",
1208 "properties": { 1186 "properties": {
1187 "code": {
1188 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
1189 "format": "int32",
1190 "type": "integer"
1191 },
1192 "message": {
1193 "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.",
1194 "type": "string"
1195 },
1209 "details": { 1196 "details": {
1210 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.", 1197 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.",
1211 "items": { 1198 "items": {
1212 "additionalProperties": { 1199 "additionalProperties": {
1213 "description": "Properties of the object. Contains f ield @type with type URL.", 1200 "description": "Properties of the object. Contains f ield @type with type URL.",
1214 "type": "any" 1201 "type": "any"
1215 }, 1202 },
1216 "type": "object" 1203 "type": "object"
1217 }, 1204 },
1218 "type": "array" 1205 "type": "array"
1219 },
1220 "code": {
1221 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
1222 "format": "int32",
1223 "type": "integer"
1224 },
1225 "message": {
1226 "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.",
1227 "type": "string"
1228 } 1206 }
1229 }, 1207 },
1230 "type": "object" 1208 "type": "object"
1231 }, 1209 },
1232 "Binding": { 1210 "Binding": {
1233 "description": "Associates `members` with a `role`.", 1211 "description": "Associates `members` with a `role`.",
1234 "id": "Binding", 1212 "id": "Binding",
1235 "properties": { 1213 "properties": {
1236 "members": { 1214 "members": {
1237 "description": "Specifies the identities requesting access f or a Cloud Platform resource.\n`members` can have the following values:\n\n* `al lUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special ident ifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a spec ific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\ n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{e mailid}`: An email address that represents a Google group.\n For example, `adm ins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represe nts all the\n users of that domain. For example, `google.com` or `example.com` .\n\n", 1215 "description": "Specifies the identities requesting access f or a Cloud Platform resource.\n`members` can have the following values:\n\n* `al lUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special ident ifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a spec ific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\ n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{e mailid}`: An email address that represents a Google group.\n For example, `adm ins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represe nts all the\n users of that domain. For example, `google.com` or `example.com` .\n\n",
1238 "items": { 1216 "items": {
1239 "type": "string" 1217 "type": "string"
1240 }, 1218 },
1241 "type": "array" 1219 "type": "array"
1242 }, 1220 },
1243 "role": { 1221 "role": {
1244 "description": "Role that is assigned to `members`.\nFor exa mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", 1222 "description": "Role that is assigned to `members`.\nFor exa mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
1245 "type": "string" 1223 "type": "string"
1246 } 1224 }
1247 }, 1225 },
1248 "type": "object" 1226 "type": "object"
1249 }, 1227 },
1250 "AuthProvider": { 1228 "AuthProvider": {
1251 "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).", 1229 "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).",
1252 "id": "AuthProvider", 1230 "id": "AuthProvider",
1253 "properties": { 1231 "properties": {
1254 "jwksUri": {
1255 "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",
1256 "type": "string"
1257 },
1258 "audiences": {
1259 "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",
1260 "type": "string"
1261 },
1262 "id": { 1232 "id": {
1263 "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstor e_auth\".", 1233 "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstor e_auth\".",
1264 "type": "string" 1234 "type": "string"
1265 }, 1235 },
1266 "issuer": { 1236 "issuer": {
1267 "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", 1237 "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",
1268 "type": "string" 1238 "type": "string"
1269 } 1239 },
1270 }, 1240 "jwksUri": {
1271 "type": "object" 1241 "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",
1272 },
1273 "EnumValue": {
1274 "description": "Enum value definition.",
1275 "id": "EnumValue",
1276 "properties": {
1277 "name": {
1278 "description": "Enum value name.",
1279 "type": "string" 1242 "type": "string"
1280 }, 1243 },
1281 "options": { 1244 "audiences": {
1282 "description": "Protocol buffer options.", 1245 "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",
1283 "items": { 1246 "type": "string"
1284 "$ref": "Option"
1285 },
1286 "type": "array"
1287 },
1288 "number": {
1289 "description": "Enum value number.",
1290 "format": "int32",
1291 "type": "integer"
1292 } 1247 }
1293 }, 1248 },
1294 "type": "object" 1249 "type": "object"
1295 }, 1250 },
1296 "Service": { 1251 "Service": {
1297 "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", 1252 "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",
1298 "id": "Service", 1253 "id": "Service",
1299 "properties": { 1254 "properties": {
1255 "usage": {
1256 "$ref": "Usage",
1257 "description": "Configuration controlling usage of this serv ice."
1258 },
1259 "metrics": {
1260 "description": "Defines the metrics used by this service.",
1261 "items": {
1262 "$ref": "MetricDescriptor"
1263 },
1264 "type": "array"
1265 },
1266 "authentication": {
1267 "$ref": "Authentication",
1268 "description": "Auth configuration."
1269 },
1270 "control": {
1271 "$ref": "Control",
1272 "description": "Configuration for the service control plane. "
1273 },
1274 "configVersion": {
1275 "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`.",
1276 "format": "uint32",
1277 "type": "integer"
1278 },
1279 "monitoring": {
1280 "$ref": "Monitoring",
1281 "description": "Monitoring configuration."
1282 },
1283 "producerProjectId": {
1284 "description": "The id of the Google developer project that owns the service.\nMembers of this project can manage the service configuration, \nmanage consumption of the service, etc.",
1285 "type": "string"
1286 },
1287 "systemTypes": {
1288 "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.",
1289 "items": {
1290 "$ref": "Type"
1291 },
1292 "type": "array"
1293 },
1294 "visibility": {
1295 "$ref": "Visibility",
1296 "description": "API visibility configuration."
1297 },
1298 "name": {
1299 "description": "The DNS address at which this service is ava ilable,\ne.g. `calendar.googleapis.com`.",
1300 "type": "string"
1301 },
1300 "customError": { 1302 "customError": {
1301 "$ref": "CustomError", 1303 "$ref": "CustomError",
1302 "description": "Custom error configuration." 1304 "description": "Custom error configuration."
1303 }, 1305 },
1304 "title": { 1306 "title": {
1305 "description": "The product title associated with this servi ce.", 1307 "description": "The product title associated with this servi ce.",
1306 "type": "string" 1308 "type": "string"
1307 }, 1309 },
1308 "endpoints": { 1310 "endpoints": {
1309 "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.", 1311 "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.",
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after
1342 "description": "System parameter configuration." 1344 "description": "System parameter configuration."
1343 }, 1345 },
1344 "backend": { 1346 "backend": {
1345 "$ref": "Backend", 1347 "$ref": "Backend",
1346 "description": "API backend configuration." 1348 "description": "API backend configuration."
1347 }, 1349 },
1348 "documentation": { 1350 "documentation": {
1349 "$ref": "Documentation", 1351 "$ref": "Documentation",
1350 "description": "Additional API documentation." 1352 "description": "Additional API documentation."
1351 }, 1353 },
1354 "logging": {
1355 "$ref": "Logging",
1356 "description": "Logging configuration."
1357 },
1352 "monitoredResources": { 1358 "monitoredResources": {
1353 "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging config urations.", 1359 "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging config urations.",
1354 "items": { 1360 "items": {
1355 "$ref": "MonitoredResourceDescriptor" 1361 "$ref": "MonitoredResourceDescriptor"
1356 }, 1362 },
1357 "type": "array" 1363 "type": "array"
1358 }, 1364 },
1359 "logging": {
1360 "$ref": "Logging",
1361 "description": "Logging configuration."
1362 },
1363 "context": {
1364 "$ref": "Context",
1365 "description": "Context configuration."
1366 },
1367 "enums": { 1365 "enums": {
1368 "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", 1366 "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",
1369 "items": { 1367 "items": {
1370 "$ref": "Enum" 1368 "$ref": "Enum"
1371 }, 1369 },
1372 "type": "array" 1370 "type": "array"
1373 }, 1371 },
1372 "context": {
1373 "$ref": "Context",
1374 "description": "Context configuration."
1375 },
1374 "id": { 1376 "id": {
1375 "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.", 1377 "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.",
1376 "type": "string" 1378 "type": "string"
1379 }
1380 },
1381 "type": "object"
1382 },
1383 "EnumValue": {
1384 "description": "Enum value definition.",
1385 "id": "EnumValue",
1386 "properties": {
1387 "name": {
1388 "description": "Enum value name.",
1389 "type": "string"
1377 }, 1390 },
1378 "usage": { 1391 "options": {
1379 "$ref": "Usage", 1392 "description": "Protocol buffer options.",
1380 "description": "Configuration controlling usage of this serv ice."
1381 },
1382 "metrics": {
1383 "description": "Defines the metrics used by this service.",
1384 "items": { 1393 "items": {
1385 "$ref": "MetricDescriptor" 1394 "$ref": "Option"
1386 }, 1395 },
1387 "type": "array" 1396 "type": "array"
1388 }, 1397 },
1389 "authentication": { 1398 "number": {
1390 "$ref": "Authentication", 1399 "description": "Enum value number.",
1391 "description": "Auth configuration." 1400 "format": "int32",
1392 },
1393 "control": {
1394 "$ref": "Control",
1395 "description": "Configuration for the service control plane. "
1396 },
1397 "configVersion": {
1398 "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`.",
1399 "format": "uint32",
1400 "type": "integer" 1401 "type": "integer"
1401 },
1402 "monitoring": {
1403 "$ref": "Monitoring",
1404 "description": "Monitoring configuration."
1405 },
1406 "producerProjectId": {
1407 "description": "The id of the Google developer project that owns the service.\nMembers of this project can manage the service configuration, \nmanage consumption of the service, etc.",
1408 "type": "string"
1409 },
1410 "systemTypes": {
1411 "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.",
1412 "items": {
1413 "$ref": "Type"
1414 },
1415 "type": "array"
1416 },
1417 "visibility": {
1418 "$ref": "Visibility",
1419 "description": "API visibility configuration."
1420 },
1421 "name": {
1422 "description": "The DNS address at which this service is ava ilable,\ne.g. `calendar.googleapis.com`.",
1423 "type": "string"
1424 } 1402 }
1425 }, 1403 },
1426 "type": "object" 1404 "type": "object"
1427 }, 1405 },
1428 "OperationMetadata": { 1406 "OperationMetadata": {
1429 "description": "The metadata associated with a long running operatio n resource.", 1407 "description": "The metadata associated with a long running operatio n resource.",
1430 "id": "OperationMetadata", 1408 "id": "OperationMetadata",
1431 "properties": { 1409 "properties": {
1432 "progressPercentage": {
1433 "description": "Percentage of completion of this operation, ranging from 0 to 100.",
1434 "format": "int32",
1435 "type": "integer"
1436 },
1437 "startTime": { 1410 "startTime": {
1438 "description": "The start time of the operation.", 1411 "description": "The start time of the operation.",
1439 "format": "google-datetime", 1412 "format": "google-datetime",
1440 "type": "string" 1413 "type": "string"
1441 }, 1414 },
1442 "resourceNames": { 1415 "resourceNames": {
1443 "description": "The full name of the resources that this ope ration is directly\nassociated with.", 1416 "description": "The full name of the resources that this ope ration is directly\nassociated with.",
1444 "items": { 1417 "items": {
1445 "type": "string" 1418 "type": "string"
1446 }, 1419 },
1447 "type": "array" 1420 "type": "array"
1448 }, 1421 },
1449 "steps": { 1422 "steps": {
1450 "description": "Detailed status information for each step. T he order is undetermined.", 1423 "description": "Detailed status information for each step. T he order is undetermined.",
1451 "items": { 1424 "items": {
1452 "$ref": "Step" 1425 "$ref": "Step"
1453 }, 1426 },
1454 "type": "array" 1427 "type": "array"
1428 },
1429 "progressPercentage": {
1430 "description": "Percentage of completion of this operation, ranging from 0 to 100.",
1431 "format": "int32",
1432 "type": "integer"
1455 } 1433 }
1456 }, 1434 },
1457 "type": "object" 1435 "type": "object"
1458 }, 1436 },
1459 "CustomHttpPattern": { 1437 "CustomHttpPattern": {
1460 "description": "A custom pattern is used for defining custom HTTP ve rb.", 1438 "description": "A custom pattern is used for defining custom HTTP ve rb.",
1461 "id": "CustomHttpPattern", 1439 "id": "CustomHttpPattern",
1462 "properties": { 1440 "properties": {
1441 "path": {
1442 "description": "The path matched by this custom verb.",
1443 "type": "string"
1444 },
1463 "kind": { 1445 "kind": {
1464 "description": "The name of this custom HTTP verb.", 1446 "description": "The name of this custom HTTP verb.",
1465 "type": "string" 1447 "type": "string"
1466 },
1467 "path": {
1468 "description": "The path matched by this custom verb.",
1469 "type": "string"
1470 } 1448 }
1471 }, 1449 },
1472 "type": "object" 1450 "type": "object"
1473 }, 1451 },
1474 "SystemParameterRule": { 1452 "SystemParameterRule": {
1475 "description": "Define a system parameter rule mapping system parame ter definitions to\nmethods.", 1453 "description": "Define a system parameter rule mapping system parame ter definitions to\nmethods.",
1476 "id": "SystemParameterRule", 1454 "id": "SystemParameterRule",
1477 "properties": { 1455 "properties": {
1478 "parameters": { 1456 "parameters": {
1479 "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.", 1457 "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.",
(...skipping 21 matching lines...) Expand all
1501 "description": "Selects methods, messages, fields, enums, et c. to which this rule applies.\n\nRefer to selector for syntax details.", 1479 "description": "Selects methods, messages, fields, enums, et c. to which this rule applies.\n\nRefer to selector for syntax details.",
1502 "type": "string" 1480 "type": "string"
1503 } 1481 }
1504 }, 1482 },
1505 "type": "object" 1483 "type": "object"
1506 }, 1484 },
1507 "HttpRule": { 1485 "HttpRule": {
1508 "description": "`HttpRule` defines the mapping of an RPC method to o ne or more HTTP\nREST APIs. The mapping determines what portions of the request \nmessage are populated from the path, query parameters, or body of\nthe HTTP re quest. The mapping is typically specified as an\n`google.api.http` annotation, see \"google/api/annotations.proto\"\nfor details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refe r to fields in the request\nmessage, as in the example below which describes a R EST GET\noperation on a resource collection of messages:\n\n\n service Messag ing {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n opti on (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n s tring subfield = 1;\n }\n string message_id = 1; // mapped to the URL\ n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n messag e Message {\n string text = 1; // content of the resource\n }\n\nThe sam e http annotation can alternatively be expressed inside the\n`GRPC API Configura tion` YAML file.\n\n http:\n rules:\n - selector: <proto_package_ name>.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfie ld}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `G etMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn gene ral, not only fields but also field paths can be referenced\nfrom a path pattern . Fields mapped to the path pattern cannot be\nrepeated and must have a primitiv e (non-message) type.\n\nAny fields in the request message which are not bound b y the path\npattern automatically become (optional) HTTP query\nparameters. Assu me the following definition of the request message:\n\n\n message GetMessageR equest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a pa rameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMe ssage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\ nNote that fields which are mapped to HTTP parameters must have a\nprimitive typ e or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A&pa ram=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\ns pecifies the mapping. Consider a REST update method on the\nmessage resource col lection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequ est) returns (Message) {\n option (google.api.http) = {\n put: \ "/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mappe d 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(m essage_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path temp late should be mapped to the\nrequest body. This enables the following alternat ive definition of\nthe update method:\n\n service Messaging {\n rpc Upda teMessage(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 HTTP JSON to RPC mapping is enabled:\n\nHTT P | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateM essage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bo und by the path end in\nthe body. This makes this option more rarely used in pra ctice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhic h don't use the URL at all for transferring data.\n\nIt is possible to define mu ltiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Exam ple:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/message s/{message_id}\"\n additional_bindings {\n get: \"/v1/users/ {user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nma ppings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(mess age_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for map ping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it assumes there is no HTTP body.\n2. Leaf fields (recursi ve expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body fi eld)\n (c) All other fields.\n3. URL query parameters found in the HTTP reque st are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Templa te = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. It follows the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String\nExpansion.\n\nThe syntax `**` matches zero or more path segments . It follows the semantics\nof [RFC 6570](https://tools.ietf.org/html/rfc6570) S ection 3.2.3 Reserved\nExpansion. NOTE: it must be the last segment in the path except the Verb.\n\nThe syntax `LITERAL` matches literal text in the URL path.\n \nThe syntax `Variable` matches the entire path as specified by its template;\nt his nested template must not contain further variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent t o `{var=*}`.\n\nNOTE: the field paths in variables and in the `body` must not re fer to\nrepeated fields or map fields.\n\nUse CustomHttpPattern to specify any H TTP method that is not included in the\n`pattern` field, such as HEAD, or \"*\" to leave the HTTP method unspecified for\na given URL path rule. The wild-card r ule is useful for services that provide\ncontent to Web (HTML) clients.", 1486 "description": "`HttpRule` defines the mapping of an RPC method to o ne or more HTTP\nREST APIs. The mapping determines what portions of the request \nmessage are populated from the path, query parameters, or body of\nthe HTTP re quest. The mapping is typically specified as an\n`google.api.http` annotation, see \"google/api/annotations.proto\"\nfor details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refe r to fields in the request\nmessage, as in the example below which describes a R EST GET\noperation on a resource collection of messages:\n\n\n service Messag ing {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n opti on (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n s tring subfield = 1;\n }\n string message_id = 1; // mapped to the URL\ n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n messag e Message {\n string text = 1; // content of the resource\n }\n\nThe sam e http annotation can alternatively be expressed inside the\n`GRPC API Configura tion` YAML file.\n\n http:\n rules:\n - selector: <proto_package_ name>.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfie ld}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `G etMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn gene ral, not only fields but also field paths can be referenced\nfrom a path pattern . Fields mapped to the path pattern cannot be\nrepeated and must have a primitiv e (non-message) type.\n\nAny fields in the request message which are not bound b y the path\npattern automatically become (optional) HTTP query\nparameters. Assu me the following definition of the request message:\n\n\n message GetMessageR equest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a pa rameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMe ssage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\ nNote that fields which are mapped to HTTP parameters must have a\nprimitive typ e or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A&pa ram=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\ns pecifies the mapping. Consider a REST update method on the\nmessage resource col lection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequ est) returns (Message) {\n option (google.api.http) = {\n put: \ "/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mappe d 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(m essage_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path temp late should be mapped to the\nrequest body. This enables the following alternat ive definition of\nthe update method:\n\n service Messaging {\n rpc Upda teMessage(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 HTTP JSON to RPC mapping is enabled:\n\nHTT P | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateM essage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bo und by the path end in\nthe body. This makes this option more rarely used in pra ctice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhic h don't use the URL at all for transferring data.\n\nIt is possible to define mu ltiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Exam ple:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/message s/{message_id}\"\n additional_bindings {\n get: \"/v1/users/ {user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nma ppings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(mess age_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for map ping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it assumes there is no HTTP body.\n2. Leaf fields (recursi ve expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body fi eld)\n (c) All other fields.\n3. URL query parameters found in the HTTP reque st are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Templa te = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. It follows the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String\nExpansion.\n\nThe syntax `**` matches zero or more path segments . It follows the semantics\nof [RFC 6570](https://tools.ietf.org/html/rfc6570) S ection 3.2.3 Reserved\nExpansion. NOTE: it must be the last segment in the path except the Verb.\n\nThe syntax `LITERAL` matches literal text in the URL path.\n \nThe syntax `Variable` matches the entire path as specified by its template;\nt his nested template must not contain further variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent t o `{var=*}`.\n\nNOTE: the field paths in variables and in the `body` must not re fer to\nrepeated fields or map fields.\n\nUse CustomHttpPattern to specify any H TTP method that is not included in the\n`pattern` field, such as HEAD, or \"*\" to leave the HTTP method unspecified for\na given URL path rule. The wild-card r ule is useful for services that provide\ncontent to Web (HTML) clients.",
1509 "id": "HttpRule", 1487 "id": "HttpRule",
1510 "properties": { 1488 "properties": {
1489 "body": {
1490 "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.",
1491 "type": "string"
1492 },
1493 "mediaDownload": {
1494 "$ref": "MediaDownload",
1495 "description": "Do not use this. For media support, add inst ead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration."
1496 },
1497 "post": {
1498 "description": "Used for creating a resource.",
1499 "type": "string"
1500 },
1511 "additionalBindings": { 1501 "additionalBindings": {
1512 "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).", 1502 "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).",
1513 "items": { 1503 "items": {
1514 "$ref": "HttpRule" 1504 "$ref": "HttpRule"
1515 }, 1505 },
1516 "type": "array" 1506 "type": "array"
1517 }, 1507 },
1518 "responseBody": { 1508 "responseBody": {
1519 "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.", 1509 "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.",
1520 "type": "string" 1510 "type": "string"
(...skipping 18 matching lines...) Expand all
1539 "description": "Used for updating a resource.", 1529 "description": "Used for updating a resource.",
1540 "type": "string" 1530 "type": "string"
1541 }, 1531 },
1542 "put": { 1532 "put": {
1543 "description": "Used for updating a resource.", 1533 "description": "Used for updating a resource.",
1544 "type": "string" 1534 "type": "string"
1545 }, 1535 },
1546 "delete": { 1536 "delete": {
1547 "description": "Used for deleting a resource.", 1537 "description": "Used for deleting a resource.",
1548 "type": "string" 1538 "type": "string"
1549 },
1550 "body": {
1551 "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.",
1552 "type": "string"
1553 },
1554 "mediaDownload": {
1555 "$ref": "MediaDownload",
1556 "description": "Do not use this. For media support, add inst ead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration."
1557 },
1558 "post": {
1559 "description": "Used for creating a resource.",
1560 "type": "string"
1561 } 1539 }
1562 }, 1540 },
1563 "type": "object" 1541 "type": "object"
1564 }, 1542 },
1565 "MonitoringDestination": { 1543 "MonitoringDestination": {
1566 "description": "Configuration of a specific monitoring destination ( the producer project\nor the consumer project).", 1544 "description": "Configuration of a specific monitoring destination ( the producer project\nor the consumer project).",
1567 "id": "MonitoringDestination", 1545 "id": "MonitoringDestination",
1568 "properties": { 1546 "properties": {
1569 "monitoredResource": { 1547 "monitoredResource": {
1570 "description": "The monitored resource type. The type must b e defined in\nService.monitored_resources section.", 1548 "description": "The monitored resource type. The type must b e defined in\nService.monitored_resources section.",
(...skipping 16 matching lines...) Expand all
1587 "rules": { 1565 "rules": {
1588 "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.", 1566 "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.",
1589 "items": { 1567 "items": {
1590 "$ref": "VisibilityRule" 1568 "$ref": "VisibilityRule"
1591 }, 1569 },
1592 "type": "array" 1570 "type": "array"
1593 } 1571 }
1594 }, 1572 },
1595 "type": "object" 1573 "type": "object"
1596 }, 1574 },
1575 "SystemParameters": {
1576 "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.",
1577 "id": "SystemParameters",
1578 "properties": {
1579 "rules": {
1580 "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.",
1581 "items": {
1582 "$ref": "SystemParameterRule"
1583 },
1584 "type": "array"
1585 }
1586 },
1587 "type": "object"
1588 },
1597 "ConfigChange": { 1589 "ConfigChange": {
1598 "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.", 1590 "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.",
1599 "id": "ConfigChange", 1591 "id": "ConfigChange",
1600 "properties": { 1592 "properties": {
1601 "oldValue": {
1602 "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.",
1603 "type": "string"
1604 },
1605 "advices": {
1606 "description": "Collection of advice provided for this chang e, useful for determining the\npossible impact of this change.",
1607 "items": {
1608 "$ref": "Advice"
1609 },
1610 "type": "array"
1611 },
1612 "newValue": { 1593 "newValue": {
1613 "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.", 1594 "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.",
1614 "type": "string" 1595 "type": "string"
1615 }, 1596 },
1616 "changeType": { 1597 "changeType": {
1617 "description": "The type for this change, either ADDED, REMO VED, or MODIFIED.", 1598 "description": "The type for this change, either ADDED, REMO VED, or MODIFIED.",
1618 "enum": [ 1599 "enum": [
1619 "CHANGE_TYPE_UNSPECIFIED", 1600 "CHANGE_TYPE_UNSPECIFIED",
1620 "ADDED", 1601 "ADDED",
1621 "REMOVED", 1602 "REMOVED",
1622 "MODIFIED" 1603 "MODIFIED"
1623 ], 1604 ],
1624 "enumDescriptions": [ 1605 "enumDescriptions": [
1625 "No value was provided.", 1606 "No value was provided.",
1626 "The changed object exists in the 'new' service configur ation, but not\nin the 'old' service configuration.", 1607 "The changed object exists in the 'new' service configur ation, but not\nin the 'old' service configuration.",
1627 "The changed object exists in the 'old' service configur ation, but not\nin the 'new' service configuration.", 1608 "The changed object exists in the 'old' service configur ation, but not\nin the 'new' service configuration.",
1628 "The changed object exists in both service configuration s, but its value\nis different." 1609 "The changed object exists in both service configuration s, but its value\nis different."
1629 ], 1610 ],
1630 "type": "string" 1611 "type": "string"
1631 }, 1612 },
1632 "element": { 1613 "element": {
1633 "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]", 1614 "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]",
1634 "type": "string" 1615 "type": "string"
1635 } 1616 },
1636 }, 1617 "oldValue": {
1637 "type": "object" 1618 "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.",
1638 }, 1619 "type": "string"
1639 "SystemParameters": { 1620 },
1640 "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.", 1621 "advices": {
1641 "id": "SystemParameters", 1622 "description": "Collection of advice provided for this chang e, useful for determining the\npossible impact of this change.",
1642 "properties": {
1643 "rules": {
1644 "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.",
1645 "items": { 1623 "items": {
1646 "$ref": "SystemParameterRule" 1624 "$ref": "Advice"
1647 }, 1625 },
1648 "type": "array" 1626 "type": "array"
1649 } 1627 }
1650 }, 1628 },
1651 "type": "object" 1629 "type": "object"
1652 }, 1630 },
1653 "Rollout": { 1631 "Rollout": {
1654 "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.", 1632 "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.",
1655 "id": "Rollout", 1633 "id": "Rollout",
1656 "properties": { 1634 "properties": {
1635 "trafficPercentStrategy": {
1636 "$ref": "TrafficPercentStrategy",
1637 "description": "Google Service Control selects service confi gurations based on\ntraffic percentage."
1638 },
1639 "createdBy": {
1640 "description": "The user who created the Rollout. Readonly." ,
1641 "type": "string"
1642 },
1643 "rolloutId": {
1644 "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'",
1645 "type": "string"
1646 },
1657 "deleteServiceStrategy": { 1647 "deleteServiceStrategy": {
1658 "$ref": "DeleteServiceStrategy", 1648 "$ref": "DeleteServiceStrategy",
1659 "description": "The strategy associated with a rollout to de lete a `ManagedService`.\nReadonly." 1649 "description": "The strategy associated with a rollout to de lete a `ManagedService`.\nReadonly."
1660 }, 1650 },
1661 "createTime": { 1651 "createTime": {
1662 "description": "Creation time of the rollout. Readonly.", 1652 "description": "Creation time of the rollout. Readonly.",
1663 "format": "google-datetime", 1653 "format": "google-datetime",
1664 "type": "string" 1654 "type": "string"
1665 }, 1655 },
1666 "status": { 1656 "status": {
(...skipping 12 matching lines...) Expand all
1679 "The Rollout has completed successfully.", 1669 "The Rollout has completed successfully.",
1680 "The Rollout has been cancelled. This can happen if you have overlapping\nRollout pushes, and the previous ones will be cancelled.", 1670 "The Rollout has been cancelled. This can happen if you have overlapping\nRollout pushes, and the previous ones will be cancelled.",
1681 "The Rollout has failed. It is typically caused by confi guration errors.", 1671 "The Rollout has failed. It is typically caused by confi guration errors.",
1682 "The Rollout has not started yet and is pending for exec ution." 1672 "The Rollout has not started yet and is pending for exec ution."
1683 ], 1673 ],
1684 "type": "string" 1674 "type": "string"
1685 }, 1675 },
1686 "serviceName": { 1676 "serviceName": {
1687 "description": "The name of the service associated with this Rollout.", 1677 "description": "The name of the service associated with this Rollout.",
1688 "type": "string" 1678 "type": "string"
1689 },
1690 "createdBy": {
1691 "description": "The user who created the Rollout. Readonly." ,
1692 "type": "string"
1693 },
1694 "trafficPercentStrategy": {
1695 "$ref": "TrafficPercentStrategy",
1696 "description": "Google Service Control selects service confi gurations based on\ntraffic percentage."
1697 },
1698 "rolloutId": {
1699 "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'",
1700 "type": "string"
1701 } 1679 }
1702 }, 1680 },
1703 "type": "object" 1681 "type": "object"
1704 }, 1682 },
1705 "GenerateConfigReportRequest": { 1683 "GenerateConfigReportRequest": {
1706 "description": "Request message for GenerateConfigReport method.", 1684 "description": "Request message for GenerateConfigReport method.",
1707 "id": "GenerateConfigReportRequest", 1685 "id": "GenerateConfigReportRequest",
1708 "properties": { 1686 "properties": {
1687 "oldConfig": {
1688 "additionalProperties": {
1689 "description": "Properties of the object. Contains field @type with type URL.",
1690 "type": "any"
1691 },
1692 "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",
1693 "type": "object"
1694 },
1709 "newConfig": { 1695 "newConfig": {
1710 "additionalProperties": { 1696 "additionalProperties": {
1711 "description": "Properties of the object. Contains field @type with type URL.", 1697 "description": "Properties of the object. Contains field @type with type URL.",
1712 "type": "any" 1698 "type": "any"
1713 }, 1699 },
1714 "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", 1700 "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",
1715 "type": "object" 1701 "type": "object"
1716 },
1717 "oldConfig": {
1718 "additionalProperties": {
1719 "description": "Properties of the object. Contains field @type with type URL.",
1720 "type": "any"
1721 },
1722 "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",
1723 "type": "object"
1724 } 1702 }
1725 }, 1703 },
1726 "type": "object" 1704 "type": "object"
1727 }, 1705 },
1728 "SetIamPolicyRequest": { 1706 "SetIamPolicyRequest": {
1729 "description": "Request message for `SetIamPolicy` method.", 1707 "description": "Request message for `SetIamPolicy` method.",
1730 "id": "SetIamPolicyRequest", 1708 "id": "SetIamPolicyRequest",
1731 "properties": { 1709 "properties": {
1732 "updateMask": { 1710 "updateMask": {
1733 "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, a default\nmask is used:\npaths: \"bindings, etag\"\nThis fiel d is only used by Cloud IAM.", 1711 "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, a default\nmask is used:\npaths: \"bindings, etag\"\nThis fiel d is only used by Cloud IAM.",
1734 "format": "google-fieldmask", 1712 "format": "google-fieldmask",
1735 "type": "string" 1713 "type": "string"
1736 }, 1714 },
1737 "policy": { 1715 "policy": {
1738 "$ref": "Policy", 1716 "$ref": "Policy",
1739 "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." 1717 "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."
1740 } 1718 }
1741 }, 1719 },
1742 "type": "object" 1720 "type": "object"
1743 }, 1721 },
1744 "Step": { 1722 "Step": {
1745 "description": "Represents the status of one operation step.", 1723 "description": "Represents the status of one operation step.",
1746 "id": "Step", 1724 "id": "Step",
1747 "properties": { 1725 "properties": {
1726 "description": {
1727 "description": "The short description of the step.",
1728 "type": "string"
1729 },
1748 "status": { 1730 "status": {
1749 "description": "The status code.", 1731 "description": "The status code.",
1750 "enum": [ 1732 "enum": [
1751 "STATUS_UNSPECIFIED", 1733 "STATUS_UNSPECIFIED",
1752 "DONE", 1734 "DONE",
1753 "NOT_STARTED", 1735 "NOT_STARTED",
1754 "IN_PROGRESS", 1736 "IN_PROGRESS",
1755 "FAILED", 1737 "FAILED",
1756 "CANCELLED" 1738 "CANCELLED"
1757 ], 1739 ],
1758 "enumDescriptions": [ 1740 "enumDescriptions": [
1759 "Unspecifed code.", 1741 "Unspecifed code.",
1760 "The step has completed without errors.", 1742 "The operation or step has completed without errors.",
1761 "The step has not started yet.", 1743 "The operation or step has not started yet.",
1762 "The step is in progress.", 1744 "The operation or step is in progress.",
1763 "The step has completed with errors.", 1745 "The operation or step has completed with errors.",
1764 "The step has completed with cancellation." 1746 "The operation or step has completed with cancellation."
1765 ], 1747 ],
1766 "type": "string" 1748 "type": "string"
1767 },
1768 "description": {
1769 "description": "The short description of the step.",
1770 "type": "string"
1771 } 1749 }
1772 }, 1750 },
1773 "type": "object" 1751 "type": "object"
1774 }, 1752 },
1775 "DeleteServiceStrategy": { 1753 "DeleteServiceStrategy": {
1776 "description": "Strategy used to delete a service. This strategy is a placeholder only\nused by the system generated rollout to delete a service.", 1754 "description": "Strategy used to delete a service. This strategy is a placeholder only\nused by the system generated rollout to delete a service.",
1777 "id": "DeleteServiceStrategy", 1755 "id": "DeleteServiceStrategy",
1778 "properties": {}, 1756 "properties": {},
1779 "type": "object" 1757 "type": "object"
1780 }, 1758 },
(...skipping 52 matching lines...) Expand 10 before | Expand all | Expand 10 after
1833 }, 1811 },
1834 "type": "array" 1812 "type": "array"
1835 } 1813 }
1836 }, 1814 },
1837 "type": "object" 1815 "type": "object"
1838 }, 1816 },
1839 "Method": { 1817 "Method": {
1840 "description": "Method represents a method of an api.", 1818 "description": "Method represents a method of an api.",
1841 "id": "Method", 1819 "id": "Method",
1842 "properties": { 1820 "properties": {
1843 "responseStreaming": {
1844 "description": "If true, the response is streamed.",
1845 "type": "boolean"
1846 },
1847 "name": {
1848 "description": "The simple name of this method.",
1849 "type": "string"
1850 },
1851 "requestTypeUrl": { 1821 "requestTypeUrl": {
1852 "description": "A URL of the input message type.", 1822 "description": "A URL of the input message type.",
1853 "type": "string" 1823 "type": "string"
1854 }, 1824 },
1855 "requestStreaming": { 1825 "requestStreaming": {
1856 "description": "If true, the request is streamed.", 1826 "description": "If true, the request is streamed.",
1857 "type": "boolean" 1827 "type": "boolean"
1858 }, 1828 },
1859 "syntax": { 1829 "syntax": {
1860 "description": "The source syntax of this method.", 1830 "description": "The source syntax of this method.",
(...skipping 10 matching lines...) Expand all
1871 "responseTypeUrl": { 1841 "responseTypeUrl": {
1872 "description": "The URL of the output message type.", 1842 "description": "The URL of the output message type.",
1873 "type": "string" 1843 "type": "string"
1874 }, 1844 },
1875 "options": { 1845 "options": {
1876 "description": "Any metadata attached to the method.", 1846 "description": "Any metadata attached to the method.",
1877 "items": { 1847 "items": {
1878 "$ref": "Option" 1848 "$ref": "Option"
1879 }, 1849 },
1880 "type": "array" 1850 "type": "array"
1881 } 1851 },
1882 }, 1852 "responseStreaming": {
1883 "type": "object" 1853 "description": "If true, the response is streamed.",
1884 }, 1854 "type": "boolean"
1885 "ConfigRef": { 1855 },
1886 "description": "Represents a service configuration with its name and id.",
1887 "id": "ConfigRef",
1888 "properties": {
1889 "name": { 1856 "name": {
1890 "description": "Resource name of a service config. It must h ave the following\nformat: \"services/{service name}/configs/{config id}\".", 1857 "description": "The simple name of this method.",
1891 "type": "string" 1858 "type": "string"
1892 } 1859 }
1893 }, 1860 },
1894 "type": "object" 1861 "type": "object"
1895 }, 1862 },
1896 "ListServiceRolloutsResponse": { 1863 "ListServiceRolloutsResponse": {
1897 "description": "Response message for ListServiceRollouts method.", 1864 "description": "Response message for ListServiceRollouts method.",
1898 "id": "ListServiceRolloutsResponse", 1865 "id": "ListServiceRolloutsResponse",
1899 "properties": { 1866 "properties": {
1900 "nextPageToken": { 1867 "nextPageToken": {
1901 "description": "The token of the next page of results.", 1868 "description": "The token of the next page of results.",
1902 "type": "string" 1869 "type": "string"
1903 }, 1870 },
1904 "rollouts": { 1871 "rollouts": {
1905 "description": "The list of rollout resources.", 1872 "description": "The list of rollout resources.",
1906 "items": { 1873 "items": {
1907 "$ref": "Rollout" 1874 "$ref": "Rollout"
1908 }, 1875 },
1909 "type": "array" 1876 "type": "array"
1910 } 1877 }
1911 }, 1878 },
1912 "type": "object" 1879 "type": "object"
1913 }, 1880 },
1881 "ConfigRef": {
1882 "description": "Represents a service configuration with its name and id.",
1883 "id": "ConfigRef",
1884 "properties": {
1885 "name": {
1886 "description": "Resource name of a service config. It must h ave the following\nformat: \"services/{service name}/configs/{config id}\".",
1887 "type": "string"
1888 }
1889 },
1890 "type": "object"
1891 },
1914 "Mixin": { 1892 "Mixin": {
1915 "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 }", 1893 "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 }",
1916 "id": "Mixin", 1894 "id": "Mixin",
1917 "properties": { 1895 "properties": {
1918 "name": { 1896 "name": {
1919 "description": "The fully qualified name of the API which is included.", 1897 "description": "The fully qualified name of the API which is included.",
1920 "type": "string" 1898 "type": "string"
1921 }, 1899 },
1922 "root": { 1900 "root": {
1923 "description": "If non-empty specifies a path under which in herited HTTP paths\nare rooted.", 1901 "description": "If non-empty specifies a path under which in herited HTTP paths\nare rooted.",
1924 "type": "string" 1902 "type": "string"
1925 } 1903 }
1926 }, 1904 },
1927 "type": "object" 1905 "type": "object"
1928 }, 1906 },
1929 "CustomError": { 1907 "CustomError": {
1930 "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", 1908 "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",
1931 "id": "CustomError", 1909 "id": "CustomError",
1932 "properties": { 1910 "properties": {
1911 "types": {
1912 "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
1913 "items": {
1914 "type": "string"
1915 },
1916 "type": "array"
1917 },
1933 "rules": { 1918 "rules": {
1934 "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.", 1919 "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.",
1935 "items": { 1920 "items": {
1936 "$ref": "CustomErrorRule" 1921 "$ref": "CustomErrorRule"
1937 }, 1922 },
1938 "type": "array" 1923 "type": "array"
1939 },
1940 "types": {
1941 "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
1942 "items": {
1943 "type": "string"
1944 },
1945 "type": "array"
1946 } 1924 }
1947 }, 1925 },
1948 "type": "object" 1926 "type": "object"
1949 }, 1927 },
1950 "CounterOptions": { 1928 "CounterOptions": {
1951 "description": "Options for counters", 1929 "description": "Options for counters",
1952 "id": "CounterOptions", 1930 "id": "CounterOptions",
1953 "properties": { 1931 "properties": {
1954 "metric": { 1932 "metric": {
1955 "description": "The metric to update.", 1933 "description": "The metric to update.",
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after
1999 "description": "Define the HTTP header name to use for the p arameter. It is case\ninsensitive.", 1977 "description": "Define the HTTP header name to use for the p arameter. It is case\ninsensitive.",
2000 "type": "string" 1978 "type": "string"
2001 }, 1979 },
2002 "name": { 1980 "name": {
2003 "description": "Define the name of the parameter, such as \" api_key\" . It is case sensitive.", 1981 "description": "Define the name of the parameter, such as \" api_key\" . It is case sensitive.",
2004 "type": "string" 1982 "type": "string"
2005 } 1983 }
2006 }, 1984 },
2007 "type": "object" 1985 "type": "object"
2008 }, 1986 },
2009 "Monitoring": {
2010 "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",
2011 "id": "Monitoring",
2012 "properties": {
2013 "consumerDestinations": {
2014 "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.",
2015 "items": {
2016 "$ref": "MonitoringDestination"
2017 },
2018 "type": "array"
2019 },
2020 "producerDestinations": {
2021 "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.",
2022 "items": {
2023 "$ref": "MonitoringDestination"
2024 },
2025 "type": "array"
2026 }
2027 },
2028 "type": "object"
2029 },
2030 "Field": { 1987 "Field": {
2031 "description": "A single field of a message type.", 1988 "description": "A single field of a message type.",
2032 "id": "Field", 1989 "id": "Field",
2033 "properties": { 1990 "properties": {
2034 "typeUrl": {
2035 "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.T imestamp\"`.",
2036 "type": "string"
2037 },
2038 "number": {
2039 "description": "The field number.",
2040 "format": "int32",
2041 "type": "integer"
2042 },
2043 "kind": { 1991 "kind": {
2044 "description": "The field type.", 1992 "description": "The field type.",
2045 "enum": [ 1993 "enum": [
2046 "TYPE_UNKNOWN", 1994 "TYPE_UNKNOWN",
2047 "TYPE_DOUBLE", 1995 "TYPE_DOUBLE",
2048 "TYPE_FLOAT", 1996 "TYPE_FLOAT",
2049 "TYPE_INT64", 1997 "TYPE_INT64",
2050 "TYPE_UINT64", 1998 "TYPE_UINT64",
2051 "TYPE_INT32", 1999 "TYPE_INT32",
2052 "TYPE_FIXED64", 2000 "TYPE_FIXED64",
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after
2095 "items": { 2043 "items": {
2096 "$ref": "Option" 2044 "$ref": "Option"
2097 }, 2045 },
2098 "type": "array" 2046 "type": "array"
2099 }, 2047 },
2100 "oneofIndex": { 2048 "oneofIndex": {
2101 "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.", 2049 "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.",
2102 "format": "int32", 2050 "format": "int32",
2103 "type": "integer" 2051 "type": "integer"
2104 }, 2052 },
2105 "packed": {
2106 "description": "Whether to use alternative packed wire repre sentation.",
2107 "type": "boolean"
2108 },
2109 "cardinality": { 2053 "cardinality": {
2110 "description": "The field cardinality.", 2054 "description": "The field cardinality.",
2111 "enum": [ 2055 "enum": [
2112 "CARDINALITY_UNKNOWN", 2056 "CARDINALITY_UNKNOWN",
2113 "CARDINALITY_OPTIONAL", 2057 "CARDINALITY_OPTIONAL",
2114 "CARDINALITY_REQUIRED", 2058 "CARDINALITY_REQUIRED",
2115 "CARDINALITY_REPEATED" 2059 "CARDINALITY_REPEATED"
2116 ], 2060 ],
2117 "enumDescriptions": [ 2061 "enumDescriptions": [
2118 "For fields with unknown cardinality.", 2062 "For fields with unknown cardinality.",
2119 "For optional fields.", 2063 "For optional fields.",
2120 "For required fields. Proto2 syntax only.", 2064 "For required fields. Proto2 syntax only.",
2121 "For repeated fields." 2065 "For repeated fields."
2122 ], 2066 ],
2123 "type": "string" 2067 "type": "string"
2124 }, 2068 },
2069 "packed": {
2070 "description": "Whether to use alternative packed wire repre sentation.",
2071 "type": "boolean"
2072 },
2125 "defaultValue": { 2073 "defaultValue": {
2126 "description": "The string value of the default value of thi s field. Proto2 syntax only.", 2074 "description": "The string value of the default value of thi s field. Proto2 syntax only.",
2127 "type": "string" 2075 "type": "string"
2128 }, 2076 },
2129 "name": { 2077 "name": {
2130 "description": "The field name.", 2078 "description": "The field name.",
2131 "type": "string" 2079 "type": "string"
2080 },
2081 "typeUrl": {
2082 "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.T imestamp\"`.",
2083 "type": "string"
2084 },
2085 "number": {
2086 "description": "The field number.",
2087 "format": "int32",
2088 "type": "integer"
2132 } 2089 }
2133 }, 2090 },
2134 "type": "object" 2091 "type": "object"
2092 },
2093 "Monitoring": {
2094 "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",
2095 "id": "Monitoring",
2096 "properties": {
2097 "consumerDestinations": {
2098 "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.",
2099 "items": {
2100 "$ref": "MonitoringDestination"
2101 },
2102 "type": "array"
2103 },
2104 "producerDestinations": {
2105 "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.",
2106 "items": {
2107 "$ref": "MonitoringDestination"
2108 },
2109 "type": "array"
2110 }
2111 },
2112 "type": "object"
2135 }, 2113 },
2136 "TestIamPermissionsRequest": { 2114 "TestIamPermissionsRequest": {
2137 "description": "Request message for `TestIamPermissions` method.", 2115 "description": "Request message for `TestIamPermissions` method.",
2138 "id": "TestIamPermissionsRequest", 2116 "id": "TestIamPermissionsRequest",
2139 "properties": { 2117 "properties": {
2140 "permissions": { 2118 "permissions": {
2141 "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).", 2119 "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).",
2142 "items": { 2120 "items": {
2143 "type": "string" 2121 "type": "string"
2144 }, 2122 },
2145 "type": "array" 2123 "type": "array"
2146 } 2124 }
2147 }, 2125 },
2148 "type": "object" 2126 "type": "object"
2149 }, 2127 },
2150 "Enum": { 2128 "Enum": {
2151 "description": "Enum type definition.", 2129 "description": "Enum type definition.",
2152 "id": "Enum", 2130 "id": "Enum",
2153 "properties": { 2131 "properties": {
2132 "options": {
2133 "description": "Protocol buffer options.",
2134 "items": {
2135 "$ref": "Option"
2136 },
2137 "type": "array"
2138 },
2154 "sourceContext": { 2139 "sourceContext": {
2155 "$ref": "SourceContext", 2140 "$ref": "SourceContext",
2156 "description": "The source context." 2141 "description": "The source context."
2157 }, 2142 },
2158 "syntax": { 2143 "syntax": {
2159 "description": "The source syntax.", 2144 "description": "The source syntax.",
2160 "enum": [ 2145 "enum": [
2161 "SYNTAX_PROTO2", 2146 "SYNTAX_PROTO2",
2162 "SYNTAX_PROTO3" 2147 "SYNTAX_PROTO3"
2163 ], 2148 ],
2164 "enumDescriptions": [ 2149 "enumDescriptions": [
2165 "Syntax `proto2`.", 2150 "Syntax `proto2`.",
2166 "Syntax `proto3`." 2151 "Syntax `proto3`."
2167 ], 2152 ],
2168 "type": "string" 2153 "type": "string"
2169 }, 2154 },
2170 "name": { 2155 "name": {
2171 "description": "Enum type name.", 2156 "description": "Enum type name.",
2172 "type": "string" 2157 "type": "string"
2173 }, 2158 },
2174 "enumvalue": { 2159 "enumvalue": {
2175 "description": "Enum value definitions.", 2160 "description": "Enum value definitions.",
2176 "items": { 2161 "items": {
2177 "$ref": "EnumValue" 2162 "$ref": "EnumValue"
2178 }, 2163 },
2179 "type": "array" 2164 "type": "array"
2180 },
2181 "options": {
2182 "description": "Protocol buffer options.",
2183 "items": {
2184 "$ref": "Option"
2185 },
2186 "type": "array"
2187 } 2165 }
2188 }, 2166 },
2189 "type": "object" 2167 "type": "object"
2190 },
2191 "LabelDescriptor": {
2192 "description": "A description of a label.",
2193 "id": "LabelDescriptor",
2194 "properties": {
2195 "key": {
2196 "description": "The label key.",
2197 "type": "string"
2198 },
2199 "description": {
2200 "description": "A human-readable description for the label." ,
2201 "type": "string"
2202 },
2203 "valueType": {
2204 "description": "The type of data that can be assigned to the label.",
2205 "enum": [
2206 "STRING",
2207 "BOOL",
2208 "INT64"
2209 ],
2210 "enumDescriptions": [
2211 "A variable-length string. This is the default.",
2212 "Boolean; true or false.",
2213 "A 64-bit signed integer."
2214 ],
2215 "type": "string"
2216 }
2217 },
2218 "type": "object"
2219 }, 2168 },
2220 "Diagnostic": { 2169 "Diagnostic": {
2221 "description": "Represents a diagnostic message (error or warning)", 2170 "description": "Represents a diagnostic message (error or warning)",
2222 "id": "Diagnostic", 2171 "id": "Diagnostic",
2223 "properties": { 2172 "properties": {
2224 "kind": { 2173 "kind": {
2225 "description": "The kind of diagnostic information provided. ", 2174 "description": "The kind of diagnostic information provided. ",
2226 "enum": [ 2175 "enum": [
2227 "WARNING", 2176 "WARNING",
2228 "ERROR" 2177 "ERROR"
(...skipping 19 matching lines...) Expand all
2248 "description": "Request message for EnableService method.", 2197 "description": "Request message for EnableService method.",
2249 "id": "EnableServiceRequest", 2198 "id": "EnableServiceRequest",
2250 "properties": { 2199 "properties": {
2251 "consumerId": { 2200 "consumerId": {
2252 "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.", 2201 "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.",
2253 "type": "string" 2202 "type": "string"
2254 } 2203 }
2255 }, 2204 },
2256 "type": "object" 2205 "type": "object"
2257 }, 2206 },
2207 "LabelDescriptor": {
2208 "description": "A description of a label.",
2209 "id": "LabelDescriptor",
2210 "properties": {
2211 "key": {
2212 "description": "The label key.",
2213 "type": "string"
2214 },
2215 "description": {
2216 "description": "A human-readable description for the label." ,
2217 "type": "string"
2218 },
2219 "valueType": {
2220 "description": "The type of data that can be assigned to the label.",
2221 "enum": [
2222 "STRING",
2223 "BOOL",
2224 "INT64"
2225 ],
2226 "enumDescriptions": [
2227 "A variable-length string. This is the default.",
2228 "Boolean; true or false.",
2229 "A 64-bit signed integer."
2230 ],
2231 "type": "string"
2232 }
2233 },
2234 "type": "object"
2235 },
2258 "GenerateConfigReportResponse": { 2236 "GenerateConfigReportResponse": {
2259 "description": "Response message for GenerateConfigReport method.", 2237 "description": "Response message for GenerateConfigReport method.",
2260 "id": "GenerateConfigReportResponse", 2238 "id": "GenerateConfigReportResponse",
2261 "properties": { 2239 "properties": {
2262 "serviceName": { 2240 "serviceName": {
2263 "description": "Name of the service this report belongs to." , 2241 "description": "Name of the service this report belongs to." ,
2264 "type": "string" 2242 "type": "string"
2265 }, 2243 },
2266 "changeReports": { 2244 "changeReports": {
2267 "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations.", 2245 "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations.",
(...skipping 13 matching lines...) Expand all
2281 }, 2259 },
2282 "type": "array" 2260 "type": "array"
2283 } 2261 }
2284 }, 2262 },
2285 "type": "object" 2263 "type": "object"
2286 }, 2264 },
2287 "Type": { 2265 "Type": {
2288 "description": "A protocol buffer message type.", 2266 "description": "A protocol buffer message type.",
2289 "id": "Type", 2267 "id": "Type",
2290 "properties": { 2268 "properties": {
2269 "fields": {
2270 "description": "The list of fields.",
2271 "items": {
2272 "$ref": "Field"
2273 },
2274 "type": "array"
2275 },
2276 "name": {
2277 "description": "The fully qualified message name.",
2278 "type": "string"
2279 },
2280 "oneofs": {
2281 "description": "The list of types appearing in `oneof` defin itions in this type.",
2282 "items": {
2283 "type": "string"
2284 },
2285 "type": "array"
2286 },
2291 "syntax": { 2287 "syntax": {
2292 "description": "The source syntax.", 2288 "description": "The source syntax.",
2293 "enum": [ 2289 "enum": [
2294 "SYNTAX_PROTO2", 2290 "SYNTAX_PROTO2",
2295 "SYNTAX_PROTO3" 2291 "SYNTAX_PROTO3"
2296 ], 2292 ],
2297 "enumDescriptions": [ 2293 "enumDescriptions": [
2298 "Syntax `proto2`.", 2294 "Syntax `proto2`.",
2299 "Syntax `proto3`." 2295 "Syntax `proto3`."
2300 ], 2296 ],
2301 "type": "string" 2297 "type": "string"
2302 }, 2298 },
2303 "sourceContext": { 2299 "sourceContext": {
2304 "$ref": "SourceContext", 2300 "$ref": "SourceContext",
2305 "description": "The source context." 2301 "description": "The source context."
2306 }, 2302 },
2307 "options": { 2303 "options": {
2308 "description": "The protocol buffer options.", 2304 "description": "The protocol buffer options.",
2309 "items": { 2305 "items": {
2310 "$ref": "Option" 2306 "$ref": "Option"
2311 }, 2307 },
2312 "type": "array" 2308 "type": "array"
2313 },
2314 "fields": {
2315 "description": "The list of fields.",
2316 "items": {
2317 "$ref": "Field"
2318 },
2319 "type": "array"
2320 },
2321 "name": {
2322 "description": "The fully qualified message name.",
2323 "type": "string"
2324 },
2325 "oneofs": {
2326 "description": "The list of types appearing in `oneof` defin itions in this type.",
2327 "items": {
2328 "type": "string"
2329 },
2330 "type": "array"
2331 } 2309 }
2332 }, 2310 },
2333 "type": "object" 2311 "type": "object"
2334 }, 2312 },
2335 "ListServiceConfigsResponse": { 2313 "ListServiceConfigsResponse": {
2336 "description": "Response message for ListServiceConfigs method.", 2314 "description": "Response message for ListServiceConfigs method.",
2337 "id": "ListServiceConfigsResponse", 2315 "id": "ListServiceConfigsResponse",
2338 "properties": { 2316 "properties": {
2339 "nextPageToken": {
2340 "description": "The token of the next page of results.",
2341 "type": "string"
2342 },
2343 "serviceConfigs": { 2317 "serviceConfigs": {
2344 "description": "The list of service configuration resources. ", 2318 "description": "The list of service configuration resources. ",
2345 "items": { 2319 "items": {
2346 "$ref": "Service" 2320 "$ref": "Service"
2347 }, 2321 },
2348 "type": "array" 2322 "type": "array"
2323 },
2324 "nextPageToken": {
2325 "description": "The token of the next page of results.",
2326 "type": "string"
2349 } 2327 }
2350 }, 2328 },
2351 "type": "object" 2329 "type": "object"
2352 },
2353 "Backend": {
2354 "description": "`Backend` defines the backend configuration for a se rvice.",
2355 "id": "Backend",
2356 "properties": {
2357 "rules": {
2358 "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.",
2359 "items": {
2360 "$ref": "BackendRule"
2361 },
2362 "type": "array"
2363 }
2364 },
2365 "type": "object"
2366 }, 2330 },
2367 "AuditConfig": { 2331 "AuditConfig": {
2368 "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, ar e exempted from logging.\nAn AuditConifg must have one or more AuditLogConfigs." , 2332 "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, ar e exempted from logging.\nAn AuditConifg must have one or more AuditLogConfigs." ,
2369 "id": "AuditConfig", 2333 "id": "AuditConfig",
2370 "properties": { 2334 "properties": {
2371 "service": {
2372 "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServ ices` is a special value that covers all services.",
2373 "type": "string"
2374 },
2375 "auditLogConfigs": { 2335 "auditLogConfigs": {
2376 "description": "The configuration for logging of each type o f permission.\nNext ID: 4", 2336 "description": "The configuration for logging of each type o f permission.\nNext ID: 4",
2377 "items": { 2337 "items": {
2378 "$ref": "AuditLogConfig" 2338 "$ref": "AuditLogConfig"
2379 }, 2339 },
2380 "type": "array" 2340 "type": "array"
2381 }, 2341 },
2382 "exemptedMembers": { 2342 "exemptedMembers": {
2383 "description": "Specifies the identities that are exempted f rom \"data access\" audit\nlogging for the `service` specified above.\nFollows t he same format of Binding.members.\nThis field is deprecated in favor of per-per mission-type exemptions.", 2343 "description": "Specifies the identities that are exempted f rom \"data access\" audit\nlogging for the `service` specified above.\nFollows t he same format of Binding.members.\nThis field is deprecated in favor of per-per mission-type exemptions.",
2384 "items": { 2344 "items": {
2385 "type": "string" 2345 "type": "string"
2386 }, 2346 },
2387 "type": "array" 2347 "type": "array"
2348 },
2349 "service": {
2350 "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServ ices` is a special value that covers all services.",
2351 "type": "string"
2352 }
2353 },
2354 "type": "object"
2355 },
2356 "Backend": {
2357 "description": "`Backend` defines the backend configuration for a se rvice.",
2358 "id": "Backend",
2359 "properties": {
2360 "rules": {
2361 "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.",
2362 "items": {
2363 "$ref": "BackendRule"
2364 },
2365 "type": "array"
2388 } 2366 }
2389 }, 2367 },
2390 "type": "object" 2368 "type": "object"
2391 }, 2369 },
2392 "SubmitConfigSourceRequest": { 2370 "SubmitConfigSourceRequest": {
2393 "description": "Request message for SubmitConfigSource method.", 2371 "description": "Request message for SubmitConfigSource method.",
2394 "id": "SubmitConfigSourceRequest", 2372 "id": "SubmitConfigSourceRequest",
2395 "properties": { 2373 "properties": {
2374 "configSource": {
2375 "$ref": "ConfigSource",
2376 "description": "The source configuration for the service."
2377 },
2396 "validateOnly": { 2378 "validateOnly": {
2397 "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.", 2379 "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.",
2398 "type": "boolean" 2380 "type": "boolean"
2399 },
2400 "configSource": {
2401 "$ref": "ConfigSource",
2402 "description": "The source configuration for the service."
2403 } 2381 }
2404 }, 2382 },
2405 "type": "object" 2383 "type": "object"
2406 }, 2384 },
2407 "DocumentationRule": { 2385 "DocumentationRule": {
2408 "description": "A documentation rule provides information about indi vidual API elements.", 2386 "description": "A documentation rule provides information about indi vidual API elements.",
2409 "id": "DocumentationRule", 2387 "id": "DocumentationRule",
2410 "properties": { 2388 "properties": {
2411 "description": { 2389 "description": {
2412 "description": "Description of the selected API(s).", 2390 "description": "Description of the selected API(s).",
(...skipping 13 matching lines...) Expand all
2426 "CloudAuditOptions": { 2404 "CloudAuditOptions": {
2427 "description": "Write a Cloud Audit log", 2405 "description": "Write a Cloud Audit log",
2428 "id": "CloudAuditOptions", 2406 "id": "CloudAuditOptions",
2429 "properties": {}, 2407 "properties": {},
2430 "type": "object" 2408 "type": "object"
2431 }, 2409 },
2432 "ContextRule": { 2410 "ContextRule": {
2433 "description": "A context rule provides information about the contex t for an individual API\nelement.", 2411 "description": "A context rule provides information about the contex t for an individual API\nelement.",
2434 "id": "ContextRule", 2412 "id": "ContextRule",
2435 "properties": { 2413 "properties": {
2436 "selector": {
2437 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
2438 "type": "string"
2439 },
2440 "provided": { 2414 "provided": {
2441 "description": "A list of full type names of provided contex ts.", 2415 "description": "A list of full type names of provided contex ts.",
2442 "items": { 2416 "items": {
2443 "type": "string" 2417 "type": "string"
2444 }, 2418 },
2445 "type": "array" 2419 "type": "array"
2446 }, 2420 },
2447 "requested": { 2421 "requested": {
2448 "description": "A list of full type names of requested conte xts.", 2422 "description": "A list of full type names of requested conte xts.",
2449 "items": { 2423 "items": {
2450 "type": "string" 2424 "type": "string"
2451 }, 2425 },
2452 "type": "array" 2426 "type": "array"
2427 },
2428 "selector": {
2429 "description": "Selects the methods to which this rule appli es.\n\nRefer to selector for syntax details.",
2430 "type": "string"
2453 } 2431 }
2454 }, 2432 },
2455 "type": "object" 2433 "type": "object"
2456 }, 2434 },
2457 "SourceContext": { 2435 "SourceContext": {
2458 "description": "`SourceContext` represents information about the sou rce of a\nprotobuf element, like the file in which it is defined.", 2436 "description": "`SourceContext` represents information about the sou rce of a\nprotobuf element, like the file in which it is defined.",
2459 "id": "SourceContext", 2437 "id": "SourceContext",
2460 "properties": { 2438 "properties": {
2461 "fileName": { 2439 "fileName": {
2462 "description": "The path-qualified name of the .proto file t hat contained the associated\nprotobuf element. For example: `\"google/protobuf /source_context.proto\"`.", 2440 "description": "The path-qualified name of the .proto file t hat contained the associated\nprotobuf element. For example: `\"google/protobuf /source_context.proto\"`.",
2463 "type": "string" 2441 "type": "string"
2464 } 2442 }
2465 }, 2443 },
2466 "type": "object" 2444 "type": "object"
2467 }, 2445 },
2468 "MetricDescriptor": { 2446 "MetricDescriptor": {
2469 "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.", 2447 "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.",
2470 "id": "MetricDescriptor", 2448 "id": "MetricDescriptor",
2471 "properties": { 2449 "properties": {
2450 "description": {
2451 "description": "A detailed description of the metric, which can be used in documentation.",
2452 "type": "string"
2453 },
2454 "displayName": {
2455 "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\".",
2456 "type": "string"
2457 },
2458 "unit": {
2459 "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 '}'.",
2460 "type": "string"
2461 },
2462 "labels": {
2463 "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.",
2464 "items": {
2465 "$ref": "LabelDescriptor"
2466 },
2467 "type": "array"
2468 },
2469 "name": {
2470 "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\"",
2471 "type": "string"
2472 },
2473 "type": {
2474 "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\"",
2475 "type": "string"
2476 },
2472 "valueType": { 2477 "valueType": {
2473 "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.", 2478 "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.",
2474 "enum": [ 2479 "enum": [
2475 "VALUE_TYPE_UNSPECIFIED", 2480 "VALUE_TYPE_UNSPECIFIED",
2476 "BOOL", 2481 "BOOL",
2477 "INT64", 2482 "INT64",
2478 "DOUBLE", 2483 "DOUBLE",
2479 "STRING", 2484 "STRING",
2480 "DISTRIBUTION", 2485 "DISTRIBUTION",
2481 "MONEY" 2486 "MONEY"
(...skipping 17 matching lines...) Expand all
2499 "DELTA", 2504 "DELTA",
2500 "CUMULATIVE" 2505 "CUMULATIVE"
2501 ], 2506 ],
2502 "enumDescriptions": [ 2507 "enumDescriptions": [
2503 "Do not use this default value.", 2508 "Do not use this default value.",
2504 "An instantaneous measurement of a value.", 2509 "An instantaneous measurement of a value.",
2505 "The change in a value during a time interval.", 2510 "The change in a value during a time interval.",
2506 "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." 2511 "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."
2507 ], 2512 ],
2508 "type": "string" 2513 "type": "string"
2509 },
2510 "description": {
2511 "description": "A detailed description of the metric, which can be used in documentation.",
2512 "type": "string"
2513 },
2514 "displayName": {
2515 "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\".",
2516 "type": "string"
2517 },
2518 "unit": {
2519 "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 '}'.",
2520 "type": "string"
2521 },
2522 "labels": {
2523 "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.",
2524 "items": {
2525 "$ref": "LabelDescriptor"
2526 },
2527 "type": "array"
2528 },
2529 "name": {
2530 "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\"",
2531 "type": "string"
2532 },
2533 "type": {
2534 "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\"",
2535 "type": "string"
2536 } 2514 }
2537 }, 2515 },
2538 "type": "object" 2516 "type": "object"
2539 }, 2517 },
2540 "ListServicesResponse": { 2518 "ListServicesResponse": {
2541 "description": "Response message for `ListServices` method.", 2519 "description": "Response message for `ListServices` method.",
2542 "id": "ListServicesResponse", 2520 "id": "ListServicesResponse",
2543 "properties": { 2521 "properties": {
2544 "services": { 2522 "services": {
2545 "description": "The returned services will only have the nam e field set.", 2523 "description": "The returned services will only have the nam e field set.",
2546 "items": { 2524 "items": {
2547 "$ref": "ManagedService" 2525 "$ref": "ManagedService"
2548 }, 2526 },
2549 "type": "array" 2527 "type": "array"
2550 }, 2528 },
2551 "nextPageToken": { 2529 "nextPageToken": {
2552 "description": "Token that can be passed to `ListServices` t o resume a paginated query.", 2530 "description": "Token that can be passed to `ListServices` t o resume a paginated query.",
2553 "type": "string" 2531 "type": "string"
2554 } 2532 }
2555 }, 2533 },
2556 "type": "object" 2534 "type": "object"
2557 }, 2535 },
2558 "Endpoint": { 2536 "Endpoint": {
2559 "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", 2537 "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",
2560 "id": "Endpoint", 2538 "id": "Endpoint",
2561 "properties": { 2539 "properties": {
2562 "name": {
2563 "description": "The canonical name of this endpoint.",
2564 "type": "string"
2565 },
2566 "apis": {
2567 "description": "The list of APIs served by this endpoint.",
2568 "items": {
2569 "type": "string"
2570 },
2571 "type": "array"
2572 },
2573 "aliases": { 2540 "aliases": {
2574 "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.", 2541 "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.",
2575 "items": { 2542 "items": {
2576 "type": "string" 2543 "type": "string"
2577 }, 2544 },
2578 "type": "array" 2545 "type": "array"
2579 }, 2546 },
2580 "features": { 2547 "features": {
2581 "description": "The list of features enabled on this endpoin t.", 2548 "description": "The list of features enabled on this endpoin t.",
2582 "items": { 2549 "items": {
2583 "type": "string" 2550 "type": "string"
2584 }, 2551 },
2585 "type": "array" 2552 "type": "array"
2586 }, 2553 },
2587 "allowCors": { 2554 "allowCors": {
2588 "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.", 2555 "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.",
2589 "type": "boolean" 2556 "type": "boolean"
2557 },
2558 "name": {
2559 "description": "The canonical name of this endpoint.",
2560 "type": "string"
2561 },
2562 "apis": {
2563 "description": "The list of APIs served by this endpoint.",
2564 "items": {
2565 "type": "string"
2566 },
2567 "type": "array"
2590 } 2568 }
2591 }, 2569 },
2592 "type": "object" 2570 "type": "object"
2593 }, 2571 },
2594 "OAuthRequirements": { 2572 "OAuthRequirements": {
2595 "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.", 2573 "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.",
2596 "id": "OAuthRequirements", 2574 "id": "OAuthRequirements",
2597 "properties": { 2575 "properties": {
2598 "canonicalScopes": { 2576 "canonicalScopes": {
2599 "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 ", 2577 "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 ",
(...skipping 143 matching lines...) Expand 10 before | Expand all | Expand 10 after
2743 "$ref": "DataAccessOptions", 2721 "$ref": "DataAccessOptions",
2744 "description": "Data access options." 2722 "description": "Data access options."
2745 } 2723 }
2746 }, 2724 },
2747 "type": "object" 2725 "type": "object"
2748 }, 2726 },
2749 "LogDescriptor": { 2727 "LogDescriptor": {
2750 "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", 2728 "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",
2751 "id": "LogDescriptor", 2729 "id": "LogDescriptor",
2752 "properties": { 2730 "properties": {
2731 "labels": {
2732 "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.",
2733 "items": {
2734 "$ref": "LabelDescriptor"
2735 },
2736 "type": "array"
2737 },
2753 "name": { 2738 "name": {
2754 "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 [/_-.].", 2739 "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 [/_-.].",
2755 "type": "string" 2740 "type": "string"
2756 }, 2741 },
2757 "description": { 2742 "description": {
2758 "description": "A human-readable description of this log. Th is information appears in\nthe documentation and can contain details.", 2743 "description": "A human-readable description of this log. Th is information appears in\nthe documentation and can contain details.",
2759 "type": "string" 2744 "type": "string"
2760 }, 2745 },
2761 "displayName": { 2746 "displayName": {
2762 "description": "The human-readable name for this log. This i nformation appears on\nthe user interface and should be concise.", 2747 "description": "The human-readable name for this log. This i nformation appears on\nthe user interface and should be concise.",
2763 "type": "string" 2748 "type": "string"
2764 },
2765 "labels": {
2766 "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.",
2767 "items": {
2768 "$ref": "LabelDescriptor"
2769 },
2770 "type": "array"
2771 } 2749 }
2772 }, 2750 },
2773 "type": "object" 2751 "type": "object"
2774 }, 2752 },
2775 "ConfigFile": { 2753 "ConfigFile": {
2776 "description": "Generic specification of a source configuration file ", 2754 "description": "Generic specification of a source configuration file ",
2777 "id": "ConfigFile", 2755 "id": "ConfigFile",
2778 "properties": { 2756 "properties": {
2779 "filePath": { 2757 "filePath": {
2780 "description": "The file name of the configuration file (ful l or relative path).", 2758 "description": "The file name of the configuration file (ful l or relative path).",
(...skipping 87 matching lines...) Expand 10 before | Expand all | Expand 10 after
2868 "properties": { 2846 "properties": {
2869 "configChanges": { 2847 "configChanges": {
2870 "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", 2848 "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",
2871 "items": { 2849 "items": {
2872 "$ref": "ConfigChange" 2850 "$ref": "ConfigChange"
2873 }, 2851 },
2874 "type": "array" 2852 "type": "array"
2875 } 2853 }
2876 }, 2854 },
2877 "type": "object" 2855 "type": "object"
2856 },
2857 "DisableServiceRequest": {
2858 "description": "Request message for DisableService method.",
2859 "id": "DisableServiceRequest",
2860 "properties": {
2861 "consumerId": {
2862 "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.",
2863 "type": "string"
2864 }
2865 },
2866 "type": "object"
2867 },
2868 "SubmitConfigSourceResponse": {
2869 "description": "Response message for SubmitConfigSource method.",
2870 "id": "SubmitConfigSourceResponse",
2871 "properties": {
2872 "serviceConfig": {
2873 "$ref": "Service",
2874 "description": "The generated service configuration."
2875 }
2876 },
2877 "type": "object"
2878 } 2878 }
2879 }, 2879 },
2880 "servicePath": "", 2880 "servicePath": "",
2881 "title": "Google Service Management API", 2881 "title": "Google Service Management API",
2882 "version": "v1" 2882 "version": "v1"
2883 } 2883 }
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