openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 60 kB
JSON
{"openapi":"3.0.0","info":{"contact":{"name":"Google","url":"https://google.com"},"description":"Provides control plane functionality to managed services, such as logging, monitoring, and status checks.","title":"Service Control","version":"v1","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-apisguru-categories":["cloud"],"x-logo":{"url":"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"},"x-origin":[{"converter":{"url":"https://github.com/lucybot/api-spec-converter","version":"2.7.18"},"format":"google","url":"https://servicecontrol.googleapis.com/$discovery/rest?version=v1","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"servicecontrol"},"externalDocs":{"url":"https://cloud.google.com/service-control/"},"tags":[{"name":"services"}],"paths":{"/v1/services/{serviceName}:allocateQuota":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Attempts to allocate quota for the specified consumer. It should be called\nbefore the operation is executed.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** The client **must** fail-open on server errors `INTERNAL`,\n`UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system\nreliability, the server may inject these errors to prohibit any hard\ndependency on the quota functionality.","operationId":"servicecontrol.services.allocateQuota","parameters":[{"description":"Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllocateQuotaRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AllocateQuotaResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/servicecontrol"]}],"tags":["services"]}},"/v1/services/{serviceName}:check":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Checks whether an operation on a service should be allowed to proceed\nbased on the configuration of the service and related policies. It must be\ncalled before the operation is executed.\n\nIf feasible, the client should cache the check results and reuse them for\n60 seconds. In case of any server errors, the client should rely on the\ncached results for much longer time to avoid outage.\nWARNING: There is general 60s delay for the configuration and policy\npropagation, therefore callers MUST NOT depend on the `Check` method having\nthe latest policy information.\n\nNOTE: the CheckRequest has the size limit of 64KB.\n\nThis method requires the `servicemanagement.services.check` permission\non the specified service. For more information, see\n[Cloud IAM](https://cloud.google.com/iam).","operationId":"servicecontrol.services.check","parameters":[{"description":"The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee\n[google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)\nfor the definition of a service name.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CheckResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/servicecontrol"]}],"tags":["services"]}},"/v1/services/{serviceName}:report":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Reports operation results to Google Service Control, such as logs and\nmetrics. It should be called after an operation is completed.\n\nIf feasible, the client should aggregate reporting data for up to 5\nseconds to reduce API traffic. Limiting aggregation to 5 seconds is to\nreduce data loss during client crashes. Clients should carefully choose\nthe aggregation time window to avoid data loss risk more than 0.01%\nfor business and compliance reasons.\n\nNOTE: the ReportRequest has the size limit of 1MB.\n\nThis method requires the `servicemanagement.services.report` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).","operationId":"servicecontrol.services.report","parameters":[{"description":"The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee\n[google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)\nfor the definition of a service name.","in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ReportResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/servicecontrol"]}],"tags":["services"]}}},"servers":[{"url":"https://servicecontrol.googleapis.com/"}],"components":{"parameters":{"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"type":"string","enum":["json","media","proto"],"default":"json"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean","default":true}},"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.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}},"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"type":"string","enum":["1","2"]}}},"securitySchemes":{"Oauth2":{"description":"Oauth 2.0 authentication","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://accounts.google.com/o/oauth2/auth","scopes":{"https://www.googleapis.com/auth/cloud-platform":"View and manage your data across Google Cloud Platform services","https://www.googleapis.com/auth/servicecontrol":"Manage your Google Service Control data"}}}}},"schemas":{"AllocateInfo":{"properties":{"unusedArguments":{"description":"A list of label keys that were unused by the server in processing the\nrequest. Thus, for similar requests repeated in a certain future time\nwindow, the caller can choose to ignore these labels in the requests\nto achieve better client-side cache hits and quota aggregation.","items":{"type":"string"},"type":"array"}},"type":"object"},"AllocateQuotaRequest":{"description":"Request message for the AllocateQuota method.","properties":{"allocateOperation":{"$ref":"#/components/schemas/QuotaOperation"},"serviceConfigId":{"description":"Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.","type":"string"}},"type":"object"},"AllocateQuotaResponse":{"description":"Response message for the AllocateQuota method.","properties":{"allocateErrors":{"description":"Indicates the decision of the allocate.","items":{"$ref":"#/components/schemas/QuotaError"},"type":"array"},"allocateInfo":{"$ref":"#/components/schemas/AllocateInfo"},"operationId":{"description":"The same operation_id value used in the AllocateQuotaRequest. Used for\nlogging and diagnostics purposes.","type":"string"},"quotaMetrics":{"description":"Quota metrics to indicate the result of allocation. Depending on the\nrequest, one or more of the following metrics will be included:\n\n1. Per quota group or per quota metric incremental usage will be specified\nusing the following delta metric :\n \"serviceruntime.googleapis.com/api/consumer/quota_used_count\"\n\n2. The quota limit reached condition will be specified using the following\nboolean metric :\n \"serviceruntime.googleapis.com/quota/exceeded\"","items":{"$ref":"#/components/schemas/MetricValueSet"},"type":"array"},"serviceConfigId":{"description":"ID of the actual config used to process the request.","type":"string"}},"type":"object"},"AuditLog":{"description":"Common audit log format for Google Cloud Platform API operations.\n\n","properties":{"authenticationInfo":{"$ref":"#/components/schemas/AuthenticationInfo"},"authorizationInfo":{"description":"Authorization information. If there are multiple\nresources or permissions involved, then there is\none AuthorizationInfo element for each {resource, permission} tuple.","items":{"$ref":"#/components/schemas/AuthorizationInfo"},"type":"array"},"metadata":{"additionalProperties":{"description":"Properties of the object."},"description":"Other service-specific data about the request, response, and other\ninformation associated with the current audited event.","type":"object"},"methodName":{"description":"The name of the service method or operation.\nFor API calls, this should be the name of the API method.\nFor example,\n\n \"google.datastore.v1.Datastore.RunQuery\"\n \"google.logging.v1.LoggingService.DeleteLog\"","type":"string"},"numResponseItems":{"description":"The number of items returned from a List or Query API method,\nif applicable.","format":"int64","type":"string"},"request":{"additionalProperties":{"description":"Properties of the object."},"description":"The operation request. This may not include all request parameters,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.","type":"object"},"requestMetadata":{"$ref":"#/components/schemas/RequestMetadata"},"resourceLocation":{"$ref":"#/components/schemas/ResourceLocation"},"resourceName":{"description":"The resource or collection that is the target of the operation.\nThe name is a scheme-less URI, not including the API service name.\nFor example:\n\n \"shelves/SHELF_ID/books\"\n \"shelves/SHELF_ID/books/BOOK_ID\"","type":"string"},"resourceOriginalState":{"additionalProperties":{"description":"Properties of the object."},"description":"The resource's original state before mutation. Present only for\noperations which have successfully modified the targeted resource(s).\nIn general, this field should contain all changed fields, except those\nthat are already been included in `request`, `response`, `metadata` or\n`service_data` fields.\nWhen the JSON object represented here has a proto equivalent,\nthe proto name will be indicated in the `@type` property.","type":"object"},"response":{"additionalProperties":{"description":"Properties of the object."},"description":"The operation response. This may not include all response elements,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.","type":"object"},"serviceData":{"additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."},"description":"Deprecated, use `metadata` field instead.\nOther service-specific data about the request, response, and other\nactivities.","type":"object"},"serviceName":{"description":"The name of the API service performing the operation. For example,\n`\"datastore.googleapis.com\"`.","type":"string"},"status":{"$ref":"#/components/schemas/Status"}},"type":"object"},"Auth":{"description":"This message defines request authentication attributes. Terminology is\nbased on the JSON Web Token (JWT) standard, but the terms also\ncorrelate to concepts in other standards.","properties":{"accessLevels":{"description":"A list of access level resource names that allow resources to be\naccessed by authenticated requester. It is part of Secure GCP processing\nfor the incoming request. An access level string has the format:\n\"//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}\"\n\nExample:\n\"//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL\"","items":{"type":"string"},"type":"array"},"audiences":{"description":"The intended audience(s) for this authentication information. Reflects\nthe audience (`aud`) claim within a JWT. The audience\nvalue(s) depends on the `issuer`, but typically include one or more of\nthe following pieces of information:\n\n* The services intended to receive the credential such as\n [\"pubsub.googleapis.com\", \"storage.googleapis.com\"]\n* A set of service-based scopes. For example,\n [\"https://www.googleapis.com/auth/cloud-platform\"]\n* The client id of an app, such as the Firebase project id for JWTs\n from Firebase Auth.\n\nConsult the documentation for the credential issuer to determine the\ninformation provided.","items":{"type":"string"},"type":"array"},"claims":{"additionalProperties":{"description":"Properties of the object."},"description":"Structured claims presented with the credential. JWTs include\n`{key: value}` pairs for standard and private claims. The following\nis a subset of the standard required and optional claims that would\ntypically be presented for a Google-based JWT:\n\n {'iss': 'accounts.google.com',\n 'sub': '113289723416554971153',\n 'aud': ['123456789012', 'pubsub.googleapis.com'],\n 'azp': '123456789012.apps.googleusercontent.com',\n 'email': 'jsmith@example.com',\n 'iat': 1353601026,\n 'exp': 1353604926}\n\nSAML assertions are similarly specified, but with an identity provider\ndependent structure.","type":"object"},"presenter":{"description":"The authorized presenter of the credential. Reflects the optional\nAuthorized Presenter (`azp`) claim within a JWT or the\nOAuth client id. For example, a Google Cloud Platform client id looks\nas follows: \"123456789012.apps.googleusercontent.com\".","type":"string"},"principal":{"description":"The authenticated principal. Reflects the issuer (`iss`) and subject\n(`sub`) claims within a JWT. The issuer and subject should be `/`\ndelimited, with `/` percent-encoded within the subject fragment. For\nGoogle accounts, the principal format is:\n\"https://accounts.google.com/{id}\"","type":"string"}},"type":"object"},"AuthenticationInfo":{"description":"Authentication information for the operation.","properties":{"authoritySelector":{"description":"The authority selector specified by the requestor, if any.\nIt is not guaranteed that the principal was allowed to use this authority.","type":"string"},"principalEmail":{"description":"The email address of the authenticated user (or service account on behalf\nof third party principal) making the request. For privacy reasons, the\nprincipal email address is redacted for all read-only operations that fail\nwith a \"permission denied\" error.","type":"string"},"serviceAccountKeyName":{"description":"The name of the service account key used to create or exchange\ncredentials for authenticating the service account making the request.\nThis is a scheme-less URI full resource name. For example:\n\n\"//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}\"","type":"string"},"thirdPartyPrincipal":{"additionalProperties":{"description":"Properties of the object."},"description":"The third party identification (if any) of the authenticated user making\nthe request.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.","type":"object"}},"type":"object"},"AuthorizationInfo":{"description":"Authorization information for the operation.","properties":{"granted":{"description":"Whether or not authorization for `resource` and `permission`\nwas granted.","type":"boolean"},"permission":{"description":"The required IAM permission.","type":"string"},"resource":{"description":"The resource being accessed, as a REST-style string. For example:\n\n bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID","type":"string"},"resourceAttributes":{"$ref":"#/components/schemas/Resource"}},"type":"object"},"CheckError":{"description":"Defines the errors to be returned in\ngoogle.api.servicecontrol.v1.CheckResponse.check_errors.","properties":{"code":{"description":"The error code.","enum":["ERROR_CODE_UNSPECIFIED","NOT_FOUND","PERMISSION_DENIED","RESOURCE_EXHAUSTED","BUDGET_EXCEEDED","DENIAL_OF_SERVICE_DETECTED","LOAD_SHEDDING","ABUSER_DETECTED","SERVICE_NOT_ACTIVATED","VISIBILITY_DENIED","BILLING_DISABLED","PROJECT_DELETED","PROJECT_INVALID","CONSUMER_INVALID","IP_ADDRESS_BLOCKED","REFERER_BLOCKED","CLIENT_APP_BLOCKED","API_TARGET_BLOCKED","API_KEY_INVALID","API_KEY_EXPIRED","API_KEY_NOT_FOUND","SPATULA_HEADER_INVALID","LOAS_ROLE_INVALID","NO_LOAS_PROJECT","LOAS_PROJECT_DISABLED","SECURITY_POLICY_VIOLATED","INVALID_CREDENTIAL","LOCATION_POLICY_VIOLATED","NAMESPACE_LOOKUP_UNAVAILABLE","SERVICE_STATUS_UNAVAILABLE","BILLING_STATUS_UNAVAILABLE","QUOTA_CHECK_UNAVAILABLE","LOAS_PROJECT_LOOKUP_UNAVAILABLE","CLOUD_RESOURCE_MANAGER_BACKEND_UNAVAILABLE","SECURITY_POLICY_BACKEND_UNAVAILABLE","LOCATION_POLICY_BACKEND_UNAVAILABLE"],"type":"string"},"detail":{"description":"Free-form text providing details on the error cause of the error.","type":"string"},"status":{"$ref":"#/components/schemas/Status"},"subject":{"description":"Subject to whom this error applies. See the specific code enum for more\ndetails on this field. For example:\n - “project:<project-id or project-number>”\n - “folder:<folder-id>”\n - “organization:<organization-id>”","type":"string"}},"type":"object"},"CheckInfo":{"description":"Contains additional information about the check operation.","properties":{"consumerInfo":{"$ref":"#/components/schemas/ConsumerInfo"},"unusedArguments":{"description":"A list of fields and label keys that are ignored by the server.\nThe client doesn't need to send them for following requests to improve\nperformance and allow better aggregation.","items":{"type":"string"},"type":"array"}},"type":"object"},"CheckRequest":{"description":"Request message for the Check method.","properties":{"operation":{"$ref":"#/components/schemas/Operation"},"requestProjectSettings":{"description":"Requests the project settings to be returned as part of the check response.","type":"boolean"},"serviceConfigId":{"description":"Specifies which version of service configuration should be used to process\nthe request.\n\nIf unspecified or no matching version can be found, the\nlatest one will be used.","type":"string"},"skipActivationCheck":{"description":"Indicates if service activation check should be skipped for this request.\nDefault behavior is to perform the check and apply relevant quota.\nWARNING: Setting this flag to \"true\" will disable quota enforcement.","type":"boolean"}},"type":"object"},"CheckResponse":{"description":"Response message for the Check method.","properties":{"checkErrors":{"description":"Indicate the decision of the check.\n\nIf no check errors are present, the service should process the operation.\nOtherwise the service should use the list of errors to determine the\nappropriate action.","items":{"$ref":"#/components/schemas/CheckError"},"type":"array"},"checkInfo":{"$ref":"#/components/schemas/CheckInfo"},"operationId":{"description":"The same operation_id value used in the CheckRequest.\nUsed for logging and diagnostics purposes.","type":"string"},"quotaInfo":{"$ref":"#/components/schemas/QuotaInfo"},"serviceConfigId":{"description":"The actual config id used to process the request.","type":"string"}},"type":"object"},"ConsumerInfo":{"description":"`ConsumerInfo` provides information about the consumer.","properties":{"consumerNumber":{"description":"The consumer identity number, can be Google cloud project number, folder\nnumber or organization number e.g. 1234567890. A value of 0 indicates no\nconsumer number is found.","format":"int64","type":"string"},"projectNumber":{"description":"The Google cloud project number, e.g. 1234567890. A value of 0 indicates\nno project number is found.\n\nNOTE: This field is deprecated after Chemist support flexible consumer\nid. New code should not depend on this field anymore.","format":"int64","type":"string"},"type":{"enum":["CONSUMER_TYPE_UNSPECIFIED","PROJECT","FOLDER","ORGANIZATION"],"type":"string"}},"type":"object"},"Distribution":{"description":"Distribution represents a frequency distribution of double-valued sample\npoints. It contains the size of the population of sample points plus\nadditional optional information:\n\n - the arithmetic mean of the samples\n - the minimum and maximum of the samples\n - the sum-squared-deviation of the samples, used to compute variance\n - a histogram of the values of the sample points","properties":{"bucketCounts":{"description":"The number of samples in each histogram bucket. `bucket_counts` are\noptional. If present, they must sum to the `count` value.\n\nThe buckets are defined below in `bucket_option`. There are N buckets.\n`bucket_counts[0]` is the number of samples in the underflow bucket.\n`bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples\nin each of the finite buckets. And `bucket_counts[N] is the number\nof samples in the overflow bucket. See the comments of `bucket_option`\nbelow for more details.\n\nAny suffix of trailing zeros may be omitted.","items":{"format":"int64","type":"string"},"type":"array"},"count":{"description":"The total number of samples in the distribution. Must be >= 0.","format":"int64","type":"string"},"explicitBuckets":{"$ref":"#/components/schemas/ExplicitBuckets"},"exponentialBuckets":{"$ref":"#/components/schemas/ExponentialBuckets"},"linearBuckets":{"$ref":"#/components/schemas/LinearBuckets"},"maximum":{"description":"The maximum of the population of values. Ignored if `count` is zero.","format":"double","type":"number"},"mean":{"description":"The arithmetic mean of the samples in the distribution. If `count` is\nzero then this field must be zero.","format":"double","type":"number"},"minimum":{"description":"The minimum of the population of values. Ignored if `count` is zero.","format":"double","type":"number"},"sumOfSquaredDeviation":{"description":"The sum of squared deviations from the mean:\n Sum[i=1..count]((x_i - mean)^2)\nwhere each x_i is a sample values. If `count` is zero then this field\nmust be zero, otherwise validation of the request fails.","format":"double","type":"number"}},"type":"object"},"ExplicitBuckets":{"description":"Describing buckets with arbitrary user-provided width.","properties":{"bounds":{"description":"'bound' is a list of strictly increasing boundaries between\nbuckets. Note that a list of length N-1 defines N buckets because\nof fenceposting. See comments on `bucket_options` for details.\n\nThe i'th finite bucket covers the interval\n [bound[i-1], bound[i])\nwhere i ranges from 1 to bound_size() - 1. Note that there are no\nfinite buckets at all if 'bound' only contains a single element; in\nthat special case the single bound defines the boundary between the\nunderflow and overflow buckets.\n\nbucket number lower bound upper bound\n i == 0 (underflow) -inf bound[i]\n 0 < i < bound_size() bound[i-1] bound[i]\n i == bound_size() (overflow) bound[i-1] +inf","items":{"format":"double","type":"number"},"type":"array"}},"type":"object"},"ExponentialBuckets":{"description":"Describing buckets with exponentially growing width.","properties":{"growthFactor":{"description":"The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be larger than 1.0.","format":"double","type":"number"},"numFiniteBuckets":{"description":"The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.","format":"int32","type":"integer"},"scale":{"description":"The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be > 0.","format":"double","type":"number"}},"type":"object"},"HttpRequest":{"description":"A common proto for logging HTTP requests. Only contains semantics\ndefined by the HTTP specification. Product-specific logging\ninformation MUST be defined in a separate message.","properties":{"cacheFillBytes":{"description":"The number of HTTP response bytes inserted into cache. Set only when a\ncache fill was attempted.","format":"int64","type":"string"},"cacheHit":{"description":"Whether or not an entity was served from cache\n(with or without validation).","type":"boolean"},"cacheLookup":{"description":"Whether or not a cache lookup was attempted.","type":"boolean"},"cacheValidatedWithOriginServer":{"description":"Whether or not the response was validated with the origin server before\nbeing served from cache. This field is only meaningful if `cache_hit` is\nTrue.","type":"boolean"},"latency":{"description":"The request processing latency on the server, from the time the request was\nreceived until the response was sent.","format":"google-duration","type":"string"},"protocol":{"description":"Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"","type":"string"},"referer":{"description":"The referer URL of the request, as defined in\n[HTTP/1.1 Header Field\nDefinitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).","type":"string"},"remoteIp":{"description":"The IP address (IPv4 or IPv6) of the client that issued the HTTP\nrequest. Examples: `\"192.168.1.1\"`, `\"FE80::0202:B3FF:FE1E:8329\"`.","type":"string"},"requestMethod":{"description":"The request method. Examples: `\"GET\"`, `\"HEAD\"`, `\"PUT\"`, `\"POST\"`.","type":"string"},"requestSize":{"description":"The size of the HTTP request message in bytes, including the request\nheaders and the request body.","format":"int64","type":"string"},"requestUrl":{"description":"The scheme (http, https), the host name, the path, and the query\nportion of the URL that was requested.\nExample: `\"http://example.com/some/info?color=red\"`.","type":"string"},"responseSize":{"description":"The size of the HTTP response message sent back to the client, in bytes,\nincluding the response headers and the response body.","format":"int64","type":"string"},"serverIp":{"description":"The IP address (IPv4 or IPv6) of the origin server that the request was\nsent to.","type":"string"},"status":{"description":"The response code indicating the status of the response.\nExamples: 200, 404.","format":"int32","type":"integer"},"userAgent":{"description":"The user agent sent by the client. Example:\n`\"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET\nCLR 1.0.3705)\"`.","type":"string"}},"type":"object"},"LinearBuckets":{"description":"Describing buckets with constant width.","properties":{"numFiniteBuckets":{"description":"The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.","format":"int32","type":"integer"},"offset":{"description":"The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.","format":"double","type":"number"},"width":{"description":"The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.\nMust be strictly positive.","format":"double","type":"number"}},"type":"object"},"LogEntry":{"description":"An individual log entry.","properties":{"httpRequest":{"$ref":"#/components/schemas/HttpRequest"},"insertId":{"description":"A unique ID for the log entry used for deduplication. If omitted,\nthe implementation will generate one based on operation_id.","type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"A set of user-defined (key, value) data that provides additional\ninformation about the log entry.","type":"object"},"name":{"description":"Required. The log to which this log entry belongs. Examples: `\"syslog\"`,\n`\"book_log\"`.","type":"string"},"operation":{"$ref":"#/components/schemas/LogEntryOperation"},"protoPayload":{"additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."},"description":"The log entry payload, represented as a protocol buffer that is\nexpressed as a JSON object. The only accepted type currently is\nAuditLog.","type":"object"},"severity":{"description":"The severity of the log entry. The default value is\n`LogSeverity.DEFAULT`.","enum":["DEFAULT","DEBUG","INFO","NOTICE","WARNING","ERROR","CRITICAL","ALERT","EMERGENCY"],"type":"string"},"structPayload":{"additionalProperties":{"description":"Properties of the object."},"description":"The log entry payload, represented as a structure that\nis expressed as a JSON object.","type":"object"},"textPayload":{"description":"The log entry payload, represented as a Unicode string (UTF-8).","type":"string"},"timestamp":{"description":"The time the event described by the log entry occurred. If\nomitted, defaults to operation start time.","format":"google-datetime","type":"string"},"trace":{"description":"Optional. Resource name of the trace associated with the log entry, if any.\nIf this field contains a relative resource name, you can assume the name is\nrelative to `//tracing.googleapis.com`. Example:\n`projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824`","type":"string"}},"type":"object"},"LogEntryOperation":{"description":"Additional information about a potentially long-running operation with which\na log entry is associated.","properties":{"first":{"description":"Optional. Set this to True if this is the first log entry in the operation.","type":"boolean"},"id":{"description":"Optional. An arbitrary operation identifier. Log entries with the\nsame identifier are assumed to be part of the same operation.","type":"string"},"last":{"description":"Optional. Set this to True if this is the last log entry in the operation.","type":"boolean"},"producer":{"description":"Optional. An arbitrary producer identifier. The combination of\n`id` and `producer` must be globally unique. Examples for `producer`:\n`\"MyDivision.MyBigCompany.com\"`, `\"github.com/MyProject/MyApplication\"`.","type":"string"}},"type":"object"},"MetricValue":{"description":"Represents a single metric value.","properties":{"boolValue":{"description":"A boolean value.","type":"boolean"},"distributionValue":{"$ref":"#/components/schemas/Distribution"},"doubleValue":{"description":"A double precision floating point value.","format":"double","type":"number"},"endTime":{"description":"The end of the time period over which this metric value's measurement\napplies.","format":"google-datetime","type":"string"},"int64Value":{"description":"A signed 64-bit integer value.","format":"int64","type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"The labels describing the metric value.\nSee comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding relationship.","type":"object"},"moneyValue":{"$ref":"#/components/schemas/Money"},"startTime":{"description":"The start of the time period over which this metric value's measurement\napplies. The time period has different semantics for different metric\ntypes (cumulative, delta, and gauge). See the metric definition\ndocumentation in the service configuration for details.","format":"google-datetime","type":"string"},"stringValue":{"description":"A text string value.","type":"string"}},"type":"object"},"MetricValueSet":{"description":"Represents a set of metric values in the same metric.\nEach metric value in the set should have a unique combination of start time,\nend time, and label values.","properties":{"metricName":{"description":"The metric name defined in the service configuration.","type":"string"},"metricValues":{"description":"The values in this metric.","items":{"$ref":"#/components/schemas/MetricValue"},"type":"array"}},"type":"object"},"Money":{"description":"Represents an amount of money with its currency type.","properties":{"currencyCode":{"description":"The 3-letter currency code defined in ISO 4217.","type":"string"},"nanos":{"description":"Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.","format":"int32","type":"integer"},"units":{"description":"The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.","format":"int64","type":"string"}},"type":"object"},"Operation":{"description":"Represents information regarding an operation.","properties":{"consumerId":{"description":"Identity of the consumer who is using the service.\nThis field should be filled in for the operations initiated by a\nconsumer, but not for service-initiated operations that are\nnot related to a specific consumer.\n\n- This can be in one of the following formats:\n - project:PROJECT_ID,\n - project`_`number:PROJECT_NUMBER,\n - api`_`key:API_KEY.","type":"string"},"endTime":{"description":"End time of the operation.\nRequired when the operation is used in ServiceController.Report,\nbut optional when the operation is used in ServiceController.Check.","format":"google-datetime","type":"string"},"importance":{"description":"DO NOT USE. This is an experimental field.","enum":["LOW","HIGH","DEBUG"],"type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"Labels describing the operation. Only the following labels are allowed:\n\n- Labels describing monitored resources as defined in\n the service configuration.\n- Default labels of metric values. When specified, labels defined in the\n metric value override these default.\n- The following labels defined by Google Cloud Platform:\n - `cloud.googleapis.com/location` describing the location where the\n operation happened,\n - `servicecontrol.googleapis.com/user_agent` describing the user agent\n of the API request,\n - `servicecontrol.googleapis.com/service_agent` describing the service\n used to handle the API request (e.g. ESP),\n - `servicecontrol.googleapis.com/platform` describing the platform\n where the API is served, such as App Engine, Compute Engine, or\n Kubernetes Engine.","type":"object"},"logEntries":{"description":"Represents information to be logged.","items":{"$ref":"#/components/schemas/LogEntry"},"type":"array"},"metricValueSets":{"description":"Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.","items":{"$ref":"#/components/schemas/MetricValueSet"},"type":"array"},"operationId":{"description":"Identity of the operation. This must be unique within the scope of the\nservice that generated the operation. If the service calls\nCheck() and Report() on the same operation, the two calls should carry\nthe same id.\n\nUUID version 4 is recommended, though not required.\nIn scenarios where an operation is computed from existing information\nand an idempotent id is desirable for deduplication purpose, UUID version 5\nis recommended. See RFC 4122 for details.","type":"string"},"operationName":{"description":"Fully qualified name of the operation. Reserved for future use.","type":"string"},"quotaProperties":{"$ref":"#/components/schemas/QuotaProperties"},"resourceContainer":{"description":"DO NOT USE. This field is deprecated, use \"resources\" field instead.\nThe resource name of the parent of a resource in the resource hierarchy.\n\nThis can be in one of the following formats:\n - “projects/<project-id or project-number>”\n - “folders/<folder-id>”\n - “organizations/<organization-id>”","type":"string"},"resources":{"description":"The resources that are involved in the operation.\nThe maximum supported number of entries in this field is 100.","items":{"$ref":"#/components/schemas/ResourceInfo"},"type":"array"},"startTime":{"description":"Required. Start time of the operation.","format":"google-datetime","type":"string"},"userLabels":{"additionalProperties":{"type":"string"},"description":"User defined labels for the resource that this operation is associated\nwith. Only a combination of 1000 user labels per consumer project are\nallowed.","type":"object"}},"type":"object"},"Peer":{"description":"This message defines attributes for a node that handles a network request.\nThe node can be either a service or an application that sends, forwards,\nor receives the request. Service peers should fill in the `service`,\n`principal`, and `labels` as appropriate.","properties":{"ip":{"description":"The IP address of the peer.","type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"The labels associated with the peer.","type":"object"},"port":{"description":"The network port of the peer.","format":"int64","type":"string"},"principal":{"description":"The identity of this peer. Similar to `Request.auth.principal`, but\nrelative to the peer instead of the request. For example, the\nidenity associated with a load balancer that forwared the request.","type":"string"},"regionCode":{"description":"The CLDR country/region code associated with the above IP address.\nIf the IP address is private, the `region_code` should reflect the\nphysical location where this peer is running.","type":"string"},"service":{"description":"The canonical service name of the peer.\n\nNOTE: different systems may have different service naming schemes.","type":"string"}},"type":"object"},"QuotaError":{"description":"Represents error information for QuotaOperation.","properties":{"code":{"description":"Error code.","enum":["UNSPECIFIED","RESOURCE_EXHAUSTED","OUT_OF_RANGE","BILLING_NOT_ACTIVE","PROJECT_DELETED","API_KEY_INVALID","API_KEY_EXPIRED","SPATULA_HEADER_INVALID","LOAS_ROLE_INVALID","NO_LOAS_PROJECT","PROJECT_STATUS_UNAVAILABLE","SERVICE_STATUS_UNAVAILABLE","BILLING_STATUS_UNAVAILABLE","QUOTA_SYSTEM_UNAVAILABLE"],"type":"string"},"description":{"description":"Free-form text that provides details on the cause of the error.","type":"string"},"subject":{"description":"Subject to whom this error applies. See the specific enum for more details\non this field. For example, \"clientip:<ip address of client>\" or\n\"project:<Google developer project id>\".","type":"string"}},"type":"object"},"QuotaInfo":{"description":"Contains the quota information for a quota check response.","properties":{"limitExceeded":{"description":"Quota Metrics that have exceeded quota limits.\nFor QuotaGroup-based quota, this is QuotaGroup.name\nFor QuotaLimit-based quota, this is QuotaLimit.name\nSee: google.api.Quota\nDeprecated: Use quota_metrics to get per quota group limit exceeded status.","items":{"type":"string"},"type":"array"},"quotaConsumed":{"additionalProperties":{"format":"int32","type":"integer"},"description":"Map of quota group name to the actual number of tokens consumed. If the\nquota check was not successful, then this will not be populated due to no\nquota consumption.\n\nWe are not merging this field with 'quota_metrics' field because of the\ncomplexity of scaling in Chemist client code base. For simplicity, we will\nkeep this field for Castor (that scales quota usage) and 'quota_metrics'\nfor SuperQuota (that doesn't scale quota usage).\n","type":"object"},"quotaMetrics":{"description":"Quota metrics to indicate the usage. Depending on the check request, one or\nmore of the following metrics will be included:\n\n1. For rate quota, per quota group or per quota metric incremental usage\nwill be specified using the following delta metric:\n \"serviceruntime.googleapis.com/api/consumer/quota_used_count\"\n\n2. For allocation quota, per quota metric total usage will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n3. For both rate quota and allocation quota, the quota limit reached\ncondition will be specified using the following boolean metric:\n \"serviceruntime.googleapis.com/quota/exceeded\"","items":{"$ref":"#/components/schemas/MetricValueSet"},"type":"array"}},"type":"object"},"QuotaOperation":{"description":"Represents information regarding a quota operation.","properties":{"consumerId":{"description":"Identity of the consumer for whom this quota operation is being performed.\n\nThis can be in one of the following formats:\n project:<project_id>,\n project_number:<project_number>,\n api_key:<api_key>.","type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"Labels describing the operation.","type":"object"},"methodName":{"description":"Fully qualified name of the API method for which this quota operation is\nrequested. This name is used for matching quota rules or metric rules and\nbilling status rules defined in service configuration.\n\nThis field should not be set if any of the following is true:\n(1) the quota operation is performed on non-API resources.\n(2) quota_metrics is set because the caller is doing quota override.\n\nExample of an RPC method name:\n google.example.library.v1.LibraryService.CreateShelf","type":"string"},"operationId":{"description":"Identity of the operation. This is expected to be unique within the scope\nof the service that generated the operation, and guarantees idempotency in\ncase of retries.\n\nUUID version 4 is recommended, though not required. In scenarios where an\noperation is computed from existing information and an idempotent id is\ndesirable for deduplication purpose, UUID version 5 is recommended. See\nRFC 4122 for details.","type":"string"},"quotaMetrics":{"description":"Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.\n\nThis field is mutually exclusive with method_name.","items":{"$ref":"#/components/schemas/MetricValueSet"},"type":"array"},"quotaMode":{"description":"Quota mode for this operation.","enum":["UNSPECIFIED","NORMAL","BEST_EFFORT","CHECK_ONLY"],"type":"string"}},"type":"object"},"QuotaProperties":{"description":"Represents the properties needed for quota operations.","properties":{"quotaMode":{"description":"Quota mode for this operation.","enum":["ACQUIRE","ACQUIRE_BEST_EFFORT","CHECK","RELEASE"],"type":"string"}},"type":"object"},"ReportError":{"description":"Represents the processing error of one Operation in the request.","properties":{"operationId":{"description":"The Operation.operation_id value from the request.","type":"string"},"status":{"$ref":"#/components/schemas/Status"}},"type":"object"},"ReportInfo":{"description":"Contains additional info about the report operation.","properties":{"operationId":{"description":"The Operation.operation_id value from the request.","type":"string"},"quotaInfo":{"$ref":"#/components/schemas/QuotaInfo"}},"type":"object"},"ReportRequest":{"description":"Request message for the Report method.","properties":{"operations":{"description":"Operations to be reported.\n\nTypically the service should report one operation per request.\nPutting multiple operations into a single request is allowed, but should\nbe used only when multiple operations are natually available at the time\nof the report.\n\nIf multiple operations are in a single request, the total request size\nshould be no larger than 1MB. See ReportResponse.report_errors for\npartial failure behavior.","items":{"$ref":"#/components/schemas/Operation"},"type":"array"},"serviceConfigId":{"description":"Specifies which version of service config should be used to process the\nrequest.\n\nIf unspecified or no matching version can be found, the\nlatest one will be used.","type":"string"}},"type":"object"},"ReportResponse":{"description":"Response message for the Report method.","properties":{"reportErrors":{"description":"Partial failures, one for each `Operation` in the request that failed\nprocessing. There are three possible combinations of the RPC status:\n\n1. The combination of a successful RPC status and an empty `report_errors`\n list indicates a complete success where all `Operations` in the\n request are processed successfully.\n2. The combination of a successful RPC status and a non-empty\n `report_errors` list indicates a partial success where some\n `Operations` in the request succeeded. Each\n `Operation` that failed processing has a corresponding item\n in this list.\n3. A failed RPC status indicates a general non-deterministic failure.\n When this happens, it's impossible to know which of the\n 'Operations' in the request succeeded or failed.","items":{"$ref":"#/components/schemas/ReportError"},"type":"array"},"reportInfos":{"description":"Quota usage for each quota release `Operation` request.\n\nFully or partially failed quota release request may or may not be present\nin `report_quota_info`. For example, a failed quota release request will\nhave the current quota usage info when precise quota library returns the\ninfo. A deadline exceeded quota request will not have quota usage info.\n\nIf there is no quota release request, report_quota_info will be empty.\n","items":{"$ref":"#/components/schemas/ReportInfo"},"type":"array"},"serviceConfigId":{"description":"The actual config id used to process the request.","type":"string"}},"type":"object"},"Request":{"description":"This message defines attributes for an HTTP request. If the actual\nrequest is not an HTTP request, the runtime system should try to map\nthe actual request to an equivalent HTTP request.","properties":{"auth":{"$ref":"#/components/schemas