| Index: discovery/googleapis/servicemanagement__v1.json
|
| diff --git a/discovery/googleapis/servicemanagement__v1.json b/discovery/googleapis/servicemanagement__v1.json
|
| index e3688964207841c288ca36225f7bda45954cd86c..240ae5bddadcce0af60637fdaf17792c9efa8563 100644
|
| --- a/discovery/googleapis/servicemanagement__v1.json
|
| +++ b/discovery/googleapis/servicemanagement__v1.json
|
| @@ -45,13 +45,13 @@
|
| "location": "query",
|
| "type": "boolean"
|
| },
|
| - "fields": {
|
| - "description": "Selector specifying which fields to include in a partial response.",
|
| + "uploadType": {
|
| + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "uploadType": {
|
| - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| + "fields": {
|
| + "description": "Selector specifying which fields to include in a partial response.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -125,36 +125,17 @@
|
| "resources": {
|
| "services": {
|
| "methods": {
|
| - "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",
|
| @@ -170,11 +151,6 @@
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| - },
|
| - "producerProjectId": {
|
| - "description": "Include services produced by the specified project.",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| "path": "v1/services",
|
| @@ -286,15 +262,6 @@
|
| "serviceName"
|
| ],
|
| "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",
|
| @@ -305,6 +272,15 @@
|
| "description": "The id of the service configuration resource.",
|
| "location": "query",
|
| "type": "string"
|
| + },
|
| + "view": {
|
| + "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
|
| + "enum": [
|
| + "BASIC",
|
| + "FULL"
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| "path": "v1/services/{serviceName}/config",
|
| @@ -318,25 +294,22 @@
|
| "https://www.googleapis.com/auth/service.management.readonly"
|
| ]
|
| },
|
| - "enable": {
|
| - "description": "Enable a managed service for a project with default setting.\n\nOperation<response: EnableServiceResponse>\n\ngoogle.rpc.Status errors may contain a\ngoogle.rpc.PreconditionFailure error detail.",
|
| - "httpMethod": "POST",
|
| - "id": "servicemanagement.services.enable",
|
| + "delete": {
|
| + "description": "Deletes a managed service. This method will change the service to the\n`Soft-Delete` state for 30 days. Within this period, service producers may\ncall UndeleteService to restore the service.\nAfter 30 days, the service will be permanently deleted.\n\nOperation<response: google.protobuf.Empty>",
|
| + "httpMethod": "DELETE",
|
| + "id": "servicemanagement.services.delete",
|
| "parameterOrder": [
|
| "serviceName"
|
| ],
|
| "parameters": {
|
| "serviceName": {
|
| - "description": "Name of the service to enable. Specifying an unknown service name will\ncause the request to fail.",
|
| + "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}:enable",
|
| - "request": {
|
| - "$ref": "EnableServiceRequest"
|
| - },
|
| + "path": "v1/services/{serviceName}",
|
| "response": {
|
| "$ref": "Operation"
|
| },
|
| @@ -345,22 +318,25 @@
|
| "https://www.googleapis.com/auth/service.management"
|
| ]
|
| },
|
| - "delete": {
|
| - "description": "Deletes a managed service. This method will change the service to the\n`Soft-Delete` state for 30 days. Within this period, service producers may\ncall UndeleteService to restore the service.\nAfter 30 days, the service will be permanently deleted.\n\nOperation<response: google.protobuf.Empty>",
|
| - "httpMethod": "DELETE",
|
| - "id": "servicemanagement.services.delete",
|
| + "enable": {
|
| + "description": "Enables a service for a project, so it can be used\nfor the project. See\n[Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation<response: EnableServiceResponse>",
|
| + "httpMethod": "POST",
|
| + "id": "servicemanagement.services.enable",
|
| "parameterOrder": [
|
| "serviceName"
|
| ],
|
| "parameters": {
|
| "serviceName": {
|
| - "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
|
| + "description": "Name of the service to enable. Specifying an unknown service name will\ncause the request to fail.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/services/{serviceName}",
|
| + "path": "v1/services/{serviceName}:enable",
|
| + "request": {
|
| + "$ref": "EnableServiceRequest"
|
| + },
|
| "response": {
|
| "$ref": "Operation"
|
| },
|
| @@ -398,7 +374,7 @@
|
| ]
|
| },
|
| "disable": {
|
| - "description": "Disable a managed service for a project.\n\nOperation<response: DisableServiceResponse>",
|
| + "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": [
|
| @@ -451,110 +427,33 @@
|
| "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": {
|
| - "rollouts": {
|
| - "methods": {
|
| - "list": {
|
| - "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest.",
|
| - "httpMethod": "GET",
|
| - "id": "servicemanagement.services.rollouts.list",
|
| - "parameterOrder": [
|
| - "serviceName"
|
| - ],
|
| - "parameters": {
|
| - "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",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "pageToken": {
|
| - "description": "The token of the page to retrieve.",
|
| - "location": "query",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/services/{serviceName}/rollouts",
|
| - "response": {
|
| - "$ref": "ListServiceRolloutsResponse"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/cloud-platform",
|
| - "https://www.googleapis.com/auth/cloud-platform.read-only",
|
| - "https://www.googleapis.com/auth/service.management",
|
| - "https://www.googleapis.com/auth/service.management.readonly"
|
| - ]
|
| - },
|
| - "get": {
|
| - "description": "Gets a service configuration rollout.",
|
| - "httpMethod": "GET",
|
| - "id": "servicemanagement.services.rollouts.get",
|
| - "parameterOrder": [
|
| - "serviceName",
|
| - "rolloutId"
|
| - ],
|
| - "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"
|
| - },
|
| - "rolloutId": {
|
| - "description": "The id of the rollout resource.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/services/{serviceName}/rollouts/{rolloutId}",
|
| - "response": {
|
| - "$ref": "Rollout"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/cloud-platform",
|
| - "https://www.googleapis.com/auth/cloud-platform.read-only",
|
| - "https://www.googleapis.com/auth/service.management",
|
| - "https://www.googleapis.com/auth/service.management.readonly"
|
| - ]
|
| - },
|
| - "create": {
|
| - "description": "Creates a new service configuration rollout. Based on rollout, the\nGoogle Service Management will roll out the service configurations to\ndifferent backend services. For example, the logging configuration will be\npushed to Google Cloud Logging.\n\nPlease note that any previous pending and running Rollouts and associated\nOperations will be automatically cancelled so that the latest Rollout will\nnot be blocked by previous Rollouts.\n\nOperation<response: Rollout>",
|
| - "httpMethod": "POST",
|
| - "id": "servicemanagement.services.rollouts.create",
|
| - "parameterOrder": [
|
| - "serviceName"
|
| - ],
|
| - "parameters": {
|
| - "serviceName": {
|
| - "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/services/{serviceName}/rollouts",
|
| - "request": {
|
| - "$ref": "Rollout"
|
| - },
|
| - "response": {
|
| - "$ref": "Operation"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/cloud-platform",
|
| - "https://www.googleapis.com/auth/service.management"
|
| - ]
|
| - }
|
| - }
|
| - },
|
| "configs": {
|
| "methods": {
|
| "submit": {
|
| @@ -630,6 +529,15 @@
|
| "configId"
|
| ],
|
| "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",
|
| @@ -641,15 +549,6 @@
|
| "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"
|
| }
|
| },
|
| "path": "v1/services/{serviceName}/configs/{configId}",
|
| @@ -691,31 +590,169 @@
|
| ]
|
| }
|
| }
|
| - }
|
| - }
|
| - },
|
| - "operations": {
|
| - "methods": {
|
| - "get": {
|
| - "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
|
| - "httpMethod": "GET",
|
| - "id": "servicemanagement.operations.get",
|
| - "parameterOrder": [
|
| - "name"
|
| - ],
|
| - "parameters": {
|
| - "name": {
|
| - "description": "The name of the operation resource.",
|
| - "location": "path",
|
| - "pattern": "^operations/.+$",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/{+name}",
|
| - "response": {
|
| - "$ref": "Operation"
|
| - },
|
| + },
|
| + "rollouts": {
|
| + "methods": {
|
| + "list": {
|
| + "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest.",
|
| + "httpMethod": "GET",
|
| + "id": "servicemanagement.services.rollouts.list",
|
| + "parameterOrder": [
|
| + "serviceName"
|
| + ],
|
| + "parameters": {
|
| + "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",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "pageToken": {
|
| + "description": "The token of the page to retrieve.",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/services/{serviceName}/rollouts",
|
| + "response": {
|
| + "$ref": "ListServiceRolloutsResponse"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only",
|
| + "https://www.googleapis.com/auth/service.management",
|
| + "https://www.googleapis.com/auth/service.management.readonly"
|
| + ]
|
| + },
|
| + "get": {
|
| + "description": "Gets a service configuration rollout.",
|
| + "httpMethod": "GET",
|
| + "id": "servicemanagement.services.rollouts.get",
|
| + "parameterOrder": [
|
| + "serviceName",
|
| + "rolloutId"
|
| + ],
|
| + "parameters": {
|
| + "rolloutId": {
|
| + "description": "The id of the rollout resource.",
|
| + "location": "path",
|
| + "required": true,
|
| + "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}/rollouts/{rolloutId}",
|
| + "response": {
|
| + "$ref": "Rollout"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only",
|
| + "https://www.googleapis.com/auth/service.management",
|
| + "https://www.googleapis.com/auth/service.management.readonly"
|
| + ]
|
| + },
|
| + "create": {
|
| + "description": "Creates a new service configuration rollout. Based on rollout, the\nGoogle Service Management will roll out the service configurations to\ndifferent backend services. For example, the logging configuration will be\npushed to Google Cloud Logging.\n\nPlease note that any previous pending and running Rollouts and associated\nOperations will be automatically cancelled so that the latest Rollout will\nnot be blocked by previous Rollouts.\n\nOperation<response: Rollout>",
|
| + "httpMethod": "POST",
|
| + "id": "servicemanagement.services.rollouts.create",
|
| + "parameterOrder": [
|
| + "serviceName"
|
| + ],
|
| + "parameters": {
|
| + "serviceName": {
|
| + "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/services/{serviceName}/rollouts",
|
| + "request": {
|
| + "$ref": "Rollout"
|
| + },
|
| + "response": {
|
| + "$ref": "Operation"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/service.management"
|
| + ]
|
| + }
|
| + }
|
| + }
|
| + }
|
| + },
|
| + "operations": {
|
| + "methods": {
|
| + "list": {
|
| + "description": "Lists service operations that match the specified filter in the request.",
|
| + "httpMethod": "GET",
|
| + "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",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "filter": {
|
| + "description": "A string for filtering Operations.\n The following filter fields are supported:\n\n * serviceName: Required. Only `=` operator is allowed.\n * startTime: The time this job was started, in ISO 8601 format.\n Allowed operators are `>=`, `>`, `<=`, and `<`.\n * status: 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:\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"
|
| + }
|
| + },
|
| + "path": "v1/operations",
|
| + "response": {
|
| + "$ref": "ListOperationsResponse"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/service.management"
|
| + ]
|
| + },
|
| + "get": {
|
| + "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
|
| + "httpMethod": "GET",
|
| + "id": "servicemanagement.operations.get",
|
| + "parameterOrder": [
|
| + "name"
|
| + ],
|
| + "parameters": {
|
| + "name": {
|
| + "description": "The name of the operation resource.",
|
| + "location": "path",
|
| + "pattern": "^operations/.+$",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/{+name}",
|
| + "response": {
|
| + "$ref": "Operation"
|
| + },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| "https://www.googleapis.com/auth/service.management"
|
| @@ -724,1037 +761,887 @@
|
| }
|
| }
|
| },
|
| - "revision": "20170227",
|
| + "revision": "20170317",
|
| "rootUrl": "https://servicemanagement.googleapis.com/",
|
| "schemas": {
|
| - "LogConfig": {
|
| - "description": "Specifies what kind of log the caller must write\nIncrement a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only,\nand end in \"_count\". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==> increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1",
|
| - "id": "LogConfig",
|
| - "properties": {
|
| - "counter": {
|
| - "$ref": "CounterOptions",
|
| - "description": "Counter options."
|
| - },
|
| - "dataAccess": {
|
| - "$ref": "DataAccessOptions",
|
| - "description": "Data access options."
|
| - },
|
| - "cloudAudit": {
|
| - "$ref": "CloudAuditOptions",
|
| - "description": "Cloud audit options."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "LogDescriptor": {
|
| - "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",
|
| + "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": {
|
| - "description": {
|
| - "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
|
| - "type": "string"
|
| - },
|
| - "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.",
|
| + "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": "LabelDescriptor"
|
| + "$ref": "LoggingDestination"
|
| },
|
| "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"
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ConfigFile": {
|
| - "description": "Generic specification of a source configuration file",
|
| - "id": "ConfigFile",
|
| + "Method": {
|
| + "description": "Method represents a method of an api.",
|
| + "id": "Method",
|
| "properties": {
|
| - "fileContents": {
|
| - "description": "The bytes that constitute the file.",
|
| - "format": "byte",
|
| + "responseStreaming": {
|
| + "description": "If true, the response is streamed.",
|
| + "type": "boolean"
|
| + },
|
| + "name": {
|
| + "description": "The simple name of this method.",
|
| "type": "string"
|
| },
|
| - "filePath": {
|
| - "description": "The file name of the configuration file (full or relative path).",
|
| + "requestTypeUrl": {
|
| + "description": "A URL of the input message type.",
|
| "type": "string"
|
| },
|
| - "fileType": {
|
| - "description": "The type of configuration file this represents.",
|
| + "requestStreaming": {
|
| + "description": "If true, the request is streamed.",
|
| + "type": "boolean"
|
| + },
|
| + "syntax": {
|
| + "description": "The source syntax of this method.",
|
| "enum": [
|
| - "FILE_TYPE_UNSPECIFIED",
|
| - "SERVICE_CONFIG_YAML",
|
| - "OPEN_API_JSON",
|
| - "OPEN_API_YAML",
|
| - "FILE_DESCRIPTOR_SET_PROTO"
|
| + "SYNTAX_PROTO2",
|
| + "SYNTAX_PROTO3"
|
| ],
|
| "enumDescriptions": [
|
| - "Unknown file type.",
|
| - "YAML-specification of service.",
|
| - "OpenAPI specification, serialized in JSON.",
|
| - "OpenAPI specification, serialized in YAML.",
|
| - "FileDescriptorSet, generated by protoc.\n\nTo generate, use protoc with imports and source info included.\nFor an example test.proto file, the following command would put the value\nin a new file named out.pb.\n\n$protoc --include_imports --include_source_info test.proto -o out.pb"
|
| + "Syntax `proto2`.",
|
| + "Syntax `proto3`."
|
| ],
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "MonitoredResourceDescriptor": {
|
| - "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": {
|
| - "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"
|
| - },
|
| - "description": {
|
| - "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation.",
|
| - "type": "string"
|
| },
|
| - "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.",
|
| + "responseTypeUrl": {
|
| + "description": "The URL of the output message type.",
|
| "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\"`.",
|
| + "options": {
|
| + "description": "Any metadata attached to the method.",
|
| "items": {
|
| - "$ref": "LabelDescriptor"
|
| + "$ref": "Option"
|
| },
|
| "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"
|
| - },
|
| - "CustomErrorRule": {
|
| - "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"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "MediaDownload": {
|
| - "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
|
| - "id": "MediaDownload",
|
| - "properties": {
|
| - "enabled": {
|
| - "description": "Whether download is enabled.",
|
| - "type": "boolean"
|
| - },
|
| - "downloadService": {
|
| - "description": "DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ChangeReport": {
|
| - "description": "Change report associated with a particular service configuration.\n\nIt contains a list of ConfigChanges based on the comparison between\ntwo service configurations.",
|
| - "id": "ChangeReport",
|
| + "ListServiceRolloutsResponse": {
|
| + "description": "Response message for ListServiceRollouts method.",
|
| + "id": "ListServiceRolloutsResponse",
|
| "properties": {
|
| - "configChanges": {
|
| - "description": "List of changes between two service configurations.\nThe changes will be alphabetically sorted based on the identifier\nof each change.\nA ConfigChange identifier is a dot separated path to the configuration.\nExample: visibility.rules[selector='LibraryService.CreateBook'].restriction",
|
| + "rollouts": {
|
| + "description": "The list of rollout resources.",
|
| "items": {
|
| - "$ref": "ConfigChange"
|
| + "$ref": "Rollout"
|
| },
|
| "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "DisableServiceRequest": {
|
| - "description": "Request message for DisableService method.",
|
| - "id": "DisableServiceRequest",
|
| - "properties": {
|
| - "consumerId": {
|
| - "description": "The identity of consumer resource which service disablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:<project_id>\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "SubmitConfigSourceResponse": {
|
| - "description": "Response message for SubmitConfigSource method.",
|
| - "id": "SubmitConfigSourceResponse",
|
| - "properties": {
|
| - "serviceConfig": {
|
| - "$ref": "Service",
|
| - "description": "The generated service configuration."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "MediaUpload": {
|
| - "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
|
| - "id": "MediaUpload",
|
| - "properties": {
|
| - "enabled": {
|
| - "description": "Whether upload is enabled.",
|
| - "type": "boolean"
|
| - },
|
| - "uploadService": {
|
| - "description": "DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Advice": {
|
| - "description": "Generated advice about this change, used for providing more\ninformation about how a change will affect the existing service.",
|
| - "id": "Advice",
|
| - "properties": {
|
| - "description": {
|
| - "description": "Useful description for why this advice was applied and what actions should\nbe taken to mitigate any implied risks.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ManagedService": {
|
| - "description": "The full representation of a Service that is managed by\nGoogle Service Management.",
|
| - "id": "ManagedService",
|
| - "properties": {
|
| - "producerProjectId": {
|
| - "description": "ID of the project that produces and owns this service.",
|
| - "type": "string"
|
| - },
|
| - "serviceName": {
|
| - "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "UsageRule": {
|
| - "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.",
|
| + "nextPageToken": {
|
| + "description": "The token of the next page of results.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "TrafficPercentStrategy": {
|
| - "description": "Strategy that specifies how Google Service Control should select\ndifferent\nversions of service configurations based on traffic percentage.\n\nOne example of how to gradually rollout a new service configuration using\nthis\nstrategy:\nDay 1\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160206\"\n traffic_percent_strategy {\n percentages: {\n \"example.googleapis.com/20160201\": 70.00\n \"example.googleapis.com/20160206\": 30.00\n }\n }\n }\n\nDay 2\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160207\"\n traffic_percent_strategy: {\n percentages: {\n \"example.googleapis.com/20160206\": 100.00\n }\n }\n }",
|
| - "id": "TrafficPercentStrategy",
|
| + "ConfigRef": {
|
| + "description": "Represents a service configuration with its name and id.",
|
| + "id": "ConfigRef",
|
| "properties": {
|
| - "percentages": {
|
| - "additionalProperties": {
|
| - "format": "double",
|
| - "type": "number"
|
| - },
|
| - "description": "Maps service configuration IDs to their corresponding traffic percentage.\nKey is the service configuration ID, Value is the traffic percentage\nwhich must be greater than 0.0 and the sum must equal to 100.0.",
|
| - "type": "object"
|
| + "name": {
|
| + "description": "Resource name of a service config. It must have the following\nformat: \"services/{service name}/configs/{config id}\".",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "AuthRequirement": {
|
| - "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
|
| - "id": "AuthRequirement",
|
| + "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": {
|
| - "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",
|
| + "root": {
|
| + "description": "If non-empty specifies a path under which inherited HTTP paths\nare rooted.",
|
| "type": "string"
|
| },
|
| - "providerId": {
|
| - "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
|
| + "name": {
|
| + "description": "The fully qualified name of the API which is included.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Condition": {
|
| - "description": "A condition to be met.",
|
| - "id": "Condition",
|
| + "FlowOperationMetadata": {
|
| + "description": "The metadata associated with a long running operation resource.",
|
| + "id": "FlowOperationMetadata",
|
| "properties": {
|
| - "values": {
|
| - "description": "The objects of the condition. This is mutually exclusive with 'value'.",
|
| + "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"
|
| + },
|
| + "resourceNames": {
|
| + "description": "The full name of the resources that this flow is directly associated with.",
|
| "items": {
|
| "type": "string"
|
| },
|
| "type": "array"
|
| },
|
| - "iam": {
|
| - "description": "Trusted attributes supplied by the IAM system.",
|
| - "enum": [
|
| - "NO_ATTR",
|
| - "AUTHORITY",
|
| - "ATTRIBUTION",
|
| - "APPROVER",
|
| - "JUSTIFICATION_TYPE"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Default non-attribute.",
|
| - "Either principal or (if present) authority selector.",
|
| - "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
|
| - "An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).\nSee: go/rpc-security-policy-dynamicauth.",
|
| - "What types of justifications have been supplied with this request.\nString values should match enum names from tech.iam.JustificationType,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *absence* of a justification, so justification conditions can only\nbe used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "op": {
|
| - "description": "An operator to apply the subject with.",
|
| + "cancelState": {
|
| + "description": "The state of the operation with respect to cancellation.",
|
| "enum": [
|
| - "NO_OP",
|
| - "EQUALS",
|
| - "NOT_EQUALS",
|
| - "IN",
|
| - "NOT_IN",
|
| - "DISCHARGED"
|
| + "RUNNING",
|
| + "UNCANCELLABLE",
|
| + "CANCELLED"
|
| ],
|
| "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"
|
| + "Default state, cancellable but not cancelled.",
|
| + "The operation has proceeded past the point of no return and cannot\nbe cancelled.",
|
| + "The operation has been cancelled, work should cease\nand any needed rollback steps executed."
|
| ],
|
| "type": "string"
|
| },
|
| - "svc": {
|
| - "description": "Trusted attributes discharged by the service.",
|
| - "type": "string"
|
| - },
|
| - "value": {
|
| - "description": "DEPRECATED. Use 'values' instead.",
|
| + "deadline": {
|
| + "description": "Deadline for the flow to complete, to prevent orphaned Operations.\n\nIf the flow has not completed by this time, it may be terminated by\nthe engine, or force-failed by Operation lookup.\n\nNote that this is not a hard deadline after which the Flow will\ndefinitely be failed, rather it is a deadline after which it is reasonable\nto suspect a problem and other parts of the system may kill operation\nto ensure we don't have orphans.\nsee also: go/prevent-orphaned-operations",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| },
|
| - "sys": {
|
| - "description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.",
|
| - "enum": [
|
| - "NO_ATTR",
|
| - "REGION",
|
| - "SERVICE",
|
| - "NAME",
|
| - "IP"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Default non-attribute type",
|
| - "Region of the resource",
|
| - "Service name",
|
| - "Resource name",
|
| - "IP address of the caller"
|
| - ],
|
| + "startTime": {
|
| + "description": "The start time of the operation.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Documentation": {
|
| - "description": "`Documentation` provides the information for describing a service.\n\nExample:\n<pre><code>documentation:\n summary: >\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: >\n ...\n - selector: google.calendar.Calendar.Put\n description: >\n ...\n</code></pre>\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n<pre><code>[fully.qualified.proto.name][]</code></pre>\nTo override the display text used for the link, this can be used:\n<pre><code>[display text][fully.qualified.proto.name]</code></pre>\nText can be excluded from doc using the following notation:\n<pre><code>(-- internal comment --)</code></pre>\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n<pre><code>(--BETA: comment for BETA users --)</code></pre>\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n<pre><code>(== include path/to/file ==)</code></pre>\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n<pre><code>(== resource_for v1.shelves.books ==)</code></pre>\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
|
| - "id": "Documentation",
|
| + "CustomError": {
|
| + "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": {
|
| - "pages": {
|
| - "description": "The top level pages for the documentation set.",
|
| + "types": {
|
| + "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
|
| "items": {
|
| - "$ref": "Page"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| },
|
| - "summary": {
|
| - "description": "A short summary of what the service does. Can only be provided by\nplain text.",
|
| - "type": "string"
|
| - },
|
| - "documentationRootUrl": {
|
| - "description": "The URL to the root of documentation.",
|
| - "type": "string"
|
| - },
|
| "rules": {
|
| - "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| + "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": {
|
| - "$ref": "DocumentationRule"
|
| + "$ref": "CustomErrorRule"
|
| },
|
| "type": "array"
|
| - },
|
| - "overview": {
|
| - "description": "Declares a single overview page. For example:\n<pre><code>documentation:\n summary: ...\n overview: (== include overview.md ==)\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: (== include overview.md ==)\n</code></pre>\nNote: you cannot specify both `overview` field and `pages` field.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "AuditLogConfig": {
|
| - "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
| - "id": "AuditLogConfig",
|
| + "CounterOptions": {
|
| + "description": "Options for counters",
|
| + "id": "CounterOptions",
|
| "properties": {
|
| - "exemptedMembers": {
|
| - "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| + "metric": {
|
| + "description": "The metric to update.",
|
| + "type": "string"
|
| },
|
| - "logType": {
|
| - "description": "The log type that this config enables.",
|
| - "enum": [
|
| - "LOG_TYPE_UNSPECIFIED",
|
| - "ADMIN_READ",
|
| - "DATA_WRITE",
|
| - "DATA_READ"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Default case. Should never be this.",
|
| - "Admin reads. Example: CloudIAM getIamPolicy",
|
| - "Data writes. Example: CloudSQL Users create",
|
| - "Data reads. Example: CloudSQL Users list"
|
| - ],
|
| + "field": {
|
| + "description": "The field value to attribute.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ConfigSource": {
|
| - "description": "Represents a source file which is used to generate the service configuration\ndefined by `google.api.Service`.",
|
| - "id": "ConfigSource",
|
| + "Http": {
|
| + "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": {
|
| - "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`).",
|
| + "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": {
|
| - "$ref": "ConfigFile"
|
| + "$ref": "HttpRule"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "BackendRule": {
|
| - "description": "A backend rule provides configuration for an individual API element.",
|
| - "id": "BackendRule",
|
| - "properties": {
|
| - "deadline": {
|
| - "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
|
| - "format": "double",
|
| - "type": "number"
|
| - },
|
| - "address": {
|
| - "description": "The address of the API backend.",
|
| - "type": "string"
|
| - },
|
| - "selector": {
|
| - "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "AuthenticationRule": {
|
| - "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.",
|
| - "id": "AuthenticationRule",
|
| + "SourceInfo": {
|
| + "description": "Source information used to create a Service Config",
|
| + "id": "SourceInfo",
|
| "properties": {
|
| - "requirements": {
|
| - "description": "Requirements for additional authentication providers.",
|
| + "sourceFiles": {
|
| + "description": "All files used during config generation.",
|
| "items": {
|
| - "$ref": "AuthRequirement"
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| + },
|
| + "type": "object"
|
| },
|
| "type": "array"
|
| - },
|
| - "selector": {
|
| - "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| - "type": "string"
|
| - },
|
| - "allowWithoutCredential": {
|
| - "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
|
| - "type": "boolean"
|
| - },
|
| - "oauth": {
|
| - "$ref": "OAuthRequirements",
|
| - "description": "The requirements for OAuth credentials."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "UndeleteServiceResponse": {
|
| - "description": "Response message for UndeleteService method.",
|
| - "id": "UndeleteServiceResponse",
|
| + "Control": {
|
| + "description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.",
|
| + "id": "Control",
|
| "properties": {
|
| - "service": {
|
| - "$ref": "ManagedService",
|
| - "description": "Revived service resource."
|
| + "environment": {
|
| + "description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Policy": {
|
| - "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",
|
| + "SystemParameter": {
|
| + "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": {
|
| - "auditConfigs": {
|
| - "description": "Specifies cloud audit logging configuration for this policy.",
|
| - "items": {
|
| - "$ref": "AuditConfig"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "bindings": {
|
| - "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
|
| - "items": {
|
| - "$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",
|
| + "httpHeader": {
|
| + "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.",
|
| "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"
|
| + "name": {
|
| + "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
|
| + "type": "string"
|
| },
|
| - "version": {
|
| - "description": "Version of the `Policy`. The default version is 0.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "urlQueryParameter": {
|
| + "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Api": {
|
| - "description": "Api is a light-weight descriptor for a protocol buffer service.",
|
| - "id": "Api",
|
| + "Field": {
|
| + "description": "A single field of a message type.",
|
| + "id": "Field",
|
| "properties": {
|
| - "mixins": {
|
| - "description": "Included APIs. See Mixin.",
|
| - "items": {
|
| - "$ref": "Mixin"
|
| - },
|
| - "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"
|
| },
|
| - "options": {
|
| - "description": "Any metadata attached to the API.",
|
| - "items": {
|
| - "$ref": "Option"
|
| - },
|
| - "type": "array"
|
| + "packed": {
|
| + "description": "Whether to use alternative packed wire representation.",
|
| + "type": "boolean"
|
| },
|
| - "methods": {
|
| - "description": "The methods of this api, in unspecified order.",
|
| - "items": {
|
| - "$ref": "Method"
|
| - },
|
| - "type": "array"
|
| + "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 fully qualified name of this api, including package name\nfollowed by the api's simple name.",
|
| + "description": "The field name.",
|
| "type": "string"
|
| },
|
| - "syntax": {
|
| - "description": "The source syntax of the service.",
|
| + "typeUrl": {
|
| + "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
|
| + "type": "string"
|
| + },
|
| + "number": {
|
| + "description": "The field number.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "kind": {
|
| + "description": "The field type.",
|
| "enum": [
|
| - "SYNTAX_PROTO2",
|
| - "SYNTAX_PROTO3"
|
| + "TYPE_UNKNOWN",
|
| + "TYPE_DOUBLE",
|
| + "TYPE_FLOAT",
|
| + "TYPE_INT64",
|
| + "TYPE_UINT64",
|
| + "TYPE_INT32",
|
| + "TYPE_FIXED64",
|
| + "TYPE_FIXED32",
|
| + "TYPE_BOOL",
|
| + "TYPE_STRING",
|
| + "TYPE_GROUP",
|
| + "TYPE_MESSAGE",
|
| + "TYPE_BYTES",
|
| + "TYPE_UINT32",
|
| + "TYPE_ENUM",
|
| + "TYPE_SFIXED32",
|
| + "TYPE_SFIXED64",
|
| + "TYPE_SINT32",
|
| + "TYPE_SINT64"
|
| ],
|
| "enumDescriptions": [
|
| - "Syntax `proto2`.",
|
| - "Syntax `proto3`."
|
| + "Field type unknown.",
|
| + "Field type double.",
|
| + "Field type float.",
|
| + "Field type int64.",
|
| + "Field type uint64.",
|
| + "Field type int32.",
|
| + "Field type fixed64.",
|
| + "Field type fixed32.",
|
| + "Field type bool.",
|
| + "Field type string.",
|
| + "Field type group. Proto2 syntax only, and deprecated.",
|
| + "Field type message.",
|
| + "Field type bytes.",
|
| + "Field type uint32.",
|
| + "Field type enum.",
|
| + "Field type sfixed32.",
|
| + "Field type sfixed64.",
|
| + "Field type sint32.",
|
| + "Field type sint64."
|
| ],
|
| "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",
|
| + "jsonName": {
|
| + "description": "The field JSON name.",
|
| "type": "string"
|
| + },
|
| + "options": {
|
| + "description": "The protocol buffer options.",
|
| + "items": {
|
| + "$ref": "Option"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "DataAccessOptions": {
|
| - "description": "Write a Data Access (Gin) log",
|
| - "id": "DataAccessOptions",
|
| - "properties": {},
|
| - "type": "object"
|
| - },
|
| - "Authentication": {
|
| - "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",
|
| + "Monitoring": {
|
| + "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count",
|
| + "id": "Monitoring",
|
| "properties": {
|
| - "providers": {
|
| - "description": "Defines a set of authentication providers that a service supports.",
|
| + "consumerDestinations": {
|
| + "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
|
| "items": {
|
| - "$ref": "AuthProvider"
|
| + "$ref": "MonitoringDestination"
|
| },
|
| "type": "array"
|
| },
|
| - "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.",
|
| + "producerDestinations": {
|
| + "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
|
| "items": {
|
| - "$ref": "AuthenticationRule"
|
| + "$ref": "MonitoringDestination"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Operation": {
|
| - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
|
| - "id": "Operation",
|
| + "TestIamPermissionsRequest": {
|
| + "description": "Request message for `TestIamPermissions` method.",
|
| + "id": "TestIamPermissionsRequest",
|
| "properties": {
|
| - "error": {
|
| - "$ref": "Status",
|
| - "description": "The error result of the operation in case of failure or cancellation."
|
| - },
|
| - "metadata": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| - },
|
| - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
|
| - "type": "object"
|
| - },
|
| - "done": {
|
| - "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
|
| - "type": "boolean"
|
| - },
|
| - "response": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| + "permissions": {
|
| + "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
|
| + "items": {
|
| + "type": "string"
|
| },
|
| - "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
|
| - "type": "object"
|
| - },
|
| - "name": {
|
| - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
|
| - "type": "string"
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Page": {
|
| - "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
|
| - "id": "Page",
|
| + "Enum": {
|
| + "description": "Enum type definition.",
|
| + "id": "Enum",
|
| "properties": {
|
| - "subpages": {
|
| - "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
|
| + "name": {
|
| + "description": "Enum type name.",
|
| + "type": "string"
|
| + },
|
| + "enumvalue": {
|
| + "description": "Enum value definitions.",
|
| "items": {
|
| - "$ref": "Page"
|
| + "$ref": "EnumValue"
|
| },
|
| "type": "array"
|
| },
|
| - "name": {
|
| - "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n<pre><code>pages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n</code></pre>\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
|
| - "type": "string"
|
| + "options": {
|
| + "description": "Protocol buffer options.",
|
| + "items": {
|
| + "$ref": "Option"
|
| + },
|
| + "type": "array"
|
| },
|
| - "content": {
|
| - "description": "The Markdown content of the page. You can use <code>(== include {path} ==)</code>\nto include content from a Markdown file.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Status": {
|
| - "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"
|
| + "sourceContext": {
|
| + "$ref": "SourceContext",
|
| + "description": "The source context."
|
| },
|
| - "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.",
|
| + "syntax": {
|
| + "description": "The source syntax.",
|
| + "enum": [
|
| + "SYNTAX_PROTO2",
|
| + "SYNTAX_PROTO3"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Syntax `proto2`.",
|
| + "Syntax `proto3`."
|
| + ],
|
| "type": "string"
|
| - },
|
| - "details": {
|
| - "description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
|
| - "items": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| - },
|
| - "type": "object"
|
| - },
|
| - "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Binding": {
|
| - "description": "Associates `members` with a `role`.",
|
| - "id": "Binding",
|
| + "EnableServiceRequest": {
|
| + "description": "Request message for EnableService method.",
|
| + "id": "EnableServiceRequest",
|
| "properties": {
|
| - "members": {
|
| - "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "role": {
|
| - "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
|
| + "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"
|
| },
|
| - "AuthProvider": {
|
| - "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",
|
| + "LabelDescriptor": {
|
| + "description": "A description of a label.",
|
| + "id": "LabelDescriptor",
|
| "properties": {
|
| - "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\".",
|
| + "key": {
|
| + "description": "The label key.",
|
| "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",
|
| + "description": {
|
| + "description": "A human-readable description for the label.",
|
| "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",
|
| + "valueType": {
|
| + "description": "The type of data that can be assigned to the label.",
|
| + "enum": [
|
| + "STRING",
|
| + "BOOL",
|
| + "INT64"
|
| + ],
|
| + "enumDescriptions": [
|
| + "A variable-length string. This is the default.",
|
| + "Boolean; true or false.",
|
| + "A 64-bit signed integer."
|
| + ],
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "EnumValue": {
|
| - "description": "Enum value definition.",
|
| - "id": "EnumValue",
|
| + "Diagnostic": {
|
| + "description": "Represents a diagnostic message (error or warning)",
|
| + "id": "Diagnostic",
|
| "properties": {
|
| - "name": {
|
| - "description": "Enum value name.",
|
| + "message": {
|
| + "description": "Message describing the error or warning.",
|
| "type": "string"
|
| },
|
| - "options": {
|
| - "description": "Protocol buffer options.",
|
| - "items": {
|
| - "$ref": "Option"
|
| - },
|
| - "type": "array"
|
| + "location": {
|
| + "description": "File name and line number of the error or warning.",
|
| + "type": "string"
|
| },
|
| - "number": {
|
| - "description": "Enum value number.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "kind": {
|
| + "description": "The kind of diagnostic information provided.",
|
| + "enum": [
|
| + "WARNING",
|
| + "ERROR"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Warnings and errors",
|
| + "Only errors"
|
| + ],
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Service": {
|
| - "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
|
| - "id": "Service",
|
| + "GenerateConfigReportResponse": {
|
| + "description": "Response message for GenerateConfigReport method.",
|
| + "id": "GenerateConfigReportResponse",
|
| "properties": {
|
| - "types": {
|
| - "description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32",
|
| + "changeReports": {
|
| + "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations.",
|
| "items": {
|
| - "$ref": "Type"
|
| + "$ref": "ChangeReport"
|
| },
|
| "type": "array"
|
| },
|
| - "http": {
|
| - "$ref": "Http",
|
| - "description": "HTTP configuration."
|
| - },
|
| - "systemParameters": {
|
| - "$ref": "SystemParameters",
|
| - "description": "System parameter configuration."
|
| - },
|
| - "backend": {
|
| - "$ref": "Backend",
|
| - "description": "API backend configuration."
|
| - },
|
| - "documentation": {
|
| - "$ref": "Documentation",
|
| - "description": "Additional API documentation."
|
| - },
|
| - "logging": {
|
| - "$ref": "Logging",
|
| - "description": "Logging configuration."
|
| + "id": {
|
| + "description": "ID of the service configuration this report belongs to.",
|
| + "type": "string"
|
| },
|
| - "monitoredResources": {
|
| - "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
|
| + "diagnostics": {
|
| + "description": "Errors / Linter warnings associated with the service definition this\nreport\nbelongs to.",
|
| "items": {
|
| - "$ref": "MonitoredResourceDescriptor"
|
| + "$ref": "Diagnostic"
|
| },
|
| "type": "array"
|
| },
|
| - "context": {
|
| - "$ref": "Context",
|
| - "description": "Context configuration."
|
| - },
|
| - "enums": {
|
| - "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum",
|
| + "serviceName": {
|
| + "description": "Name of the service this report belongs to.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Type": {
|
| + "description": "A protocol buffer message type.",
|
| + "id": "Type",
|
| + "properties": {
|
| + "fields": {
|
| + "description": "The list of fields.",
|
| "items": {
|
| - "$ref": "Enum"
|
| + "$ref": "Field"
|
| },
|
| "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.",
|
| + "name": {
|
| + "description": "The fully qualified message name.",
|
| "type": "string"
|
| },
|
| - "usage": {
|
| - "$ref": "Usage",
|
| - "description": "Configuration controlling usage of this service."
|
| - },
|
| - "metrics": {
|
| - "description": "Defines the metrics used by this service.",
|
| + "oneofs": {
|
| + "description": "The list of types appearing in `oneof` definitions in this type.",
|
| "items": {
|
| - "$ref": "MetricDescriptor"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| },
|
| - "authentication": {
|
| - "$ref": "Authentication",
|
| - "description": "Auth configuration."
|
| - },
|
| - "experimental": {
|
| - "$ref": "Experimental",
|
| - "description": "Experimental configuration."
|
| - },
|
| - "control": {
|
| - "$ref": "Control",
|
| - "description": "Configuration for the service control plane."
|
| - },
|
| - "configVersion": {
|
| - "description": "The version of the service configuration. The config version may\ninfluence interpretation of the configuration, for example, to\ndetermine defaults. This is documented together with applicable\noptions. The current default for the config version itself is `3`.",
|
| - "format": "uint32",
|
| - "type": "integer"
|
| - },
|
| - "monitoring": {
|
| - "$ref": "Monitoring",
|
| - "description": "Monitoring configuration."
|
| + "sourceContext": {
|
| + "$ref": "SourceContext",
|
| + "description": "The source context."
|
| },
|
| - "producerProjectId": {
|
| - "description": "The id of the Google developer project that owns the service.\nMembers of this project can manage the service configuration,\nmanage consumption of the service, etc.",
|
| + "syntax": {
|
| + "description": "The source syntax.",
|
| + "enum": [
|
| + "SYNTAX_PROTO2",
|
| + "SYNTAX_PROTO3"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Syntax `proto2`.",
|
| + "Syntax `proto3`."
|
| + ],
|
| "type": "string"
|
| },
|
| - "systemTypes": {
|
| - "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.",
|
| + "options": {
|
| + "description": "The protocol buffer options.",
|
| "items": {
|
| - "$ref": "Type"
|
| + "$ref": "Option"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "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"
|
| + },
|
| + "ListServiceConfigsResponse": {
|
| + "description": "Response message for ListServiceConfigs method.",
|
| + "id": "ListServiceConfigsResponse",
|
| + "properties": {
|
| + "serviceConfigs": {
|
| + "description": "The list of service configuration resources.",
|
| + "items": {
|
| + "$ref": "Service"
|
| },
|
| "type": "array"
|
| },
|
| - "visibility": {
|
| - "$ref": "Visibility",
|
| - "description": "API visibility configuration."
|
| - },
|
| - "name": {
|
| - "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
|
| - "type": "string"
|
| - },
|
| - "customError": {
|
| - "$ref": "CustomError",
|
| - "description": "Custom error configuration."
|
| - },
|
| - "title": {
|
| - "description": "The product title associated with this service.",
|
| + "nextPageToken": {
|
| + "description": "The token of the next page of results.",
|
| "type": "string"
|
| - },
|
| - "endpoints": {
|
| - "description": "Configuration for network endpoints. If this is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.",
|
| + }
|
| + },
|
| + "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.",
|
| + "id": "AuditConfig",
|
| + "properties": {
|
| + "auditLogConfigs": {
|
| + "description": "The configuration for logging of each type of permission.\nNext ID: 4",
|
| "items": {
|
| - "$ref": "Endpoint"
|
| + "$ref": "AuditLogConfig"
|
| },
|
| "type": "array"
|
| },
|
| - "apis": {
|
| - "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files.",
|
| + "exemptedMembers": {
|
| "items": {
|
| - "$ref": "Api"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| },
|
| - "logs": {
|
| - "description": "Defines the logs used by this service.",
|
| + "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"
|
| + },
|
| + "Backend": {
|
| + "description": "`Backend` defines the backend configuration for a service.",
|
| + "id": "Backend",
|
| + "properties": {
|
| + "rules": {
|
| + "description": "A list of API backend rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| "items": {
|
| - "$ref": "LogDescriptor"
|
| + "$ref": "BackendRule"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "CustomHttpPattern": {
|
| - "description": "A custom pattern is used for defining custom HTTP verb.",
|
| - "id": "CustomHttpPattern",
|
| + "SubmitConfigSourceRequest": {
|
| + "description": "Request message for SubmitConfigSource method.",
|
| + "id": "SubmitConfigSourceRequest",
|
| "properties": {
|
| - "kind": {
|
| - "description": "The name of this custom HTTP verb.",
|
| - "type": "string"
|
| + "configSource": {
|
| + "$ref": "ConfigSource",
|
| + "description": "The source configuration for the service."
|
| },
|
| - "path": {
|
| - "description": "The path matched by this custom verb.",
|
| + "validateOnly": {
|
| + "description": "Optional. If set, this will result in the generation of a\n`google.api.Service` configuration based on the `ConfigSource` provided,\nbut the generated config and the sources will NOT be persisted.",
|
| + "type": "boolean"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "AuthorizationConfig": {
|
| + "description": "Configuration of authorization.\n\nThis section determines the authorization provider, if unspecified, then no\nauthorization check will be done.\n\nExample:\n\n experimental:\n authorization:\n provider: firebaserules.googleapis.com",
|
| + "id": "AuthorizationConfig",
|
| + "properties": {
|
| + "provider": {
|
| + "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "OperationMetadata": {
|
| - "description": "The metadata associated with a long running operation resource.",
|
| - "id": "OperationMetadata",
|
| + "DocumentationRule": {
|
| + "description": "A documentation rule provides information about individual API elements.",
|
| + "id": "DocumentationRule",
|
| "properties": {
|
| - "startTime": {
|
| - "description": "The start time of the operation.",
|
| - "format": "google-datetime",
|
| + "deprecationDescription": {
|
| + "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.",
|
| "type": "string"
|
| },
|
| - "resourceNames": {
|
| - "description": "The full name of the resources that this operation is directly\nassociated with.",
|
| + "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"
|
| + },
|
| + "CloudAuditOptions": {
|
| + "description": "Write a Cloud Audit log",
|
| + "id": "CloudAuditOptions",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| + "ContextRule": {
|
| + "description": "A context rule provides information about the context for an individual API\nelement.",
|
| + "id": "ContextRule",
|
| + "properties": {
|
| + "requested": {
|
| + "description": "A list of full type names of requested contexts.",
|
| "items": {
|
| "type": "string"
|
| },
|
| "type": "array"
|
| },
|
| - "steps": {
|
| - "description": "Detailed status information for each step. The order is undetermined.",
|
| + "selector": {
|
| + "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| + "type": "string"
|
| + },
|
| + "provided": {
|
| + "description": "A list of full type names of provided contexts.",
|
| "items": {
|
| - "$ref": "Step"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| - },
|
| - "progressPercentage": {
|
| - "description": "Percentage of completion of this operation, ranging from 0 to 100.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "SystemParameterRule": {
|
| - "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
|
| - "id": "SystemParameterRule",
|
| + "SourceContext": {
|
| + "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
|
| + "id": "SourceContext",
|
| "properties": {
|
| - "parameters": {
|
| - "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.",
|
| - "items": {
|
| - "$ref": "SystemParameter"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "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.",
|
| + "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"
|
| },
|
| - "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¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it assumes there is no HTTP body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. It follows the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String\nExpansion.\n\nThe syntax `**` matches zero or more path segments. It follows the semantics\nof [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved\nExpansion. NOTE: it must be the last segment in the path except the Verb.\n\nThe syntax `LITERAL` matches literal text in the URL path.\n\nThe syntax `Variable` matches the entire path as specified by its template;\nthis nested template must not contain further variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.\n\nUse CustomHttpPattern to specify any HTTP method that is not included in the\n`pattern` field, such as HEAD, or \"*\" to leave the HTTP method unspecified for\na given URL path rule. The wild-card rule is useful for services that provide\ncontent to Web (HTML) clients.",
|
| - "id": "HttpRule",
|
| + "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": {
|
| - "mediaUpload": {
|
| - "$ref": "MediaUpload",
|
| - "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods."
|
| - },
|
| - "selector": {
|
| - "description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| + "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"
|
| },
|
| - "custom": {
|
| - "$ref": "CustomHttpPattern",
|
| - "description": "Custom pattern is used for defining custom verbs."
|
| + "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"
|
| },
|
| - "patch": {
|
| - "description": "Used for updating a resource.",
|
| + "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"
|
| },
|
| - "get": {
|
| - "description": "Used for listing and getting information about resources.",
|
| + "type": {
|
| + "description": "The metric type, including its DNS name prefix. The type is not\nURL-encoded. All user-defined custom metric types have the DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchical\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"\n \"appengine.googleapis.com/http/server/response_latencies\"",
|
| "type": "string"
|
| },
|
| - "put": {
|
| - "description": "Used for updating a resource.",
|
| + "valueType": {
|
| + "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
|
| + "enum": [
|
| + "VALUE_TYPE_UNSPECIFIED",
|
| + "BOOL",
|
| + "INT64",
|
| + "DOUBLE",
|
| + "STRING",
|
| + "DISTRIBUTION",
|
| + "MONEY"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Do not use this default value.",
|
| + "The value is a boolean.\nThis value type can be used only if the metric kind is `GAUGE`.",
|
| + "The value is a signed 64-bit integer.",
|
| + "The value is a double precision floating point number.",
|
| + "The value is a text string.\nThis value type can be used only if the metric kind is `GAUGE`.",
|
| + "The value is a `Distribution`.",
|
| + "The value is money."
|
| + ],
|
| "type": "string"
|
| },
|
| - "delete": {
|
| - "description": "Used for deleting a resource.",
|
| + "metricKind": {
|
| + "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
|
| + "enum": [
|
| + "METRIC_KIND_UNSPECIFIED",
|
| + "GAUGE",
|
| + "DELTA",
|
| + "CUMULATIVE"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Do not use this default value.",
|
| + "An instantaneous measurement of a value.",
|
| + "The change in a value during a time interval.",
|
| + "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints."
|
| + ],
|
| "type": "string"
|
| },
|
| - "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.",
|
| + "description": {
|
| + "description": "A detailed description of the metric, which can be used in documentation.",
|
| "type": "string"
|
| },
|
| - "post": {
|
| - "description": "Used for creating a resource.",
|
| + "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"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListServicesResponse": {
|
| + "description": "Response message for `ListServices` method.",
|
| + "id": "ListServicesResponse",
|
| + "properties": {
|
| + "services": {
|
| + "description": "The returned services will only have the name field set.",
|
| + "items": {
|
| + "$ref": "ManagedService"
|
| + },
|
| + "type": "array"
|
| },
|
| - "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."
|
| + "nextPageToken": {
|
| + "description": "Token that can be passed to `ListServices` to resume a paginated query.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Endpoint": {
|
| + "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.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| },
|
| - "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).",
|
| + "features": {
|
| + "description": "The list of features enabled on this endpoint.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "allowCors": {
|
| + "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.",
|
| + "type": "boolean"
|
| + },
|
| + "name": {
|
| + "description": "The canonical name of this endpoint.",
|
| + "type": "string"
|
| + },
|
| + "apis": {
|
| + "description": "The list of APIs served by this endpoint.",
|
| "items": {
|
| - "$ref": "HttpRule"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| - },
|
| - "responseBody": {
|
| - "description": "The name of the response field whose value is mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "VisibilityRule": {
|
| - "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
|
| - "id": "VisibilityRule",
|
| + "OAuthRequirements": {
|
| + "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
|
| + "id": "OAuthRequirements",
|
| "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.",
|
| + "canonicalScopes": {
|
| + "description": "The list of publicly documented OAuth scopes that are allowed access. An\nOAuth token containing any of these scopes will be accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth/calendar,\n https://www.googleapis.com/auth/calendar.read",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "MonitoringDestination": {
|
| - "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
|
| - "id": "MonitoringDestination",
|
| + "TestIamPermissionsResponse": {
|
| + "description": "Response message for `TestIamPermissions` method.",
|
| + "id": "TestIamPermissionsResponse",
|
| "properties": {
|
| - "monitoredResource": {
|
| - "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
|
| - "type": "string"
|
| - },
|
| - "metrics": {
|
| - "description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.",
|
| + "permissions": {
|
| + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
|
| "items": {
|
| "type": "string"
|
| },
|
| @@ -1763,1066 +1650,1167 @@
|
| },
|
| "type": "object"
|
| },
|
| - "Visibility": {
|
| - "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate.",
|
| - "id": "Visibility",
|
| + "GetIamPolicyRequest": {
|
| + "description": "Request message for `GetIamPolicy` method.",
|
| + "id": "GetIamPolicyRequest",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| + "Usage": {
|
| + "description": "Configuration controlling usage of a service.",
|
| + "id": "Usage",
|
| "properties": {
|
| + "producerNotificationChannel": {
|
| + "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.",
|
| + "type": "string"
|
| + },
|
| "rules": {
|
| - "description": "A list of visibility rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| + "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| "items": {
|
| - "$ref": "VisibilityRule"
|
| + "$ref": "UsageRule"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "requirements": {
|
| + "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form <service.name>/<requirement-id>;\nfor example 'serviceusage.googleapis.com/billing-enabled'.",
|
| + "items": {
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "SystemParameters": {
|
| - "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.",
|
| - "id": "SystemParameters",
|
| + "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",
|
| "properties": {
|
| "rules": {
|
| - "description": "Define system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\n\nExample: define api key for all methods\n\n system_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n\n\nExample: define 2 api key names for a specific method.\n\n system_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n - name: api_key\n http_header: Api-Key1\n - name: api_key\n http_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| + "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| "items": {
|
| - "$ref": "SystemParameterRule"
|
| + "$ref": "ContextRule"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ConfigChange": {
|
| - "description": "Output generated from semantically comparing two versions of a service\nconfiguration.\n\nIncludes detailed information about a field that have changed with\napplicable advice about potential consequences for the change, such as\nbackwards-incompatibility.",
|
| - "id": "ConfigChange",
|
| + "Rule": {
|
| + "description": "A rule to be applied in a Policy.",
|
| + "id": "Rule",
|
| "properties": {
|
| - "changeType": {
|
| - "description": "The type for this change, either ADDED, REMOVED, or MODIFIED.",
|
| + "logConfig": {
|
| + "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
|
| + "items": {
|
| + "$ref": "LogConfig"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "in": {
|
| + "description": "If one or more 'in' clauses are specified, the rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "permissions": {
|
| + "description": "A permission is a string of form '<service>.<resource type>.<verb>'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "action": {
|
| + "description": "Required",
|
| "enum": [
|
| - "CHANGE_TYPE_UNSPECIFIED",
|
| - "ADDED",
|
| - "REMOVED",
|
| - "MODIFIED"
|
| + "NO_ACTION",
|
| + "ALLOW",
|
| + "ALLOW_WITH_LOG",
|
| + "DENY",
|
| + "DENY_WITH_LOG",
|
| + "LOG"
|
| ],
|
| "enumDescriptions": [
|
| - "No value was provided.",
|
| - "The changed object exists in the 'new' service configuration, but not\nin the 'old' service configuration.",
|
| - "The changed object exists in the 'old' service configuration, but not\nin the 'new' service configuration.",
|
| - "The changed object exists in both service configurations, but its value\nis different."
|
| + "Default no action.",
|
| + "Matching 'Entries' grant access.",
|
| + "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",
|
| + "Matching 'Entries' deny access.",
|
| + "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
|
| + "Matching 'Entries' tell IAM.Check callers to generate logs."
|
| ],
|
| "type": "string"
|
| },
|
| - "element": {
|
| - "description": "Object hierarchy path to the change, with levels separated by a '.'\ncharacter. For repeated fields, an applicable unique identifier field is\nused for the index (usually selector, name, or id). For maps, the term\n'key' is used. If the field has no unique identifier, the numeric index\nis used.\nExamples:\n- visibility.rules[selector==\"google.LibraryService.CreateBook\"].restriction\n- quota.metric_rules[selector==\"google\"].metric_costs[key==\"reads\"].value\n- logging.producer_destinations[0]",
|
| - "type": "string"
|
| + "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"
|
| },
|
| - "oldValue": {
|
| - "description": "Value of the changed object in the old Service configuration,\nin JSON format. This field will not be populated if ChangeType == ADDED.",
|
| + "description": {
|
| + "description": "Human-readable description of the rule.",
|
| "type": "string"
|
| },
|
| - "advices": {
|
| - "description": "Collection of advice provided for this change, useful for determining the\npossible impact of this change.",
|
| + "conditions": {
|
| + "description": "Additional restrictions that must be met",
|
| "items": {
|
| - "$ref": "Advice"
|
| + "$ref": "Condition"
|
| },
|
| "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "LogConfig": {
|
| + "description": "Specifies what kind of log the caller must write",
|
| + "id": "LogConfig",
|
| + "properties": {
|
| + "counter": {
|
| + "$ref": "CounterOptions",
|
| + "description": "Counter options."
|
| },
|
| - "newValue": {
|
| - "description": "Value of the changed object in the new Service configuration,\nin JSON format. This field will not be populated if ChangeType == REMOVED.",
|
| - "type": "string"
|
| + "dataAccess": {
|
| + "$ref": "DataAccessOptions",
|
| + "description": "Data access options."
|
| + },
|
| + "cloudAudit": {
|
| + "$ref": "CloudAuditOptions",
|
| + "description": "Cloud audit options."
|
| }
|
| },
|
| "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",
|
| + "LogDescriptor": {
|
| + "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": {
|
| - "deleteServiceStrategy": {
|
| - "$ref": "DeleteServiceStrategy",
|
| - "description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly."
|
| + "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"
|
| },
|
| - "createTime": {
|
| - "description": "Creation time of the rollout. Readonly.",
|
| - "format": "google-datetime",
|
| + "description": {
|
| + "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
|
| "type": "string"
|
| },
|
| - "status": {
|
| - "description": "The status of this rollout. Readonly. In case of a failed rollout,\nthe system will automatically rollback to the current Rollout\nversion. Readonly.",
|
| + "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"
|
| + },
|
| + "ConfigFile": {
|
| + "description": "Generic specification of a source configuration file",
|
| + "id": "ConfigFile",
|
| + "properties": {
|
| + "filePath": {
|
| + "description": "The file name of the configuration file (full or relative path).",
|
| + "type": "string"
|
| + },
|
| + "fileType": {
|
| + "description": "The type of configuration file this represents.",
|
| "enum": [
|
| - "ROLLOUT_STATUS_UNSPECIFIED",
|
| - "IN_PROGRESS",
|
| - "SUCCESS",
|
| - "CANCELLED",
|
| - "FAILED",
|
| - "PENDING"
|
| + "FILE_TYPE_UNSPECIFIED",
|
| + "SERVICE_CONFIG_YAML",
|
| + "OPEN_API_JSON",
|
| + "OPEN_API_YAML",
|
| + "FILE_DESCRIPTOR_SET_PROTO"
|
| ],
|
| "enumDescriptions": [
|
| - "No status specified.",
|
| - "The Rollout is in progress.",
|
| - "The Rollout has completed successfully.",
|
| - "The Rollout has been cancelled. This can happen if you have overlapping\nRollout pushes, and the previous ones will be cancelled.",
|
| - "The Rollout has failed. It is typically caused by configuration errors.",
|
| - "The Rollout has not started yet and is pending for execution."
|
| + "Unknown file type.",
|
| + "YAML-specification of service.",
|
| + "OpenAPI specification, serialized in JSON.",
|
| + "OpenAPI specification, serialized in YAML.",
|
| + "FileDescriptorSet, generated by protoc.\n\nTo generate, use protoc with imports and source info included.\nFor an example test.proto file, the following command would put the value\nin a new file named out.pb.\n\n$protoc --include_imports --include_source_info test.proto -o out.pb"
|
| ],
|
| "type": "string"
|
| },
|
| - "serviceName": {
|
| - "description": "The name of the service associated with this Rollout.",
|
| + "fileContents": {
|
| + "description": "The bytes that constitute the file.",
|
| + "format": "byte",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "MonitoredResourceDescriptor": {
|
| + "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"
|
| },
|
| - "createdBy": {
|
| - "description": "The user who created the Rollout. Readonly.",
|
| + "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"
|
| + },
|
| + "description": {
|
| + "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation.",
|
| "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": {
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "GenerateConfigReportRequest": {
|
| - "description": "Request message for GenerateConfigReport method.",
|
| - "id": "GenerateConfigReportRequest",
|
| + "CustomErrorRule": {
|
| + "description": "A custom error rule.",
|
| + "id": "CustomErrorRule",
|
| "properties": {
|
| - "oldConfig": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| - },
|
| - "description": "Service configuration against which the comparison will be done.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service",
|
| - "type": "object"
|
| + "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"
|
| },
|
| - "newConfig": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| - },
|
| - "description": "Service configuration for which we want to generate the report.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service",
|
| - "type": "object"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "SetIamPolicyRequest": {
|
| - "description": "Request message for `SetIamPolicy` method.",
|
| - "id": "SetIamPolicyRequest",
|
| - "properties": {
|
| - "updateMask": {
|
| - "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, a default\nmask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
|
| - "format": "google-fieldmask",
|
| + "selector": {
|
| + "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.",
|
| "type": "string"
|
| - },
|
| - "policy": {
|
| - "$ref": "Policy",
|
| - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Step": {
|
| - "description": "Represents the status of one operation step.",
|
| - "id": "Step",
|
| + "MediaDownload": {
|
| + "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
|
| + "id": "MediaDownload",
|
| "properties": {
|
| - "description": {
|
| - "description": "The short description of the step.",
|
| - "type": "string"
|
| + "enabled": {
|
| + "description": "Whether download is enabled.",
|
| + "type": "boolean"
|
| },
|
| - "status": {
|
| - "description": "The status code.",
|
| - "enum": [
|
| - "STATUS_UNSPECIFIED",
|
| - "DONE",
|
| - "NOT_STARTED",
|
| - "IN_PROGRESS",
|
| - "FAILED",
|
| - "CANCELLED"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Unspecifed code.",
|
| - "The operation or step has completed without errors.",
|
| - "The operation or step has not started yet.",
|
| - "The operation or step is in progress.",
|
| - "The operation or step has completed with errors.",
|
| - "The operation or step has completed with cancellation."
|
| - ],
|
| + "downloadService": {
|
| + "description": "DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "DeleteServiceStrategy": {
|
| - "description": "Strategy used to delete a service. This strategy is a placeholder only\nused by the system generated rollout to delete a service.",
|
| - "id": "DeleteServiceStrategy",
|
| - "properties": {},
|
| - "type": "object"
|
| - },
|
| - "LoggingDestination": {
|
| - "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
|
| - "id": "LoggingDestination",
|
| + "ChangeReport": {
|
| + "description": "Change report associated with a particular service configuration.\n\nIt contains a list of ConfigChanges based on the comparison between\ntwo service configurations.",
|
| + "id": "ChangeReport",
|
| "properties": {
|
| - "logs": {
|
| - "description": "Names of the logs to be sent to this destination. Each name must\nbe defined in the Service.logs section. If the log name is\nnot a domain scoped name, it will be automatically prefixed with\nthe service name followed by \"/\".",
|
| + "configChanges": {
|
| + "description": "List of changes between two service configurations.\nThe changes will be alphabetically sorted based on the identifier\nof each change.\nA ConfigChange identifier is a dot separated path to the configuration.\nExample: visibility.rules[selector='LibraryService.CreateBook'].restriction",
|
| "items": {
|
| - "type": "string"
|
| + "$ref": "ConfigChange"
|
| },
|
| "type": "array"
|
| - },
|
| - "monitoredResource": {
|
| - "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Option": {
|
| - "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
|
| - "id": "Option",
|
| + "DisableServiceRequest": {
|
| + "description": "Request message for DisableService method.",
|
| + "id": "DisableServiceRequest",
|
| "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\"`.",
|
| + "consumerId": {
|
| + "description": "The identity of consumer resource which service disablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:<project_id>\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "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",
|
| + "SubmitConfigSourceResponse": {
|
| + "description": "Response message for SubmitConfigSource method.",
|
| + "id": "SubmitConfigSourceResponse",
|
| "properties": {
|
| - "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"
|
| - },
|
| - "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"
|
| - },
|
| - "type": "array"
|
| + "serviceConfig": {
|
| + "$ref": "Service",
|
| + "description": "The generated service configuration."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Method": {
|
| - "description": "Method represents a method of an api.",
|
| - "id": "Method",
|
| + "MediaUpload": {
|
| + "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
|
| + "id": "MediaUpload",
|
| "properties": {
|
| - "requestTypeUrl": {
|
| - "description": "A URL of the input message type.",
|
| + "uploadService": {
|
| + "description": "DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
|
| "type": "string"
|
| },
|
| - "requestStreaming": {
|
| - "description": "If true, the request is streamed.",
|
| + "enabled": {
|
| + "description": "Whether upload is enabled.",
|
| "type": "boolean"
|
| - },
|
| - "syntax": {
|
| - "description": "The source syntax of this method.",
|
| - "enum": [
|
| - "SYNTAX_PROTO2",
|
| - "SYNTAX_PROTO3"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Syntax `proto2`.",
|
| - "Syntax `proto3`."
|
| - ],
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Advice": {
|
| + "description": "Generated advice about this change, used for providing more\ninformation about how a change will affect the existing service.",
|
| + "id": "Advice",
|
| + "properties": {
|
| + "description": {
|
| + "description": "Useful description for why this advice was applied and what actions should\nbe taken to mitigate any implied risks.",
|
| "type": "string"
|
| - },
|
| - "responseTypeUrl": {
|
| - "description": "The URL of the output message type.",
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ManagedService": {
|
| + "description": "The full representation of a Service that is managed by\nGoogle Service Management.",
|
| + "id": "ManagedService",
|
| + "properties": {
|
| + "serviceName": {
|
| + "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements.",
|
| "type": "string"
|
| },
|
| - "options": {
|
| - "description": "Any metadata attached to the method.",
|
| - "items": {
|
| - "$ref": "Option"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "responseStreaming": {
|
| - "description": "If true, the response is streamed.",
|
| - "type": "boolean"
|
| - },
|
| - "name": {
|
| - "description": "The simple name of this method.",
|
| + "producerProjectId": {
|
| + "description": "ID of the project that produces and owns this service.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ConfigRef": {
|
| - "description": "Represents a service configuration with its name and id.",
|
| - "id": "ConfigRef",
|
| + "UsageRule": {
|
| + "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": {
|
| - "name": {
|
| - "description": "Resource name of a service config. It must have the following\nformat: \"services/{service name}/configs/{config id}\".",
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListServiceRolloutsResponse": {
|
| - "description": "Response message for ListServiceRollouts method.",
|
| - "id": "ListServiceRolloutsResponse",
|
| + "AuthRequirement": {
|
| + "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
|
| + "id": "AuthRequirement",
|
| "properties": {
|
| - "nextPageToken": {
|
| - "description": "The token of the next page of results.",
|
| + "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"
|
| },
|
| - "rollouts": {
|
| - "description": "The list of rollout resources.",
|
| - "items": {
|
| - "$ref": "Rollout"
|
| - },
|
| - "type": "array"
|
| + "providerId": {
|
| + "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Mixin": {
|
| - "description": "Declares an API to be included in this API. The including API must\nredeclare all the methods from the included API, but documentation\nand options are inherited as follows:\n\n- If after comment and whitespace stripping, the documentation\n string of the redeclared method is empty, it will be inherited\n from the original method.\n\n- Each annotation belonging to the service config (http,\n visibility) which is not set in the redeclared method will be\n inherited.\n\n- If an http annotation is inherited, the path pattern will be\n modified as follows. Any version prefix will be replaced by the\n version of the including API plus the root path if specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n service AccessControl {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rpc GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in `AccessControl` are\nalso declared with same name and request/response types in\n`Storage`. A documentation generator or annotation processor will\nsee the effective `Storage.GetAcl` method after inherting\ndocumentation and annotations as follows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the version in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP paths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nThis implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\";\n }\n ...\n }",
|
| - "id": "Mixin",
|
| + "TrafficPercentStrategy": {
|
| + "description": "Strategy that specifies how Google Service Control should select\ndifferent\nversions of service configurations based on traffic percentage.\n\nOne example of how to gradually rollout a new service configuration using\nthis\nstrategy:\nDay 1\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160206\"\n traffic_percent_strategy {\n percentages: {\n \"example.googleapis.com/20160201\": 70.00\n \"example.googleapis.com/20160206\": 30.00\n }\n }\n }\n\nDay 2\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160207\"\n traffic_percent_strategy: {\n percentages: {\n \"example.googleapis.com/20160206\": 100.00\n }\n }\n }",
|
| + "id": "TrafficPercentStrategy",
|
| "properties": {
|
| - "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"
|
| + "percentages": {
|
| + "additionalProperties": {
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "description": "Maps service configuration IDs to their corresponding traffic percentage.\nKey is the service configuration ID, Value is the traffic percentage\nwhich must be greater than 0.0 and the sum must equal to 100.0.",
|
| + "type": "object"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "CustomError": {
|
| - "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",
|
| + "Documentation": {
|
| + "description": "`Documentation` provides the information for describing a service.\n\nExample:\n<pre><code>documentation:\n summary: >\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: >\n ...\n - selector: google.calendar.Calendar.Put\n description: >\n ...\n</code></pre>\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n<pre><code>[fully.qualified.proto.name][]</code></pre>\nTo override the display text used for the link, this can be used:\n<pre><code>[display text][fully.qualified.proto.name]</code></pre>\nText can be excluded from doc using the following notation:\n<pre><code>(-- internal comment --)</code></pre>\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n<pre><code>(--BETA: comment for BETA users --)</code></pre>\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n<pre><code>(== include path/to/file ==)</code></pre>\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n<pre><code>(== resource_for v1.shelves.books ==)</code></pre>\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
|
| + "id": "Documentation",
|
| "properties": {
|
| - "types": {
|
| - "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
|
| + "pages": {
|
| + "description": "The top level pages for the documentation set.",
|
| "items": {
|
| - "type": "string"
|
| + "$ref": "Page"
|
| },
|
| "type": "array"
|
| },
|
| + "summary": {
|
| + "description": "A short summary of what the service does. Can only be provided by\nplain text.",
|
| + "type": "string"
|
| + },
|
| + "documentationRootUrl": {
|
| + "description": "The URL to the root of documentation.",
|
| + "type": "string"
|
| + },
|
| "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.",
|
| + "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| "items": {
|
| - "$ref": "CustomErrorRule"
|
| + "$ref": "DocumentationRule"
|
| },
|
| "type": "array"
|
| + },
|
| + "overview": {
|
| + "description": "Declares a single overview page. For example:\n<pre><code>documentation:\n summary: ...\n overview: (== include overview.md ==)\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: (== include overview.md ==)\n</code></pre>\nNote: you cannot specify both `overview` field and `pages` field.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "CounterOptions": {
|
| - "description": "Options for counters",
|
| - "id": "CounterOptions",
|
| + "Condition": {
|
| + "description": "A condition to be met.",
|
| + "id": "Condition",
|
| "properties": {
|
| - "metric": {
|
| - "description": "The metric to update.",
|
| + "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"
|
| },
|
| - "field": {
|
| - "description": "The field value to attribute.",
|
| + "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": [
|
| + "NO_ATTR",
|
| + "REGION",
|
| + "SERVICE",
|
| + "NAME",
|
| + "IP"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Default non-attribute type",
|
| + "Region of the resource",
|
| + "Service name",
|
| + "Resource name",
|
| + "IP address of the caller"
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "iam": {
|
| + "description": "Trusted attributes supplied by the IAM system.",
|
| + "enum": [
|
| + "NO_ATTR",
|
| + "AUTHORITY",
|
| + "ATTRIBUTION",
|
| + "APPROVER",
|
| + "JUSTIFICATION_TYPE"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Default non-attribute.",
|
| + "Either principal or (if present) authority selector.",
|
| + "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
|
| + "An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).\nSee: go/rpc-security-policy-dynamicauth.",
|
| + "What types of justifications have been supplied with this request.\nString values should match enum names from tech.iam.JustificationType,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *absence* of a justification, so justification conditions can only\nbe used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "values": {
|
| + "description": "The objects of the condition. This is mutually exclusive with 'value'.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Http": {
|
| - "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",
|
| + "AuditLogConfig": {
|
| + "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
| + "id": "AuditLogConfig",
|
| "properties": {
|
| - "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.",
|
| + "exemptedMembers": {
|
| + "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
|
| "items": {
|
| - "$ref": "HttpRule"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| + },
|
| + "logType": {
|
| + "description": "The log type that this config enables.",
|
| + "enum": [
|
| + "LOG_TYPE_UNSPECIFIED",
|
| + "ADMIN_READ",
|
| + "DATA_WRITE",
|
| + "DATA_READ"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Default case. Should never be this.",
|
| + "Admin reads. Example: CloudIAM getIamPolicy",
|
| + "Data writes. Example: CloudSQL Users create",
|
| + "Data reads. Example: CloudSQL Users list"
|
| + ],
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Control": {
|
| - "description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.",
|
| - "id": "Control",
|
| + "ConfigSource": {
|
| + "description": "Represents a source file which is used to generate the service configuration\ndefined by `google.api.Service`.",
|
| + "id": "ConfigSource",
|
| "properties": {
|
| - "environment": {
|
| - "description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled.",
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "SystemParameter": {
|
| - "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",
|
| + "BackendRule": {
|
| + "description": "A backend rule provides configuration for an individual API element.",
|
| + "id": "BackendRule",
|
| "properties": {
|
| - "httpHeader": {
|
| - "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.",
|
| - "type": "string"
|
| + "deadline": {
|
| + "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
|
| + "format": "double",
|
| + "type": "number"
|
| },
|
| - "name": {
|
| - "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
|
| + "address": {
|
| + "description": "The address of the API backend.",
|
| "type": "string"
|
| },
|
| - "urlQueryParameter": {
|
| - "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
|
| + "selector": {
|
| + "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Monitoring": {
|
| - "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count",
|
| - "id": "Monitoring",
|
| + "AuthenticationRule": {
|
| + "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.",
|
| + "id": "AuthenticationRule",
|
| "properties": {
|
| - "consumerDestinations": {
|
| - "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
|
| - "items": {
|
| - "$ref": "MonitoringDestination"
|
| - },
|
| - "type": "array"
|
| + "oauth": {
|
| + "$ref": "OAuthRequirements",
|
| + "description": "The requirements for OAuth credentials."
|
| },
|
| - "producerDestinations": {
|
| - "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
|
| + "requirements": {
|
| + "description": "Requirements for additional authentication providers.",
|
| "items": {
|
| - "$ref": "MonitoringDestination"
|
| + "$ref": "AuthRequirement"
|
| },
|
| "type": "array"
|
| + },
|
| + "selector": {
|
| + "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| + "type": "string"
|
| + },
|
| + "allowWithoutCredential": {
|
| + "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
|
| + "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Field": {
|
| - "description": "A single field of a message type.",
|
| - "id": "Field",
|
| + "UndeleteServiceResponse": {
|
| + "description": "Response message for UndeleteService method.",
|
| + "id": "UndeleteServiceResponse",
|
| "properties": {
|
| - "jsonName": {
|
| - "description": "The field JSON name.",
|
| - "type": "string"
|
| - },
|
| - "kind": {
|
| - "description": "The field type.",
|
| - "enum": [
|
| - "TYPE_UNKNOWN",
|
| - "TYPE_DOUBLE",
|
| - "TYPE_FLOAT",
|
| - "TYPE_INT64",
|
| - "TYPE_UINT64",
|
| - "TYPE_INT32",
|
| - "TYPE_FIXED64",
|
| - "TYPE_FIXED32",
|
| - "TYPE_BOOL",
|
| - "TYPE_STRING",
|
| - "TYPE_GROUP",
|
| - "TYPE_MESSAGE",
|
| - "TYPE_BYTES",
|
| - "TYPE_UINT32",
|
| - "TYPE_ENUM",
|
| - "TYPE_SFIXED32",
|
| - "TYPE_SFIXED64",
|
| - "TYPE_SINT32",
|
| - "TYPE_SINT64"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Field type unknown.",
|
| - "Field type double.",
|
| - "Field type float.",
|
| - "Field type int64.",
|
| - "Field type uint64.",
|
| - "Field type int32.",
|
| - "Field type fixed64.",
|
| - "Field type fixed32.",
|
| - "Field type bool.",
|
| - "Field type string.",
|
| - "Field type group. Proto2 syntax only, and deprecated.",
|
| - "Field type message.",
|
| - "Field type bytes.",
|
| - "Field type uint32.",
|
| - "Field type enum.",
|
| - "Field type sfixed32.",
|
| - "Field type sfixed64.",
|
| - "Field type sint32.",
|
| - "Field type sint64."
|
| - ],
|
| + "service": {
|
| + "$ref": "ManagedService",
|
| + "description": "Revived service resource."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Policy": {
|
| + "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
|
| + "id": "Policy",
|
| + "properties": {
|
| + "version": {
|
| + "description": "Version of the `Policy`. The default version is 0.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "auditConfigs": {
|
| + "description": "Specifies cloud audit logging configuration for this policy.",
|
| + "items": {
|
| + "$ref": "AuditConfig"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "bindings": {
|
| + "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
|
| + "items": {
|
| + "$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"
|
| + },
|
| + "Api": {
|
| + "description": "Api is a light-weight descriptor for a protocol buffer service.",
|
| + "id": "Api",
|
| + "properties": {
|
| "options": {
|
| - "description": "The protocol buffer options.",
|
| + "description": "Any metadata attached to the API.",
|
| "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"
|
| + "methods": {
|
| + "description": "The methods of this api, in unspecified order.",
|
| + "items": {
|
| + "$ref": "Method"
|
| + },
|
| + "type": "array"
|
| },
|
| - "cardinality": {
|
| - "description": "The field cardinality.",
|
| + "name": {
|
| + "description": "The fully qualified name of this api, including package name\nfollowed by the api's simple name.",
|
| + "type": "string"
|
| + },
|
| + "syntax": {
|
| + "description": "The source syntax of the service.",
|
| "enum": [
|
| - "CARDINALITY_UNKNOWN",
|
| - "CARDINALITY_OPTIONAL",
|
| - "CARDINALITY_REQUIRED",
|
| - "CARDINALITY_REPEATED"
|
| + "SYNTAX_PROTO2",
|
| + "SYNTAX_PROTO3"
|
| ],
|
| "enumDescriptions": [
|
| - "For fields with unknown cardinality.",
|
| - "For optional fields.",
|
| - "For required fields. Proto2 syntax only.",
|
| - "For repeated fields."
|
| + "Syntax `proto2`.",
|
| + "Syntax `proto3`."
|
| ],
|
| "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"
|
| + "sourceContext": {
|
| + "$ref": "SourceContext",
|
| + "description": "Source context for the protocol buffer service represented by this\nmessage."
|
| },
|
| - "typeUrl": {
|
| - "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
|
| + "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"
|
| },
|
| - "number": {
|
| - "description": "The field number.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "mixins": {
|
| + "description": "Included APIs. See Mixin.",
|
| + "items": {
|
| + "$ref": "Mixin"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "TestIamPermissionsRequest": {
|
| - "description": "Request message for `TestIamPermissions` method.",
|
| - "id": "TestIamPermissionsRequest",
|
| + "DataAccessOptions": {
|
| + "description": "Write a Data Access (Gin) log",
|
| + "id": "DataAccessOptions",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| + "Authentication": {
|
| + "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": {
|
| - "permissions": {
|
| - "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
|
| + "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": {
|
| - "type": "string"
|
| + "$ref": "AuthenticationRule"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "providers": {
|
| + "description": "Defines a set of authentication providers that a service supports.",
|
| + "items": {
|
| + "$ref": "AuthProvider"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Enum": {
|
| - "description": "Enum type definition.",
|
| - "id": "Enum",
|
| + "Operation": {
|
| + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
|
| + "id": "Operation",
|
| "properties": {
|
| + "response": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| + },
|
| + "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
|
| + "type": "object"
|
| + },
|
| "name": {
|
| - "description": "Enum type name.",
|
| + "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
|
| "type": "string"
|
| },
|
| - "enumvalue": {
|
| - "description": "Enum value definitions.",
|
| - "items": {
|
| - "$ref": "EnumValue"
|
| + "error": {
|
| + "$ref": "Status",
|
| + "description": "The error result of the operation in case of failure or cancellation."
|
| + },
|
| + "metadata": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| },
|
| - "type": "array"
|
| + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
|
| + "type": "object"
|
| },
|
| - "options": {
|
| - "description": "Protocol buffer options.",
|
| + "done": {
|
| + "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
|
| + "type": "boolean"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Page": {
|
| + "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
|
| + "id": "Page",
|
| + "properties": {
|
| + "content": {
|
| + "description": "The Markdown content of the page. You can use <code>(== include {path} ==)</code>\nto include content from a Markdown file.",
|
| + "type": "string"
|
| + },
|
| + "subpages": {
|
| + "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
|
| "items": {
|
| - "$ref": "Option"
|
| + "$ref": "Page"
|
| },
|
| "type": "array"
|
| },
|
| - "sourceContext": {
|
| - "$ref": "SourceContext",
|
| - "description": "The source context."
|
| - },
|
| - "syntax": {
|
| - "description": "The source syntax.",
|
| - "enum": [
|
| - "SYNTAX_PROTO2",
|
| - "SYNTAX_PROTO3"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Syntax `proto2`.",
|
| - "Syntax `proto3`."
|
| - ],
|
| + "name": {
|
| + "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n<pre><code>pages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n</code></pre>\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Diagnostic": {
|
| - "description": "Represents a diagnostic message (error or warning)",
|
| - "id": "Diagnostic",
|
| + "Status": {
|
| + "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": {
|
| - "kind": {
|
| - "description": "The kind of diagnostic information provided.",
|
| - "enum": [
|
| - "WARNING",
|
| - "ERROR"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Warnings and errors",
|
| - "Only errors"
|
| - ],
|
| - "type": "string"
|
| + "code": {
|
| + "description": "The status code, which should be an enum value of google.rpc.Code.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| },
|
| "message": {
|
| - "description": "Message describing the error or warning.",
|
| + "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"
|
| },
|
| - "location": {
|
| - "description": "File name and line number of the error or warning.",
|
| - "type": "string"
|
| + "details": {
|
| + "description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
|
| + "items": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "EnableServiceRequest": {
|
| - "description": "Request message for EnableService method.",
|
| - "id": "EnableServiceRequest",
|
| + "Binding": {
|
| + "description": "Associates `members` with a `role`.",
|
| + "id": "Binding",
|
| "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.",
|
| + "members": {
|
| + "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "role": {
|
| + "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "LabelDescriptor": {
|
| - "description": "A description of a label.",
|
| - "id": "LabelDescriptor",
|
| + "AuthProvider": {
|
| + "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": {
|
| - "description": {
|
| - "description": "A human-readable description for the label.",
|
| + "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"
|
| },
|
| - "valueType": {
|
| - "description": "The type of data that can be assigned to the label.",
|
| - "enum": [
|
| - "STRING",
|
| - "BOOL",
|
| - "INT64"
|
| - ],
|
| - "enumDescriptions": [
|
| - "A variable-length string. This is the default.",
|
| - "Boolean; true or false.",
|
| - "A 64-bit signed integer."
|
| - ],
|
| + "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"
|
| },
|
| - "key": {
|
| - "description": "The label key.",
|
| + "jwksUri": {
|
| + "description": "URL of the provider's public key set to validate signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set document:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the email domain of the issuer (e.g. a Google service account).\n\nExample: https://www.googleapis.com/oauth2/v1/certs",
|
| + "type": "string"
|
| + },
|
| + "audiences": {
|
| + "description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "GenerateConfigReportResponse": {
|
| - "description": "Response message for GenerateConfigReport method.",
|
| - "id": "GenerateConfigReportResponse",
|
| + "EnumValue": {
|
| + "description": "Enum value definition.",
|
| + "id": "EnumValue",
|
| "properties": {
|
| - "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.",
|
| + "name": {
|
| + "description": "Enum value name.",
|
| "type": "string"
|
| },
|
| - "changeReports": {
|
| - "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations.",
|
| + "options": {
|
| + "description": "Protocol buffer options.",
|
| "items": {
|
| - "$ref": "ChangeReport"
|
| + "$ref": "Option"
|
| },
|
| "type": "array"
|
| },
|
| - "id": {
|
| - "description": "ID of the service configuration this report belongs to.",
|
| - "type": "string"
|
| + "number": {
|
| + "description": "Enum value number.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Type": {
|
| - "description": "A protocol buffer message type.",
|
| - "id": "Type",
|
| + "Service": {
|
| + "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
|
| + "id": "Service",
|
| "properties": {
|
| - "options": {
|
| - "description": "The protocol buffer options.",
|
| + "metrics": {
|
| + "description": "Defines the metrics used by this service.",
|
| "items": {
|
| - "$ref": "Option"
|
| + "$ref": "MetricDescriptor"
|
| },
|
| "type": "array"
|
| },
|
| - "fields": {
|
| - "description": "The list of fields.",
|
| + "authentication": {
|
| + "$ref": "Authentication",
|
| + "description": "Auth configuration."
|
| + },
|
| + "experimental": {
|
| + "$ref": "Experimental",
|
| + "description": "Experimental configuration."
|
| + },
|
| + "control": {
|
| + "$ref": "Control",
|
| + "description": "Configuration for the service control plane."
|
| + },
|
| + "configVersion": {
|
| + "description": "The version of the service configuration. The config version may\ninfluence interpretation of the configuration, for example, to\ndetermine defaults. This is documented together with applicable\noptions. The current default for the config version itself is `3`.",
|
| + "format": "uint32",
|
| + "type": "integer"
|
| + },
|
| + "monitoring": {
|
| + "$ref": "Monitoring",
|
| + "description": "Monitoring configuration."
|
| + },
|
| + "producerProjectId": {
|
| + "description": "The id of the Google developer project that owns the service.\nMembers of this project can manage the service configuration,\nmanage consumption of the service, etc.",
|
| + "type": "string"
|
| + },
|
| + "systemTypes": {
|
| + "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.",
|
| "items": {
|
| - "$ref": "Field"
|
| + "$ref": "Type"
|
| },
|
| "type": "array"
|
| },
|
| + "visibility": {
|
| + "$ref": "Visibility",
|
| + "description": "API visibility configuration."
|
| + },
|
| "name": {
|
| - "description": "The fully qualified message name.",
|
| + "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
|
| "type": "string"
|
| },
|
| - "oneofs": {
|
| - "description": "The list of types appearing in `oneof` definitions in this type.",
|
| + "customError": {
|
| + "$ref": "CustomError",
|
| + "description": "Custom error configuration."
|
| + },
|
| + "title": {
|
| + "description": "The product title associated with this service.",
|
| + "type": "string"
|
| + },
|
| + "endpoints": {
|
| + "description": "Configuration for network endpoints. If this is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.",
|
| "items": {
|
| - "type": "string"
|
| + "$ref": "Endpoint"
|
| },
|
| "type": "array"
|
| },
|
| - "syntax": {
|
| - "description": "The source syntax.",
|
| - "enum": [
|
| - "SYNTAX_PROTO2",
|
| - "SYNTAX_PROTO3"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Syntax `proto2`.",
|
| - "Syntax `proto3`."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "sourceContext": {
|
| - "$ref": "SourceContext",
|
| - "description": "The source context."
|
| - }
|
| - },
|
| - "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"
|
| - },
|
| - "ListServiceConfigsResponse": {
|
| - "description": "Response message for ListServiceConfigs method.",
|
| - "id": "ListServiceConfigsResponse",
|
| - "properties": {
|
| - "serviceConfigs": {
|
| - "description": "The list of service configuration resources.",
|
| + "apis": {
|
| + "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files.",
|
| "items": {
|
| - "$ref": "Service"
|
| + "$ref": "Api"
|
| },
|
| "type": "array"
|
| },
|
| - "nextPageToken": {
|
| - "description": "The token of the next page of results.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "AuditConfig": {
|
| - "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, are exempted from logging.\nAn AuditConifg must have one or more AuditLogConfigs.\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.",
|
| - "id": "AuditConfig",
|
| - "properties": {
|
| - "service": {
|
| - "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServices` is a special value that covers all services.",
|
| - "type": "string"
|
| + "logs": {
|
| + "description": "Defines the logs used by this service.",
|
| + "items": {
|
| + "$ref": "LogDescriptor"
|
| + },
|
| + "type": "array"
|
| },
|
| - "auditLogConfigs": {
|
| - "description": "The configuration for logging of each type of permission.\nNext ID: 4",
|
| + "types": {
|
| + "description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32",
|
| "items": {
|
| - "$ref": "AuditLogConfig"
|
| + "$ref": "Type"
|
| },
|
| "type": "array"
|
| },
|
| - "exemptedMembers": {
|
| + "sourceInfo": {
|
| + "$ref": "SourceInfo",
|
| + "description": "Output only. The source information for this configuration if available."
|
| + },
|
| + "http": {
|
| + "$ref": "Http",
|
| + "description": "HTTP configuration."
|
| + },
|
| + "backend": {
|
| + "$ref": "Backend",
|
| + "description": "API backend configuration."
|
| + },
|
| + "systemParameters": {
|
| + "$ref": "SystemParameters",
|
| + "description": "System parameter configuration."
|
| + },
|
| + "documentation": {
|
| + "$ref": "Documentation",
|
| + "description": "Additional API documentation."
|
| + },
|
| + "monitoredResources": {
|
| + "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
|
| "items": {
|
| - "type": "string"
|
| + "$ref": "MonitoredResourceDescriptor"
|
| },
|
| "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Backend": {
|
| - "description": "`Backend` defines the backend configuration for a service.",
|
| - "id": "Backend",
|
| - "properties": {
|
| - "rules": {
|
| - "description": "A list of API backend rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| + },
|
| + "logging": {
|
| + "$ref": "Logging",
|
| + "description": "Logging configuration."
|
| + },
|
| + "enums": {
|
| + "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum",
|
| "items": {
|
| - "$ref": "BackendRule"
|
| + "$ref": "Enum"
|
| },
|
| "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "SubmitConfigSourceRequest": {
|
| - "description": "Request message for SubmitConfigSource method.",
|
| - "id": "SubmitConfigSourceRequest",
|
| - "properties": {
|
| - "configSource": {
|
| - "$ref": "ConfigSource",
|
| - "description": "The source configuration for the service."
|
| },
|
| - "validateOnly": {
|
| - "description": "Optional. If set, this will result in the generation of a\n`google.api.Service` configuration based on the `ConfigSource` provided,\nbut the generated config and the sources will NOT be persisted.",
|
| - "type": "boolean"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "AuthorizationConfig": {
|
| - "description": "Configuration of authorization.\n\nThis section determines the authorization provider, if unspecified, then no\nauthorization check will be done.\n\nExample:\n\n experimental:\n authorization:\n provider: firebaserules.googleapis.com",
|
| - "id": "AuthorizationConfig",
|
| - "properties": {
|
| - "provider": {
|
| - "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
|
| + "context": {
|
| + "$ref": "Context",
|
| + "description": "Context configuration."
|
| + },
|
| + "id": {
|
| + "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.",
|
| "type": "string"
|
| + },
|
| + "usage": {
|
| + "$ref": "Usage",
|
| + "description": "Configuration controlling usage of this service."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "DocumentationRule": {
|
| - "description": "A documentation rule provides information about individual API elements.",
|
| - "id": "DocumentationRule",
|
| + "ListOperationsResponse": {
|
| + "description": "The response message for Operations.ListOperations.",
|
| + "id": "ListOperationsResponse",
|
| "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`.",
|
| + "nextPageToken": {
|
| + "description": "The standard List next-page token.",
|
| "type": "string"
|
| },
|
| - "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"
|
| + "operations": {
|
| + "description": "A list of operations that matches the specified filter in the request.",
|
| + "items": {
|
| + "$ref": "Operation"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "CloudAuditOptions": {
|
| - "description": "Write a Cloud Audit log",
|
| - "id": "CloudAuditOptions",
|
| - "properties": {},
|
| - "type": "object"
|
| - },
|
| - "ContextRule": {
|
| - "description": "A context rule provides information about the context for an individual API\nelement.",
|
| - "id": "ContextRule",
|
| + "OperationMetadata": {
|
| + "description": "The metadata associated with a long running operation resource.",
|
| + "id": "OperationMetadata",
|
| "properties": {
|
| - "selector": {
|
| - "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| + "startTime": {
|
| + "description": "The start time of the operation.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| },
|
| - "provided": {
|
| - "description": "A list of full type names of provided contexts.",
|
| + "resourceNames": {
|
| + "description": "The full name of the resources that this operation is directly\nassociated with.",
|
| "items": {
|
| "type": "string"
|
| },
|
| "type": "array"
|
| },
|
| - "requested": {
|
| - "description": "A list of full type names of requested contexts.",
|
| + "steps": {
|
| + "description": "Detailed status information for each step. The order is undetermined.",
|
| "items": {
|
| - "type": "string"
|
| + "$ref": "Step"
|
| },
|
| "type": "array"
|
| + },
|
| + "progressPercentage": {
|
| + "description": "Percentage of completion of this operation, ranging from 0 to 100.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| }
|
| },
|
| "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",
|
| + "CustomHttpPattern": {
|
| + "description": "A custom pattern is used for defining custom HTTP verb.",
|
| + "id": "CustomHttpPattern",
|
| "properties": {
|
| - "labels": {
|
| - "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.",
|
| - "items": {
|
| - "$ref": "LabelDescriptor"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "name": {
|
| - "description": "The resource name of the metric descriptor. Depending on the\nimplementation, the name typically includes: (1) the parent resource name\nthat defines the scope of the metric type or of its data; and (2) the\nmetric's URL-encoded type, which also appears in the `type` field of this\ndescriptor. For example, following is the resource name of a custom\nmetric within the GCP project `my-project-id`:\n\n \"projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount\"",
|
| - "type": "string"
|
| - },
|
| - "type": {
|
| - "description": "The metric type, including its DNS name prefix. The type is not\nURL-encoded. All user-defined custom metric types have the DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchical\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"\n \"appengine.googleapis.com/http/server/response_latencies\"",
|
| - "type": "string"
|
| - },
|
| - "valueType": {
|
| - "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
|
| - "enum": [
|
| - "VALUE_TYPE_UNSPECIFIED",
|
| - "BOOL",
|
| - "INT64",
|
| - "DOUBLE",
|
| - "STRING",
|
| - "DISTRIBUTION",
|
| - "MONEY"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Do not use this default value.",
|
| - "The value is a boolean.\nThis value type can be used only if the metric kind is `GAUGE`.",
|
| - "The value is a signed 64-bit integer.",
|
| - "The value is a double precision floating point number.",
|
| - "The value is a text string.\nThis value type can be used only if the metric kind is `GAUGE`.",
|
| - "The value is a `Distribution`.",
|
| - "The value is money."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "metricKind": {
|
| - "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
|
| - "enum": [
|
| - "METRIC_KIND_UNSPECIFIED",
|
| - "GAUGE",
|
| - "DELTA",
|
| - "CUMULATIVE"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Do not use this default value.",
|
| - "An instantaneous measurement of a value.",
|
| - "The change in a value during a time interval.",
|
| - "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "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.",
|
| + "kind": {
|
| + "description": "The name of this custom HTTP verb.",
|
| "type": "string"
|
| },
|
| - "unit": {
|
| - "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.",
|
| + "path": {
|
| + "description": "The path matched by this custom verb.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "SourceContext": {
|
| - "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
|
| - "id": "SourceContext",
|
| + "SystemParameterRule": {
|
| + "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
|
| + "id": "SystemParameterRule",
|
| "properties": {
|
| - "fileName": {
|
| - "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.",
|
| + "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"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListServicesResponse": {
|
| - "description": "Response message for `ListServices` method.",
|
| - "id": "ListServicesResponse",
|
| - "properties": {
|
| - "services": {
|
| - "description": "The returned services will only have the name field set.",
|
| + },
|
| + "parameters": {
|
| + "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.",
|
| "items": {
|
| - "$ref": "ManagedService"
|
| + "$ref": "SystemParameter"
|
| },
|
| "type": "array"
|
| - },
|
| - "nextPageToken": {
|
| - "description": "Token that can be passed to `ListServices` to resume a paginated query.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Endpoint": {
|
| - "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",
|
| + "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¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it assumes there is no HTTP body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. It follows the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String\nExpansion.\n\nThe syntax `**` matches zero or more path segments. It follows the semantics\nof [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved\nExpansion. NOTE: it must be the last segment in the path except the Verb.\n\nThe syntax `LITERAL` matches literal text in the URL path.\n\nThe syntax `Variable` matches the entire path as specified by its template;\nthis nested template must not contain further variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.\n\nUse CustomHttpPattern to specify any HTTP method that is not included in the\n`pattern` field, such as HEAD, or \"*\" to leave the HTTP method unspecified for\na given URL path rule. The wild-card rule is useful for services that provide\ncontent to Web (HTML) clients.",
|
| + "id": "HttpRule",
|
| "properties": {
|
| - "apis": {
|
| - "description": "The list of APIs served by this endpoint.",
|
| + "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": {
|
| - "type": "string"
|
| + "$ref": "HttpRule"
|
| },
|
| "type": "array"
|
| },
|
| - "aliases": {
|
| - "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intented\nalias.\n\nAdditional names that this endpoint will be hosted on.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| + "responseBody": {
|
| + "description": "The name of the response field whose value is mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type.",
|
| + "type": "string"
|
| },
|
| - "features": {
|
| - "description": "The list of features enabled on this endpoint.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| + "mediaUpload": {
|
| + "$ref": "MediaUpload",
|
| + "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods."
|
| },
|
| - "allowCors": {
|
| - "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.",
|
| - "type": "boolean"
|
| + "selector": {
|
| + "description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| + "type": "string"
|
| },
|
| - "name": {
|
| - "description": "The canonical name of this endpoint.",
|
| + "custom": {
|
| + "$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"
|
| + },
|
| + "put": {
|
| + "description": "Used for updating a resource.",
|
| + "type": "string"
|
| + },
|
| + "delete": {
|
| + "description": "Used for deleting a resource.",
|
| + "type": "string"
|
| + },
|
| + "body": {
|
| + "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.",
|
| + "type": "string"
|
| + },
|
| + "mediaDownload": {
|
| + "$ref": "MediaDownload",
|
| + "description": "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"
|
| },
|
| - "OAuthRequirements": {
|
| - "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
|
| - "id": "OAuthRequirements",
|
| + "VisibilityRule": {
|
| + "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
|
| + "id": "VisibilityRule",
|
| "properties": {
|
| - "canonicalScopes": {
|
| - "description": "The list of publicly documented OAuth scopes that are allowed access. An\nOAuth token containing any of these scopes will be accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth/calendar,\n https://www.googleapis.com/auth/calendar.read",
|
| + "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"
|
| },
|
| - "Usage": {
|
| - "description": "Configuration controlling usage of a service.",
|
| - "id": "Usage",
|
| - "properties": {
|
| - "producerNotificationChannel": {
|
| - "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.",
|
| - "type": "string"
|
| - },
|
| - "rules": {
|
| - "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| - "items": {
|
| - "$ref": "UsageRule"
|
| - },
|
| - "type": "array"
|
| + "MonitoringDestination": {
|
| + "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
|
| + "id": "MonitoringDestination",
|
| + "properties": {
|
| + "monitoredResource": {
|
| + "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
|
| + "type": "string"
|
| },
|
| - "requirements": {
|
| - "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form <service.name>/<requirement-id>;\nfor example 'serviceusage.googleapis.com/billing-enabled'.",
|
| + "metrics": {
|
| + "description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.",
|
| "items": {
|
| "type": "string"
|
| },
|
| @@ -2831,102 +2819,237 @@
|
| },
|
| "type": "object"
|
| },
|
| - "TestIamPermissionsResponse": {
|
| - "description": "Response message for `TestIamPermissions` method.",
|
| - "id": "TestIamPermissionsResponse",
|
| + "Visibility": {
|
| + "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate.",
|
| + "id": "Visibility",
|
| "properties": {
|
| - "permissions": {
|
| - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
|
| + "rules": {
|
| + "description": "A list of visibility rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| "items": {
|
| - "type": "string"
|
| + "$ref": "VisibilityRule"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "GetIamPolicyRequest": {
|
| - "description": "Request message for `GetIamPolicy` method.",
|
| - "id": "GetIamPolicyRequest",
|
| - "properties": {},
|
| - "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",
|
| + "SystemParameters": {
|
| + "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.",
|
| + "id": "SystemParameters",
|
| "properties": {
|
| "rules": {
|
| - "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| + "description": "Define system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\n\nExample: define api key for all methods\n\n system_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n\n\nExample: define 2 api key names for a specific method.\n\n system_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n - name: api_key\n http_header: Api-Key1\n - name: api_key\n http_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| "items": {
|
| - "$ref": "ContextRule"
|
| + "$ref": "SystemParameterRule"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Rule": {
|
| - "description": "A rule to be applied in a Policy.",
|
| - "id": "Rule",
|
| + "ConfigChange": {
|
| + "description": "Output generated from semantically comparing two versions of a service\nconfiguration.\n\nIncludes detailed information about a field that have changed with\napplicable advice about potential consequences for the change, such as\nbackwards-incompatibility.",
|
| + "id": "ConfigChange",
|
| "properties": {
|
| - "description": {
|
| - "description": "Human-readable description of the rule.",
|
| + "newValue": {
|
| + "description": "Value of the changed object in the new Service configuration,\nin JSON format. This field will not be populated if ChangeType == REMOVED.",
|
| "type": "string"
|
| },
|
| - "conditions": {
|
| - "description": "Additional restrictions that must be met",
|
| - "items": {
|
| - "$ref": "Condition"
|
| - },
|
| - "type": "array"
|
| + "changeType": {
|
| + "description": "The type for this change, either ADDED, REMOVED, or MODIFIED.",
|
| + "enum": [
|
| + "CHANGE_TYPE_UNSPECIFIED",
|
| + "ADDED",
|
| + "REMOVED",
|
| + "MODIFIED"
|
| + ],
|
| + "enumDescriptions": [
|
| + "No value was provided.",
|
| + "The changed object exists in the 'new' service configuration, but not\nin the 'old' service configuration.",
|
| + "The changed object exists in the 'old' service configuration, but not\nin the 'new' service configuration.",
|
| + "The changed object exists in both service configurations, but its value\nis different."
|
| + ],
|
| + "type": "string"
|
| },
|
| - "logConfig": {
|
| - "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
|
| + "element": {
|
| + "description": "Object hierarchy path to the change, with levels separated by a '.'\ncharacter. For repeated fields, an applicable unique identifier field is\nused for the index (usually selector, name, or id). For maps, the term\n'key' is used. If the field has no unique identifier, the numeric index\nis used.\nExamples:\n- visibility.rules[selector==\"google.LibraryService.CreateBook\"].restriction\n- quota.metric_rules[selector==\"google\"].metric_costs[key==\"reads\"].value\n- logging.producer_destinations[0]",
|
| + "type": "string"
|
| + },
|
| + "oldValue": {
|
| + "description": "Value of the changed object in the old Service configuration,\nin JSON format. This field will not be populated if ChangeType == ADDED.",
|
| + "type": "string"
|
| + },
|
| + "advices": {
|
| + "description": "Collection of advice provided for this change, useful for determining the\npossible impact of this change.",
|
| "items": {
|
| - "$ref": "LogConfig"
|
| + "$ref": "Advice"
|
| },
|
| "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"
|
| },
|
| - "in": {
|
| - "description": "If one or more 'in' clauses are specified, the rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.",
|
| - "items": {
|
| - "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"
|
| + },
|
| + "deleteServiceStrategy": {
|
| + "$ref": "DeleteServiceStrategy",
|
| + "description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly."
|
| + },
|
| + "createTime": {
|
| + "description": "Creation time of the rollout. Readonly.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| + },
|
| + "status": {
|
| + "description": "The status of this rollout. Readonly. In case of a failed rollout,\nthe system will automatically rollback to the current Rollout\nversion. Readonly.",
|
| + "enum": [
|
| + "ROLLOUT_STATUS_UNSPECIFIED",
|
| + "IN_PROGRESS",
|
| + "SUCCESS",
|
| + "CANCELLED",
|
| + "FAILED",
|
| + "PENDING"
|
| + ],
|
| + "enumDescriptions": [
|
| + "No status specified.",
|
| + "The Rollout is in progress.",
|
| + "The Rollout has completed successfully.",
|
| + "The Rollout has been cancelled. This can happen if you have overlapping\nRollout pushes, and the previous ones will be cancelled.",
|
| + "The Rollout has failed. It is typically caused by configuration errors.",
|
| + "The Rollout has not started yet and is pending for execution."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "serviceName": {
|
| + "description": "The name of the service associated with this Rollout.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "GenerateConfigReportRequest": {
|
| + "description": "Request message for GenerateConfigReport method.",
|
| + "id": "GenerateConfigReportRequest",
|
| + "properties": {
|
| + "oldConfig": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| },
|
| - "type": "array"
|
| + "description": "Service configuration against which the comparison will be done.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service",
|
| + "type": "object"
|
| },
|
| - "permissions": {
|
| - "description": "A permission is a string of form '<service>.<resource type>.<verb>'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
|
| - "items": {
|
| - "type": "string"
|
| + "newConfig": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| },
|
| - "type": "array"
|
| + "description": "Service configuration for which we want to generate the report.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service",
|
| + "type": "object"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "SetIamPolicyRequest": {
|
| + "description": "Request message for `SetIamPolicy` method.",
|
| + "id": "SetIamPolicyRequest",
|
| + "properties": {
|
| + "policy": {
|
| + "$ref": "Policy",
|
| + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
|
| },
|
| - "action": {
|
| - "description": "Required",
|
| + "updateMask": {
|
| + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
|
| + "format": "google-fieldmask",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "DeleteServiceStrategy": {
|
| + "description": "Strategy used to delete a service. This strategy is a placeholder only\nused by the system generated rollout to delete a service.",
|
| + "id": "DeleteServiceStrategy",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| + "Step": {
|
| + "description": "Represents the status of one operation step.",
|
| + "id": "Step",
|
| + "properties": {
|
| + "status": {
|
| + "description": "The status code.",
|
| "enum": [
|
| - "NO_ACTION",
|
| - "ALLOW",
|
| - "ALLOW_WITH_LOG",
|
| - "DENY",
|
| - "DENY_WITH_LOG",
|
| - "LOG"
|
| + "STATUS_UNSPECIFIED",
|
| + "DONE",
|
| + "NOT_STARTED",
|
| + "IN_PROGRESS",
|
| + "FAILED",
|
| + "CANCELLED"
|
| ],
|
| "enumDescriptions": [
|
| - "Default no action.",
|
| - "Matching 'Entries' grant access.",
|
| - "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",
|
| - "Matching 'Entries' deny access.",
|
| - "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
|
| - "Matching 'Entries' tell IAM.Check callers to generate logs."
|
| + "Unspecifed code.",
|
| + "The operation or step has completed without errors.",
|
| + "The operation or step has not started yet.",
|
| + "The operation or step is in progress.",
|
| + "The operation or step has completed with errors.",
|
| + "The operation or step has completed with cancellation."
|
| ],
|
| "type": "string"
|
| },
|
| - "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).",
|
| + "description": {
|
| + "description": "The short description of the step.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "LoggingDestination": {
|
| + "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
|
| + "id": "LoggingDestination",
|
| + "properties": {
|
| + "logs": {
|
| + "description": "Names of the logs to be sent to this destination. Each name must\nbe defined in the Service.logs section. If the log name is\nnot a domain scoped name, it will be automatically prefixed with\nthe service name followed by \"/\".",
|
| "items": {
|
| "type": "string"
|
| },
|
| "type": "array"
|
| + },
|
| + "monitoredResource": {
|
| + "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "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"
|
|
|
Chromium Code Reviews
Issue 2779563003:
Api-roll 47: 2017-03-27 (Closed)
