Index: discovery/googleapis/servicemanagement__v1.json |
diff --git a/discovery/googleapis/servicemanagement__v1.json b/discovery/googleapis/servicemanagement__v1.json |
index 9cf79cf27483e62f365d3b72d14a74428ef64363..05c2586ec6c0f0664c53c731195c13204049f15a 100644 |
--- a/discovery/googleapis/servicemanagement__v1.json |
+++ b/discovery/googleapis/servicemanagement__v1.json |
@@ -34,27 +34,6 @@ |
"ownerDomain": "google.com", |
"ownerName": "Google", |
"parameters": { |
- "quotaUser": { |
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
- "location": "query", |
- "type": "string" |
- }, |
- "pp": { |
- "default": "true", |
- "description": "Pretty-print response.", |
- "location": "query", |
- "type": "boolean" |
- }, |
- "bearer_token": { |
- "description": "OAuth bearer token.", |
- "location": "query", |
- "type": "string" |
- }, |
- "oauth_token": { |
- "description": "OAuth 2.0 token for the current user.", |
- "location": "query", |
- "type": "string" |
- }, |
"upload_protocol": { |
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
"location": "query", |
@@ -66,13 +45,13 @@ |
"location": "query", |
"type": "boolean" |
}, |
- "fields": { |
- "description": "Selector specifying which fields to include in a partial response.", |
+ "uploadType": { |
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
"location": "query", |
"type": "string" |
}, |
- "uploadType": { |
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
+ "fields": { |
+ "description": "Selector specifying which fields to include in a partial response.", |
"location": "query", |
"type": "string" |
}, |
@@ -110,13 +89,34 @@ |
"location": "query", |
"type": "string" |
}, |
+ "key": { |
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
"access_token": { |
"description": "OAuth access token.", |
"location": "query", |
"type": "string" |
}, |
- "key": { |
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", |
+ "quotaUser": { |
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "pp": { |
+ "default": "true", |
+ "description": "Pretty-print response.", |
+ "location": "query", |
+ "type": "boolean" |
+ }, |
+ "bearer_token": { |
+ "description": "OAuth bearer token.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "oauth_token": { |
+ "description": "OAuth 2.0 token for the current user.", |
"location": "query", |
"type": "string" |
} |
@@ -125,34 +125,6 @@ |
"resources": { |
"services": { |
"methods": { |
- "setIamPolicy": { |
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", |
- "httpMethod": "POST", |
- "id": "servicemanagement.services.setIamPolicy", |
- "parameterOrder": [ |
- "resource" |
- ], |
- "parameters": { |
- "resource": { |
- "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.", |
- "location": "path", |
- "pattern": "^services/[^/]+$", |
- "required": true, |
- "type": "string" |
- } |
- }, |
- "path": "v1/{+resource}:setIamPolicy", |
- "request": { |
- "$ref": "SetIamPolicyRequest" |
- }, |
- "response": { |
- "$ref": "Policy" |
- }, |
- "scopes": [ |
- "https://www.googleapis.com/auth/cloud-platform", |
- "https://www.googleapis.com/auth/service.management" |
- ] |
- }, |
"disable": { |
"description": "Disable a managed service for a project.\n\nOperation<response: DisableServiceResponse>", |
"httpMethod": "POST", |
@@ -442,65 +414,39 @@ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/service.management" |
] |
+ }, |
+ "setIamPolicy": { |
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", |
+ "httpMethod": "POST", |
+ "id": "servicemanagement.services.setIamPolicy", |
+ "parameterOrder": [ |
+ "resource" |
+ ], |
+ "parameters": { |
+ "resource": { |
+ "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.", |
+ "location": "path", |
+ "pattern": "^services/[^/]+$", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "v1/{+resource}:setIamPolicy", |
+ "request": { |
+ "$ref": "SetIamPolicyRequest" |
+ }, |
+ "response": { |
+ "$ref": "Policy" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/cloud-platform", |
+ "https://www.googleapis.com/auth/service.management" |
+ ] |
} |
}, |
"resources": { |
"configs": { |
"methods": { |
- "create": { |
- "description": "Creates a new service configuration (version) for a managed service.\nThis method only stores the service configuration. To roll out the service\nconfiguration to backend systems please call\nCreateServiceRollout.", |
- "httpMethod": "POST", |
- "id": "servicemanagement.services.configs.create", |
- "parameterOrder": [ |
- "serviceName" |
- ], |
- "parameters": { |
- "serviceName": { |
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- } |
- }, |
- "path": "v1/services/{serviceName}/configs", |
- "request": { |
- "$ref": "Service" |
- }, |
- "response": { |
- "$ref": "Service" |
- }, |
- "scopes": [ |
- "https://www.googleapis.com/auth/cloud-platform", |
- "https://www.googleapis.com/auth/service.management" |
- ] |
- }, |
- "submit": { |
- "description": "Creates a new service configuration (version) for a managed service based\non\nuser-supplied configuration source files (for example: OpenAPI\nSpecification). This method stores the source configurations as well as the\ngenerated service configuration. To rollout the service configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperation<response: SubmitConfigSourceResponse>", |
- "httpMethod": "POST", |
- "id": "servicemanagement.services.configs.submit", |
- "parameterOrder": [ |
- "serviceName" |
- ], |
- "parameters": { |
- "serviceName": { |
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- } |
- }, |
- "path": "v1/services/{serviceName}/configs:submit", |
- "request": { |
- "$ref": "SubmitConfigSourceRequest" |
- }, |
- "response": { |
- "$ref": "Operation" |
- }, |
- "scopes": [ |
- "https://www.googleapis.com/auth/cloud-platform", |
- "https://www.googleapis.com/auth/service.management" |
- ] |
- }, |
"list": { |
"description": "Lists the history of the service configuration for a managed service,\nfrom the newest to the oldest.", |
"httpMethod": "GET", |
@@ -570,15 +516,11 @@ |
"https://www.googleapis.com/auth/service.management", |
"https://www.googleapis.com/auth/service.management.readonly" |
] |
- } |
- } |
- }, |
- "rollouts": { |
- "methods": { |
+ }, |
"create": { |
- "description": "Creates a new service configuration rollout. Based on rollout, the\nGoogle Service Management will roll out the service configurations to\ndifferent backend services. For example, the logging configuration will be\npushed to Google Cloud Logging.\n\nPlease note that any previous pending and running Rollouts and associated\nOperations will be automatically cancelled so that the latest Rollout will\nnot be blocked by previous Rollouts.\n\nOperation<response: Rollout>", |
+ "description": "Creates a new service configuration (version) for a managed service.\nThis method only stores the service configuration. To roll out the service\nconfiguration to backend systems please call\nCreateServiceRollout.", |
"httpMethod": "POST", |
- "id": "servicemanagement.services.rollouts.create", |
+ "id": "servicemanagement.services.configs.create", |
"parameterOrder": [ |
"serviceName" |
], |
@@ -590,22 +532,22 @@ |
"type": "string" |
} |
}, |
- "path": "v1/services/{serviceName}/rollouts", |
+ "path": "v1/services/{serviceName}/configs", |
"request": { |
- "$ref": "Rollout" |
+ "$ref": "Service" |
}, |
"response": { |
- "$ref": "Operation" |
+ "$ref": "Service" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/service.management" |
] |
}, |
- "list": { |
- "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest.", |
- "httpMethod": "GET", |
- "id": "servicemanagement.services.rollouts.list", |
+ "submit": { |
+ "description": "Creates a new service configuration (version) for a managed service based\non\nuser-supplied configuration source files (for example: OpenAPI\nSpecification). This method stores the source configurations as well as the\ngenerated service configuration. To rollout the service configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperation<response: SubmitConfigSourceResponse>", |
+ "httpMethod": "POST", |
+ "id": "servicemanagement.services.configs.submit", |
"parameterOrder": [ |
"serviceName" |
], |
@@ -615,7 +557,32 @@ |
"location": "path", |
"required": true, |
"type": "string" |
- }, |
+ } |
+ }, |
+ "path": "v1/services/{serviceName}/configs:submit", |
+ "request": { |
+ "$ref": "SubmitConfigSourceRequest" |
+ }, |
+ "response": { |
+ "$ref": "Operation" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/cloud-platform", |
+ "https://www.googleapis.com/auth/service.management" |
+ ] |
+ } |
+ } |
+ }, |
+ "rollouts": { |
+ "methods": { |
+ "list": { |
+ "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest.", |
+ "httpMethod": "GET", |
+ "id": "servicemanagement.services.rollouts.list", |
+ "parameterOrder": [ |
+ "serviceName" |
+ ], |
+ "parameters": { |
"pageToken": { |
"description": "The token of the page to retrieve.", |
"location": "query", |
@@ -626,6 +593,12 @@ |
"format": "int32", |
"location": "query", |
"type": "integer" |
+ }, |
+ "serviceName": { |
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
} |
}, |
"path": "v1/services/{serviceName}/rollouts", |
@@ -648,14 +621,14 @@ |
"rolloutId" |
], |
"parameters": { |
- "serviceName": { |
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", |
+ "rolloutId": { |
+ "description": "The id of the rollout resource.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
- "rolloutId": { |
- "description": "The id of the rollout resource.", |
+ "serviceName": { |
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", |
"location": "path", |
"required": true, |
"type": "string" |
@@ -671,6 +644,33 @@ |
"https://www.googleapis.com/auth/service.management", |
"https://www.googleapis.com/auth/service.management.readonly" |
] |
+ }, |
+ "create": { |
+ "description": "Creates a new service configuration rollout. Based on rollout, the\nGoogle Service Management will roll out the service configurations to\ndifferent backend services. For example, the logging configuration will be\npushed to Google Cloud Logging.\n\nPlease note that any previous pending and running Rollouts and associated\nOperations will be automatically cancelled so that the latest Rollout will\nnot be blocked by previous Rollouts.\n\nOperation<response: Rollout>", |
+ "httpMethod": "POST", |
+ "id": "servicemanagement.services.rollouts.create", |
+ "parameterOrder": [ |
+ "serviceName" |
+ ], |
+ "parameters": { |
+ "serviceName": { |
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "v1/services/{serviceName}/rollouts", |
+ "request": { |
+ "$ref": "Rollout" |
+ }, |
+ "response": { |
+ "$ref": "Operation" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/cloud-platform", |
+ "https://www.googleapis.com/auth/service.management" |
+ ] |
} |
} |
} |
@@ -706,31 +706,9 @@ |
} |
} |
}, |
- "revision": "20170117", |
+ "revision": "20170209", |
"rootUrl": "https://servicemanagement.googleapis.com/", |
"schemas": { |
- "DisableServiceRequest": { |
- "description": "Request message for DisableService method.", |
- "id": "DisableServiceRequest", |
- "properties": { |
- "consumerId": { |
- "description": "The identity of consumer resource which service disablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:<project_id>\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.", |
- "type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "SubmitConfigSourceResponse": { |
- "description": "Response message for SubmitConfigSource method.", |
- "id": "SubmitConfigSourceResponse", |
- "properties": { |
- "serviceConfig": { |
- "$ref": "Service", |
- "description": "The generated service configuration." |
- } |
- }, |
- "type": "object" |
- }, |
"MediaUpload": { |
"description": "Do not use this. For media support, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration.", |
"id": "MediaUpload", |
@@ -772,12 +750,27 @@ |
"description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer 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_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true", |
"id": "UsageRule", |
"properties": { |
+ "selector": { |
+ "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.", |
+ "type": "string" |
+ }, |
"allowUnregisteredCalls": { |
"description": "True, if the method allows unregistered calls; false otherwise.", |
"type": "boolean" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "AuthRequirement": { |
+ "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).", |
+ "id": "AuthRequirement", |
+ "properties": { |
+ "audiences": { |
+ "description": "NOTE: This will be deprecated soon, once AuthProvider.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-json-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 with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com", |
+ "type": "string" |
}, |
- "selector": { |
- "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.", |
+ "providerId": { |
+ "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth", |
"type": "string" |
} |
}, |
@@ -798,29 +791,10 @@ |
}, |
"type": "object" |
}, |
- "AuthRequirement": { |
- "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).", |
- "id": "AuthRequirement", |
- "properties": { |
- "audiences": { |
- "description": "NOTE: This will be deprecated soon, once AuthProvider.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-json-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 with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com", |
- "type": "string" |
- }, |
- "providerId": { |
- "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth", |
- "type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
"Condition": { |
"description": "A condition to be met.", |
"id": "Condition", |
"properties": { |
- "value": { |
- "description": "DEPRECATED. Use 'values' instead.", |
- "type": "string" |
- }, |
"sys": { |
"description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.", |
"enum": [ |
@@ -839,6 +813,10 @@ |
], |
"type": "string" |
}, |
+ "value": { |
+ "description": "DEPRECATED. Use 'values' instead.", |
+ "type": "string" |
+ }, |
"values": { |
"description": "The objects of the condition. This is mutually exclusive with 'value'.", |
"items": { |
@@ -891,6 +869,10 @@ |
"description": "`Documentation` provides the information for describing a service.\n\nExample:\n<pre><code>documentation:\n summary: >\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: >\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\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n<pre><code>[fully.qualified.proto.name][]</code></pre>\nTo override the display text used for the link, this can be used:\n<pre><code>[display text][fully.qualified.proto.name]</code></pre>\nText can be excluded from doc using the following notation:\n<pre><code>(-- internal comment --)</code></pre>\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n<pre><code>(--BETA: comment for BETA users --)</code></pre>\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n<pre><code>(== include path/to/file ==)</code></pre>\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n<pre><code>(== resource_for v1.shelves.books ==)</code></pre>\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.", |
"id": "Documentation", |
"properties": { |
+ "summary": { |
+ "description": "A short summary of what the service does. Can only be provided by\nplain text.", |
+ "type": "string" |
+ }, |
"documentationRootUrl": { |
"description": "The URL to the root of documentation.", |
"type": "string" |
@@ -912,10 +894,6 @@ |
"$ref": "Page" |
}, |
"type": "array" |
- }, |
- "summary": { |
- "description": "A short summary of what the service does. Can only be provided by\nplain text.", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -954,16 +932,16 @@ |
"description": "Represents a source file which is used to generate the service configuration\ndefined by `google.api.Service`.", |
"id": "ConfigSource", |
"properties": { |
+ "id": { |
+ "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.", |
+ "type": "string" |
+ }, |
"files": { |
"description": "Set of source configuration files that are used to generate a service\nconfiguration (`google.api.Service`).", |
"items": { |
"$ref": "ConfigFile" |
}, |
"type": "array" |
- }, |
- "id": { |
- "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -992,14 +970,6 @@ |
"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 more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.", |
"id": "AuthenticationRule", |
"properties": { |
- "selector": { |
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.", |
- "type": "string" |
- }, |
- "allowWithoutCredential": { |
- "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment 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\nproject.", |
- "type": "boolean" |
- }, |
"oauth": { |
"$ref": "OAuthRequirements", |
"description": "The requirements for OAuth credentials." |
@@ -1010,17 +980,14 @@ |
"$ref": "AuthRequirement" |
}, |
"type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "UndeleteServiceResponse": { |
- "description": "Response message for UndeleteService method.", |
- "id": "UndeleteServiceResponse", |
- "properties": { |
- "service": { |
- "$ref": "ManagedService", |
- "description": "Revived service resource." |
+ }, |
+ "selector": { |
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.", |
+ "type": "string" |
+ }, |
+ "allowWithoutCredential": { |
+ "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment 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\nproject.", |
+ "type": "boolean" |
} |
}, |
"type": "object" |
@@ -1029,11 +996,6 @@ |
"description": "Defines an Identity and Access Management (IAM) policy. 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,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined 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.gserviceaccount.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).", |
"id": "Policy", |
"properties": { |
- "version": { |
- "description": "Version of the `Policy`. The default version is 0.", |
- "format": "int32", |
- "type": "integer" |
- }, |
"auditConfigs": { |
"description": "Specifies cloud audit logging configuration for this policy.", |
"items": { |
@@ -1062,6 +1024,22 @@ |
"$ref": "Rule" |
}, |
"type": "array" |
+ }, |
+ "version": { |
+ "description": "Version of the `Policy`. The default version is 0.", |
+ "format": "int32", |
+ "type": "integer" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "UndeleteServiceResponse": { |
+ "description": "Response message for UndeleteService method.", |
+ "id": "UndeleteServiceResponse", |
+ "properties": { |
+ "service": { |
+ "$ref": "ManagedService", |
+ "description": "Revived service resource." |
} |
}, |
"type": "object" |
@@ -1149,6 +1127,18 @@ |
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", |
"id": "Operation", |
"properties": { |
+ "metadata": { |
+ "additionalProperties": { |
+ "description": "Properties of the object. Contains field @type with type URL.", |
+ "type": "any" |
+ }, |
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", |
+ "type": "object" |
+ }, |
+ "done": { |
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.", |
+ "type": "boolean" |
+ }, |
"response": { |
"additionalProperties": { |
"description": "Properties of the object. Contains field @type with type URL.", |
@@ -1164,18 +1154,6 @@ |
"error": { |
"$ref": "Status", |
"description": "The error result of the operation in case of failure or cancellation." |
- }, |
- "metadata": { |
- "additionalProperties": { |
- "description": "Properties of the object. Contains field @type with type URL.", |
- "type": "any" |
- }, |
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", |
- "type": "object" |
- }, |
- "done": { |
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.", |
- "type": "boolean" |
} |
}, |
"type": "object" |
@@ -1184,13 +1162,6 @@ |
"description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.", |
"id": "Page", |
"properties": { |
- "subpages": { |
- "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.", |
- "items": { |
- "$ref": "Page" |
- }, |
- "type": "array" |
- }, |
"name": { |
"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\ndocumentation. For example:\n<pre><code>pages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n</code></pre>\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.", |
"type": "string" |
@@ -1198,6 +1169,13 @@ |
"content": { |
"description": "The Markdown content of the page. You can use <code>(== include {path} ==)</code>\nto include content from a Markdown file.", |
"type": "string" |
+ }, |
+ "subpages": { |
+ "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.", |
+ "items": { |
+ "$ref": "Page" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
@@ -1206,6 +1184,15 @@ |
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should 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 that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\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\ninformation 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# Language 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` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\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\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.", |
"id": "Status", |
"properties": { |
+ "code": { |
+ "description": "The status code, which should be an enum value of google.rpc.Code.", |
+ "format": "int32", |
+ "type": "integer" |
+ }, |
+ "message": { |
+ "description": "A developer-facing error message, which should 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.", |
+ "type": "string" |
+ }, |
"details": { |
"description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.", |
"items": { |
@@ -1216,15 +1203,6 @@ |
"type": "object" |
}, |
"type": "array" |
- }, |
- "code": { |
- "description": "The status code, which should be an enum value of google.rpc.Code.", |
- "format": "int32", |
- "type": "integer" |
- }, |
- "message": { |
- "description": "A developer-facing error message, which should 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.", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -1251,14 +1229,6 @@ |
"description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", |
"id": "AuthProvider", |
"properties": { |
- "jwksUri": { |
- "description": "URL of the provider's public key set to validate signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set document:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/openid-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", |
- "type": "string" |
- }, |
- "audiences": { |
- "description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-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 with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com", |
- "type": "string" |
- }, |
"id": { |
"description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\".", |
"type": "string" |
@@ -1266,37 +1236,69 @@ |
"issuer": { |
"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.com\nExample: 1234567-compute@developer.gserviceaccount.com", |
"type": "string" |
+ }, |
+ "jwksUri": { |
+ "description": "URL of the provider's public key set to validate signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set document:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/openid-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", |
+ "type": "string" |
+ }, |
+ "audiences": { |
+ "description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-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 with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com", |
+ "type": "string" |
} |
}, |
"type": "object" |
}, |
- "EnumValue": { |
- "description": "Enum value definition.", |
- "id": "EnumValue", |
+ "Service": { |
+ "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name 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\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\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.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth", |
+ "id": "Service", |
"properties": { |
- "name": { |
- "description": "Enum value name.", |
- "type": "string" |
+ "usage": { |
+ "$ref": "Usage", |
+ "description": "Configuration controlling usage of this service." |
}, |
- "options": { |
- "description": "Protocol buffer options.", |
+ "metrics": { |
+ "description": "Defines the metrics used by this service.", |
"items": { |
- "$ref": "Option" |
+ "$ref": "MetricDescriptor" |
}, |
"type": "array" |
}, |
- "number": { |
- "description": "Enum value number.", |
- "format": "int32", |
+ "authentication": { |
+ "$ref": "Authentication", |
+ "description": "Auth configuration." |
+ }, |
+ "control": { |
+ "$ref": "Control", |
+ "description": "Configuration for the service control plane." |
+ }, |
+ "configVersion": { |
+ "description": "The version of the service configuration. The 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`.", |
+ "format": "uint32", |
"type": "integer" |
- } |
- }, |
- "type": "object" |
- }, |
- "Service": { |
- "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name 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\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\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.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth", |
- "id": "Service", |
- "properties": { |
+ }, |
+ "monitoring": { |
+ "$ref": "Monitoring", |
+ "description": "Monitoring configuration." |
+ }, |
+ "producerProjectId": { |
+ "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.", |
+ "type": "string" |
+ }, |
+ "systemTypes": { |
+ "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except 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.", |
+ "items": { |
+ "$ref": "Type" |
+ }, |
+ "type": "array" |
+ }, |
+ "visibility": { |
+ "$ref": "Visibility", |
+ "description": "API visibility configuration." |
+ }, |
+ "name": { |
+ "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.", |
+ "type": "string" |
+ }, |
"customError": { |
"$ref": "CustomError", |
"description": "Custom error configuration." |
@@ -1349,6 +1351,10 @@ |
"$ref": "Documentation", |
"description": "Additional API documentation." |
}, |
+ "logging": { |
+ "$ref": "Logging", |
+ "description": "Logging configuration." |
+ }, |
"monitoredResources": { |
"description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.", |
"items": { |
@@ -1356,14 +1362,6 @@ |
}, |
"type": "array" |
}, |
- "logging": { |
- "$ref": "Logging", |
- "description": "Logging configuration." |
- }, |
- "context": { |
- "$ref": "Context", |
- "description": "Context configuration." |
- }, |
"enums": { |
"description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\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.SomeEnum", |
"items": { |
@@ -1371,56 +1369,36 @@ |
}, |
"type": "array" |
}, |
+ "context": { |
+ "$ref": "Context", |
+ "description": "Context configuration." |
+ }, |
"id": { |
"description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.", |
"type": "string" |
- }, |
- "usage": { |
- "$ref": "Usage", |
- "description": "Configuration controlling usage of this service." |
- }, |
- "metrics": { |
- "description": "Defines the metrics used by this service.", |
- "items": { |
- "$ref": "MetricDescriptor" |
- }, |
- "type": "array" |
- }, |
- "authentication": { |
- "$ref": "Authentication", |
- "description": "Auth configuration." |
- }, |
- "control": { |
- "$ref": "Control", |
- "description": "Configuration for the service control plane." |
- }, |
- "configVersion": { |
- "description": "The version of the service configuration. The 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`.", |
- "format": "uint32", |
- "type": "integer" |
- }, |
- "monitoring": { |
- "$ref": "Monitoring", |
- "description": "Monitoring configuration." |
- }, |
- "producerProjectId": { |
- "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.", |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "EnumValue": { |
+ "description": "Enum value definition.", |
+ "id": "EnumValue", |
+ "properties": { |
+ "name": { |
+ "description": "Enum value name.", |
"type": "string" |
}, |
- "systemTypes": { |
- "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except 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.", |
+ "options": { |
+ "description": "Protocol buffer options.", |
"items": { |
- "$ref": "Type" |
+ "$ref": "Option" |
}, |
"type": "array" |
}, |
- "visibility": { |
- "$ref": "Visibility", |
- "description": "API visibility configuration." |
- }, |
- "name": { |
- "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.", |
- "type": "string" |
+ "number": { |
+ "description": "Enum value number.", |
+ "format": "int32", |
+ "type": "integer" |
} |
}, |
"type": "object" |
@@ -1429,11 +1407,6 @@ |
"description": "The metadata associated with a long running operation resource.", |
"id": "OperationMetadata", |
"properties": { |
- "progressPercentage": { |
- "description": "Percentage of completion of this operation, ranging from 0 to 100.", |
- "format": "int32", |
- "type": "integer" |
- }, |
"startTime": { |
"description": "The start time of the operation.", |
"format": "google-datetime", |
@@ -1452,6 +1425,11 @@ |
"$ref": "Step" |
}, |
"type": "array" |
+ }, |
+ "progressPercentage": { |
+ "description": "Percentage of completion of this operation, ranging from 0 to 100.", |
+ "format": "int32", |
+ "type": "integer" |
} |
}, |
"type": "object" |
@@ -1460,13 +1438,13 @@ |
"description": "A custom pattern is used for defining custom HTTP verb.", |
"id": "CustomHttpPattern", |
"properties": { |
- "kind": { |
- "description": "The name of this custom HTTP verb.", |
- "type": "string" |
- }, |
"path": { |
"description": "The path matched by this custom verb.", |
"type": "string" |
+ }, |
+ "kind": { |
+ "description": "The name of this custom HTTP verb.", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -1508,6 +1486,18 @@ |
"description": "`HttpRule` defines the mapping of an RPC method to one 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 request. 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 refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: <proto_package_name>.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, 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 primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) 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; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it assumes there is no HTTP body.\n2. Leaf fields (recursive 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 field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" 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) Section 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;\nthis nested template must not contain further variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.\n\nUse CustomHttpPattern to specify any HTTP 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 rule is useful for services that provide\ncontent to Web (HTML) clients.", |
"id": "HttpRule", |
"properties": { |
+ "body": { |
+ "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 path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.", |
+ "type": "string" |
+ }, |
+ "mediaDownload": { |
+ "$ref": "MediaDownload", |
+ "description": "Do not use this. For media support, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration." |
+ }, |
+ "post": { |
+ "description": "Used for creating a resource.", |
+ "type": "string" |
+ }, |
"additionalBindings": { |
"description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).", |
"items": { |
@@ -1540,23 +1530,11 @@ |
"type": "string" |
}, |
"put": { |
- "description": "Used for updating a resource.", |
- "type": "string" |
- }, |
- "delete": { |
- "description": "Used for deleting a resource.", |
- "type": "string" |
- }, |
- "body": { |
- "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 path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.", |
- "type": "string" |
- }, |
- "mediaDownload": { |
- "$ref": "MediaDownload", |
- "description": "Do not use this. For media support, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration." |
+ "description": "Used for updating a resource.", |
+ "type": "string" |
}, |
- "post": { |
- "description": "Used for creating a resource.", |
+ "delete": { |
+ "description": "Used for deleting a resource.", |
"type": "string" |
} |
}, |
@@ -1594,21 +1572,24 @@ |
}, |
"type": "object" |
}, |
- "ConfigChange": { |
- "description": "Output generated from semantically comparing two versions of a service\nconfiguration.\n\nIncludes detailed information about a field that have changed with\napplicable advice about potential consequences for the change, such as\nbackwards-incompatibility.", |
- "id": "ConfigChange", |
+ "SystemParameters": { |
+ "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual 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 parameters.", |
+ "id": "SystemParameters", |
"properties": { |
- "oldValue": { |
- "description": "Value of the changed object in the old Service configuration,\nin JSON format. This field will not be populated if ChangeType == ADDED.", |
- "type": "string" |
- }, |
- "advices": { |
- "description": "Collection of advice provided for this change, useful for determining the\npossible impact of this change.", |
+ "rules": { |
+ "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\nExample: 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_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", |
"items": { |
- "$ref": "Advice" |
+ "$ref": "SystemParameterRule" |
}, |
"type": "array" |
- }, |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ConfigChange": { |
+ "description": "Output generated from semantically comparing two versions of a service\nconfiguration.\n\nIncludes detailed information about a field that have changed with\napplicable advice about potential consequences for the change, such as\nbackwards-incompatibility.", |
+ "id": "ConfigChange", |
+ "properties": { |
"newValue": { |
"description": "Value of the changed object in the new Service configuration,\nin JSON format. This field will not be populated if ChangeType == REMOVED.", |
"type": "string" |
@@ -1632,18 +1613,15 @@ |
"element": { |
"description": "Object hierarchy path to the change, with levels separated by a '.'\ncharacter. For repeated fields, an applicable unique identifier 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 index\nis used.\nExamples:\n- visibility.rules[selector==\"google.LibraryService.CreateBook\"].restriction\n- quota.metric_rules[selector==\"google\"].metric_costs[key==\"reads\"].value\n- logging.producer_destinations[0]", |
"type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "SystemParameters": { |
- "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual 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 parameters.", |
- "id": "SystemParameters", |
- "properties": { |
- "rules": { |
- "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\nExample: 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_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", |
+ }, |
+ "oldValue": { |
+ "description": "Value of the changed object in the old Service configuration,\nin JSON format. This field will not be populated if ChangeType == ADDED.", |
+ "type": "string" |
+ }, |
+ "advices": { |
+ "description": "Collection of advice provided for this change, useful for determining the\npossible impact of this change.", |
"items": { |
- "$ref": "SystemParameterRule" |
+ "$ref": "Advice" |
}, |
"type": "array" |
} |
@@ -1654,6 +1632,18 @@ |
"description": "A rollout resource that defines how service configuration 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 config.", |
"id": "Rollout", |
"properties": { |
+ "trafficPercentStrategy": { |
+ "$ref": "TrafficPercentStrategy", |
+ "description": "Google Service Control selects service configurations based on\ntraffic percentage." |
+ }, |
+ "createdBy": { |
+ "description": "The user who created the Rollout. Readonly.", |
+ "type": "string" |
+ }, |
+ "rolloutId": { |
+ "description": "Optional unique identifier of this Rollout. Only lower case letters, digits\n and '-' are allowed.\n\nIf not specified by client, the server will generate one. The generated id\nwill have the form of <date><revision number>, where \"date\" is the create\ndate in ISO 8601 format. \"revision number\" is a monotonically increasing\npositive number that is reset every day for each service.\nAn example of the generated rollout_id is '2016-02-16r1'", |
+ "type": "string" |
+ }, |
"deleteServiceStrategy": { |
"$ref": "DeleteServiceStrategy", |
"description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly." |
@@ -1686,18 +1676,6 @@ |
"serviceName": { |
"description": "The name of the service associated with this Rollout.", |
"type": "string" |
- }, |
- "createdBy": { |
- "description": "The user who created the Rollout. Readonly.", |
- "type": "string" |
- }, |
- "trafficPercentStrategy": { |
- "$ref": "TrafficPercentStrategy", |
- "description": "Google Service Control selects service configurations based on\ntraffic percentage." |
- }, |
- "rolloutId": { |
- "description": "Optional unique identifier of this Rollout. Only lower case letters, digits\n and '-' are allowed.\n\nIf not specified by client, the server will generate one. The generated id\nwill have the form of <date><revision number>, where \"date\" is the create\ndate in ISO 8601 format. \"revision number\" is a monotonically increasing\npositive number that is reset every day for each service.\nAn example of the generated rollout_id is '2016-02-16r1'", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -1706,20 +1684,20 @@ |
"description": "Request message for GenerateConfigReport method.", |
"id": "GenerateConfigReportRequest", |
"properties": { |
- "newConfig": { |
+ "oldConfig": { |
"additionalProperties": { |
"description": "Properties of the object. Contains field @type with type URL.", |
"type": "any" |
}, |
- "description": "Service configuration for which we want to generate the report.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service", |
+ "description": "Service configuration against which the comparison will be done.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service", |
"type": "object" |
}, |
- "oldConfig": { |
+ "newConfig": { |
"additionalProperties": { |
"description": "Properties of the object. Contains field @type with type URL.", |
"type": "any" |
}, |
- "description": "Service configuration against which the comparison will be done.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service", |
+ "description": "Service configuration for which we want to generate the report.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service", |
"type": "object" |
} |
}, |
@@ -1745,6 +1723,10 @@ |
"description": "Represents the status of one operation step.", |
"id": "Step", |
"properties": { |
+ "description": { |
+ "description": "The short description of the step.", |
+ "type": "string" |
+ }, |
"status": { |
"description": "The status code.", |
"enum": [ |
@@ -1757,17 +1739,13 @@ |
], |
"enumDescriptions": [ |
"Unspecifed code.", |
- "The step has completed without errors.", |
- "The step has not started yet.", |
- "The step is in progress.", |
- "The step has completed with errors.", |
- "The step has completed with cancellation." |
+ "The operation or step has completed without errors.", |
+ "The operation or step has not started yet.", |
+ "The operation or step is in progress.", |
+ "The operation or step has completed with errors.", |
+ "The operation or step has completed with cancellation." |
], |
"type": "string" |
- }, |
- "description": { |
- "description": "The short description of the step.", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -1840,14 +1818,6 @@ |
"description": "Method represents a method of an api.", |
"id": "Method", |
"properties": { |
- "responseStreaming": { |
- "description": "If true, the response is streamed.", |
- "type": "boolean" |
- }, |
- "name": { |
- "description": "The simple name of this method.", |
- "type": "string" |
- }, |
"requestTypeUrl": { |
"description": "A URL of the input message type.", |
"type": "string" |
@@ -1878,16 +1848,13 @@ |
"$ref": "Option" |
}, |
"type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "ConfigRef": { |
- "description": "Represents a service configuration with its name and id.", |
- "id": "ConfigRef", |
- "properties": { |
+ }, |
+ "responseStreaming": { |
+ "description": "If true, the response is streamed.", |
+ "type": "boolean" |
+ }, |
"name": { |
- "description": "Resource name of a service config. It must have the following\nformat: \"services/{service name}/configs/{config id}\".", |
+ "description": "The simple name of this method.", |
"type": "string" |
} |
}, |
@@ -1911,6 +1878,17 @@ |
}, |
"type": "object" |
}, |
+ "ConfigRef": { |
+ "description": "Represents a service configuration with its name and id.", |
+ "id": "ConfigRef", |
+ "properties": { |
+ "name": { |
+ "description": "Resource name of a service config. It must have the following\nformat: \"services/{service name}/configs/{config id}\".", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
"Mixin": { |
"description": "Declares an API to be included in this API. The including API must\nredeclare all the methods from the included API, but documentation\nand options are inherited as follows:\n\n- If after comment and whitespace stripping, 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 version of the including API plus the root path if specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n service AccessControl {\n // Get 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 // rpc GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.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 effective `Storage.GetAcl` method after inherting\ndocumentation and annotations as follows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the version in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP paths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nThis 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 }", |
"id": "Mixin", |
@@ -1930,17 +1908,17 @@ |
"description": "Customize service error responses. For example, list 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", |
"id": "CustomError", |
"properties": { |
- "rules": { |
- "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.", |
+ "types": { |
+ "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.", |
"items": { |
- "$ref": "CustomErrorRule" |
+ "type": "string" |
}, |
"type": "array" |
}, |
- "types": { |
- "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.", |
+ "rules": { |
+ "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.", |
"items": { |
- "type": "string" |
+ "$ref": "CustomErrorRule" |
}, |
"type": "array" |
} |
@@ -2006,40 +1984,10 @@ |
}, |
"type": "object" |
}, |
- "Monitoring": { |
- "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\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", |
- "id": "Monitoring", |
- "properties": { |
- "consumerDestinations": { |
- "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.", |
- "items": { |
- "$ref": "MonitoringDestination" |
- }, |
- "type": "array" |
- }, |
- "producerDestinations": { |
- "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.", |
- "items": { |
- "$ref": "MonitoringDestination" |
- }, |
- "type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
"Field": { |
"description": "A single field of a message type.", |
"id": "Field", |
"properties": { |
- "typeUrl": { |
- "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.", |
- "type": "string" |
- }, |
- "number": { |
- "description": "The field number.", |
- "format": "int32", |
- "type": "integer" |
- }, |
"kind": { |
"description": "The field type.", |
"enum": [ |
@@ -2102,10 +2050,6 @@ |
"format": "int32", |
"type": "integer" |
}, |
- "packed": { |
- "description": "Whether to use alternative packed wire representation.", |
- "type": "boolean" |
- }, |
"cardinality": { |
"description": "The field cardinality.", |
"enum": [ |
@@ -2122,6 +2066,10 @@ |
], |
"type": "string" |
}, |
+ "packed": { |
+ "description": "Whether to use alternative packed wire representation.", |
+ "type": "boolean" |
+ }, |
"defaultValue": { |
"description": "The string value of the default value of this field. Proto2 syntax only.", |
"type": "string" |
@@ -2129,6 +2077,36 @@ |
"name": { |
"description": "The field name.", |
"type": "string" |
+ }, |
+ "typeUrl": { |
+ "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.", |
+ "type": "string" |
+ }, |
+ "number": { |
+ "description": "The field number.", |
+ "format": "int32", |
+ "type": "integer" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "Monitoring": { |
+ "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\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", |
+ "id": "Monitoring", |
+ "properties": { |
+ "consumerDestinations": { |
+ "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.", |
+ "items": { |
+ "$ref": "MonitoringDestination" |
+ }, |
+ "type": "array" |
+ }, |
+ "producerDestinations": { |
+ "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.", |
+ "items": { |
+ "$ref": "MonitoringDestination" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
@@ -2151,68 +2129,39 @@ |
"description": "Enum type definition.", |
"id": "Enum", |
"properties": { |
- "sourceContext": { |
- "$ref": "SourceContext", |
- "description": "The source context." |
- }, |
- "syntax": { |
- "description": "The source syntax.", |
- "enum": [ |
- "SYNTAX_PROTO2", |
- "SYNTAX_PROTO3" |
- ], |
- "enumDescriptions": [ |
- "Syntax `proto2`.", |
- "Syntax `proto3`." |
- ], |
- "type": "string" |
- }, |
- "name": { |
- "description": "Enum type name.", |
- "type": "string" |
- }, |
- "enumvalue": { |
- "description": "Enum value definitions.", |
- "items": { |
- "$ref": "EnumValue" |
- }, |
- "type": "array" |
- }, |
"options": { |
"description": "Protocol buffer options.", |
"items": { |
"$ref": "Option" |
}, |
"type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "LabelDescriptor": { |
- "description": "A description of a label.", |
- "id": "LabelDescriptor", |
- "properties": { |
- "key": { |
- "description": "The label key.", |
- "type": "string" |
}, |
- "description": { |
- "description": "A human-readable description for the label.", |
- "type": "string" |
+ "sourceContext": { |
+ "$ref": "SourceContext", |
+ "description": "The source context." |
}, |
- "valueType": { |
- "description": "The type of data that can be assigned to the label.", |
- "enum": [ |
- "STRING", |
- "BOOL", |
- "INT64" |
+ "syntax": { |
+ "description": "The source syntax.", |
+ "enum": [ |
+ "SYNTAX_PROTO2", |
+ "SYNTAX_PROTO3" |
], |
"enumDescriptions": [ |
- "A variable-length string. This is the default.", |
- "Boolean; true or false.", |
- "A 64-bit signed integer." |
+ "Syntax `proto2`.", |
+ "Syntax `proto3`." |
], |
"type": "string" |
+ }, |
+ "name": { |
+ "description": "Enum type name.", |
+ "type": "string" |
+ }, |
+ "enumvalue": { |
+ "description": "Enum value definitions.", |
+ "items": { |
+ "$ref": "EnumValue" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
@@ -2255,6 +2204,35 @@ |
}, |
"type": "object" |
}, |
+ "LabelDescriptor": { |
+ "description": "A description of a label.", |
+ "id": "LabelDescriptor", |
+ "properties": { |
+ "key": { |
+ "description": "The label key.", |
+ "type": "string" |
+ }, |
+ "description": { |
+ "description": "A human-readable description for the label.", |
+ "type": "string" |
+ }, |
+ "valueType": { |
+ "description": "The type of data that can be assigned to the label.", |
+ "enum": [ |
+ "STRING", |
+ "BOOL", |
+ "INT64" |
+ ], |
+ "enumDescriptions": [ |
+ "A variable-length string. This is the default.", |
+ "Boolean; true or false.", |
+ "A 64-bit signed integer." |
+ ], |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
"GenerateConfigReportResponse": { |
"description": "Response message for GenerateConfigReport method.", |
"id": "GenerateConfigReportResponse", |
@@ -2288,6 +2266,24 @@ |
"description": "A protocol buffer message type.", |
"id": "Type", |
"properties": { |
+ "fields": { |
+ "description": "The list of fields.", |
+ "items": { |
+ "$ref": "Field" |
+ }, |
+ "type": "array" |
+ }, |
+ "name": { |
+ "description": "The fully qualified message name.", |
+ "type": "string" |
+ }, |
+ "oneofs": { |
+ "description": "The list of types appearing in `oneof` definitions in this type.", |
+ "items": { |
+ "type": "string" |
+ }, |
+ "type": "array" |
+ }, |
"syntax": { |
"description": "The source syntax.", |
"enum": [ |
@@ -2310,24 +2306,6 @@ |
"$ref": "Option" |
}, |
"type": "array" |
- }, |
- "fields": { |
- "description": "The list of fields.", |
- "items": { |
- "$ref": "Field" |
- }, |
- "type": "array" |
- }, |
- "name": { |
- "description": "The fully qualified message name.", |
- "type": "string" |
- }, |
- "oneofs": { |
- "description": "The list of types appearing in `oneof` definitions in this type.", |
- "items": { |
- "type": "string" |
- }, |
- "type": "array" |
} |
}, |
"type": "object" |
@@ -2336,30 +2314,16 @@ |
"description": "Response message for ListServiceConfigs method.", |
"id": "ListServiceConfigsResponse", |
"properties": { |
- "nextPageToken": { |
- "description": "The token of the next page of results.", |
- "type": "string" |
- }, |
"serviceConfigs": { |
"description": "The list of service configuration resources.", |
"items": { |
"$ref": "Service" |
}, |
"type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "Backend": { |
- "description": "`Backend` defines the backend configuration for a service.", |
- "id": "Backend", |
- "properties": { |
- "rules": { |
- "description": "A list of API backend rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", |
- "items": { |
- "$ref": "BackendRule" |
- }, |
- "type": "array" |
+ }, |
+ "nextPageToken": { |
+ "description": "The token of the next page of results.", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -2368,10 +2332,6 @@ |
"description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, are exempted from logging.\nAn AuditConifg must have one or more AuditLogConfigs.", |
"id": "AuditConfig", |
"properties": { |
- "service": { |
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServices` is a special value that covers all services.", |
- "type": "string" |
- }, |
"auditLogConfigs": { |
"description": "The configuration for logging of each type of permission.\nNext ID: 4", |
"items": { |
@@ -2385,6 +2345,24 @@ |
"type": "string" |
}, |
"type": "array" |
+ }, |
+ "service": { |
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServices` is a special value that covers all services.", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "Backend": { |
+ "description": "`Backend` defines the backend configuration for a service.", |
+ "id": "Backend", |
+ "properties": { |
+ "rules": { |
+ "description": "A list of API backend rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", |
+ "items": { |
+ "$ref": "BackendRule" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
@@ -2393,13 +2371,13 @@ |
"description": "Request message for SubmitConfigSource method.", |
"id": "SubmitConfigSourceRequest", |
"properties": { |
- "validateOnly": { |
- "description": "Optional. If set, this will result in the generation of a\n`google.api.Service` configuration based on the `ConfigSource` provided,\nbut the generated config and the sources will NOT be persisted.", |
- "type": "boolean" |
- }, |
"configSource": { |
"$ref": "ConfigSource", |
"description": "The source configuration for the service." |
+ }, |
+ "validateOnly": { |
+ "description": "Optional. If set, this will result in the generation of a\n`google.api.Service` configuration based on the `ConfigSource` provided,\nbut the generated config and the sources will NOT be persisted.", |
+ "type": "boolean" |
} |
}, |
"type": "object" |
@@ -2433,10 +2411,6 @@ |
"description": "A context rule provides information about the context for an individual API\nelement.", |
"id": "ContextRule", |
"properties": { |
- "selector": { |
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.", |
- "type": "string" |
- }, |
"provided": { |
"description": "A list of full type names of provided contexts.", |
"items": { |
@@ -2450,6 +2424,10 @@ |
"type": "string" |
}, |
"type": "array" |
+ }, |
+ "selector": { |
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -2469,6 +2447,33 @@ |
"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.", |
"id": "MetricDescriptor", |
"properties": { |
+ "description": { |
+ "description": "A detailed description of the metric, which can be used in documentation.", |
+ "type": "string" |
+ }, |
+ "displayName": { |
+ "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".", |
+ "type": "string" |
+ }, |
+ "unit": { |
+ "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](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` hour\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` yocto (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 includes 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 | Annotation\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 ASCII characters not\n containing '{' or '}'.", |
+ "type": "string" |
+ }, |
+ "labels": { |
+ "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.", |
+ "items": { |
+ "$ref": "LabelDescriptor" |
+ }, |
+ "type": "array" |
+ }, |
+ "name": { |
+ "description": "The resource name of the metric descriptor. Depending on the\nimplementation, the name typically includes: (1) the parent resource name\nthat defines the scope of the metric type or of its data; and (2) the\nmetric's URL-encoded type, which also appears in the `type` field of this\ndescriptor. For example, following is the resource name of a custom\nmetric within the GCP project `my-project-id`:\n\n \"projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount\"", |
+ "type": "string" |
+ }, |
+ "type": { |
+ "description": "The metric type, including its DNS name prefix. 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 hierarchical\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"\n \"appengine.googleapis.com/http/server/response_latencies\"", |
+ "type": "string" |
+ }, |
"valueType": { |
"description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.", |
"enum": [ |
@@ -2506,33 +2511,6 @@ |
"A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints." |
], |
"type": "string" |
- }, |
- "description": { |
- "description": "A detailed description of the metric, which can be used in documentation.", |
- "type": "string" |
- }, |
- "displayName": { |
- "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".", |
- "type": "string" |
- }, |
- "unit": { |
- "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](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` hour\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` yocto (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 includes 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 | Annotation\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 ASCII characters not\n containing '{' or '}'.", |
- "type": "string" |
- }, |
- "labels": { |
- "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.", |
- "items": { |
- "$ref": "LabelDescriptor" |
- }, |
- "type": "array" |
- }, |
- "name": { |
- "description": "The resource name of the metric descriptor. Depending on the\nimplementation, the name typically includes: (1) the parent resource name\nthat defines the scope of the metric type or of its data; and (2) the\nmetric's URL-encoded type, which also appears in the `type` field of this\ndescriptor. For example, following is the resource name of a custom\nmetric within the GCP project `my-project-id`:\n\n \"projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount\"", |
- "type": "string" |
- }, |
- "type": { |
- "description": "The metric type, including its DNS name prefix. 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 hierarchical\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"\n \"appengine.googleapis.com/http/server/response_latencies\"", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -2559,17 +2537,6 @@ |
"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 monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true", |
"id": "Endpoint", |
"properties": { |
- "name": { |
- "description": "The canonical name of this endpoint.", |
- "type": "string" |
- }, |
- "apis": { |
- "description": "The list of APIs served by this endpoint.", |
- "items": { |
- "type": "string" |
- }, |
- "type": "array" |
- }, |
"aliases": { |
"description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intented\nalias.\n\nAdditional names that this endpoint will be hosted on.", |
"items": { |
@@ -2587,6 +2554,17 @@ |
"allowCors": { |
"description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.", |
"type": "boolean" |
+ }, |
+ "name": { |
+ "description": "The canonical name of this endpoint.", |
+ "type": "string" |
+ }, |
+ "apis": { |
+ "description": "The list of APIs served by this endpoint.", |
+ "items": { |
+ "type": "string" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
@@ -2750,6 +2728,13 @@ |
"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", |
"id": "LogDescriptor", |
"properties": { |
+ "labels": { |
+ "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.", |
+ "items": { |
+ "$ref": "LabelDescriptor" |
+ }, |
+ "type": "array" |
+ }, |
"name": { |
"description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].", |
"type": "string" |
@@ -2761,13 +2746,6 @@ |
"displayName": { |
"description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.", |
"type": "string" |
- }, |
- "labels": { |
- "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.", |
- "items": { |
- "$ref": "LabelDescriptor" |
- }, |
- "type": "array" |
} |
}, |
"type": "object" |
@@ -2875,6 +2853,28 @@ |
} |
}, |
"type": "object" |
+ }, |
+ "DisableServiceRequest": { |
+ "description": "Request message for DisableService method.", |
+ "id": "DisableServiceRequest", |
+ "properties": { |
+ "consumerId": { |
+ "description": "The identity of consumer resource which service disablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:<project_id>\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "SubmitConfigSourceResponse": { |
+ "description": "Response message for SubmitConfigSource method.", |
+ "id": "SubmitConfigSourceResponse", |
+ "properties": { |
+ "serviceConfig": { |
+ "$ref": "Service", |
+ "description": "The generated service configuration." |
+ } |
+ }, |
+ "type": "object" |
} |
}, |
"servicePath": "", |