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

Unified Diff: discovery/googleapis/servicemanagement__v1.json

Issue 2824163002: Api-roll 48: 2017-04-18 (Closed)
Patch Set: Revert changes to pubspecs Created 3 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « discovery/googleapis/servicecontrol__v1.json ('k') | discovery/googleapis/serviceuser__v1.json » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: discovery/googleapis/servicemanagement__v1.json
diff --git a/discovery/googleapis/servicemanagement__v1.json b/discovery/googleapis/servicemanagement__v1.json
index 240ae5bddadcce0af60637fdaf17792c9efa8563..3e79884ad0b1cdc50bfe88790606f29cb33b6f5e 100644
--- a/discovery/googleapis/servicemanagement__v1.json
+++ b/discovery/googleapis/servicemanagement__v1.json
@@ -2,17 +2,17 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/service.management.readonly": {
- "description": "View your Google API service configuration"
- },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/service.management": {
"description": "Manage your Google API service configuration"
+ },
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/service.management.readonly": {
+ "description": "View your Google API service configuration"
}
}
}
@@ -34,6 +34,16 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
@@ -55,6 +65,11 @@
"location": "query",
"type": "string"
},
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
"$.xgafv": {
"description": "V1 error format.",
"enum": [
@@ -68,11 +83,6 @@
"location": "query",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "location": "query",
- "type": "string"
- },
"alt": {
"default": "json",
"description": "Data format for response.",
@@ -89,13 +99,13 @@
"location": "query",
"type": "string"
},
- "access_token": {
- "description": "OAuth access token.",
+ "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"
},
- "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.",
+ "access_token": {
+ "description": "OAuth access token.",
"location": "query",
"type": "string"
},
@@ -109,33 +119,97 @@
"description": "Pretty-print response.",
"location": "query",
"type": "boolean"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "location": "query",
- "type": "string"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "location": "query",
- "type": "string"
}
},
"protocol": "rest",
"resources": {
"services": {
"methods": {
+ "disable": {
+ "description": "Disables a service for a project, so it can no longer be\nbe used for the project. It prevents accidental usage that may cause\nunexpected billing charges or security leaks.\n\nOperation<response: DisableServiceResponse>",
+ "httpMethod": "POST",
+ "id": "servicemanagement.services.disable",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "parameters": {
+ "serviceName": {
+ "description": "Name of the service to disable. Specifying an unknown service name\nwill cause the request to fail.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/services/{serviceName}:disable",
+ "request": {
+ "$ref": "DisableServiceRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ]
+ },
+ "getIamPolicy": {
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "httpMethod": "POST",
+ "id": "servicemanagement.services.getIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "location": "path",
+ "pattern": "^services/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ]
+ },
+ "undelete": {
+ "description": "Revives a previously deleted managed service. The method restores the\nservice using the configuration at the time the service was deleted.\nThe target service must exist and must have been deleted within the\nlast 30 days.\n\nOperation<response: UndeleteServiceResponse>",
+ "httpMethod": "POST",
+ "id": "servicemanagement.services.undelete",
+ "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}:undelete",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ]
+ },
"list": {
"description": "Lists managed services.\n\nReturns all public services. For authenticated users, also returns all\nservices the calling user has \"servicemanagement.services.get\" permission\nfor.\n\n**BETA:** If the caller specifies the `consumer_id`, it returns only the\nservices enabled on the consumer. The `consumer_id` must have the format\nof \"project:{PROJECT-ID}\".",
"httpMethod": "GET",
"id": "servicemanagement.services.list",
"parameterOrder": [],
"parameters": {
- "producerProjectId": {
- "description": "Include services produced by the specified project.",
- "location": "query",
- "type": "string"
- },
"consumerId": {
"description": "Include services consumed by the specified consumer.\n\nThe Google Service Management implementation accepts the following\nforms:\n- project:<project_id>",
"location": "query",
@@ -151,6 +225,11 @@
"format": "int32",
"location": "query",
"type": "integer"
+ },
+ "producerProjectId": {
+ "description": "Include services produced by the specified project.",
+ "location": "query",
+ "type": "string"
}
},
"path": "v1/services",
@@ -262,12 +341,6 @@
"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"
- },
"configId": {
"description": "The id of the service configuration resource.",
"location": "query",
@@ -281,6 +354,12 @@
],
"location": "query",
"type": "string"
+ },
+ "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}/config",
@@ -372,121 +451,15 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
- },
- "disable": {
- "description": "Disables a service for a project, so it can no longer be\nbe used for the project. It prevents accidental usage that may cause\nunexpected billing charges or security leaks.\n\nOperation<response: DisableServiceResponse>",
- "httpMethod": "POST",
- "id": "servicemanagement.services.disable",
- "parameterOrder": [
- "serviceName"
- ],
- "parameters": {
- "serviceName": {
- "description": "Name of the service to disable. Specifying an unknown service name\nwill cause the request to fail.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1/services/{serviceName}:disable",
- "request": {
- "$ref": "DisableServiceRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ]
- },
- "getIamPolicy": {
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "httpMethod": "POST",
- "id": "servicemanagement.services.getIamPolicy",
- "parameterOrder": [
- "resource"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "location": "path",
- "pattern": "^services/[^/]+$",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1/{+resource}:getIamPolicy",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ]
- },
- "undelete": {
- "description": "Revives a previously deleted managed service. The method restores the\nservice using the configuration at the time the service was deleted.\nThe target service must exist and must have been deleted within the\nlast 30 days.\n\nOperation<response: UndeleteServiceResponse>",
- "httpMethod": "POST",
- "id": "servicemanagement.services.undelete",
- "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}:undelete",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ]
}
},
"resources": {
- "configs": {
+ "rollouts": {
"methods": {
- "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.",
+ "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest.",
"httpMethod": "GET",
- "id": "servicemanagement.services.configs.list",
+ "id": "servicemanagement.services.rollouts.list",
"parameterOrder": [
"serviceName"
],
@@ -509,9 +482,9 @@
"type": "integer"
}
},
- "path": "v1/services/{serviceName}/configs",
+ "path": "v1/services/{serviceName}/rollouts",
"response": {
- "$ref": "ListServiceConfigsResponse"
+ "$ref": "ListServiceRolloutsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -521,39 +494,30 @@
]
},
"get": {
- "description": "Gets a service configuration (version) for a managed service.",
+ "description": "Gets a service configuration rollout.",
"httpMethod": "GET",
- "id": "servicemanagement.services.configs.get",
+ "id": "servicemanagement.services.rollouts.get",
"parameterOrder": [
"serviceName",
- "configId"
+ "rolloutId"
],
"parameters": {
- "view": {
- "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "location": "query",
- "type": "string"
- },
"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"
},
- "configId": {
- "description": "The id of the service configuration resource.",
+ "rolloutId": {
+ "description": "The id of the rollout resource.",
"location": "path",
"required": true,
"type": "string"
}
},
- "path": "v1/services/{serviceName}/configs/{configId}",
+ "path": "v1/services/{serviceName}/rollouts/{rolloutId}",
"response": {
- "$ref": "Service"
+ "$ref": "Rollout"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -563,9 +527,9 @@
]
},
"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.",
+ "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.configs.create",
+ "id": "servicemanagement.services.rollouts.create",
"parameterOrder": [
"serviceName"
],
@@ -577,12 +541,12 @@
"type": "string"
}
},
- "path": "v1/services/{serviceName}/configs",
+ "path": "v1/services/{serviceName}/rollouts",
"request": {
- "$ref": "Service"
+ "$ref": "Rollout"
},
"response": {
- "$ref": "Service"
+ "$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -591,22 +555,16 @@
}
}
},
- "rollouts": {
+ "configs": {
"methods": {
"list": {
- "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest.",
+ "description": "Lists the history of the service configuration for a managed service,\nfrom the newest to the oldest.",
"httpMethod": "GET",
- "id": "servicemanagement.services.rollouts.list",
+ "id": "servicemanagement.services.configs.list",
"parameterOrder": [
"serviceName"
],
"parameters": {
- "pageSize": {
- "description": "The max number of items to include in the response list.",
- "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",
@@ -617,11 +575,17 @@
"description": "The token of the page to retrieve.",
"location": "query",
"type": "string"
+ },
+ "pageSize": {
+ "description": "The max number of items to include in the response list.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
}
},
- "path": "v1/services/{serviceName}/rollouts",
+ "path": "v1/services/{serviceName}/configs",
"response": {
- "$ref": "ListServiceRolloutsResponse"
+ "$ref": "ListServiceConfigsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -631,20 +595,29 @@
]
},
"get": {
- "description": "Gets a service configuration rollout.",
+ "description": "Gets a service configuration (version) for a managed service.",
"httpMethod": "GET",
- "id": "servicemanagement.services.rollouts.get",
+ "id": "servicemanagement.services.configs.get",
"parameterOrder": [
"serviceName",
- "rolloutId"
+ "configId"
],
"parameters": {
- "rolloutId": {
- "description": "The id of the rollout resource.",
+ "configId": {
+ "description": "The id of the service configuration resource.",
"location": "path",
"required": true,
"type": "string"
},
+ "view": {
+ "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "location": "query",
+ "type": "string"
+ },
"serviceName": {
"description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
"location": "path",
@@ -652,9 +625,9 @@
"type": "string"
}
},
- "path": "v1/services/{serviceName}/rollouts/{rolloutId}",
+ "path": "v1/services/{serviceName}/configs/{configId}",
"response": {
- "$ref": "Rollout"
+ "$ref": "Service"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -664,9 +637,9 @@
]
},
"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"
],
@@ -678,9 +651,36 @@
"type": "string"
}
},
- "path": "v1/services/{serviceName}/rollouts",
+ "path": "v1/services/{serviceName}/configs",
"request": {
- "$ref": "Rollout"
+ "$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"
@@ -702,16 +702,6 @@
"id": "servicemanagement.operations.list",
"parameterOrder": [],
"parameters": {
- "name": {
- "description": "Not used.",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "location": "query",
- "type": "string"
- },
"pageSize": {
"description": "The maximum number of operations to return. If unspecified, defaults to\n50. The maximum value is 100.",
"format": "int32",
@@ -722,6 +712,16 @@
"description": "A string for filtering Operations.\n The following filter fields are supported&#58;\n\n * serviceName&#58; Required. Only `=` operator is allowed.\n * startTime&#58; The time this job was started, in ISO 8601 format.\n Allowed operators are `>=`, `>`, `<=`, and `<`.\n * status&#58; Can be `done`, `in_progress`, or `failed`. Allowed\n operators are `=`, and `!=`.\n\n Filter expression supports conjunction (AND) and disjunction (OR)\n logical operators. However, the serviceName restriction must be at the\n top-level and can only be combined with other restrictions via the AND\n logical operator.\n\n Examples&#58;\n\n * `serviceName={some-service}.googleapis.com`\n * `serviceName={some-service}.googleapis.com AND startTime>=\"2017-02-01\"`\n * `serviceName={some-service}.googleapis.com AND status=done`\n * `serviceName={some-service}.googleapis.com AND (status=done OR startTime>=\"2017-02-01\")`",
"location": "query",
"type": "string"
+ },
+ "name": {
+ "description": "Not used.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "location": "query",
+ "type": "string"
}
},
"path": "v1/operations",
@@ -761,22 +761,41 @@
}
}
},
- "revision": "20170317",
+ "revision": "20170410",
"rootUrl": "https://servicemanagement.googleapis.com/",
"schemas": {
+ "Option": {
+ "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
+ "id": "Option",
+ "properties": {
+ "name": {
+ "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.",
+ "type": "string"
+ },
+ "value": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
"Logging": {
"description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer 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 logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history",
"id": "Logging",
"properties": {
- "producerDestinations": {
- "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.",
+ "consumerDestinations": {
+ "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.",
"items": {
"$ref": "LoggingDestination"
},
"type": "array"
},
- "consumerDestinations": {
- "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.",
+ "producerDestinations": {
+ "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.",
"items": {
"$ref": "LoggingDestination"
},
@@ -831,20 +850,56 @@
},
"type": "object"
},
- "ListServiceRolloutsResponse": {
- "description": "Response message for ListServiceRollouts method.",
- "id": "ListServiceRolloutsResponse",
+ "QuotaLimit": {
+ "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
+ "id": "QuotaLimit",
"properties": {
- "rollouts": {
- "description": "The list of rollout resources.",
- "items": {
- "$ref": "Rollout"
- },
- "type": "array"
+ "unit": {
+ "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nThe [Google Service Control](https://cloud.google.com/service-control)\nsupports the following unit components:\n* One of the time intevals:\n * \"/min\" for quota every minute.\n * \"/d\" for quota every 24 hours, starting 00:00 US Pacific Time.\n * Otherwise the quota won't be reset by time, such as storage limit.\n* One and only one of the granted containers:\n * \"/{organization}\" quota for an organization.\n * \"/{project}\" quota for a project.\n * \"/{folder}\" quota for a folder.\n * \"/{resource}\" quota for a universal resource.\n* Zero or more quota segmentation dimension. Not all combos are valid.\n * \"/{region}\" quota for every region. Not to be used with time intervals.\n * Otherwise the resources granted on the target is not segmented.\n * \"/{zone}\" quota for every zone. Not to be used with time intervals.\n * Otherwise the resources granted on the target is not segmented.\n * \"/{resource}\" quota for a resource associated with a project or org.\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n* \"1/min/{user}\" for quota per minute per user.\n* \"1/min/{organization}\" for quota per minute per organization.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.\n\nUsed by metric-based quotas only.",
+ "type": "string"
},
- "nextPageToken": {
- "description": "The token of the next page of results.",
+ "maxLimit": {
+ "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the quota limit. The name is used to refer to the limit when\noverriding the default limit on per-consumer basis.\n\nFor group-based quota limits, the name must be unique within the quota\ngroup. If a name is not provided, it will be generated from the limit_by\nand duration fields.\n\nFor metric-based quota limits, the name must be provided, and it must be\nunique within the service. The name can only include alphanumeric\ncharacters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.\n\nThe name of a limit is used as a unique identifier for this limit.\nTherefore, once a limit has been put into use, its name should be\nimmutable. You can use the display_name field to provide a user-friendly\nname for the limit. The display name can be evolved over time without\naffecting the identity of the limit.",
+ "type": "string"
+ },
+ "duration": {
+ "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.",
+ "type": "string"
+ },
+ "freeTier": {
+ "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.",
+ "format": "int64",
+ "type": "string"
+ },
+ "defaultLimit": {
+ "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.",
+ "format": "int64",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).",
+ "type": "string"
+ },
+ "metric": {
+ "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.\n\nUsed by metric-based quotas only.",
"type": "string"
+ },
+ "values": {
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ },
+ "description": "Tiered limit values. Also allows for regional or zone overrides for these\nvalues if \"/{region}\" or \"/{zone}\" is specified in the unit field.\n\nCurrently supported tiers from low to high:\nVERY_LOW, LOW, STANDARD, HIGH, VERY_HIGH\n\nTo apply different limit values for users according to their tiers, specify\nthe values for the tiers you want to differentiate. For example:\n{LOW:100, STANDARD:500, HIGH:1000, VERY_HIGH:5000}\n\nThe limit value for each tier is optional except for the tier STANDARD.\nThe limit value for an unspecified tier falls to the value of its next\ntier towards tier STANDARD. For the above example, the limit value for tier\nSTANDARD is 500.\n\nTo apply the same limit value for all users, just specify limit value for\ntier STANDARD. For example: {STANDARD:500}.\n\nTo apply a regional overide for a tier, add a map entry with key\n\"<TIER>/<region>\", where <region> is a region name. Similarly, for a zone\noverride, add a map entry with key \"<TIER>/{zone}\".\nFurther, a wildcard can be used at the end of a zone name in order to\nspecify zone level overrides. For example:\nLOW: 10, STANDARD: 50, HIGH: 100,\nLOW/us-central1: 20, STANDARD/us-central1: 60, HIGH/us-central1: 200,\nLOW/us-central1-*: 10, STANDARD/us-central1-*: 20, HIGH/us-central1-*: 80\n\nThe regional overrides tier set for each region must be the same as\nthe tier set for default limit values. Same rule applies for zone overrides\ntier as well.\n\nUsed by metric-based quotas only.",
+ "type": "object"
}
},
"type": "object"
@@ -860,17 +915,35 @@
},
"type": "object"
},
+ "ListServiceRolloutsResponse": {
+ "description": "Response message for ListServiceRollouts method.",
+ "id": "ListServiceRolloutsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "The token of the next page of results.",
+ "type": "string"
+ },
+ "rollouts": {
+ "description": "The list of rollout resources.",
+ "items": {
+ "$ref": "Rollout"
+ },
+ "type": "array"
+ }
+ },
+ "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",
"properties": {
- "root": {
- "description": "If non-empty specifies a path under which inherited HTTP paths\nare rooted.",
- "type": "string"
- },
"name": {
"description": "The fully qualified name of the API which is included.",
"type": "string"
+ },
+ "root": {
+ "description": "If non-empty specifies a path under which inherited HTTP paths\nare rooted.",
+ "type": "string"
}
},
"type": "object"
@@ -879,10 +952,6 @@
"description": "The metadata associated with a long running operation resource.",
"id": "FlowOperationMetadata",
"properties": {
- "isPersisted": {
- "description": "Is the update for the operation persisted?",
- "type": "boolean"
- },
"flowName": {
"description": "The name of the top-level flow corresponding to this operation.\nMust be equal to the \"name\" field for a FlowName enum.",
"type": "string"
@@ -925,17 +994,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": {
- "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"
},
- "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"
}
@@ -961,6 +1030,10 @@
"description": "Defines the HTTP configuration for a service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.",
"id": "Http",
"properties": {
+ "fullyDecodeReservedExpansion": {
+ "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.",
+ "type": "boolean"
+ },
"rules": {
"description": "A list of HTTP configuration rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
"items": {
@@ -1004,10 +1077,6 @@
"description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.",
"id": "SystemParameter",
"properties": {
- "httpHeader": {
- "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.",
- "type": "string"
- },
"name": {
"description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
"type": "string"
@@ -1015,56 +1084,22 @@
"urlQueryParameter": {
"description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
"type": "string"
- }
- },
- "type": "object"
- },
- "Field": {
- "description": "A single field of a message type.",
- "id": "Field",
- "properties": {
- "oneofIndex": {
- "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
- "format": "int32",
- "type": "integer"
- },
- "packed": {
- "description": "Whether to use alternative packed wire representation.",
- "type": "boolean"
- },
- "cardinality": {
- "description": "The field cardinality.",
- "enum": [
- "CARDINALITY_UNKNOWN",
- "CARDINALITY_OPTIONAL",
- "CARDINALITY_REQUIRED",
- "CARDINALITY_REPEATED"
- ],
- "enumDescriptions": [
- "For fields with unknown cardinality.",
- "For optional fields.",
- "For required fields. Proto2 syntax only.",
- "For repeated fields."
- ],
- "type": "string"
- },
- "defaultValue": {
- "description": "The string value of the default value of this field. Proto2 syntax only.",
- "type": "string"
},
- "name": {
- "description": "The field name.",
+ "httpHeader": {
+ "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.",
"type": "string"
- },
- "typeUrl": {
- "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
+ }
+ },
+ "type": "object"
+ },
+ "Field": {
+ "description": "A single field of a message type.",
+ "id": "Field",
+ "properties": {
+ "jsonName": {
+ "description": "The field JSON name.",
"type": "string"
},
- "number": {
- "description": "The field number.",
- "format": "int32",
- "type": "integer"
- },
"kind": {
"description": "The field type.",
"enum": [
@@ -1111,16 +1146,54 @@
],
"type": "string"
},
- "jsonName": {
- "description": "The field JSON name.",
- "type": "string"
- },
"options": {
"description": "The protocol buffer options.",
"items": {
"$ref": "Option"
},
"type": "array"
+ },
+ "oneofIndex": {
+ "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "cardinality": {
+ "description": "The field cardinality.",
+ "enum": [
+ "CARDINALITY_UNKNOWN",
+ "CARDINALITY_OPTIONAL",
+ "CARDINALITY_REQUIRED",
+ "CARDINALITY_REPEATED"
+ ],
+ "enumDescriptions": [
+ "For fields with unknown cardinality.",
+ "For optional fields.",
+ "For required fields. Proto2 syntax only.",
+ "For repeated fields."
+ ],
+ "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"
+ },
+ "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"
@@ -1164,6 +1237,22 @@
"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"
@@ -1181,33 +1270,6 @@
"$ref": "Option"
},
"type": "array"
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
- },
- "syntax": {
- "description": "The source syntax.",
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "EnableServiceRequest": {
- "description": "Request message for EnableService method.",
- "id": "EnableServiceRequest",
- "properties": {
- "consumerId": {
- "description": "The identity of consumer resource which service enablement 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"
@@ -1245,14 +1307,6 @@
"description": "Represents a diagnostic message (error or warning)",
"id": "Diagnostic",
"properties": {
- "message": {
- "description": "Message describing the error or warning.",
- "type": "string"
- },
- "location": {
- "description": "File name and line number of the error or warning.",
- "type": "string"
- },
"kind": {
"description": "The kind of diagnostic information provided.",
"enum": [
@@ -1264,34 +1318,24 @@
"Only errors"
],
"type": "string"
+ },
+ "message": {
+ "description": "Message describing the error or warning.",
+ "type": "string"
+ },
+ "location": {
+ "description": "File name and line number of the error or warning.",
+ "type": "string"
}
},
"type": "object"
},
- "GenerateConfigReportResponse": {
- "description": "Response message for GenerateConfigReport method.",
- "id": "GenerateConfigReportResponse",
+ "EnableServiceRequest": {
+ "description": "Request message for EnableService method.",
+ "id": "EnableServiceRequest",
"properties": {
- "changeReports": {
- "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations.",
- "items": {
- "$ref": "ChangeReport"
- },
- "type": "array"
- },
- "id": {
- "description": "ID of the service configuration this report belongs to.",
- "type": "string"
- },
- "diagnostics": {
- "description": "Errors / Linter warnings associated with the service definition this\nreport\nbelongs to.",
- "items": {
- "$ref": "Diagnostic"
- },
- "type": "array"
- },
- "serviceName": {
- "description": "Name of the service this report belongs to.",
+ "consumerId": {
+ "description": "The identity of consumer resource which service enablement 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"
}
},
@@ -1345,13 +1389,31 @@
},
"type": "object"
},
- "Experimental": {
- "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
- "id": "Experimental",
+ "GenerateConfigReportResponse": {
+ "description": "Response message for GenerateConfigReport method.",
+ "id": "GenerateConfigReportResponse",
"properties": {
- "authorization": {
- "$ref": "AuthorizationConfig",
- "description": "Authorization configuration."
+ "diagnostics": {
+ "description": "Errors / Linter warnings associated with the service definition this\nreport\nbelongs to.",
+ "items": {
+ "$ref": "Diagnostic"
+ },
+ "type": "array"
+ },
+ "serviceName": {
+ "description": "Name of the service this report belongs to.",
+ "type": "string"
+ },
+ "changeReports": {
+ "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations.",
+ "items": {
+ "$ref": "ChangeReport"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "ID of the service configuration this report belongs to.",
+ "type": "string"
}
},
"type": "object"
@@ -1374,10 +1436,25 @@
},
"type": "object"
},
+ "Experimental": {
+ "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
+ "id": "Experimental",
+ "properties": {
+ "authorization": {
+ "$ref": "AuthorizationConfig",
+ "description": "Authorization configuration."
+ }
+ },
+ "type": "object"
+ },
"AuditConfig": {
- "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConifg must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\nExample Policy with multiple AuditConfigs:\n{\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice@googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n}\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConifg must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
"id": "AuditConfig",
"properties": {
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.\nNext ID: 4",
"items": {
@@ -1390,10 +1467,6 @@
"type": "string"
},
"type": "array"
- },
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
}
},
"type": "object"
@@ -1442,6 +1515,10 @@
"description": "A documentation rule provides information about individual API elements.",
"id": "DocumentationRule",
"properties": {
+ "description": {
+ "description": "Description of the selected API(s).",
+ "type": "string"
+ },
"deprecationDescription": {
"description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.",
"type": "string"
@@ -1449,10 +1526,6 @@
"selector": {
"description": "The selector is a comma-separated list of patterns. Each pattern is a\nqualified name of the element which may end in \"*\", indicating a wildcard.\nWildcards are only allowed at the end and for a whole component of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"foo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern \"*\"\nis used.",
"type": "string"
- },
- "description": {
- "description": "Description of the selected API(s).",
- "type": "string"
}
},
"type": "object"
@@ -1488,32 +1561,10 @@
},
"type": "object"
},
- "SourceContext": {
- "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
- "id": "SourceContext",
- "properties": {
- "fileName": {
- "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.",
- "type": "string"
- }
- },
- "type": "object"
- },
"MetricDescriptor": {
"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": {
- "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"
@@ -1560,12 +1611,34 @@
],
"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"
+ },
"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\".",
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "SourceContext": {
+ "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
+ "id": "SourceContext",
+ "properties": {
+ "fileName": {
+ "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.",
"type": "string"
}
},
@@ -1593,15 +1666,15 @@
"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": {
- "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.",
+ "apis": {
+ "description": "The list of APIs served by this endpoint.",
"items": {
"type": "string"
},
"type": "array"
},
- "features": {
- "description": "The list of features enabled on this endpoint.",
+ "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": {
"type": "string"
},
@@ -1611,12 +1684,16 @@
"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"
},
+ "target": {
+ "description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".",
+ "type": "string"
+ },
"name": {
"description": "The canonical name of this endpoint.",
"type": "string"
},
- "apis": {
- "description": "The list of APIs served by this endpoint.",
+ "features": {
+ "description": "The list of features enabled on this endpoint.",
"items": {
"type": "string"
},
@@ -1636,26 +1713,6 @@
},
"type": "object"
},
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "id": "TestIamPermissionsResponse",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "id": "GetIamPolicyRequest",
- "properties": {},
- "type": "object"
- },
"Usage": {
"description": "Configuration controlling usage of a service.",
"id": "Usage",
@@ -1681,6 +1738,26 @@
},
"type": "object"
},
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "id": "GetIamPolicyRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsResponse",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
"Context": {
"description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.",
"id": "Context",
@@ -1699,6 +1776,24 @@
"description": "A rule to be applied in a Policy.",
"id": "Rule",
"properties": {
+ "notIn": {
+ "description": "If one or more 'not_in' clauses are specified, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.\nThe format for in and not_in entries is the same as for members in a\nBinding (see google/iam/v1/policy.proto).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "description": {
+ "description": "Human-readable description of the rule.",
+ "type": "string"
+ },
+ "conditions": {
+ "description": "Additional restrictions that must be met",
+ "items": {
+ "$ref": "Condition"
+ },
+ "type": "array"
+ },
"logConfig": {
"description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
"items": {
@@ -1739,24 +1834,6 @@
"Matching 'Entries' tell IAM.Check callers to generate logs."
],
"type": "string"
- },
- "notIn": {
- "description": "If one or more 'not_in' clauses are specified, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.\nThe format for in and not_in entries is the same as for members in a\nBinding (see google/iam/v1/policy.proto).",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "description": {
- "description": "Human-readable description of the rule.",
- "type": "string"
- },
- "conditions": {
- "description": "Additional restrictions that must be met",
- "items": {
- "$ref": "Condition"
- },
- "type": "array"
}
},
"type": "object"
@@ -1765,10 +1842,6 @@
"description": "Specifies what kind of log the caller must write",
"id": "LogConfig",
"properties": {
- "counter": {
- "$ref": "CounterOptions",
- "description": "Counter options."
- },
"dataAccess": {
"$ref": "DataAccessOptions",
"description": "Data access options."
@@ -1776,6 +1849,10 @@
"cloudAudit": {
"$ref": "CloudAuditOptions",
"description": "Cloud audit options."
+ },
+ "counter": {
+ "$ref": "CounterOptions",
+ "description": "Counter options."
}
},
"type": "object"
@@ -1784,6 +1861,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"
@@ -1795,13 +1879,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"
@@ -1844,17 +1921,6 @@
"description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.",
"id": "MonitoredResourceDescriptor",
"properties": {
- "labels": {
- "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.",
- "items": {
- "$ref": "LabelDescriptor"
- },
- "type": "array"
- },
- "name": {
- "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.",
- "type": "string"
- },
"displayName": {
"description": "Optional. A concise name for the monitored resource type that might be\ndisplayed in user interfaces. It should be a Title Cased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Google Cloud SQL Database\"`.",
"type": "string"
@@ -1866,6 +1932,17 @@
"type": {
"description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters.",
"type": "string"
+ },
+ "labels": {
+ "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.",
+ "items": {
+ "$ref": "LabelDescriptor"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.",
+ "type": "string"
}
},
"type": "object"
@@ -1874,13 +1951,13 @@
"description": "A custom error rule.",
"id": "CustomErrorRule",
"properties": {
- "isErrorType": {
- "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.",
- "type": "boolean"
- },
"selector": {
"description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.",
"type": "string"
+ },
+ "isErrorType": {
+ "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.",
+ "type": "boolean"
}
},
"type": "object"
@@ -1981,13 +2058,13 @@
"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": {
- "allowUnregisteredCalls": {
- "description": "True, if the method allows unregistered calls; false otherwise.",
- "type": "boolean"
- },
"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"
@@ -1996,13 +2073,13 @@
"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"
+ },
+ "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"
}
},
"type": "object"
@@ -2026,13 +2103,6 @@
"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: &#40;== include google/foo/overview.md ==&#41;\n - name: Tutorial\n content: &#40;== include google/foo/tutorial.md ==&#41;\n subpages;\n - name: Java\n content: &#40;== include google/foo/tutorial_java.md ==&#41;\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>&#91;fully.qualified.proto.name]&#91;]</code></pre>\nTo override the display text used for the link, this can be used:\n<pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre>\nText can be excluded from doc using the following notation:\n<pre><code>&#40;-- internal comment --&#41;</code></pre>\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n<pre><code>&#40;--BETA: comment for BETA users --&#41;</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>&#40;== include path/to/file ==&#41;</code></pre>\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n<pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre>\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
"id": "Documentation",
"properties": {
- "pages": {
- "description": "The top level pages for the documentation set.",
- "items": {
- "$ref": "Page"
- },
- "type": "array"
- },
"summary": {
"description": "A short summary of what the service does. Can only be provided by\nplain text.",
"type": "string"
@@ -2051,6 +2121,13 @@
"overview": {
"description": "Declares a single overview page. For example:\n<pre><code>documentation:\n summary: ...\n overview: &#40;== include overview.md ==&#41;\n</code></pre>\nThis is a shortcut for the following declaration (using pages style):\n<pre><code>documentation:\n summary: ...\n pages:\n - name: Overview\n content: &#40;== include overview.md ==&#41;\n</code></pre>\nNote: you cannot specify both `overview` field and `pages` field.",
"type": "string"
+ },
+ "pages": {
+ "description": "The top level pages for the documentation set.",
+ "items": {
+ "$ref": "Page"
+ },
+ "type": "array"
}
},
"type": "object"
@@ -2059,34 +2136,6 @@
"description": "A condition to be met.",
"id": "Condition",
"properties": {
- "op": {
- "description": "An operator to apply the subject with.",
- "enum": [
- "NO_OP",
- "EQUALS",
- "NOT_EQUALS",
- "IN",
- "NOT_IN",
- "DISCHARGED"
- ],
- "enumDescriptions": [
- "Default no-op.",
- "DEPRECATED. Use IN instead.",
- "DEPRECATED. Use NOT_IN instead.",
- "The condition is true if the subject (or any element of it if it is\na set) matches any of the supplied values.",
- "The condition is true if the subject (or every element of it if it is\na set) matches none of the supplied values.",
- "Subject is discharged"
- ],
- "type": "string"
- },
- "svc": {
- "description": "Trusted attributes discharged by the service.",
- "type": "string"
- },
- "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": [
@@ -2105,6 +2154,17 @@
],
"type": "string"
},
+ "value": {
+ "description": "DEPRECATED. Use 'values' instead.",
+ "type": "string"
+ },
+ "values": {
+ "description": "The objects of the condition. This is mutually exclusive with 'value'.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
"iam": {
"description": "Trusted attributes supplied by the IAM system.",
"enum": [
@@ -2123,12 +2183,29 @@
],
"type": "string"
},
- "values": {
- "description": "The objects of the condition. This is mutually exclusive with 'value'.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "op": {
+ "description": "An operator to apply the subject with.",
+ "enum": [
+ "NO_OP",
+ "EQUALS",
+ "NOT_EQUALS",
+ "IN",
+ "NOT_IN",
+ "DISCHARGED"
+ ],
+ "enumDescriptions": [
+ "Default no-op.",
+ "DEPRECATED. Use IN instead.",
+ "DEPRECATED. Use NOT_IN instead.",
+ "The condition is true if the subject (or any element of it if it is\na set) matches any of the supplied values.",
+ "The condition is true if the subject (or every element of it if it is\na set) matches none of the supplied values.",
+ "Subject is discharged"
+ ],
+ "type": "string"
+ },
+ "svc": {
+ "description": "Trusted attributes discharged by the service.",
+ "type": "string"
}
},
"type": "object"
@@ -2167,16 +2244,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"
@@ -2242,6 +2319,21 @@
"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": {
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ },
+ "iamOwned": {
+ "type": "boolean"
+ },
+ "rules": {
+ "description": "If more than one rule is specified, the rules are applied in the following\nmanner:\n- All matching LOG rules are always applied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if no rule applies, permission is denied.",
+ "items": {
+ "$ref": "Rule"
+ },
+ "type": "array"
+ },
"version": {
"description": "Version of the `Policy`. The default version is 0.",
"format": "int32",
@@ -2260,21 +2352,6 @@
"$ref": "Binding"
},
"type": "array"
- },
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
- "type": "string"
- },
- "iamOwned": {
- "type": "boolean"
- },
- "rules": {
- "description": "If more than one rule is specified, the rules are applied in the following\nmanner:\n- All matching LOG rules are always applied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if no rule applies, permission is denied.",
- "items": {
- "$ref": "Rule"
- },
- "type": "array"
}
},
"type": "object"
@@ -2283,23 +2360,9 @@
"description": "Api is a light-weight descriptor for a protocol buffer service.",
"id": "Api",
"properties": {
- "options": {
- "description": "Any metadata attached to the API.",
- "items": {
- "$ref": "Option"
- },
- "type": "array"
- },
- "methods": {
- "description": "The methods of this api, in unspecified order.",
- "items": {
- "$ref": "Method"
- },
- "type": "array"
- },
- "name": {
- "description": "The fully qualified name of this api, including package name\nfollowed by the api's simple name.",
- "type": "string"
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "Source context for the protocol buffer service represented by this\nmessage."
},
"syntax": {
"description": "The source syntax of the service.",
@@ -2313,10 +2376,6 @@
],
"type": "string"
},
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "Source context for the protocol buffer service represented by this\nmessage."
- },
"version": {
"description": "A version string for this api. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version\nis omitted, it defaults to zero. If the entire version field is\nempty, the major version is derived from the package name, as\noutlined below. If the field is not empty, the version in the\npackage name will be verified to be consistent with what is\nprovided here.\n\nThe versioning schema uses [semantic\nversioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version numbers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also reflected in the package name of the\nAPI, which must end in `v<major-version>`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, none-GA apis.\n",
"type": "string"
@@ -2327,6 +2386,43 @@
"$ref": "Mixin"
},
"type": "array"
+ },
+ "options": {
+ "description": "Any metadata attached to the API.",
+ "items": {
+ "$ref": "Option"
+ },
+ "type": "array"
+ },
+ "methods": {
+ "description": "The methods of this api, in unspecified order.",
+ "items": {
+ "$ref": "Method"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The fully qualified name of this api, including package name\nfollowed by the api's simple name.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MetricRule": {
+ "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota, billing, and monitoring behaviors to apply to the\nmethod call.\n\nUsed by metric-based quotas only.",
+ "id": "MetricRule",
+ "properties": {
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "metricCosts": {
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ },
+ "description": "Metrics to update when the selected methods are called, and the associated\ncost applied to each metric.\n\nThe key of the map is the metric name, and the values are the amount\nincreased for the metric against which the quota limits are defined.\nThe value must not be negative.",
+ "type": "object"
}
},
"type": "object"
@@ -2341,17 +2437,17 @@
"description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\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": "Authentication",
"properties": {
- "rules": {
- "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "providers": {
+ "description": "Defines a set of authentication providers that a service supports.",
"items": {
- "$ref": "AuthenticationRule"
+ "$ref": "AuthProvider"
},
"type": "array"
},
- "providers": {
- "description": "Defines a set of authentication providers that a service supports.",
+ "rules": {
+ "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
"items": {
- "$ref": "AuthProvider"
+ "$ref": "AuthenticationRule"
},
"type": "array"
}
@@ -2397,6 +2493,10 @@
"description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
"id": "Page",
"properties": {
+ "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: &#40;== include tutorial.md ==&#41;\n subpages:\n - name: Java\n content: &#40;== include tutorial_java.md ==&#41;\n</code></pre>\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
+ "type": "string"
+ },
"content": {
"description": "The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code>\nto include content from a Markdown file.",
"type": "string"
@@ -2407,10 +2507,6 @@
"$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: &#40;== include tutorial.md ==&#41;\n subpages:\n - name: Java\n content: &#40;== include tutorial_java.md ==&#41;\n</code></pre>\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
- "type": "string"
}
},
"type": "object"
@@ -2419,11 +2515,6 @@
"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"
@@ -2438,6 +2529,11 @@
"type": "object"
},
"type": "array"
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
@@ -2464,14 +2560,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": {
- "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"
- },
- "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"
@@ -2479,6 +2567,14 @@
"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"
+ },
+ "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"
}
},
"type": "object"
@@ -2487,10 +2583,6 @@
"description": "Enum value definition.",
"id": "EnumValue",
"properties": {
- "name": {
- "description": "Enum value name.",
- "type": "string"
- },
"options": {
"description": "Protocol buffer options.",
"items": {
@@ -2502,6 +2594,10 @@
"description": "Enum value number.",
"format": "int32",
"type": "integer"
+ },
+ "name": {
+ "description": "Enum value name.",
+ "type": "string"
}
},
"type": "object"
@@ -2510,6 +2606,10 @@
"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": {
+ "usage": {
+ "$ref": "Usage",
+ "description": "Configuration controlling usage of this service."
+ },
"metrics": {
"description": "Defines the metrics used by this service.",
"items": {
@@ -2553,6 +2653,10 @@
"$ref": "Visibility",
"description": "API visibility configuration."
},
+ "quota": {
+ "$ref": "Quota",
+ "description": "Quota configuration."
+ },
"name": {
"description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
"type": "string"
@@ -2638,10 +2742,6 @@
"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."
}
},
"type": "object"
@@ -2668,11 +2768,6 @@
"description": "The metadata associated with a long running operation resource.",
"id": "OperationMetadata",
"properties": {
- "startTime": {
- "description": "The start time of the operation.",
- "format": "google-datetime",
- "type": "string"
- },
"resourceNames": {
"description": "The full name of the resources that this operation is directly\nassociated with.",
"items": {
@@ -2691,6 +2786,11 @@
"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",
+ "type": "string"
}
},
"type": "object"
@@ -2728,10 +2828,37 @@
},
"type": "object"
},
+ "VisibilityRule": {
+ "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
+ "id": "VisibilityRule",
+ "properties": {
+ "restriction": {
+ "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
+ "type": "string"
+ },
+ "selector": {
+ "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"HttpRule": {
"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&param=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"
+ },
+ "post": {
+ "description": "Used for creating a resource.",
+ "type": "string"
+ },
+ "mediaDownload": {
+ "$ref": "MediaDownload",
+ "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration."
+ },
"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": {
@@ -2755,14 +2882,14 @@
"$ref": "CustomHttpPattern",
"description": "Custom pattern is used for defining custom verbs."
},
- "get": {
- "description": "Used for listing and getting information about resources.",
- "type": "string"
- },
"patch": {
"description": "Used for updating a resource.",
"type": "string"
},
+ "get": {
+ "description": "Used for listing and getting information about resources.",
+ "type": "string"
+ },
"put": {
"description": "Used for updating a resource.",
"type": "string"
@@ -2770,33 +2897,6 @@
"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": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration."
- },
- "post": {
- "description": "Used for creating a resource.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "VisibilityRule": {
- "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
- "id": "VisibilityRule",
- "properties": {
- "restriction": {
- "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
- "type": "string"
- },
- "selector": {
- "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
}
},
"type": "object"
@@ -2889,18 +2989,31 @@
},
"type": "object"
},
+ "Quota": {
+ "description": "Quota configuration helps to achieve fairness and budgeting in service\nusage.\n\nThe quota configuration works this way:\n- The service configuration defines a set of metrics.\n- For API calls, the quota.metric_rules maps methods to metrics with\n corresponding costs.\n- The quota.limits defines limits on the metrics, which will be used for\n quota checks at runtime.\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the read_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook method\n # consuming at twice rate as the DeleteBook method.\n metric_rules:\n - selector: \"*\"\n metric_costs:\n library.googleapis.com/read_calls: 1\n - selector: google.example.library.v1.LibraryService.UpdateBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metric_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metric definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type: INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64",
+ "id": "Quota",
+ "properties": {
+ "limits": {
+ "description": "List of `QuotaLimit` definitions for the service.\n\nUsed by metric-based quotas only.",
+ "items": {
+ "$ref": "QuotaLimit"
+ },
+ "type": "array"
+ },
+ "metricRules": {
+ "description": "List of `MetricRule` definitions, each one mapping a selected method to one\nor more metrics.\n\nUsed by metric-based quotas only.",
+ "items": {
+ "$ref": "MetricRule"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
"Rollout": {
"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": {
- "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"
@@ -2937,6 +3050,14 @@
"serviceName": {
"description": "The name of the service associated with this Rollout.",
"type": "string"
+ },
+ "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"
}
},
"type": "object"
@@ -3034,25 +3155,6 @@
}
},
"type": "object"
- },
- "Option": {
- "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
- "id": "Option",
- "properties": {
- "value": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.",
- "type": "object"
- },
- "name": {
- "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.",
- "type": "string"
- }
- },
- "type": "object"
}
},
"servicePath": "",
« no previous file with comments | « discovery/googleapis/servicecontrol__v1.json ('k') | discovery/googleapis/serviceuser__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698