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

Side by Side Diff: discovery/googleapis_beta/appengine__v1beta4.json

Issue 2159673002: Api-roll 39: 2016-07-18 (Closed) Base URL: git@github.com:dart-lang/googleapis.git@master
Patch Set: Created 4 years, 5 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
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 } 8 }
9 } 9 }
10 }, 10 },
11 "basePath": "", 11 "basePath": "",
12 "baseUrl": "https://appengine.googleapis.com/", 12 "baseUrl": "https://appengine.googleapis.com/",
13 "batchPath": "batch", 13 "batchPath": "batch",
14 "description": "Provisions and manages App Engine applications.", 14 "description": "Provisions and manages App Engine applications.",
15 "discoveryVersion": "v1", 15 "discoveryVersion": "v1",
16 "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", 16 "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
17 "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/JDymrl7cTvTgc8y6o_7KAyRtSLk\"", 17 "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/kNEfMfcEmFteZqx2KfsZSxjecDQ\"",
18 "icons": { 18 "icons": {
19 "x16": "http://www.google.com/images/icons/product/search-16.gif", 19 "x16": "http://www.google.com/images/icons/product/search-16.gif",
20 "x32": "http://www.google.com/images/icons/product/search-32.gif" 20 "x32": "http://www.google.com/images/icons/product/search-32.gif"
21 }, 21 },
22 "id": "appengine:v1beta4", 22 "id": "appengine:v1beta4",
23 "kind": "discovery#restDescription", 23 "kind": "discovery#restDescription",
24 "name": "appengine", 24 "name": "appengine",
25 "ownerDomain": "google.com", 25 "ownerDomain": "google.com",
26 "ownerName": "Google", 26 "ownerName": "Google",
27 "parameters": { 27 "parameters": {
(...skipping 72 matching lines...) Expand 10 before | Expand all | Expand 10 after
100 "v2 error format" 100 "v2 error format"
101 ], 101 ],
102 "location": "query", 102 "location": "query",
103 "type": "string" 103 "type": "string"
104 } 104 }
105 }, 105 },
106 "protocol": "rest", 106 "protocol": "rest",
107 "resources": { 107 "resources": {
108 "apps": { 108 "apps": {
109 "methods": { 109 "methods": {
110 "create": {
111 "description": "Creates an App Engine application for a Goog le Cloud Platform project. This requires a project that excludes an App Engine a pplication. For details about creating a project without an application, see the [Google Cloud Resource Manager create project topic](https://cloud.google.com/r esource-manager/docs/creating-project).",
112 "httpMethod": "POST",
113 "id": "appengine.apps.create",
114 "path": "v1beta4/apps",
115 "request": {
116 "$ref": "Application"
117 },
118 "response": {
119 "$ref": "Operation"
120 },
121 "scopes": [
122 "https://www.googleapis.com/auth/cloud-platform"
123 ]
124 },
110 "get": { 125 "get": {
111 "description": "Gets information about an application.", 126 "description": "Gets information about an application.",
112 "httpMethod": "GET", 127 "httpMethod": "GET",
113 "id": "appengine.apps.get", 128 "id": "appengine.apps.get",
114 "parameterOrder": [ 129 "parameterOrder": [
115 "appsId" 130 "appsId"
116 ], 131 ],
117 "parameters": { 132 "parameters": {
118 "appsId": { 133 "appsId": {
119 "description": "Part of `name`. Name of the applicat ion to get. For example: \"apps/myapp\".", 134 "description": "Part of `name`. Name of the applicat ion to get. For example: \"apps/myapp\".",
(...skipping 368 matching lines...) Expand 10 before | Expand all | Expand 10 after
488 "$ref": "Operation" 503 "$ref": "Operation"
489 }, 504 },
490 "scopes": [ 505 "scopes": [
491 "https://www.googleapis.com/auth/cloud-p latform" 506 "https://www.googleapis.com/auth/cloud-p latform"
492 ] 507 ]
493 } 508 }
494 }, 509 },
495 "resources": { 510 "resources": {
496 "instances": { 511 "instances": {
497 "methods": { 512 "methods": {
513 "delete": {
514 "description": "Stops a running inst ance.",
515 "httpMethod": "DELETE",
516 "id": "appengine.apps.modules.versio ns.instances.delete",
517 "parameterOrder": [
518 "appsId",
519 "modulesId",
520 "versionsId",
521 "instancesId"
522 ],
523 "parameters": {
524 "appsId": {
525 "description": "Part of `nam e`. Name of the resource requested. For example: \"apps/myapp/modules/default/ve rsions/v1/instances/instance-1\".",
526 "location": "path",
527 "required": true,
528 "type": "string"
529 },
530 "modulesId": {
531 "description": "Part of `nam e`. See documentation of `appsId`.",
532 "location": "path",
533 "required": true,
534 "type": "string"
535 },
536 "versionsId": {
537 "description": "Part of `nam e`. See documentation of `appsId`.",
538 "location": "path",
539 "required": true,
540 "type": "string"
541 },
542 "instancesId": {
543 "description": "Part of `nam e`. See documentation of `appsId`.",
544 "location": "path",
545 "required": true,
546 "type": "string"
547 }
548 },
549 "path": "v1beta4/apps/{appsId}/modul es/{modulesId}/versions/{versionsId}/instances/{instancesId}",
550 "response": {
551 "$ref": "Operation"
552 },
553 "scopes": [
554 "https://www.googleapis.com/auth /cloud-platform"
555 ]
556 },
557 "get": {
558 "description": "Gets instance inform ation.",
559 "httpMethod": "GET",
560 "id": "appengine.apps.modules.versio ns.instances.get",
561 "parameterOrder": [
562 "appsId",
563 "modulesId",
564 "versionsId",
565 "instancesId"
566 ],
567 "parameters": {
568 "appsId": {
569 "description": "Part of `nam e`. Name of the resource requested. For example: \"apps/myapp/modules/default/ve rsions/v1/instances/instance-1\".",
570 "location": "path",
571 "required": true,
572 "type": "string"
573 },
574 "modulesId": {
575 "description": "Part of `nam e`. See documentation of `appsId`.",
576 "location": "path",
577 "required": true,
578 "type": "string"
579 },
580 "versionsId": {
581 "description": "Part of `nam e`. See documentation of `appsId`.",
582 "location": "path",
583 "required": true,
584 "type": "string"
585 },
586 "instancesId": {
587 "description": "Part of `nam e`. See documentation of `appsId`.",
588 "location": "path",
589 "required": true,
590 "type": "string"
591 }
592 },
593 "path": "v1beta4/apps/{appsId}/modul es/{modulesId}/versions/{versionsId}/instances/{instancesId}",
594 "response": {
595 "$ref": "Instance"
596 },
597 "scopes": [
598 "https://www.googleapis.com/auth /cloud-platform"
599 ]
600 },
498 "list": { 601 "list": {
499 "description": "Lists the instances of a version.", 602 "description": "Lists the instances of a version.",
500 "httpMethod": "GET", 603 "httpMethod": "GET",
501 "id": "appengine.apps.modules.versio ns.instances.list", 604 "id": "appengine.apps.modules.versio ns.instances.list",
502 "parameterOrder": [ 605 "parameterOrder": [
503 "appsId", 606 "appsId",
504 "modulesId", 607 "modulesId",
505 "versionsId" 608 "versionsId"
506 ], 609 ],
507 "parameters": { 610 "parameters": {
(...skipping 27 matching lines...) Expand all
535 "type": "string" 638 "type": "string"
536 } 639 }
537 }, 640 },
538 "path": "v1beta4/apps/{appsId}/modul es/{modulesId}/versions/{versionsId}/instances", 641 "path": "v1beta4/apps/{appsId}/modul es/{modulesId}/versions/{versionsId}/instances",
539 "response": { 642 "response": {
540 "$ref": "ListInstancesResponse" 643 "$ref": "ListInstancesResponse"
541 }, 644 },
542 "scopes": [ 645 "scopes": [
543 "https://www.googleapis.com/auth /cloud-platform" 646 "https://www.googleapis.com/auth /cloud-platform"
544 ] 647 ]
648 },
649 "debug": {
650 "description": "Enable debugging of this VM instance. This call allows you to SSH to the VM. While the VM is in debu g mode, it continues to serve live traffic. After you're done debugging an insta nce, delete the instance; the system creates a new instance when needed. You can 't debug a non-VM instance.",
651 "httpMethod": "POST",
652 "id": "appengine.apps.modules.versio ns.instances.debug",
653 "parameterOrder": [
654 "appsId",
655 "modulesId",
656 "versionsId",
657 "instancesId"
658 ],
659 "parameters": {
660 "appsId": {
661 "description": "Part of `nam e`. Name of the resource requested. For example: \"apps/myapp/modules/default/ve rsions/v1/instances/instance-1\".",
662 "location": "path",
663 "required": true,
664 "type": "string"
665 },
666 "modulesId": {
667 "description": "Part of `nam e`. See documentation of `appsId`.",
668 "location": "path",
669 "required": true,
670 "type": "string"
671 },
672 "versionsId": {
673 "description": "Part of `nam e`. See documentation of `appsId`.",
674 "location": "path",
675 "required": true,
676 "type": "string"
677 },
678 "instancesId": {
679 "description": "Part of `nam e`. See documentation of `appsId`.",
680 "location": "path",
681 "required": true,
682 "type": "string"
683 }
684 },
685 "path": "v1beta4/apps/{appsId}/modul es/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
686 "request": {
687 "$ref": "DebugInstanceRequest"
688 },
689 "response": {
690 "$ref": "Operation"
691 },
692 "scopes": [
693 "https://www.googleapis.com/auth /cloud-platform"
694 ]
545 } 695 }
546 } 696 }
547 } 697 }
548 } 698 }
549 } 699 }
550 } 700 }
551 }, 701 },
552 "operations": { 702 "operations": {
553 "methods": { 703 "methods": {
554 "get": { 704 "get": {
(...skipping 59 matching lines...) Expand 10 before | Expand all | Expand 10 after
614 }, 764 },
615 "path": "v1beta4/apps/{appsId}/operations", 765 "path": "v1beta4/apps/{appsId}/operations",
616 "response": { 766 "response": {
617 "$ref": "ListOperationsResponse" 767 "$ref": "ListOperationsResponse"
618 }, 768 },
619 "scopes": [ 769 "scopes": [
620 "https://www.googleapis.com/auth/cloud-platform" 770 "https://www.googleapis.com/auth/cloud-platform"
621 ] 771 ]
622 } 772 }
623 } 773 }
774 },
775 "locations": {
776 "methods": {
777 "list": {
778 "description": "Lists information about the supporte d locations for this service.",
779 "httpMethod": "GET",
780 "id": "appengine.apps.locations.list",
781 "parameterOrder": [
782 "appsId"
783 ],
784 "parameters": {
785 "appsId": {
786 "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
787 "location": "path",
788 "required": true,
789 "type": "string"
790 },
791 "filter": {
792 "description": "The standard list filter.",
793 "location": "query",
794 "type": "string"
795 },
796 "pageSize": {
797 "description": "The standard list page size. ",
798 "format": "int32",
799 "location": "query",
800 "type": "integer"
801 },
802 "pageToken": {
803 "description": "The standard list page token .",
804 "location": "query",
805 "type": "string"
806 }
807 },
808 "path": "v1beta4/apps/{appsId}/locations",
809 "response": {
810 "$ref": "ListLocationsResponse"
811 },
812 "scopes": [
813 "https://www.googleapis.com/auth/cloud-platform"
814 ]
815 },
816 "get": {
817 "description": "Get information about a location.",
818 "httpMethod": "GET",
819 "id": "appengine.apps.locations.get",
820 "parameterOrder": [
821 "appsId",
822 "locationsId"
823 ],
824 "parameters": {
825 "appsId": {
826 "description": "Part of `name`. Resource nam e for the location.",
827 "location": "path",
828 "required": true,
829 "type": "string"
830 },
831 "locationsId": {
832 "description": "Part of `name`. See document ation of `appsId`.",
833 "location": "path",
834 "required": true,
835 "type": "string"
836 }
837 },
838 "path": "v1beta4/apps/{appsId}/locations/{locationsI d}",
839 "response": {
840 "$ref": "Location"
841 },
842 "scopes": [
843 "https://www.googleapis.com/auth/cloud-platform"
844 ]
845 }
846 }
624 } 847 }
625 } 848 }
626 } 849 }
627 }, 850 },
628 "revision": "20160614", 851 "revision": "20160711",
629 "rootUrl": "https://appengine.googleapis.com/", 852 "rootUrl": "https://appengine.googleapis.com/",
630 "schemas": { 853 "schemas": {
631 "Application": { 854 "Application": {
632 "description": "An Application contains the top-level configuration of an App Engine application.", 855 "description": "An Application contains the top-level configuration of an App Engine application.",
633 "id": "Application", 856 "id": "Application",
634 "properties": { 857 "properties": {
635 "name": { 858 "name": {
636 "description": "The full path to the application in the API. Example: \"apps/myapp\". @OutputOnly", 859 "description": "The full path to the Application resource in the API. Example: \"apps/myapp\". @OutputOnly",
637 "type": "string" 860 "type": "string"
638 }, 861 },
639 "id": { 862 "id": {
640 "description": "The relative name/path of the application. E xample: \"myapp\".", 863 "description": "The identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform pro ject where you want to deploy your application. Example: \"myapp\".",
641 "type": "string" 864 "type": "string"
642 }, 865 },
643 "dispatchRules": { 866 "dispatchRules": {
644 "description": "HTTP path dispatch rules for requests to the app that do not explicitly target a module or version. The rules are order-depe ndent. @OutputOnly", 867 "description": "HTTP path dispatch rules for requests to the app that do not explicitly target a module or version. The rules are order-depe ndent. @OutputOnly",
645 "items": { 868 "items": {
646 "$ref": "UrlDispatchRule" 869 "$ref": "UrlDispatchRule"
647 }, 870 },
648 "type": "array" 871 "type": "array"
649 }, 872 },
650 "authDomain": { 873 "authDomain": {
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after
686 "description": "The pathname within the host. This must star t with a '/'. A single '*' (glob) can be included at the end of the path. The su m of the lengths of the domain and path may not exceed 100 characters.", 909 "description": "The pathname within the host. This must star t with a '/'. A single '*' (glob) can be included at the end of the path. The su m of the lengths of the domain and path may not exceed 100 characters.",
687 "type": "string" 910 "type": "string"
688 }, 911 },
689 "module": { 912 "module": {
690 "description": "The resource id of a Module in this applicat ion that should service the matched request. The Module must already exist. Exam ple: \"default\".", 913 "description": "The resource id of a Module in this applicat ion that should service the matched request. The Module must already exist. Exam ple: \"default\".",
691 "type": "string" 914 "type": "string"
692 } 915 }
693 }, 916 },
694 "type": "object" 917 "type": "object"
695 }, 918 },
919 "Operation": {
920 "description": "This resource represents a long-running operation th at is the result of a network API call.",
921 "id": "Operation",
922 "properties": {
923 "name": {
924 "description": "The server-assigned name, which is only uniq ue within the same service that originally returns it. If you use the default HT TP mapping, the `name` should have the format of `operations/some/unique/name`." ,
925 "type": "string"
926 },
927 "metadata": {
928 "additionalProperties": {
929 "description": "Properties of the object. Contains field @ype with type URL.",
930 "type": "any"
931 },
932 "description": "Service-specific metadata associated with th e operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
933 "type": "object"
934 },
935 "done": {
936 "description": "If the value is `false`, it means the operat ion is still in progress. If true, the operation is completed, and either `error ` or `response` is available.",
937 "type": "boolean"
938 },
939 "error": {
940 "$ref": "Status",
941 "description": "The error result of the operation in case of failure."
942 },
943 "response": {
944 "additionalProperties": {
945 "description": "Properties of the object. Contains field @ype with type URL.",
946 "type": "any"
947 },
948 "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete` , the response is `google.protobuf.Empty`. If the original method is standard `G et`/`Create`/`Update`, the response should be the resource. For other methods, t he response should have the type `XxxResponse`, where `Xxx` is the original meth od name. For example, if the original method name is `TakeSnapshot()`, the infer red response type is `TakeSnapshotResponse`.",
949 "type": "object"
950 }
951 },
952 "type": "object"
953 },
954 "Status": {
955 "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designe d to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. Th e error message should be a developer-facing English message that helps develope rs *understand* and *resolve* the error. If a localized user-facing error messag e is needed, put the localized message in the error details or localize it in th e client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.r pc` which can be used for common error conditions. # Language mapping The `Statu s` message is the logical representation of the error model, but it is not neces sarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. Fo r example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` m essage can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Exampl e uses of this error model include: - Partial errors. If a service needs to retu rn partial errors to the client, it may embed the `Status` in the normal respons e to indicate the partial errors. - Workflow errors. A typical workflow has mult iple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Statu s` message should be used directly inside batch response, one for each error sub -response. - Asynchronous operations. If an API call embeds asynchronous operati on results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored i n logs, the message `Status` could be used directly after any stripping needed f or security/privacy reasons.",
956 "id": "Status",
957 "properties": {
958 "code": {
959 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
960 "format": "int32",
961 "type": "integer"
962 },
963 "message": {
964 "description": "A developer-facing error message, which shou ld be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
965 "type": "string"
966 },
967 "details": {
968 "description": "A list of messages that carry the error deta ils. There will be a common set of message types for APIs to use.",
969 "items": {
970 "additionalProperties": {
971 "description": "Properties of the object. Contains f ield @ype with type URL.",
972 "type": "any"
973 },
974 "type": "object"
975 },
976 "type": "array"
977 }
978 },
979 "type": "object"
980 },
696 "Version": { 981 "Version": {
697 "description": "A Version is a specific set of source code and confi guration files deployed to a module.", 982 "description": "A Version is a specific set of source code and confi guration files deployed to a module.",
698 "id": "Version", 983 "id": "Version",
699 "properties": { 984 "properties": {
700 "name": { 985 "name": {
701 "description": "The full path to the Version resource in the API. Example: \"apps/myapp/modules/default/versions/v1\". @OutputOnly", 986 "description": "The full path to the Version resource in the API. Example: \"apps/myapp/modules/default/versions/v1\". @OutputOnly",
702 "type": "string" 987 "type": "string"
703 }, 988 },
704 "id": { 989 "id": {
705 "description": "The relative name/path of the Version within the module. Example: \"v1\". Version specifiers can contain lowercase letters, digits, and hyphens. It cannot begin with the prefix `ah-` and the names `defaul t` and `latest` are reserved and cannot be used.", 990 "description": "The relative name/path of the Version within the module. Example: \"v1\". Version specifiers can contain lowercase letters, digits, and hyphens. It cannot begin with the prefix `ah-` and the names `defaul t` and `latest` are reserved and cannot be used.",
(...skipping 711 matching lines...) Expand 10 before | Expand all | Expand 10 after
1417 "description": "Optional. A URI string identifying the repos itory. Example: \"https://source.developers.google.com/p/app-123/r/default\"", 1702 "description": "Optional. A URI string identifying the repos itory. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
1418 "type": "string" 1703 "type": "string"
1419 }, 1704 },
1420 "revisionId": { 1705 "revisionId": {
1421 "description": "The canonical (and persistent) identifier of the deployed revision, i.e. any kind of aliases including tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"", 1706 "description": "The canonical (and persistent) identifier of the deployed revision, i.e. any kind of aliases including tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
1422 "type": "string" 1707 "type": "string"
1423 } 1708 }
1424 }, 1709 },
1425 "type": "object" 1710 "type": "object"
1426 }, 1711 },
1427 "Operation": {
1428 "description": "This resource represents a long-running operation th at is the result of a network API call.",
1429 "id": "Operation",
1430 "properties": {
1431 "name": {
1432 "description": "The server-assigned name, which is only uniq ue within the same service that originally returns it. If you use the default HT TP mapping, the `name` should have the format of `operations/some/unique/name`." ,
1433 "type": "string"
1434 },
1435 "metadata": {
1436 "additionalProperties": {
1437 "description": "Properties of the object. Contains field @ype with type URL.",
1438 "type": "any"
1439 },
1440 "description": "Service-specific metadata associated with th e operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
1441 "type": "object"
1442 },
1443 "done": {
1444 "description": "If the value is `false`, it means the operat ion is still in progress. If true, the operation is completed, and either `error ` or `response` is available.",
1445 "type": "boolean"
1446 },
1447 "error": {
1448 "$ref": "Status",
1449 "description": "The error result of the operation in case of failure."
1450 },
1451 "response": {
1452 "additionalProperties": {
1453 "description": "Properties of the object. Contains field @ype with type URL.",
1454 "type": "any"
1455 },
1456 "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete` , the response is `google.protobuf.Empty`. If the original method is standard `G et`/`Create`/`Update`, the response should be the resource. For other methods, t he response should have the type `XxxResponse`, where `Xxx` is the original meth od name. For example, if the original method name is `TakeSnapshot()`, the infer red response type is `TakeSnapshotResponse`.",
1457 "type": "object"
1458 }
1459 },
1460 "type": "object"
1461 },
1462 "Status": {
1463 "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designe d to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. Th e error message should be a developer-facing English message that helps develope rs *understand* and *resolve* the error. If a localized user-facing error messag e is needed, put the localized message in the error details or localize it in th e client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.r pc` which can be used for common error conditions. # Language mapping The `Statu s` message is the logical representation of the error model, but it is not neces sarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. Fo r example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` m essage can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Exampl e uses of this error model include: - Partial errors. If a service needs to retu rn partial errors to the client, it may embed the `Status` in the normal respons e to indicate the partial errors. - Workflow errors. A typical workflow has mult iple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Statu s` message should be used directly inside batch response, one for each error sub -response. - Asynchronous operations. If an API call embeds asynchronous operati on results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored i n logs, the message `Status` could be used directly after any stripping needed f or security/privacy reasons.",
1464 "id": "Status",
1465 "properties": {
1466 "code": {
1467 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
1468 "format": "int32",
1469 "type": "integer"
1470 },
1471 "message": {
1472 "description": "A developer-facing error message, which shou ld be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
1473 "type": "string"
1474 },
1475 "details": {
1476 "description": "A list of messages that carry the error deta ils. There will be a common set of message types for APIs to use.",
1477 "items": {
1478 "additionalProperties": {
1479 "description": "Properties of the object. Contains f ield @ype with type URL.",
1480 "type": "any"
1481 },
1482 "type": "object"
1483 },
1484 "type": "array"
1485 }
1486 },
1487 "type": "object"
1488 },
1489 "ListVersionsResponse": { 1712 "ListVersionsResponse": {
1490 "description": "Response message for `Versions.ListVersions`.", 1713 "description": "Response message for `Versions.ListVersions`.",
1491 "id": "ListVersionsResponse", 1714 "id": "ListVersionsResponse",
1492 "properties": { 1715 "properties": {
1493 "versions": { 1716 "versions": {
1494 "description": "The versions belonging to the requested appl ication module.", 1717 "description": "The versions belonging to the requested appl ication module.",
1495 "items": { 1718 "items": {
1496 "$ref": "Version" 1719 "$ref": "Version"
1497 }, 1720 },
1498 "type": "array" 1721 "type": "array"
(...skipping 59 matching lines...) Expand 10 before | Expand all | Expand 10 after
1558 }, 1781 },
1559 "type": "array" 1782 "type": "array"
1560 }, 1783 },
1561 "nextPageToken": { 1784 "nextPageToken": {
1562 "description": "Continuation token for fetching the next pag e of results.", 1785 "description": "Continuation token for fetching the next pag e of results.",
1563 "type": "string" 1786 "type": "string"
1564 } 1787 }
1565 }, 1788 },
1566 "type": "object" 1789 "type": "object"
1567 }, 1790 },
1568 "ListInstancesResponse": {
1569 "description": "Response message for `Instances.ListInstances`.",
1570 "id": "ListInstancesResponse",
1571 "properties": {
1572 "instances": {
1573 "description": "The instances belonging to the requested ver sion.",
1574 "items": {
1575 "$ref": "Instance"
1576 },
1577 "type": "array"
1578 },
1579 "nextPageToken": {
1580 "description": "Continuation token for fetching the next pag e of results.",
1581 "type": "string"
1582 }
1583 },
1584 "type": "object"
1585 },
1586 "Instance": { 1791 "Instance": {
1587 "description": "Instances are the computing units that App Engine us es to automatically scale an application.", 1792 "description": "Instances are the computing units that App Engine us es to automatically scale an application.",
1588 "id": "Instance", 1793 "id": "Instance",
1589 "properties": { 1794 "properties": {
1590 "name": { 1795 "name": {
1591 "description": "The full path to the Instance resource in th e API. Example: \"apps/myapp/modules/default/versions/v1/instances/instance-1\" @OutputOnly", 1796 "description": "The full path to the Instance resource in th e API. Example: \"apps/myapp/modules/default/versions/v1/instances/instance-1\" @OutputOnly",
1592 "type": "string" 1797 "type": "string"
1593 }, 1798 },
1594 "id": { 1799 "id": {
1595 "description": "The relative name/path of the instance withi n the version. Example: \"instance-1\" @OutputOnly", 1800 "description": "The relative name/path of the instance withi n the version. Example: \"instance-1\" @OutputOnly",
(...skipping 57 matching lines...) Expand 10 before | Expand all | Expand 10 after
1653 "description": "For VMEngines instances, the status of the C ompute Engine VM where the instance lives. @OutputOnly", 1858 "description": "For VMEngines instances, the status of the C ompute Engine VM where the instance lives. @OutputOnly",
1654 "type": "string" 1859 "type": "string"
1655 }, 1860 },
1656 "vmUnlocked": { 1861 "vmUnlocked": {
1657 "description": "For VMEngines instances, whether the instanc e has been unlocked. @OutputOnly", 1862 "description": "For VMEngines instances, whether the instanc e has been unlocked. @OutputOnly",
1658 "type": "boolean" 1863 "type": "boolean"
1659 } 1864 }
1660 }, 1865 },
1661 "type": "object" 1866 "type": "object"
1662 }, 1867 },
1868 "ListInstancesResponse": {
1869 "description": "Response message for `Instances.ListInstances`.",
1870 "id": "ListInstancesResponse",
1871 "properties": {
1872 "instances": {
1873 "description": "The instances belonging to the requested ver sion.",
1874 "items": {
1875 "$ref": "Instance"
1876 },
1877 "type": "array"
1878 },
1879 "nextPageToken": {
1880 "description": "Continuation token for fetching the next pag e of results.",
1881 "type": "string"
1882 }
1883 },
1884 "type": "object"
1885 },
1886 "DebugInstanceRequest": {
1887 "description": "Request message for `Instances.DebugInstance`.",
1888 "id": "DebugInstanceRequest",
1889 "type": "object"
1890 },
1663 "ListOperationsResponse": { 1891 "ListOperationsResponse": {
1664 "description": "The response message for Operations.ListOperations." , 1892 "description": "The response message for Operations.ListOperations." ,
1665 "id": "ListOperationsResponse", 1893 "id": "ListOperationsResponse",
1666 "properties": { 1894 "properties": {
1667 "operations": { 1895 "operations": {
1668 "description": "A list of operations that matches the specif ied filter in the request.", 1896 "description": "A list of operations that matches the specif ied filter in the request.",
1669 "items": { 1897 "items": {
1670 "$ref": "Operation" 1898 "$ref": "Operation"
1671 }, 1899 },
1672 "type": "array" 1900 "type": "array"
1673 }, 1901 },
1674 "nextPageToken": { 1902 "nextPageToken": {
1675 "description": "The standard List next-page token.", 1903 "description": "The standard List next-page token.",
1676 "type": "string" 1904 "type": "string"
1677 } 1905 }
1678 }, 1906 },
1679 "type": "object" 1907 "type": "object"
1680 }, 1908 },
1909 "ListLocationsResponse": {
1910 "description": "The response message for LocationService.ListLocatio ns.",
1911 "id": "ListLocationsResponse",
1912 "properties": {
1913 "locations": {
1914 "description": "A list of locations that matches the specifi ed filter in the request.",
1915 "items": {
1916 "$ref": "Location"
1917 },
1918 "type": "array"
1919 },
1920 "nextPageToken": {
1921 "description": "The standard List next-page token.",
1922 "type": "string"
1923 }
1924 },
1925 "type": "object"
1926 },
1927 "Location": {
1928 "description": "A resource that represents Google Cloud Platform loc ation.",
1929 "id": "Location",
1930 "properties": {
1931 "name": {
1932 "description": "Resource name for the location, which may va ry between implementations. Example: `\"projects/example-project/locations/us-ea st1\"`",
1933 "type": "string"
1934 },
1935 "labels": {
1936 "additionalProperties": {
1937 "type": "string"
1938 },
1939 "description": "Cross-service attributes for the location. F or example {\"cloud.googleapis.com/region\": \"us-east1\"}",
1940 "type": "object"
1941 },
1942 "metadata": {
1943 "additionalProperties": {
1944 "description": "Properties of the object. Contains field @ype with type URL.",
1945 "type": "any"
1946 },
1947 "description": "Service-specific metadata. For example the a vailable capacity at the given location.",
1948 "type": "object"
1949 }
1950 },
1951 "type": "object"
1952 },
1681 "OperationMetadata": { 1953 "OperationMetadata": {
1682 "description": "Metadata for the given google.longrunning.Operation. ", 1954 "description": "Metadata for the given google.longrunning.Operation. ",
1683 "id": "OperationMetadata", 1955 "id": "OperationMetadata",
1684 "properties": { 1956 "properties": {
1685 "operationType": { 1957 "operationType": {
1686 "description": "The type of the operation (deprecated, use m ethod field instead). Example: \"create_version\". @OutputOnly", 1958 "description": "The type of the operation (deprecated, use m ethod field instead). Example: \"create_version\". @OutputOnly",
1687 "type": "string" 1959 "type": "string"
1688 }, 1960 },
1689 "insertTime": { 1961 "insertTime": {
1690 "description": "Timestamp that this operation was received. @OutputOnly", 1962 "description": "Timestamp that this operation was received. @OutputOnly",
(...skipping 75 matching lines...) Expand 10 before | Expand all | Expand 10 after
1766 "LocationMetadata": { 2038 "LocationMetadata": {
1767 "description": "Metadata for the given google.cloud.location.Locatio n.", 2039 "description": "Metadata for the given google.cloud.location.Locatio n.",
1768 "id": "LocationMetadata", 2040 "id": "LocationMetadata",
1769 "type": "object" 2041 "type": "object"
1770 } 2042 }
1771 }, 2043 },
1772 "servicePath": "", 2044 "servicePath": "",
1773 "title": "Google App Engine Admin API", 2045 "title": "Google App Engine Admin API",
1774 "version": "v1beta4" 2046 "version": "v1beta4"
1775 } 2047 }
OLDNEW
« no previous file with comments | « discovery/googleapis_beta/adexchangebuyer2__v2beta1.json ('k') | discovery/googleapis_beta/appengine__v1beta5.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698