ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/vendor/google.golang.org/api/servicemanagement/v1/servicemanagement-api.json

2858 lines
145 KiB
JSON
Raw Normal View History

providers/google: Support managing projects Add support for creating, updating, and deleting projects, as well as their enabled services and their IAM policies. Various concessions were made for backwards compatibility, and will be removed in 0.9 or 0.10.
2016-11-23 07:55:40 +01:00
{
"id": "servicemanagement:v1",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/service.management": {
"description": "Manage your Google API service configuration"
},
"https://www.googleapis.com/auth/service.management.readonly": {
"description": "View your Google API service configuration"
}
}
}
},
"description": "Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers.",
"protocol": "rest",
"title": "Google Service Management API",
"resources": {
"services": {
"resources": {
"rollouts": {
"methods": {
"get": {
"id": "servicemanagement.services.rollouts.get",
"response": {
"$ref": "Rollout"
},
"parameterOrder": [
"serviceName",
"rolloutId"
],
"description": "Gets a service configuration rollout.",
"flatPath": "v1/services/{serviceName}/rollouts/{rolloutId}",
"httpMethod": "GET",
"parameters": {
"rolloutId": {
"description": "The id of the rollout resource.",
"required": true,
"location": "path",
"type": "string"
},
"serviceName": {
"description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
"required": true,
"location": "path",
"type": "string"
}
},
"path": "v1/services/{serviceName}/rollouts/{rolloutId}",
"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": {
"id": "servicemanagement.services.rollouts.create",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"serviceName"
],
"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\u003cresponse: Rollout\u003e",
"request": {
"$ref": "Rollout"
},
"flatPath": "v1/services/{serviceName}/rollouts",
"httpMethod": "POST",
"parameters": {
"serviceName": {
"description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
"required": true,
"location": "path",
"type": "string"
}
},
"path": "v1/services/{serviceName}/rollouts",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"list": {
"id": "servicemanagement.services.rollouts.list",
"response": {
"$ref": "ListServiceRolloutsResponse"
},
"parameterOrder": [
"serviceName"
],
"description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest.",
"flatPath": "v1/services/{serviceName}/rollouts",
"httpMethod": "GET",
"parameters": {
"pageSize": {
"description": "The max number of items to include in the response list.",
"location": "query",
"type": "integer",
"format": "int32"
},
"serviceName": {
"description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
"required": true,
"location": "path",
"type": "string"
},
"pageToken": {
"description": "The token of the page to retrieve.",
"location": "query",
"type": "string"
}
},
"path": "v1/services/{serviceName}/rollouts",
"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"
]
}
}
},
"configs": {
"methods": {
"submit": {
"id": "servicemanagement.services.configs.submit",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"serviceName"
],
"description": "Creates a new service configuration (version) for a managed service based\non\nuser-supplied configuration source files (for example: OpenAPI\nSpecification). This method stores the source configurations as well as the\ngenerated service configuration. To rollout the service configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperation\u003cresponse: SubmitConfigSourceResponse\u003e",
"request": {
"$ref": "SubmitConfigSourceRequest"
},
"flatPath": "v1/services/{serviceName}/configs:submit",
"httpMethod": "POST",
"parameters": {
"serviceName": {
"description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
"required": true,
"location": "path",
"type": "string"
}
},
"path": "v1/services/{serviceName}/configs:submit",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"get": {
"id": "servicemanagement.services.configs.get",
"response": {
"$ref": "Service"
},
"parameterOrder": [
"serviceName",
"configId"
],
"description": "Gets a service configuration (version) for a managed service.",
"flatPath": "v1/services/{serviceName}/configs/{configId}",
"httpMethod": "GET",
"parameters": {
"configId": {
"description": "The id of the service configuration resource.",
"required": true,
"location": "path",
"type": "string"
},
"serviceName": {
"description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
"required": true,
"location": "path",
"type": "string"
}
},
"path": "v1/services/{serviceName}/configs/{configId}",
"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": {
"id": "servicemanagement.services.configs.create",
"response": {
"$ref": "Service"
},
"parameterOrder": [
"serviceName"
],
"description": "Creates a new service configuration (version) for a managed service.\nThis method only stores the service configuration. To roll out the service\nconfiguration to backend systems please call\nCreateServiceRollout.",
"request": {
"$ref": "Service"
},
"flatPath": "v1/services/{serviceName}/configs",
"httpMethod": "POST",
"parameters": {
"serviceName": {
"description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
"required": true,
"location": "path",
"type": "string"
}
},
"path": "v1/services/{serviceName}/configs",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"list": {
"id": "servicemanagement.services.configs.list",
"response": {
"$ref": "ListServiceConfigsResponse"
},
"parameterOrder": [
"serviceName"
],
"description": "Lists the history of the service configuration for a managed service,\nfrom the newest to the oldest.",
"flatPath": "v1/services/{serviceName}/configs",
"httpMethod": "GET",
"parameters": {
"pageSize": {
"description": "The max number of items to include in the response list.",
"location": "query",
"type": "integer",
"format": "int32"
},
"serviceName": {
"description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
"required": true,
"location": "path",
"type": "string"
},
"pageToken": {
"description": "The token of the page to retrieve.",
"location": "query",
"type": "string"
}
},
"path": "v1/services/{serviceName}/configs",
"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"
]
}
}
}
},
"methods": {
"getIamPolicy": {
"id": "servicemanagement.services.getIamPolicy",
"response": {
"$ref": "Policy"
},
"parameterOrder": [
"resource"
],
"description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"request": {
"$ref": "GetIamPolicyRequest"
},
"flatPath": "v1/services/{servicesId}:getIamPolicy",
"httpMethod": "POST",
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
"required": true,
"pattern": "^services/[^/]+$",
"location": "path",
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"disable": {
"id": "servicemanagement.services.disable",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"serviceName"
],
"description": "Disable a managed service for a project.\n\nOperation\u003cresponse: DisableServiceResponse\u003e",
"request": {
"$ref": "DisableServiceRequest"
},
"flatPath": "v1/services/{serviceName}:disable",
"httpMethod": "POST",
"parameters": {
"serviceName": {
"description": "Name of the service to disable. Specifying an unknown service name\nwill cause the request to fail.",
"required": true,
"location": "path",
"type": "string"
}
},
"path": "v1/services/{serviceName}:disable",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"generateConfigReport": {
"id": "servicemanagement.services.generateConfigReport",
"response": {
"$ref": "GenerateConfigReportResponse"
},
"parameterOrder": [],
"description": "Generates and returns a report (errors, warnings and changes from\nexisting configurations) associated with\nGenerateConfigReportRequest.new_value\n\nIf GenerateConfigReportRequest.old_value is specified,\nGenerateConfigReportRequest will contain a single ChangeReport based on the\ncomparison between GenerateConfigReportRequest.new_value and\nGenerateConfigReportRequest.old_value.\nIf GenerateConfigReportRequest.old_value is not specified, this method\nwill compare GenerateConfigReportRequest.new_value with the last pushed\nservice configuration.",
"request": {
"$ref": "GenerateConfigReportRequest"
},
"flatPath": "v1/services:generateConfigReport",
"httpMethod": "POST",
"parameters": {},
"path": "v1/services:generateConfigReport",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"getConfig": {
"id": "servicemanagement.services.getConfig",
"response": {
"$ref": "Service"
},
"parameterOrder": [
"serviceName"
],
"description": "Gets a service configuration (version) for a managed service.",
"flatPath": "v1/services/{serviceName}/config",
"httpMethod": "GET",
"parameters": {
"configId": {
"description": "The id of the service configuration resource.",
"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`.",
"required": true,
"location": "path",
"type": "string"
}
},
"path": "v1/services/{serviceName}/config",
"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"
]
},
"undelete": {
"id": "servicemanagement.services.undelete",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"serviceName"
],
"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\u003cresponse: UndeleteServiceResponse\u003e",
"flatPath": "v1/services/{serviceName}:undelete",
"httpMethod": "POST",
"parameters": {
"serviceName": {
"description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
"required": true,
"location": "path",
"type": "string"
}
},
"path": "v1/services/{serviceName}:undelete",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"get": {
"id": "servicemanagement.services.get",
"response": {
"$ref": "ManagedService"
},
"parameterOrder": [
"serviceName"
],
"description": "Gets a managed service. Authentication is required unless the service is\npublic.",
"flatPath": "v1/services/{serviceName}",
"httpMethod": "GET",
"parameters": {
"serviceName": {
"description": "The name of the service. See the `ServiceManager` overview for naming\nrequirements. For example: `example.googleapis.com`.",
"required": true,
"location": "path",
"type": "string"
}
},
"path": "v1/services/{serviceName}",
"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"
]
},
"list": {
"id": "servicemanagement.services.list",
"response": {
"$ref": "ListServicesResponse"
},
"parameterOrder": [],
"description": "Lists all managed services. The result is limited to services that the\ncaller has \"servicemanagement.services.get\" permission for. If the request\nis made without authentication, it returns only public services that are\navailable to everyone.",
"flatPath": "v1/services",
"httpMethod": "GET",
"parameters": {
"pageSize": {
"description": "Requested size of the next page of data.",
"location": "query",
"type": "integer",
"format": "int32"
},
"producerProjectId": {
"description": "Include services produced by the specified project.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Token identifying which result to start with; returned by a previous list\ncall.",
"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:\u003cproject_id\u003e",
"location": "query",
"type": "string"
}
},
"path": "v1/services",
"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": {
"id": "servicemanagement.services.create",
"response": {
"$ref": "Operation"
},
"parameterOrder": [],
"description": "Creates a new managed service.\nPlease note one producer project can own no more than 20 services.\n\nOperation\u003cresponse: ManagedService\u003e",
"request": {
"$ref": "ManagedService"
},
"flatPath": "v1/services",
"httpMethod": "POST",
"parameters": {},
"path": "v1/services",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"enable": {
"id": "servicemanagement.services.enable",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"serviceName"
],
"description": "Enable a managed service for a project with default setting.\n\nOperation\u003cresponse: EnableServiceResponse\u003e\n\ngoogle.rpc.Status errors may contain a\ngoogle.rpc.PreconditionFailure error detail.",
"request": {
"$ref": "EnableServiceRequest"
},
"flatPath": "v1/services/{serviceName}:enable",
"httpMethod": "POST",
"parameters": {
"serviceName": {
"description": "Name of the service to enable. Specifying an unknown service name will\ncause the request to fail.",
"required": true,
"location": "path",
"type": "string"
}
},
"path": "v1/services/{serviceName}:enable",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"setIamPolicy": {
"id": "servicemanagement.services.setIamPolicy",
"response": {
"$ref": "Policy"
},
"parameterOrder": [
"resource"
],
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"request": {
"$ref": "SetIamPolicyRequest"
},
"flatPath": "v1/services/{servicesId}:setIamPolicy",
"httpMethod": "POST",
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
"required": true,
"pattern": "^services/[^/]+$",
"location": "path",
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"delete": {
"id": "servicemanagement.services.delete",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"serviceName"
],
"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\u003cresponse: google.protobuf.Empty\u003e",
"flatPath": "v1/services/{serviceName}",
"httpMethod": "DELETE",
"parameters": {
"serviceName": {
"description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
"required": true,
"location": "path",
"type": "string"
}
},
"path": "v1/services/{serviceName}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
},
"testIamPermissions": {
"id": "servicemanagement.services.testIamPermissions",
"response": {
"$ref": "TestIamPermissionsResponse"
},
"parameterOrder": [
"resource"
],
"description": "Returns permissions that a caller has on the specified resource.",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"flatPath": "v1/services/{servicesId}:testIamPermissions",
"httpMethod": "POST",
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
"required": true,
"pattern": "^services/[^/]+$",
"location": "path",
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
}
}
},
"operations": {
"methods": {
"get": {
"id": "servicemanagement.operations.get",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"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.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "GET",
"parameters": {
"name": {
"description": "The name of the operation resource.",
"required": true,
"pattern": "^operations/.+$",
"location": "path",
"type": "string"
}
},
"path": "v1/{+name}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
]
}
}
}
},
"schemas": {
"Api": {
"description": "Api is a light-weight descriptor for a protocol buffer service.",
"type": "object",
"properties": {
"methods": {
"description": "The methods of this api, in unspecified order.",
"type": "array",
"items": {
"$ref": "Method"
}
},
"options": {
"description": "Any metadata attached to the API.",
"type": "array",
"items": {
"$ref": "Option"
}
},
"sourceContext": {
"description": "Source context for the protocol buffer service represented by this\nmessage.",
"$ref": "SourceContext"
},
"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": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
],
"enumDescriptions": [
"Syntax `proto2`.",
"Syntax `proto3`."
],
"type": "string"
},
"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\u003cmajor-version\u003e`, 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"
},
"mixins": {
"description": "Included APIs. See Mixin.",
"type": "array",
"items": {
"$ref": "Mixin"
}
}
},
"id": "Api"
},
"SystemParameterRule": {
"description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
"type": "object",
"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.",
"type": "array",
"items": {
"$ref": "SystemParameter"
}
},
"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"
}
},
"id": "SystemParameterRule"
},
"Diagnostic": {
"description": "Represents a diagnostic message (error or warning)",
"type": "object",
"properties": {
"location": {
"description": "File name and line number of the error or warning.",
"type": "string"
},
"kind": {
"description": "The kind of diagnostic information provided.",
"enum": [
"WARNING",
"ERROR"
],
"enumDescriptions": [
"Warnings and errors",
"Only errors"
],
"type": "string"
},
"message": {
"description": "Message describing the error or warning.",
"type": "string"
}
},
"id": "Diagnostic"
},
"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.",
"type": "object",
"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",
"type": "array",
"items": {
"$ref": "ConfigChange"
}
}
},
"id": "ChangeReport"
},
"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.",
"type": "object",
"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"
},
"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\"`.",
"type": "array",
"items": {
"$ref": "LabelDescriptor"
}
},
"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"
},
"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"
}
},
"id": "MonitoredResourceDescriptor"
},
"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 ==\u003e 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",
"type": "object",
"properties": {
"dataAccess": {
"description": "Data access options.",
"$ref": "DataAccessOptions"
},
"counter": {
"description": "Counter options.",
"$ref": "CounterOptions"
},
"cloudAudit": {
"description": "Cloud audit options.",
"$ref": "CloudAuditOptions"
}
},
"id": "LogConfig"
},
"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 }",
"type": "object",
"properties": {
"root": {
"description": "If non-empty specifies a path under which inherited HTTP paths\nare rooted.",
"type": "string"
},
"name": {
"description": "The fully qualified name of the API which is included.",
"type": "string"
}
},
"id": "Mixin"
},
"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 backend:\n rules:\n - selector: \"google.calendar.v3.*\"\n address: calendar.example.com",
"type": "object",
"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"
},
"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",
"type": "array",
"items": {
"$ref": "Enum"
}
},
"usage": {
"description": "Configuration controlling usage of this service.",
"$ref": "Usage"
},
"control": {
"description": "Configuration for the service control plane.",
"$ref": "Control"
},
"title": {
"description": "The product title associated with this service.",
"type": "string"
},
"http": {
"description": "HTTP configuration.",
"$ref": "Http"
},
"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.",
"type": "array",
"items": {
"$ref": "Type"
}
},
"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`.",
"type": "integer",
"format": "uint32"
},
"backend": {
"description": "API backend configuration.",
"$ref": "Backend"
},
"monitoring": {
"description": "Monitoring configuration.",
"$ref": "Monitoring"
},
"visibility": {
"description": "API visibility configuration.",
"$ref": "Visibility"
},
"logging": {
"description": "Logging configuration.",
"$ref": "Logging"
},
"customError": {
"description": "Custom error configuration.",
"$ref": "CustomError"
},
"context": {
"description": "Context configuration.",
"$ref": "Context"
},
"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.",
"type": "array",
"items": {
"$ref": "Api"
}
},
"metrics": {
"description": "Defines the metrics used by this service.",
"type": "array",
"items": {
"$ref": "MetricDescriptor"
}
},
"systemParameters": {
"description": "System parameter configuration.",
"$ref": "SystemParameters"
},
"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": "array",
"items": {
"$ref": "Endpoint"
}
},
"name": {
"description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
"type": "string"
},
"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"
},
"documentation": {
"description": "Additional API documentation.",
"$ref": "Documentation"
},
"monitoredResources": {
"description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
"type": "array",
"items": {
"$ref": "MonitoredResourceDescriptor"
}
},
"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",
"type": "array",
"items": {
"$ref": "Type"
}
},
"logs": {
"description": "Defines the logs used by this service.",
"type": "array",
"items": {
"$ref": "LogDescriptor"
}
},
"authentication": {
"description": "Auth configuration.",
"$ref": "Authentication"
}
},
"id": "Service"
},
"SubmitConfigSourceResponse": {
"description": "Response message for SubmitConfigSource method.",
"type": "object",
"properties": {
"serviceConfig": {
"description": "The generated service configuration.",
"$ref": "Service"
}
},
"id": "SubmitConfigSourceResponse"
},
"Documentation": {
"description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\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: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\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\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\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\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\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\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
"type": "object",
"properties": {
"overview": {
"description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field.",
"type": "string"
},
"documentationRootUrl": {
"description": "The URL to the root of documentation.",
"type": "string"
},
"pages": {
"description": "The top level pages for the documentation set.",
"type": "array",
"items": {
"$ref": "Page"
}
},
"summary": {
"description": "A short summary of what the service does. Can only be provided by\nplain text.",
"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.",
"type": "array",
"items": {
"$ref": "DocumentationRule"
}
}
},
"id": "Documentation"
},
"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).",
"type": "object",
"properties": {
"auditConfigs": {
"description": "Specifies audit logging configs for \"data access\".\n\"data access\": generally refers to data reads/writes and admin reads.\n\"admin activity\": generally refers to admin writes.\n\nNote: `AuditConfig` doesn't apply to \"admin activity\", which always\nenables audit logging.",
"type": "array",
"items": {
"$ref": "AuditConfig"
}
},
"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.",
"type": "array",
"items": {
"$ref": "Rule"
}
},
"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.",
"type": "array",
"items": {
"$ref": "Binding"
}
},
"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.",
"type": "string",
"format": "byte"
},
"iamOwned": {
"type": "boolean"
},
"version": {
"description": "Version of the `Policy`. The default version is 0.",
"type": "integer",
"format": "int32"
}
},
"id": "Policy"
},
"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.",
"type": "object",
"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",
"type": "string"
}
},
"id": "OAuthRequirements"
},
"ListServicesResponse": {
"description": "Response message for `ListServices` method.",
"type": "object",
"properties": {
"nextPageToken": {
"description": "Token that can be passed to `ListServices` to resume a paginated query.",
"type": "string"
},
"services": {
"description": "The returned services will only have the name field set.",
"type": "array",
"items": {
"$ref": "ManagedService"
}
}
},
"id": "ListServicesResponse"
},
"Step": {
"description": "Represents the status of one operation step.",
"type": "object",
"properties": {
"description": {
"description": "The short description of the step.",
"type": "string"
},
"status": {
"description": "The status code.",
"enum": [
"STATUS_UNSPECIFIED",
"DONE",
"NOT_STARTED",
"IN_PROGRESS",
"FAILED",
"CANCELLED"
],
"enumDescriptions": [
"Unspecifed code.",
"The step has completed without errors.",
"The step has not started yet.",
"The step is in progress.",
"The step has completed with errors.",
"The step has completed with cancellation."
],
"type": "string"
}
},
"id": "Step"
},
"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`.",
"type": "object",
"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.",
"type": "array",
"items": {
"$ref": "ContextRule"
}
}
},
"id": "Context"
},
"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",
"type": "object",
"properties": {
"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.",
"type": "array",
"items": {
"$ref": "MonitoringDestination"
}
},
"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.",
"type": "array",
"items": {
"$ref": "MonitoringDestination"
}
}
},
"id": "Monitoring"
},
"ManagedService": {
"description": "The full representation of a Service that is managed by\nGoogle Service Management.",
"type": "object",
"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"
}
},
"id": "ManagedService"
},
"ConfigFile": {
"description": "Generic specification of a source configuration file",
"type": "object",
"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": [
"FILE_TYPE_UNSPECIFIED",
"SERVICE_CONFIG_YAML",
"OPEN_API_JSON",
"OPEN_API_YAML",
"FILE_DESCRIPTOR_SET_PROTO"
],
"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"
],
"type": "string"
},
"fileContents": {
"description": "The bytes that constitute the file.",
"type": "string",
"format": "byte"
}
},
"id": "ConfigFile"
},
"ListServiceConfigsResponse": {
"description": "Response message for ListServiceConfigs method.",
"type": "object",
"properties": {
"nextPageToken": {
"description": "The token of the next page of results.",
"type": "string"
},
"serviceConfigs": {
"description": "The list of service configuration resources.",
"type": "array",
"items": {
"$ref": "Service"
}
}
},
"id": "ListServiceConfigsResponse"
},
"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 }",
"type": "object",
"properties": {
"percentages": {
"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.",
"additionalProperties": {
"type": "number",
"format": "double"
},
"type": "object"
}
},
"id": "TrafficPercentStrategy"
},
"GenerateConfigReportRequest": {
"description": "Request message for GenerateConfigReport method.",
"type": "object",
"properties": {
"oldConfig": {
"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",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"newConfig": {
"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",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
}
},
"id": "GenerateConfigReportRequest"
},
"GetIamPolicyRequest": {
"description": "Request message for `GetIamPolicy` method.",
"type": "object",
"properties": {},
"id": "GetIamPolicyRequest"
},
"LoggingDestination": {
"description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
"type": "object",
"properties": {
"monitoredResource": {
"description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.",
"type": "string"
},
"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 \"/\".",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "LoggingDestination"
},
"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 rules:\n - selector: \"*\"\n oauth:\n canonical_scopes: https://www.googleapis.com/auth/calendar\n\n - selector: google.calendar.Delegate\n oauth:\n canonical_scopes: https://www.googleapis.com/auth/calendar.read",
"type": "object",
"properties": {
"providers": {
"description": "Defines a set of authentication providers that a service supports.",
"type": "array",
"items": {
"$ref": "AuthProvider"
}
},
"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.",
"type": "array",
"items": {
"$ref": "AuthenticationRule"
}
}
},
"id": "Authentication"
},
"Type": {
"description": "A protocol buffer message type.",
"type": "object",
"properties": {
"oneofs": {
"description": "The list of types appearing in `oneof` definitions in this type.",
"type": "array",
"items": {
"type": "string"
}
},
"options": {
"description": "The protocol buffer options.",
"type": "array",
"items": {
"$ref": "Option"
}
},
"sourceContext": {
"description": "The source context.",
"$ref": "SourceContext"
},
"fields": {
"description": "The list of fields.",
"type": "array",
"items": {
"$ref": "Field"
}
},
"name": {
"description": "The fully qualified message name.",
"type": "string"
},
"syntax": {
"description": "The source syntax.",
"enum": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
],
"enumDescriptions": [
"Syntax `proto2`.",
"Syntax `proto3`."
],
"type": "string"
}
},
"id": "Type"
},
"Backend": {
"description": "`Backend` defines the backend configuration for a service.",
"type": "object",
"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.",
"type": "array",
"items": {
"$ref": "BackendRule"
}
}
},
"id": "Backend"
},
"AuditConfig": {
"description": "Enables \"data access\" audit logging for a service and specifies a list\nof members that are log-exempted.",
"type": "object",
"properties": {
"service": {
"description": "Specifies a service that will be enabled for \"data access\" audit\nlogging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServices` is a special value that covers all services.",
"type": "string"
},
"exemptedMembers": {
"description": "Specifies the identities that are exempted from \"data access\" audit\nlogging for the `service` specified above.\nFollows the same format of Binding.members.",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "AuditConfig"
},
"ListServiceRolloutsResponse": {
"description": "Response message for ListServiceRollouts method.",
"type": "object",
"properties": {
"rollouts": {
"description": "The list of rollout resources.",
"type": "array",
"items": {
"$ref": "Rollout"
}
},
"nextPageToken": {
"description": "The token of the next page of results.",
"type": "string"
}
},
"id": "ListServiceRolloutsResponse"
},
"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.",
"type": "object",
"properties": {
"createdBy": {
"description": "The user who created the Rollout. Readonly.",
"type": "string"
},
"trafficPercentStrategy": {
"description": "Google Service Control selects service configurations based on\ntraffic percentage.",
"$ref": "TrafficPercentStrategy"
},
"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"
},
"deleteServiceStrategy": {
"description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly.",
"$ref": "DeleteServiceStrategy"
},
"createTime": {
"description": "Creation time of the rollout. Readonly.",
"type": "string",
"format": "google-datetime"
},
"serviceName": {
"description": "The name of the service associated with this Rollout.",
"type": "string"
},
"rolloutId": {
"description": "Optional unique identifier of this Rollout. Only lower case letters, digits\n and '-' are allowed.\n\nIf not specified by client, the server will generate one. The generated id\nwill have the form of \u003cdate\u003e\u003crevision number\u003e, 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"
}
},
"id": "Rollout"
},
"ConfigSource": {
"description": "Represents a source file which is used to generate the service configuration\ndefined by `google.api.Service`.",
"type": "object",
"properties": {
"files": {
"description": "Set of source configuration files that are used to generate a service\nconfiguration (`google.api.Service`).",
"type": "array",
"items": {
"$ref": "ConfigFile"
}
},
"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"
}
},
"id": "ConfigSource"
},
"Method": {
"description": "Method represents a method of an api.",
"type": "object",
"properties": {
"requestStreaming": {
"description": "If true, the request is streamed.",
"type": "boolean"
},
"options": {
"description": "Any metadata attached to the method.",
"type": "array",
"items": {
"$ref": "Option"
}
},
"requestTypeUrl": {
"description": "A URL of the input message type.",
"type": "string"
},
"name": {
"description": "The simple name of this method.",
"type": "string"
},
"syntax": {
"description": "The source syntax of this method.",
"enum": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
],
"enumDescriptions": [
"Syntax `proto2`.",
"Syntax `proto3`."
],
"type": "string"
},
"responseTypeUrl": {
"description": "The URL of the output message type.",
"type": "string"
},
"responseStreaming": {
"description": "If true, the response is streamed.",
"type": "boolean"
}
},
"id": "Method"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
"error": {
"description": "The error result of the operation in case of failure or cancellation.",
"$ref": "Status"
},
"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"
},
"metadata": {
"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.",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"response": {
"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`.",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"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"
}
},
"id": "Operation"
},
"Rule": {
"description": "A rule to be applied in a Policy.",
"type": "object",
"properties": {
"description": {
"description": "Human-readable description of the rule.",
"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.",
"type": "array",
"items": {
"type": "string"
}
},
"action": {
"description": "Required",
"enum": [
"NO_ACTION",
"ALLOW",
"ALLOW_WITH_LOG",
"DENY",
"DENY_WITH_LOG",
"LOG"
],
"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."
],
"type": "string"
},
"conditions": {
"description": "Additional restrictions that must be met",
"type": "array",
"items": {
"$ref": "Condition"
}
},
"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).",
"type": "array",
"items": {
"type": "string"
}
},
"logConfig": {
"description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
"type": "array",
"items": {
"$ref": "LogConfig"
}
},
"permissions": {
"description": "A permission is a string of form '\u003cservice\u003e.\u003cresource type\u003e.\u003cverb\u003e'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "Rule"
},
"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.",
"type": "object",
"properties": {
"description": {
"description": "A detailed description of the metric, which can be used in documentation.",
"type": "string"
},
"unit": {
"description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.",
"type": "string"
},
"labels": {
"description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.",
"type": "array",
"items": {
"$ref": "LabelDescriptor"
}
},
"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"
},
"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"
},
"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"
},
"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 123456789:\n\n \"projects/123456789/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 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"
}
},
"id": "MetricDescriptor"
},
"EnableServiceRequest": {
"description": "Request message for EnableService method.",
"type": "object",
"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:\u003cproject_id\u003e\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
"type": "string"
}
},
"id": "EnableServiceRequest"
},
"DocumentationRule": {
"description": "A documentation rule provides information about individual API elements.",
"type": "object",
"properties": {
"description": {
"description": "Description of the selected API(s).",
"type": "string"
},
"deprecationDescription": {
"description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.",
"type": "string"
},
"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"
}
},
"id": "DocumentationRule"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
"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.",
"$ref": "Policy"
}
},
"id": "SetIamPolicyRequest"
},
"CounterOptions": {
"description": "Options for counters",
"type": "object",
"properties": {
"metric": {
"description": "The metric to update.",
"type": "string"
},
"field": {
"description": "The field value to attribute.",
"type": "string"
}
},
"id": "CounterOptions"
},
"Condition": {
"description": "A condition to be met.",
"type": "object",
"properties": {
"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"
},
"values": {
"description": "The objects of the condition. This is mutually exclusive with 'value'.",
"type": "array",
"items": {
"type": "string"
}
},
"iam": {
"description": "Trusted attributes supplied by the IAM system.",
"enum": [
"NO_ATTR",
"AUTHORITY",
"ATTRIBUTION"
],
"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."
],
"type": "string"
},
"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.",
"Set-inclusion check.",
"Set-exclusion check.",
"Subject is discharged"
],
"type": "string"
},
"value": {
"description": "DEPRECATED. Use 'values' instead.",
"type": "string"
},
"svc": {
"description": "Trusted attributes discharged by the service.",
"type": "string"
}
},
"id": "Condition"
},
"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.",
"type": "object",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"type": "integer",
"format": "int32"
},
"details": {
"description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
"type": "array",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
}
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"id": "Status"
},
"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 apis: google.example.library.v1.Library\n allow_cors: true\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address\n # google.example.library-example.v1.LibraryManager.\n - name: library-manager.googleapis.com\n apis: google.example.library.v1.LibraryManager\n # BNS address for a borg job. Can specify a task by appending\n # \"/taskId\" (e.g. \"/0\") to the job spec.\n\nExample OpenAPI extension for endpoint with allow_cors set to true:\n\n {\n \"swagger\": \"2.0\",\n \"info\": {\n \"description\": \"A simple...\"\n },\n \"host\": \"MY_PROJECT_ID.appspot.com\",\n \"x-google-endpoints\": [{\n \"name\": \"MY_PROJECT_ID.appspot.com\",\n \"allow_cors\": \"true\"\n }]\n }",
"type": "object",
"properties": {
"apis": {
"description": "The list of APIs served by this endpoint.",
"type": "array",
"items": {
"type": "string"
}
},
"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"
},
"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.",
"type": "array",
"items": {
"type": "string"
}
},
"features": {
"description": "The list of features enabled on this endpoint.",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "Endpoint"
},
"Page": {
"description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
"type": "object",
"properties": {
"subpages": {
"description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
"type": "array",
"items": {
"$ref": "Page"
}
},
"content": {
"description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.",
"type": "string"
},
"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\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
"type": "string"
}
},
"id": "Page"
},
"CustomErrorRule": {
"description": "A custom error rule.",
"type": "object",
"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"
}
},
"id": "CustomErrorRule"
},
"Option": {
"description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
"type": "object",
"properties": {
"value": {
"description": "The option's value. For example, `\"com.google.protobuf\"`.",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"name": {
"description": "The option's name. For example, `\"java_package\"`.",
"type": "string"
}
},
"id": "Option"
},
"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```proto\nservice Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n}\nmessage 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}\nmessage Message {\n string text = 1; // content of the resource\n}\n```\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```proto\nmessage GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n}\n```\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A&param=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n```proto\nservice Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n}\nmessage 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```proto\nservice Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n}\nmessage 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\ndefin
"type": "object",
"properties": {
"custom": {
"description": "Custom pattern is used for defining custom verbs.",
"$ref": "CustomHttpPattern"
},
"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"
},
"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).",
"type": "array",
"items": {
"$ref": "HttpRule"
}
},
"mediaDownload": {
"description": "Do not use this. For media support, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration.",
"$ref": "MediaDownload"
},
"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 response message type.",
"type": "string"
},
"put": {
"description": "Used for updating a resource.",
"type": "string"
},
"get": {
"description": "Used for listing and getting information about resources.",
"type": "string"
},
"selector": {
"description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details.",
"type": "string"
},
"post": {
"description": "Used for creating a resource.",
"type": "string"
},
"patch": {
"description": "Used for updating a resource.",
"type": "string"
},
"delete": {
"description": "Used for deleting a resource.",
"type": "string"
},
"mediaUpload": {
"description": "Do not use this. For media support, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration.",
"$ref": "MediaUpload"
}
},
"id": "HttpRule"
},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
"type": "object",
"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).",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "TestIamPermissionsRequest"
},
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"type": "object",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "TestIamPermissionsResponse"
},
"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",
"type": "object",
"properties": {
"types": {
"description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
"type": "array",
"items": {
"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.",
"type": "array",
"items": {
"$ref": "CustomErrorRule"
}
}
},
"id": "CustomError"
},
"MediaDownload": {
"description": "Do not use this. For media support, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration.",
"type": "object",
"properties": {
"enabled": {
"description": "Whether download is enabled.",
"type": "boolean"
}
},
"id": "MediaDownload"
},
"SubmitConfigSourceRequest": {
"description": "Request message for SubmitConfigSource method.",
"type": "object",
"properties": {
"configSource": {
"description": "The source configuration for the service.",
"$ref": "ConfigSource"
},
"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"
}
},
"id": "SubmitConfigSourceRequest"
},
"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.",
"type": "object",
"properties": {
"oauth": {
"description": "The requirements for OAuth credentials.",
"$ref": "OAuthRequirements"
},
"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"
},
"requirements": {
"description": "Requirements for additional authentication providers.",
"type": "array",
"items": {
"$ref": "AuthRequirement"
}
},
"selector": {
"description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
"type": "string"
}
},
"id": "AuthenticationRule"
},
"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",
"type": "object",
"properties": {
"producerDestinations": {
"description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.",
"type": "array",
"items": {
"$ref": "LoggingDestination"
}
},
"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.",
"type": "array",
"items": {
"$ref": "LoggingDestination"
}
}
},
"id": "Logging"
},
"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.",
"type": "object",
"properties": {
"urlQueryParameter": {
"description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
"type": "string"
},
"name": {
"description": "Define the name of the parameter, such as \"api_key\", \"alt\", \"callback\",\nand etc. It is case sensitive.",
"type": "string"
},
"httpHeader": {
"description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.",
"type": "string"
}
},
"id": "SystemParameter"
},
"Enum": {
"description": "Enum type definition.",
"type": "object",
"properties": {
"syntax": {
"description": "The source syntax.",
"enum": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
],
"enumDescriptions": [
"Syntax `proto2`.",
"Syntax `proto3`."
],
"type": "string"
},
"enumvalue": {
"description": "Enum value definitions.",
"type": "array",
"items": {
"$ref": "EnumValue"
}
},
"options": {
"description": "Protocol buffer options.",
"type": "array",
"items": {
"$ref": "Option"
}
},
"sourceContext": {
"description": "The source context.",
"$ref": "SourceContext"
},
"name": {
"description": "Enum type name.",
"type": "string"
}
},
"id": "Enum"
},
"GenerateConfigReportResponse": {
"description": "Response message for GenerateConfigReport method.",
"type": "object",
"properties": {
"serviceName": {
"description": "Name of the service this report belongs to.",
"type": "string"
},
"id": {
"description": "ID of the service configuration this report belongs to.",
"type": "string"
},
"changeReports": {
"description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations.",
"type": "array",
"items": {
"$ref": "ChangeReport"
}
},
"diagnostics": {
"description": "Errors / Linter warnings associated with the service definition this\nreport\nbelongs to.",
"type": "array",
"items": {
"$ref": "Diagnostic"
}
}
},
"id": "GenerateConfigReportResponse"
},
"DeleteServiceStrategy": {
"description": "Strategy used to delete a service. This strategy is a placeholder only\nused by the system generated rollout to delete a service.",
"type": "object",
"properties": {},
"id": "DeleteServiceStrategy"
},
"OperationMetadata": {
"description": "The metadata associated with a long running operation resource.",
"type": "object",
"properties": {
"steps": {
"description": "Detailed status information for each step. The order is undetermined.",
"type": "array",
"items": {
"$ref": "Step"
}
},
"startTime": {
"description": "The start time of the operation.",
"type": "string",
"format": "google-datetime"
},
"resourceNames": {
"description": "The full name of the resources that this operation is directly\nassociated with.",
"type": "array",
"items": {
"type": "string"
}
},
"progressPercentage": {
"description": "Percentage of completion of this operation, ranging from 0 to 100.",
"type": "integer",
"format": "int32"
}
},
"id": "OperationMetadata"
},
"DisableServiceRequest": {
"description": "Request message for DisableService method.",
"type": "object",
"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:\u003cproject_id\u003e\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
"type": "string"
}
},
"id": "DisableServiceRequest"
},
"CustomHttpPattern": {
"description": "A custom pattern is used for defining custom HTTP verb.",
"type": "object",
"properties": {
"path": {
"description": "The path matched by this custom verb.",
"type": "string"
},
"kind": {
"description": "The name of this custom HTTP verb.",
"type": "string"
}
},
"id": "CustomHttpPattern"
},
"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",
"type": "object",
"properties": {
"labels": {
"description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.",
"type": "array",
"items": {
"$ref": "LabelDescriptor"
}
},
"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"
},
"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"
}
},
"id": "LogDescriptor"
},
"MonitoringDestination": {
"description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
"type": "object",
"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.",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "MonitoringDestination"
},
"Field": {
"description": "A single field of a message type.",
"type": "object",
"properties": {
"defaultValue": {
"description": "The string value of the default value of this field. Proto2 syntax only.",
"type": "string"
},
"jsonName": {
"description": "The field JSON name.",
"type": "string"
},
"options": {
"description": "The protocol buffer options.",
"type": "array",
"items": {
"$ref": "Option"
}
},
"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.",
"type": "integer",
"format": "int32"
},
"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"
},
"typeUrl": {
"description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
"type": "string"
},
"name": {
"description": "The field name.",
"type": "string"
},
"packed": {
"description": "Whether to use alternative packed wire representation.",
"type": "boolean"
},
"number": {
"description": "The field number.",
"type": "integer",
"format": "int32"
},
"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."
],
"type": "string"
}
},
"id": "Field"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"type": "object",
"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",
"type": "array",
"items": {
"type": "string"
}
},
"role": {
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
}
},
"id": "Binding"
},
"ConfigRef": {
"description": "Represents a service configuration with its name and id.",
"type": "object",
"properties": {
"name": {
"description": "Resource name of a service config. It must have the following\nformat: \"services/{service name}/configs/{config id}\".",
"type": "string"
}
},
"id": "ConfigRef"
},
"DataAccessOptions": {
"description": "Write a Data Access (Gin) log",
"type": "object",
"properties": {},
"id": "DataAccessOptions"
},
"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).",
"type": "object",
"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"
},
"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"
},
"id": {
"description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\".",
"type": "string"
},
"issuer": {
"description": "Identifies the principal that issued the JWT. See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.com\nExample: 1234567-compute@developer.gserviceaccount.com",
"type": "string"
}
},
"id": "AuthProvider"
},
"VisibilityRule": {
"description": "A visibility rule provides visibility configuration for an individual API\nelement.",
"type": "object",
"properties": {
"restriction": {
"description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
"type": "string"
},
"selector": {
"description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
"type": "string"
}
},
"id": "VisibilityRule"
},
"UndeleteServiceResponse": {
"description": "Response message for UndeleteService method.",
"type": "object",
"properties": {
"service": {
"description": "Revived service resource.",
"$ref": "ManagedService"
}
},
"id": "UndeleteServiceResponse"
},
"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",
"type": "object",
"properties": {
"allowUnregisteredCalls": {
"description": "True, if the method allows unregistered calls; false otherwise.",
"type": "boolean"
},
"selector": {
"description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
"type": "string"
}
},
"id": "UsageRule"
},
"EnumValue": {
"description": "Enum value definition.",
"type": "object",
"properties": {
"options": {
"description": "Protocol buffer options.",
"type": "array",
"items": {
"$ref": "Option"
}
},
"name": {
"description": "Enum value name.",
"type": "string"
},
"number": {
"description": "Enum value number.",
"type": "integer",
"format": "int32"
}
},
"id": "EnumValue"
},
"MediaUpload": {
"description": "Do not use this. For media support, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration.",
"type": "object",
"properties": {
"enabled": {
"description": "Whether upload is enabled.",
"type": "boolean"
}
},
"id": "MediaUpload"
},
"BackendRule": {
"description": "A backend rule provides configuration for an individual API element.",
"type": "object",
"properties": {
"address": {
"description": "The address of the API backend.",
"type": "string"
},
"deadline": {
"description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
"type": "number",
"format": "double"
},
"selector": {
"description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
"type": "string"
}
},
"id": "BackendRule"
},
"ContextRule": {
"description": "A context rule provides information about the context for an individual API\nelement.",
"type": "object",
"properties": {
"provided": {
"description": "A list of full type names of provided contexts.",
"type": "array",
"items": {
"type": "string"
}
},
"selector": {
"description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
"type": "string"
},
"requested": {
"description": "A list of full type names of requested contexts.",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "ContextRule"
},
"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.",
"type": "object",
"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.",
"type": "array",
"items": {
"$ref": "HttpRule"
}
}
},
"id": "Http"
},
"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.",
"type": "object",
"properties": {
"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.",
"type": "array",
"items": {
"$ref": "VisibilityRule"
}
}
},
"id": "Visibility"
},
"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.",
"type": "object",
"properties": {
"newValue": {
"description": "Value of the changed object in the new Service configuration,\nin JSON format. This field will not be populated if ChangeType == REMOVED.",
"type": "string"
},
"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"
},
"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"
},
"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"
},
"advices": {
"description": "Collection of advice provided for this change, useful for determining the\npossible impact of this change.",
"type": "array",
"items": {
"$ref": "Advice"
}
}
},
"id": "ConfigChange"
},
"SystemParameters": {
"description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.",
"type": "object",
"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 and alt name for all methods\n\nsystem_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n - name: alt\n http_header: Response-Content-Type\n\nExample: define 2 api key names for a specific method.\n\nsystem_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.",
"type": "array",
"items": {
"$ref": "SystemParameterRule"
}
}
},
"id": "SystemParameters"
},
"LabelDescriptor": {
"description": "A description of a label.",
"type": "object",
"properties": {
"description": {
"description": "A human-readable description for the label.",
"type": "string"
},
"valueType": {
"description": "The type of data that can be assigned to the label.",
"enum": [
"STRING",
"BOOL",
"INT64"
],
"enumDescriptions": [
"A variable-length string. This is the default.",
"Boolean; true or false.",
"A 64-bit signed integer."
],
"type": "string"
},
"key": {
"description": "The label key.",
"type": "string"
}
},
"id": "LabelDescriptor"
},
"Usage": {
"description": "Configuration controlling usage of a service.",
"type": "object",
"properties": {
"requirements": {
"description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'.",
"type": "array",
"items": {
"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.",
"type": "array",
"items": {
"$ref": "UsageRule"
}
}
},
"id": "Usage"
},
"Advice": {
"description": "Generated advice about this change, used for providing more\ninformation about how a change will affect the existing service.",
"type": "object",
"properties": {
"description": {
"description": "Useful description for why this advice was applied and what actions should\nbe taken to mitigate any implied risks.",
"type": "string"
}
},
"id": "Advice"
},
"CloudAuditOptions": {
"description": "Write a Cloud Audit log",
"type": "object",
"properties": {},
"id": "CloudAuditOptions"
},
"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).",
"type": "object",
"properties": {
"audiences": {
"description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
"type": "string"
},
"providerId": {
"description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
"type": "string"
}
},
"id": "AuthRequirement"
},
"Control": {
"description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.",
"type": "object",
"properties": {
"environment": {
"description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled.",
"type": "string"
}
},
"id": "Control"
},
"SourceContext": {
"description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
"type": "object",
"properties": {
"fileName": {
"description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.",
"type": "string"
}
},
"id": "SourceContext"
}
},
"revision": "20161114",
"basePath": "",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"canonicalName": "Service Management",
"discoveryVersion": "v1",
"baseUrl": "https://servicemanagement.googleapis.com/",
"name": "servicemanagement",
"parameters": {
"access_token": {
"description": "OAuth access token.",
"type": "string",
"location": "query"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean",
"location": "query"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
},
"pp": {
"description": "Pretty-print response.",
"default": "true",
"type": "boolean",
"location": "query"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"alt": {
"description": "Data format for response.",
"location": "query",
"enum": [
"json",
"media",
"proto"
],
"default": "json",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"type": "string"
},
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"type": "string",
"location": "query"
},
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
"bearer_token": {
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
}
},
"documentationLink": "https://cloud.google.com/service-management/",
"ownerDomain": "google.com",
"batchPath": "batch",
"servicePath": "",
"ownerName": "Google",
"version": "v1",
"rootUrl": "https://servicemanagement.googleapis.com/",
"kind": "discovery#restDescription"
}