| Index: discovery/googleapis/servicecontrol__v1.json
|
| diff --git a/discovery/googleapis/servicecontrol__v1.json b/discovery/googleapis/servicecontrol__v1.json
|
| index d64a7ca645cfe8dccf65edc6f7ea06b3e2bbe4d4..f08c305c59cfb6e83855cf0a86cdbe19a19a45ca 100644
|
| --- a/discovery/googleapis/servicecontrol__v1.json
|
| +++ b/discovery/googleapis/servicecontrol__v1.json
|
| @@ -2,11 +2,11 @@
|
| "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/servicecontrol": {
|
| "description": "Manage your Google Service Control data"
|
| + },
|
| + "https://www.googleapis.com/auth/cloud-platform": {
|
| + "description": "View and manage your data across Google Cloud Platform services"
|
| }
|
| }
|
| }
|
| @@ -28,6 +28,16 @@
|
| "ownerDomain": "google.com",
|
| "ownerName": "Google",
|
| "parameters": {
|
| + "uploadType": {
|
| + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "fields": {
|
| + "description": "Selector specifying which fields to include in a partial response.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "$.xgafv": {
|
| "description": "V1 error format.",
|
| "enum": [
|
| @@ -62,13 +72,13 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "key": {
|
| - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| + "access_token": {
|
| + "description": "OAuth access token.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "access_token": {
|
| - "description": "OAuth access token.",
|
| + "key": {
|
| + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -103,80 +113,70 @@
|
| "description": "Returns response with indentations and line breaks.",
|
| "location": "query",
|
| "type": "boolean"
|
| - },
|
| - "uploadType": {
|
| - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "fields": {
|
| - "description": "Selector specifying which fields to include in a partial response.",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| "protocol": "rest",
|
| "resources": {
|
| "services": {
|
| "methods": {
|
| - "endReconciliation": {
|
| - "description": "Signals the quota controller that service ends the ongoing usage\nreconciliation.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
|
| + "check": {
|
| + "description": "Checks an operation with Google Service Control to decide whether\nthe given operation should proceed. It should be called before the\noperation is executed.\n\nIf feasible, the client should cache the check results and reuse them for\n60 seconds. In case of server errors, the client can rely on the cached\nresults for longer time.\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[Google Cloud IAM](https://cloud.google.com/iam).",
|
| "httpMethod": "POST",
|
| - "id": "servicecontrol.services.endReconciliation",
|
| + "id": "servicecontrol.services.check",
|
| "parameterOrder": [
|
| "serviceName"
|
| ],
|
| "parameters": {
|
| "serviceName": {
|
| - "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.",
|
| + "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/services/{serviceName}:endReconciliation",
|
| + "path": "v1/services/{serviceName}:check",
|
| "request": {
|
| - "$ref": "EndReconciliationRequest"
|
| + "$ref": "CheckRequest"
|
| },
|
| "response": {
|
| - "$ref": "EndReconciliationResponse"
|
| + "$ref": "CheckResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| "https://www.googleapis.com/auth/servicecontrol"
|
| ]
|
| },
|
| - "report": {
|
| - "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).",
|
| + "releaseQuota": {
|
| + "description": "Releases previously allocated quota done through AllocateQuota method.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** the client code **must** fail-open if the server returns one\nof the following quota errors:\n- `PROJECT_STATUS_UNAVAILABLE`\n- `SERVICE_STATUS_UNAVAILABLE`\n- `BILLING_STATUS_UNAVAILABLE`\n- `QUOTA_SYSTEM_UNAVAILABLE`\n\nThe server may inject above errors to prohibit any hard dependency\non the quota system.",
|
| "httpMethod": "POST",
|
| - "id": "servicecontrol.services.report",
|
| + "id": "servicecontrol.services.releaseQuota",
|
| "parameterOrder": [
|
| "serviceName"
|
| ],
|
| "parameters": {
|
| "serviceName": {
|
| - "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
|
| + "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.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/services/{serviceName}:report",
|
| + "path": "v1/services/{serviceName}:releaseQuota",
|
| "request": {
|
| - "$ref": "ReportRequest"
|
| + "$ref": "ReleaseQuotaRequest"
|
| },
|
| "response": {
|
| - "$ref": "ReportResponse"
|
| + "$ref": "ReleaseQuotaResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| "https://www.googleapis.com/auth/servicecontrol"
|
| ]
|
| },
|
| - "allocateQuota": {
|
| - "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[Google Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** the client code **must** fail-open if the server returns one\nof the following quota errors:\n- `PROJECT_STATUS_UNAVAILABLE`\n- `SERVICE_STATUS_UNAVAILABLE`\n- `BILLING_STATUS_UNAVAILABLE`\n- `QUOTA_SYSTEM_UNAVAILABLE`\n\nThe server may inject above errors to prohibit any hard dependency\non the quota system.",
|
| + "endReconciliation": {
|
| + "description": "Signals the quota controller that service ends the ongoing usage\nreconciliation.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
|
| "httpMethod": "POST",
|
| - "id": "servicecontrol.services.allocateQuota",
|
| + "id": "servicecontrol.services.endReconciliation",
|
| "parameterOrder": [
|
| "serviceName"
|
| ],
|
| @@ -188,76 +188,76 @@
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/services/{serviceName}:allocateQuota",
|
| + "path": "v1/services/{serviceName}:endReconciliation",
|
| "request": {
|
| - "$ref": "AllocateQuotaRequest"
|
| + "$ref": "EndReconciliationRequest"
|
| },
|
| "response": {
|
| - "$ref": "AllocateQuotaResponse"
|
| + "$ref": "EndReconciliationResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| "https://www.googleapis.com/auth/servicecontrol"
|
| ]
|
| },
|
| - "startReconciliation": {
|
| - "description": "Unlike rate quota, allocation quota does not get refilled periodically.\nSo, it is possible that the quota usage as seen by the service differs from\nwhat the One Platform considers the usage is. This is expected to happen\nonly rarely, but over time this can accumulate. Services can invoke\nStartReconciliation and EndReconciliation to correct this usage drift, as\ndescribed below:\n1. Service sends StartReconciliation with a timestamp in future for each\n metric that needs to be reconciled. The timestamp being in future allows\n to account for in-flight AllocateQuota and ReleaseQuota requests for the\n same metric.\n2. One Platform records this timestamp and starts tracking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconciliation is\n called.\n3. At or after the time specified in the StartReconciliation, service\n sends EndReconciliation with the usage that needs to be reconciled to.\n4. One Platform adjusts its own record of usage for that metric to the\n value specified in EndReconciliation by taking in to account any\n allocation or release between StartReconciliation and EndReconciliation.\n\nSignals the quota controller that the service wants to perform a usage\nreconciliation as specified in the request.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
|
| + "report": {
|
| + "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).",
|
| "httpMethod": "POST",
|
| - "id": "servicecontrol.services.startReconciliation",
|
| + "id": "servicecontrol.services.report",
|
| "parameterOrder": [
|
| "serviceName"
|
| ],
|
| "parameters": {
|
| "serviceName": {
|
| - "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.",
|
| + "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/services/{serviceName}:startReconciliation",
|
| + "path": "v1/services/{serviceName}:report",
|
| "request": {
|
| - "$ref": "StartReconciliationRequest"
|
| + "$ref": "ReportRequest"
|
| },
|
| "response": {
|
| - "$ref": "StartReconciliationResponse"
|
| + "$ref": "ReportResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| "https://www.googleapis.com/auth/servicecontrol"
|
| ]
|
| },
|
| - "check": {
|
| - "description": "Checks an operation with Google Service Control to decide whether\nthe given operation should proceed. It should be called before the\noperation is executed.\n\nIf feasible, the client should cache the check results and reuse them for\n60 seconds. In case of server errors, the client can rely on the cached\nresults for longer time.\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[Google Cloud IAM](https://cloud.google.com/iam).",
|
| + "allocateQuota": {
|
| + "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[Google Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** the client code **must** fail-open if the server returns one\nof the following quota errors:\n- `PROJECT_STATUS_UNAVAILABLE`\n- `SERVICE_STATUS_UNAVAILABLE`\n- `BILLING_STATUS_UNAVAILABLE`\n- `QUOTA_SYSTEM_UNAVAILABLE`\n\nThe server may inject above errors to prohibit any hard dependency\non the quota system.",
|
| "httpMethod": "POST",
|
| - "id": "servicecontrol.services.check",
|
| + "id": "servicecontrol.services.allocateQuota",
|
| "parameterOrder": [
|
| "serviceName"
|
| ],
|
| "parameters": {
|
| "serviceName": {
|
| - "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
|
| + "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.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/services/{serviceName}:check",
|
| + "path": "v1/services/{serviceName}:allocateQuota",
|
| "request": {
|
| - "$ref": "CheckRequest"
|
| + "$ref": "AllocateQuotaRequest"
|
| },
|
| "response": {
|
| - "$ref": "CheckResponse"
|
| + "$ref": "AllocateQuotaResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| "https://www.googleapis.com/auth/servicecontrol"
|
| ]
|
| },
|
| - "releaseQuota": {
|
| - "description": "Releases previously allocated quota done through AllocateQuota method.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** the client code **must** fail-open if the server returns one\nof the following quota errors:\n- `PROJECT_STATUS_UNAVAILABLE`\n- `SERVICE_STATUS_UNAVAILABLE`\n- `BILLING_STATUS_UNAVAILABLE`\n- `QUOTA_SYSTEM_UNAVAILABLE`\n\nThe server may inject above errors to prohibit any hard dependency\non the quota system.",
|
| + "startReconciliation": {
|
| + "description": "Unlike rate quota, allocation quota does not get refilled periodically.\nSo, it is possible that the quota usage as seen by the service differs from\nwhat the One Platform considers the usage is. This is expected to happen\nonly rarely, but over time this can accumulate. Services can invoke\nStartReconciliation and EndReconciliation to correct this usage drift, as\ndescribed below:\n1. Service sends StartReconciliation with a timestamp in future for each\n metric that needs to be reconciled. The timestamp being in future allows\n to account for in-flight AllocateQuota and ReleaseQuota requests for the\n same metric.\n2. One Platform records this timestamp and starts tracking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconciliation is\n called.\n3. At or after the time specified in the StartReconciliation, service\n sends EndReconciliation with the usage that needs to be reconciled to.\n4. One Platform adjusts its own record of usage for that metric to the\n value specified in EndReconciliation by taking in to account any\n allocation or release between StartReconciliation and EndReconciliation.\n\nSignals the quota controller that the service wants to perform a usage\nreconciliation as specified in the request.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
|
| "httpMethod": "POST",
|
| - "id": "servicecontrol.services.releaseQuota",
|
| + "id": "servicecontrol.services.startReconciliation",
|
| "parameterOrder": [
|
| "serviceName"
|
| ],
|
| @@ -269,12 +269,12 @@
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/services/{serviceName}:releaseQuota",
|
| + "path": "v1/services/{serviceName}:startReconciliation",
|
| "request": {
|
| - "$ref": "ReleaseQuotaRequest"
|
| + "$ref": "StartReconciliationRequest"
|
| },
|
| "response": {
|
| - "$ref": "ReleaseQuotaResponse"
|
| + "$ref": "StartReconciliationResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -284,294 +284,282 @@
|
| }
|
| }
|
| },
|
| - "revision": "20170626",
|
| + "revision": "20170724",
|
| "rootUrl": "https://servicecontrol.googleapis.com/",
|
| "schemas": {
|
| - "CheckResponse": {
|
| - "description": "Response message for the Check method.",
|
| - "id": "CheckResponse",
|
| + "Money": {
|
| + "description": "Represents an amount of money with its currency type.",
|
| + "id": "Money",
|
| "properties": {
|
| - "checkInfo": {
|
| - "$ref": "CheckInfo",
|
| - "description": "Feedback data returned from the server during processing a Check request."
|
| + "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"
|
| },
|
| - "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.",
|
| + "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"
|
| + },
|
| + "currencyCode": {
|
| + "description": "The 3-letter currency code defined in ISO 4217.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "EndReconciliationResponse": {
|
| + "id": "EndReconciliationResponse",
|
| + "properties": {
|
| + "quotaMetrics": {
|
| + "description": "Metric values as tracked by One Platform before the adjustment was made.\nThe following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"\n\n3. Delta value of the usage after the reconciliation for limits associated\nwith the metrics will be specified using the following metric:\n \"serviceruntime.googleapis.com/allocation/reconciliation_delta\"\nThe delta value is defined as:\n new_usage_from_client - existing_value_in_spanner.\nThis metric is not defined in serviceruntime.yaml or in Cloud Monarch.\nThis metric is meant for callers' use only. Since this metric is not\ndefined in the monitoring backend, reporting on this metric will result in\nan error.",
|
| "items": {
|
| - "$ref": "CheckError"
|
| + "$ref": "MetricValueSet"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "reconciliationErrors": {
|
| + "description": "Indicates the decision of the reconciliation end.",
|
| + "items": {
|
| + "$ref": "QuotaError"
|
| },
|
| "type": "array"
|
| },
|
| "operationId": {
|
| - "description": "The same operation_id value used in the CheckRequest.\nUsed for logging and diagnostics purposes.",
|
| + "description": "The same operation_id value used in the EndReconciliationRequest. Used for\nlogging and diagnostics purposes.",
|
| "type": "string"
|
| },
|
| "serviceConfigId": {
|
| - "description": "The actual config id used to process the request.",
|
| + "description": "ID of the actual config used to process the request.",
|
| "type": "string"
|
| - },
|
| - "quotaInfo": {
|
| - "$ref": "QuotaInfo",
|
| - "description": "Quota information for the check request associated with this response.\n"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ReportRequest": {
|
| - "description": "Request message for the Report method.",
|
| - "id": "ReportRequest",
|
| + "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",
|
| + "id": "Distribution",
|
| "properties": {
|
| - "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.",
|
| + "minimum": {
|
| + "description": "The minimum of the population of values. Ignored if `count` is zero.",
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "linearBuckets": {
|
| + "$ref": "LinearBuckets",
|
| + "description": "Buckets with constant width."
|
| + },
|
| + "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"
|
| + },
|
| + "count": {
|
| + "description": "The total number of samples in the distribution. Must be >= 0.",
|
| + "format": "int64",
|
| "type": "string"
|
| },
|
| - "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.",
|
| + "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": {
|
| - "$ref": "Operation"
|
| + "format": "int64",
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| + },
|
| + "explicitBuckets": {
|
| + "$ref": "ExplicitBuckets",
|
| + "description": "Buckets with arbitrary user-provided width."
|
| + },
|
| + "maximum": {
|
| + "description": "The maximum 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"
|
| + },
|
| + "exponentialBuckets": {
|
| + "$ref": "ExponentialBuckets",
|
| + "description": "Buckets with exponentially growing width."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Status": {
|
| - "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that 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.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
|
| - "id": "Status",
|
| + "ExplicitBuckets": {
|
| + "description": "Describing buckets with arbitrary user-provided width.",
|
| + "id": "ExplicitBuckets",
|
| "properties": {
|
| - "details": {
|
| - "description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
|
| + "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": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| - },
|
| - "type": "object"
|
| + "format": "double",
|
| + "type": "number"
|
| },
|
| "type": "array"
|
| - },
|
| - "code": {
|
| - "description": "The status code, which should be an enum value of google.rpc.Code.",
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ExponentialBuckets": {
|
| + "description": "Describing buckets with exponentially growing width.",
|
| + "id": "ExponentialBuckets",
|
| + "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"
|
| },
|
| - "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"
|
| + "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"
|
| + },
|
| + "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"
|
| },
|
| - "LogEntry": {
|
| - "description": "An individual log entry.",
|
| - "id": "LogEntry",
|
| + "AuthorizationInfo": {
|
| + "description": "Authorization information for the operation.",
|
| + "id": "AuthorizationInfo",
|
| "properties": {
|
| - "labels": {
|
| - "additionalProperties": {
|
| - "type": "string"
|
| - },
|
| - "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.",
|
| - "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"
|
| - ],
|
| - "enumDescriptions": [
|
| - "(0) The log entry has no assigned severity level.",
|
| - "(100) Debug or trace information.",
|
| - "(200) Routine information, such as ongoing status or performance.",
|
| - "(300) Normal but significant events, such as start up, shut down, or\na configuration change.",
|
| - "(400) Warning events might cause problems.",
|
| - "(500) Error events are likely to cause problems.",
|
| - "(600) Critical events cause more severe problems or outages.",
|
| - "(700) A person must take an action immediately.",
|
| - "(800) One or more systems are unusable."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "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"
|
| - },
|
| - "name": {
|
| - "description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`,\n`\"book_log\"`.",
|
| - "type": "string"
|
| - },
|
| - "structPayload": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object.",
|
| - "type": "any"
|
| - },
|
| - "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).",
|
| + "resource": {
|
| + "description": "The resource being accessed, as a REST-style string. For example:\n\n bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID",
|
| "type": "string"
|
| },
|
| - "protoPayload": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| - },
|
| - "description": "The log entry payload, represented as a protocol buffer that is\nexpressed as a JSON object. You can only pass `protoPayload`\nvalues that belong to a set of approved types.",
|
| - "type": "object"
|
| + "granted": {
|
| + "description": "Whether or not authorization for `resource` and `permission`\nwas granted.",
|
| + "type": "boolean"
|
| },
|
| - "timestamp": {
|
| - "description": "The time the event described by the log entry occurred. If\nomitted, defaults to operation start time.",
|
| - "format": "google-datetime",
|
| + "permission": {
|
| + "description": "The required IAM permission.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "AuditLog": {
|
| - "description": "Common audit log format for Google Cloud Platform API operations.\n\n",
|
| - "id": "AuditLog",
|
| + "StartReconciliationResponse": {
|
| + "id": "StartReconciliationResponse",
|
| "properties": {
|
| - "request": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object.",
|
| - "type": "any"
|
| + "quotaMetrics": {
|
| + "description": "Metric values as tracked by One Platform before the start of\nreconciliation. The following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"",
|
| + "items": {
|
| + "$ref": "MetricValueSet"
|
| },
|
| - "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": "RequestMetadata",
|
| - "description": "Metadata about the operation."
|
| + "type": "array"
|
| },
|
| - "serviceData": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| + "reconciliationErrors": {
|
| + "description": "Indicates the decision of the reconciliation start.",
|
| + "items": {
|
| + "$ref": "QuotaError"
|
| },
|
| - "description": "Other service-specific data about the request, response, and other\nactivities.",
|
| - "type": "object"
|
| + "type": "array"
|
| },
|
| - "numResponseItems": {
|
| - "description": "The number of items returned from a List or Query API method,\nif applicable.",
|
| - "format": "int64",
|
| + "operationId": {
|
| + "description": "The same operation_id value used in the StartReconciliationRequest. Used\nfor logging and diagnostics purposes.",
|
| "type": "string"
|
| },
|
| - "status": {
|
| - "$ref": "Status",
|
| - "description": "The status of the overall operation."
|
| - },
|
| - "authenticationInfo": {
|
| - "$ref": "AuthenticationInfo",
|
| - "description": "Authentication information."
|
| - },
|
| - "serviceName": {
|
| - "description": "The name of the API service performing the operation. For example,\n`\"datastore.googleapis.com\"`.",
|
| + "serviceConfigId": {
|
| + "description": "ID of the actual config used to process the request.",
|
| "type": "string"
|
| - },
|
| - "response": {
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "QuotaProperties": {
|
| + "description": "Represents the properties needed for quota operations.",
|
| + "id": "QuotaProperties",
|
| + "properties": {
|
| + "limitByIds": {
|
| "additionalProperties": {
|
| - "description": "Properties of the object.",
|
| - "type": "any"
|
| + "type": "string"
|
| },
|
| - "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.",
|
| + "description": "LimitType IDs that should be used for checking quota. Key in this map\nshould be a valid LimitType string, and the value is the ID to be used. For\nexample, an entry <USER, 123> will cause all user quota limits to use 123\nas the user ID. See google/api/quota.proto for the definition of LimitType.\nCLIENT_PROJECT: Not supported.\nUSER: Value of this entry will be used for enforcing user-level quota\n limits. If none specified, caller IP passed in the\n servicecontrol.googleapis.com/caller_ip label will be used instead.\n If the server cannot resolve a value for this LimitType, an error\n will be thrown. No validation will be performed on this ID.\nDeprecated: use servicecontrol.googleapis.com/user label to send user ID.",
|
| "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"
|
| - },
|
| - "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\"",
|
| + "quotaMode": {
|
| + "description": "Quota mode for this operation.",
|
| + "enum": [
|
| + "ACQUIRE",
|
| + "ACQUIRE_BEST_EFFORT",
|
| + "CHECK",
|
| + "RELEASE"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Decreases available quota by the cost specified for the operation.\nIf cost is higher than available quota, operation fails and returns\nerror.",
|
| + "Decreases available quota by the cost specified for the operation.\nIf cost is higher than available quota, operation does not fail and\navailable quota goes down to zero but it returns error.",
|
| + "Does not change any available quota. Only checks if there is enough\nquota.\nNo lock is placed on the checked tokens neither.",
|
| + "Increases available quota by the operation cost specified for the\noperation."
|
| + ],
|
| "type": "string"
|
| - },
|
| - "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": "AuthorizationInfo"
|
| - },
|
| - "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "MetricValue": {
|
| - "description": "Represents a single metric value.",
|
| - "id": "MetricValue",
|
| + "LinearBuckets": {
|
| + "description": "Describing buckets with constant width.",
|
| + "id": "LinearBuckets",
|
| "properties": {
|
| - "stringValue": {
|
| - "description": "A text string value.",
|
| - "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"
|
| + "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"
|
| },
|
| - "doubleValue": {
|
| - "description": "A double precision floating point value.",
|
| + "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"
|
| },
|
| - "int64Value": {
|
| - "description": "A signed 64-bit integer value.",
|
| - "format": "int64",
|
| - "type": "string"
|
| - },
|
| - "distributionValue": {
|
| - "$ref": "Distribution",
|
| - "description": "A distribution value."
|
| - },
|
| - "boolValue": {
|
| - "description": "A boolean value.",
|
| - "type": "boolean"
|
| - },
|
| - "endTime": {
|
| - "description": "The end of the time period over which this metric value's measurement\napplies.",
|
| - "format": "google-datetime",
|
| + "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"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "AuthenticationInfo": {
|
| + "description": "Authentication information for the operation.",
|
| + "id": "AuthenticationInfo",
|
| + "properties": {
|
| + "principalEmail": {
|
| + "description": "The email address of the authenticated user making the request.",
|
| "type": "string"
|
| },
|
| - "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",
|
| + "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"
|
| - },
|
| - "moneyValue": {
|
| - "$ref": "Money",
|
| - "description": "A money value."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "EndReconciliationResponse": {
|
| - "id": "EndReconciliationResponse",
|
| + "AllocateQuotaResponse": {
|
| + "description": "Response message for the AllocateQuota method.",
|
| + "id": "AllocateQuotaResponse",
|
| "properties": {
|
| - "reconciliationErrors": {
|
| - "description": "Indicates the decision of the reconciliation end.",
|
| - "items": {
|
| - "$ref": "QuotaError"
|
| - },
|
| - "type": "array"
|
| - },
|
| "operationId": {
|
| - "description": "The same operation_id value used in the EndReconciliationRequest. Used for\nlogging and diagnostics purposes.",
|
| + "description": "The same operation_id value used in the AllocateQuotaRequest. Used for\nlogging and diagnostics purposes.",
|
| "type": "string"
|
| },
|
| "serviceConfigId": {
|
| "description": "ID of the actual config used to process the request.",
|
| "type": "string"
|
| },
|
| + "allocateErrors": {
|
| + "description": "Indicates the decision of the allocate.",
|
| + "items": {
|
| + "$ref": "QuotaError"
|
| + },
|
| + "type": "array"
|
| + },
|
| "quotaMetrics": {
|
| - "description": "Metric values as tracked by One Platform before the adjustment was made.\nThe following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"\n\n3. Delta value of the usage after the reconciliation for limits associated\nwith the metrics will be specified using the following metric:\n \"serviceruntime.googleapis.com/allocation/reconciliation_delta\"\nThe delta value is defined as:\n new_usage_from_client - existing_value_in_spanner.\nThis metric is not defined in serviceruntime.yaml or in Cloud Monarch.\nThis metric is meant for callers' use only. Since this metric is not\ndefined in the monitoring backend, reporting on this metric will result in\nan error.",
|
| + "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. 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\"\n\n4. For allocation quota, value for each quota limit associated with\nthe metrics will be specified using the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"",
|
| "items": {
|
| "$ref": "MetricValueSet"
|
| },
|
| @@ -580,439 +568,206 @@
|
| },
|
| "type": "object"
|
| },
|
| - "Money": {
|
| - "description": "Represents an amount of money with its currency type.",
|
| - "id": "Money",
|
| + "ReleaseQuotaRequest": {
|
| + "description": "Request message for the ReleaseQuota method.",
|
| + "id": "ReleaseQuotaRequest",
|
| "properties": {
|
| - "currencyCode": {
|
| - "description": "The 3-letter currency code defined in ISO 4217.",
|
| + "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"
|
| },
|
| - "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"
|
| + "releaseOperation": {
|
| + "$ref": "QuotaOperation",
|
| + "description": "Operation that describes the quota release."
|
| }
|
| },
|
| "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",
|
| - "id": "Distribution",
|
| + "QuotaError": {
|
| + "id": "QuotaError",
|
| "properties": {
|
| - "explicitBuckets": {
|
| - "$ref": "ExplicitBuckets",
|
| - "description": "Buckets with arbitrary user-provided width."
|
| - },
|
| - "maximum": {
|
| - "description": "The maximum 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"
|
| - },
|
| - "exponentialBuckets": {
|
| - "$ref": "ExponentialBuckets",
|
| - "description": "Buckets with exponentially growing width."
|
| - },
|
| - "minimum": {
|
| - "description": "The minimum of the population of values. Ignored if `count` is zero.",
|
| - "format": "double",
|
| - "type": "number"
|
| - },
|
| - "linearBuckets": {
|
| - "$ref": "LinearBuckets",
|
| - "description": "Buckets with constant width."
|
| - },
|
| - "count": {
|
| - "description": "The total number of samples in the distribution. Must be >= 0.",
|
| - "format": "int64",
|
| + "description": {
|
| + "description": "Free-form text that provides details on the cause of the error.",
|
| "type": "string"
|
| },
|
| - "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"
|
| + "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"
|
| },
|
| - "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"
|
| + "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"
|
| + ],
|
| + "enumDescriptions": [
|
| + "This is never used.",
|
| + "Quota allocation failed.\nSame as google.rpc.Code.RESOURCE_EXHAUSTED.",
|
| + "Quota release failed. This error is ONLY returned on a NORMAL release.\nMore formally: if a user requests a release of 10 tokens, but only\n5 tokens were previously allocated, in a BEST_EFFORT release, this will\nbe considered a success, 5 tokens will be released, and the result will\nbe \"Ok\". If this is done in NORMAL mode, no tokens will be released,\nand an OUT_OF_RANGE error will be returned.\nSame as google.rpc.Code.OUT_OF_RANGE.",
|
| + "Consumer cannot access the service because the service requires active\nbilling.",
|
| + "Consumer's project has been marked as deleted (soft deletion).",
|
| + "Specified API key is invalid.",
|
| + "Specified API Key has expired.",
|
| + "Consumer's spatula header is invalid.",
|
| + "The consumer's LOAS role is invalid.",
|
| + "The consumer's LOAS role has no associated project.",
|
| + "The backend server for looking up project id/number is unavailable.",
|
| + "The backend server for checking service status is unavailable.",
|
| + "The backend server for checking billing status is unavailable.",
|
| + "The backend server for checking quota limits is unavailable."
|
| + ],
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ExplicitBuckets": {
|
| - "description": "Describing buckets with arbitrary user-provided width.",
|
| - "id": "ExplicitBuckets",
|
| + "RequestMetadata": {
|
| + "description": "Metadata about the request.",
|
| + "id": "RequestMetadata",
|
| "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"
|
| + "callerIp": {
|
| + "description": "The IP address of the caller.\nFor caller from internet, this will be public IPv4 or IPv6 address.\nFor caller from GCE VM with external IP address, this will be the VM's\nexternal IP address. For caller from GCE VM without external IP address, if\nthe VM is in the same GCP organization (or project) as the accessed\nresource, `caller_ip` will be the GCE VM's internal IPv4 address, otherwise\nit will be redacted to \"gce-internal-ip\".\nSee https://cloud.google.com/compute/docs/vpc/ for more information.",
|
| + "type": "string"
|
| + },
|
| + "callerSuppliedUserAgent": {
|
| + "description": "The user agent of the caller.\nThis information is not authenticated and should be treated accordingly.\nFor example:\n\n+ `google-api-python-client/1.4.0`:\n The request was made by the Google API client for Python.\n+ `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`:\n The request was made by the Google Cloud SDK CLI (gcloud).\n+ `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`:\n The request was made from the `my-project` App Engine app.\nNOLINT",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ExponentialBuckets": {
|
| - "description": "Describing buckets with exponentially growing width.",
|
| - "id": "ExponentialBuckets",
|
| + "CheckInfo": {
|
| + "id": "CheckInfo",
|
| "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"
|
| - },
|
| - "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"
|
| + "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"
|
| },
|
| - "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"
|
| + "consumerInfo": {
|
| + "$ref": "ConsumerInfo",
|
| + "description": "Consumer info of this check."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "AuthorizationInfo": {
|
| - "description": "Authorization information for the operation.",
|
| - "id": "AuthorizationInfo",
|
| + "ReleaseQuotaResponse": {
|
| + "description": "Response message for the ReleaseQuota method.",
|
| + "id": "ReleaseQuotaResponse",
|
| "properties": {
|
| - "resource": {
|
| - "description": "The resource being accessed, as a REST-style string. For example:\n\n bigquery.googlapis.com/projects/PROJECTID/datasets/DATASETID",
|
| + "operationId": {
|
| + "description": "The same operation_id value used in the ReleaseQuotaRequest. Used for\nlogging and diagnostics purposes.",
|
| "type": "string"
|
| },
|
| - "granted": {
|
| - "description": "Whether or not authorization for `resource` and `permission`\nwas granted.",
|
| - "type": "boolean"
|
| - },
|
| - "permission": {
|
| - "description": "The required IAM permission.",
|
| + "serviceConfigId": {
|
| + "description": "ID of the actual config used to process the request.",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "StartReconciliationResponse": {
|
| - "id": "StartReconciliationResponse",
|
| - "properties": {
|
| - "quotaMetrics": {
|
| - "description": "Metric values as tracked by One Platform before the start of\nreconciliation. The following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"",
|
| + },
|
| + "releaseErrors": {
|
| + "description": "Indicates the decision of the release.",
|
| "items": {
|
| - "$ref": "MetricValueSet"
|
| + "$ref": "QuotaError"
|
| },
|
| "type": "array"
|
| },
|
| - "reconciliationErrors": {
|
| - "description": "Indicates the decision of the reconciliation start.",
|
| + "quotaMetrics": {
|
| + "description": "Quota metrics to indicate the result of release. Depending on the\nrequest, one or more of the following metrics will be included:\n\n1. For rate quota, per quota group or per quota metric released amount\nwill be specified using the following delta metric:\n \"serviceruntime.googleapis.com/api/consumer/quota_refund_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 allocation quota, value for each quota limit associated with\nthe metrics will be specified using the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"",
|
| "items": {
|
| - "$ref": "QuotaError"
|
| + "$ref": "MetricValueSet"
|
| },
|
| "type": "array"
|
| - },
|
| - "operationId": {
|
| - "description": "The same operation_id value used in the StartReconciliationRequest. Used\nfor logging and diagnostics purposes.",
|
| - "type": "string"
|
| - },
|
| - "serviceConfigId": {
|
| - "description": "ID of the actual config used to process the request.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "QuotaProperties": {
|
| - "description": "Represents the properties needed for quota operations.",
|
| - "id": "QuotaProperties",
|
| + "AllocateQuotaRequest": {
|
| + "description": "Request message for the AllocateQuota method.",
|
| + "id": "AllocateQuotaRequest",
|
| "properties": {
|
| - "limitByIds": {
|
| - "additionalProperties": {
|
| - "type": "string"
|
| - },
|
| - "description": "LimitType IDs that should be used for checking quota. Key in this map\nshould be a valid LimitType string, and the value is the ID to be used. For\nexample, an entry <USER, 123> will cause all user quota limits to use 123\nas the user ID. See google/api/quota.proto for the definition of LimitType.\nCLIENT_PROJECT: Not supported.\nUSER: Value of this entry will be used for enforcing user-level quota\n limits. If none specified, caller IP passed in the\n servicecontrol.googleapis.com/caller_ip label will be used instead.\n If the server cannot resolve a value for this LimitType, an error\n will be thrown. No validation will be performed on this ID.\nDeprecated: use servicecontrol.googleapis.com/user label to send user ID.",
|
| - "type": "object"
|
| - },
|
| - "quotaMode": {
|
| - "description": "Quota mode for this operation.",
|
| + "allocationMode": {
|
| + "description": "Allocation mode for this operation.\nDeprecated: use QuotaMode inside the QuotaOperation.",
|
| "enum": [
|
| - "ACQUIRE",
|
| - "ACQUIRE_BEST_EFFORT",
|
| - "CHECK",
|
| - "RELEASE"
|
| + "UNSPECIFIED",
|
| + "NORMAL",
|
| + "BEST_EFFORT",
|
| + "CHECK_ONLY"
|
| ],
|
| "enumDescriptions": [
|
| - "Decreases available quota by the cost specified for the operation.\nIf cost is higher than available quota, operation fails and returns\nerror.",
|
| - "Decreases available quota by the cost specified for the operation.\nIf cost is higher than available quota, operation does not fail and\navailable quota goes down to zero but it returns error.",
|
| - "Does not change any available quota. Only checks if there is enough\nquota.\nNo lock is placed on the checked tokens neither.",
|
| - "Increases available quota by the operation cost specified for the\noperation."
|
| + "",
|
| + "Allocates quota for the amount specified in the service configuration or\nspecified using the quota_metrics. If the amount is higher than the\navailable quota, allocation error will be returned and no quota will be\nallocated.",
|
| + "Allocates quota for the amount specified in the service configuration or\nspecified using the quota_metrics. If the amount is higher than the\navailable quota, request does not fail but all available quota will be\nallocated.",
|
| + "Only checks if there is enough quota available and does not change the\navailable quota. No lock is placed on the available quota either."
|
| ],
|
| "type": "string"
|
| + },
|
| + "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"
|
| + },
|
| + "allocateOperation": {
|
| + "$ref": "QuotaOperation",
|
| + "description": "Operation that describes the quota allocation."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "LinearBuckets": {
|
| - "description": "Describing buckets with constant width.",
|
| - "id": "LinearBuckets",
|
| + "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.",
|
| + "id": "MetricValueSet",
|
| "properties": {
|
| - "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"
|
| - },
|
| - "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"
|
| + "metricName": {
|
| + "description": "The metric name defined in the service configuration.",
|
| + "type": "string"
|
| },
|
| - "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"
|
| + "metricValues": {
|
| + "description": "The values in this metric.",
|
| + "items": {
|
| + "$ref": "MetricValue"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "AuthenticationInfo": {
|
| - "description": "Authentication information for the operation.",
|
| - "id": "AuthenticationInfo",
|
| - "properties": {
|
| - "principalEmail": {
|
| - "description": "The email address of the authenticated user making the request.",
|
| - "type": "string"
|
| - },
|
| - "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"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "AllocateQuotaResponse": {
|
| - "description": "Response message for the AllocateQuota method.",
|
| - "id": "AllocateQuotaResponse",
|
| - "properties": {
|
| - "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. 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\"\n\n4. For allocation quota, value for each quota limit associated with\nthe metrics will be specified using the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"",
|
| - "items": {
|
| - "$ref": "MetricValueSet"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "operationId": {
|
| - "description": "The same operation_id value used in the AllocateQuotaRequest. Used for\nlogging and diagnostics purposes.",
|
| - "type": "string"
|
| - },
|
| - "serviceConfigId": {
|
| - "description": "ID of the actual config used to process the request.",
|
| - "type": "string"
|
| - },
|
| - "allocateErrors": {
|
| - "description": "Indicates the decision of the allocate.",
|
| - "items": {
|
| - "$ref": "QuotaError"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ReleaseQuotaRequest": {
|
| - "description": "Request message for the ReleaseQuota method.",
|
| - "id": "ReleaseQuotaRequest",
|
| - "properties": {
|
| - "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"
|
| - },
|
| - "releaseOperation": {
|
| - "$ref": "QuotaOperation",
|
| - "description": "Operation that describes the quota release."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "RequestMetadata": {
|
| - "description": "Metadata about the request.",
|
| - "id": "RequestMetadata",
|
| - "properties": {
|
| - "callerIp": {
|
| - "description": "The IP address of the caller.",
|
| - "type": "string"
|
| - },
|
| - "callerSuppliedUserAgent": {
|
| - "description": "The user agent of the caller.\nThis information is not authenticated and should be treated accordingly.\nFor example:\n\n+ `google-api-python-client/1.4.0`:\n The request was made by the Google API client for Python.\n+ `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`:\n The request was made by the Google Cloud SDK CLI (gcloud).\n+ `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`:\n The request was made from the `my-project` App Engine app.\n\nNOLINT",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "QuotaError": {
|
| - "id": "QuotaError",
|
| - "properties": {
|
| - "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"
|
| - },
|
| - "code": {
|
| - "description": "Error code.",
|
| - "enum": [
|
| - "UNSPECIFIED",
|
| - "RESOURCE_EXHAUSTED",
|
| - "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"
|
| - ],
|
| - "enumDescriptions": [
|
| - "This is never used.",
|
| - "Quota allocation failed.\nSame as google.rpc.Code.RESOURCE_EXHAUSTED.",
|
| - "Consumer cannot access the service because the service requires active\nbilling.",
|
| - "Consumer's project has been marked as deleted (soft deletion).",
|
| - "Specified API key is invalid.",
|
| - "Specified API Key has expired.",
|
| - "Consumer's spatula header is invalid.",
|
| - "The consumer's LOAS role is invalid.",
|
| - "The consumer's LOAS role has no associated project.",
|
| - "The backend server for looking up project id/number is unavailable.",
|
| - "The backend server for checking service status is unavailable.",
|
| - "The backend server for checking billing status is unavailable.",
|
| - "The backend server for checking quota limits is unavailable."
|
| - ],
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "CheckInfo": {
|
| - "id": "CheckInfo",
|
| - "properties": {
|
| - "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"
|
| - },
|
| - "ReleaseQuotaResponse": {
|
| - "description": "Response message for the ReleaseQuota method.",
|
| - "id": "ReleaseQuotaResponse",
|
| + "ReportError": {
|
| + "description": "Represents the processing error of one `Operation` in the request.",
|
| + "id": "ReportError",
|
| "properties": {
|
| "operationId": {
|
| - "description": "The same operation_id value used in the ReleaseQuotaRequest. Used for\nlogging and diagnostics purposes.",
|
| - "type": "string"
|
| - },
|
| - "serviceConfigId": {
|
| - "description": "ID of the actual config used to process the request.",
|
| + "description": "The Operation.operation_id value from the request.",
|
| "type": "string"
|
| },
|
| - "releaseErrors": {
|
| - "description": "Indicates the decision of the release.",
|
| - "items": {
|
| - "$ref": "QuotaError"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "quotaMetrics": {
|
| - "description": "Quota metrics to indicate the result of release. Depending on the\nrequest, one or more of the following metrics will be included:\n\n1. For rate quota, per quota group or per quota metric released amount\nwill be specified using the following delta metric:\n \"serviceruntime.googleapis.com/api/consumer/quota_refund_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 allocation quota, value for each quota limit associated with\nthe metrics will be specified using the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"",
|
| - "items": {
|
| - "$ref": "MetricValueSet"
|
| - },
|
| - "type": "array"
|
| + "status": {
|
| + "$ref": "Status",
|
| + "description": "Details of the error when processing the `Operation`."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "AllocateQuotaRequest": {
|
| - "description": "Request message for the AllocateQuota method.",
|
| - "id": "AllocateQuotaRequest",
|
| + "StartReconciliationRequest": {
|
| + "id": "StartReconciliationRequest",
|
| "properties": {
|
| "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"
|
| },
|
| - "allocateOperation": {
|
| + "reconciliationOperation": {
|
| "$ref": "QuotaOperation",
|
| - "description": "Operation that describes the quota allocation."
|
| - },
|
| - "allocationMode": {
|
| - "description": "Allocation mode for this operation.\nDeprecated: use QuotaMode inside the QuotaOperation.",
|
| - "enum": [
|
| - "UNSPECIFIED",
|
| - "NORMAL",
|
| - "BEST_EFFORT",
|
| - "CHECK_ONLY"
|
| - ],
|
| - "enumDescriptions": [
|
| - "",
|
| - "Allocates quota for the amount specified in the service configuration or\nspecified using the quota_metrics. If the amount is higher than the\navailable quota, allocation error will be returned and no quota will be\nallocated.",
|
| - "Allocates quota for the amount specified in the service configuration or\nspecified using the quota_metrics. If the amount is higher than the\navailable quota, request does not fail but all available quota will be\nallocated.",
|
| - "Only checks if there is enough quota available and does not change the\navailable quota. No lock is placed on the available quota either."
|
| - ],
|
| - "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.",
|
| - "id": "MetricValueSet",
|
| - "properties": {
|
| - "metricValues": {
|
| - "description": "The values in this metric.",
|
| - "items": {
|
| - "$ref": "MetricValue"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "metricName": {
|
| - "description": "The metric name defined in the service configuration.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ReportError": {
|
| - "description": "Represents the processing error of one `Operation` in the request.",
|
| - "id": "ReportError",
|
| - "properties": {
|
| - "status": {
|
| - "$ref": "Status",
|
| - "description": "Details of the error when processing the `Operation`."
|
| - },
|
| - "operationId": {
|
| - "description": "The Operation.operation_id value from the request.",
|
| - "type": "string"
|
| + "description": "Operation that describes the quota reconciliation."
|
| }
|
| },
|
| "type": "object"
|
| @@ -1021,10 +776,6 @@
|
| "description": "Defines the errors to be returned in\ngoogle.api.servicecontrol.v1.CheckResponse.check_errors.",
|
| "id": "CheckError",
|
| "properties": {
|
| - "detail": {
|
| - "description": "Free-form text providing details on the error cause of the error.",
|
| - "type": "string"
|
| - },
|
| "code": {
|
| "description": "The error code.",
|
| "enum": [
|
| @@ -1096,20 +847,10 @@
|
| "Backend server for evaluating security policy is unavailable."
|
| ],
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "StartReconciliationRequest": {
|
| - "id": "StartReconciliationRequest",
|
| - "properties": {
|
| - "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"
|
| },
|
| - "reconciliationOperation": {
|
| - "$ref": "QuotaOperation",
|
| - "description": "Operation that describes the quota reconciliation."
|
| + "detail": {
|
| + "description": "Free-form text providing details on the error cause of the error.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1143,6 +884,18 @@
|
| },
|
| "type": "object"
|
| },
|
| + "ConsumerInfo": {
|
| + "description": "`ConsumerInfo` provides information about the consumer project.",
|
| + "id": "ConsumerInfo",
|
| + "properties": {
|
| + "projectNumber": {
|
| + "description": "The Google cloud project number, e.g. 1234567890. A value of 0 indicates\nno project number is found.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "CheckRequest": {
|
| "description": "Request message for the Check method.",
|
| "id": "CheckRequest",
|
| @@ -1170,27 +923,9 @@
|
| "description": "Represents information regarding a quota operation.",
|
| "id": "QuotaOperation",
|
| "properties": {
|
| - "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.",
|
| - "items": {
|
| - "$ref": "MetricValueSet"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "labels": {
|
| - "additionalProperties": {
|
| - "type": "string"
|
| - },
|
| - "description": "Labels describing the operation.",
|
| - "type": "object"
|
| - },
|
| - "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"
|
| - },
|
| - "operationId": {
|
| - "description": "Identity of the operation. This must be unique within the scope of the\nservice that generated the operation. If the service calls AllocateQuota\nand ReleaseQuota on the same operation, the two calls should carry the\nsame ID.\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"
|
| + "operationId": {
|
| + "description": "Identity of the operation. This must be unique within the scope of the\nservice that generated the operation. If the service calls AllocateQuota\nand ReleaseQuota on the same operation, the two calls should carry the\nsame ID.\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"
|
| },
|
| "quotaMode": {
|
| "description": "Quota mode for this operation.",
|
| @@ -1211,6 +946,24 @@
|
| "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. This field is not\nrequired if the quota operation is performed on non-API resources.\n\nExample of an RPC method name:\n google.example.library.v1.LibraryService.CreateShelf",
|
| "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.",
|
| + "items": {
|
| + "$ref": "MetricValueSet"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "labels": {
|
| + "additionalProperties": {
|
| + "type": "string"
|
| + },
|
| + "description": "Labels describing the operation.",
|
| + "type": "object"
|
| + },
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1247,6 +1000,38 @@
|
| "description": "Represents information regarding an operation.",
|
| "id": "Operation",
|
| "properties": {
|
| + "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"
|
| + },
|
| + "operationName": {
|
| + "description": "Fully qualified name of the operation. Reserved for future use.",
|
| + "type": "string"
|
| + },
|
| + "startTime": {
|
| + "description": "Required. Start time of the operation.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| + },
|
| + "importance": {
|
| + "description": "DO NOT USE. This is an experimental field.",
|
| + "enum": [
|
| + "LOW",
|
| + "HIGH",
|
| + "DEBUG"
|
| + ],
|
| + "enumDescriptions": [
|
| + "The API implementation may cache and aggregate the data.\nThe data may be lost when rare and unexpected system failures occur.",
|
| + "The API implementation doesn't cache and aggregate the data.\nIf the method returns successfully, it's guaranteed that the data has\nbeen persisted in durable storage.",
|
| + "In addition to the behavior described in HIGH, DEBUG enables\nadditional validation logic that is only useful during the onboarding\nprocess. This is only available to Google internal services and\nthe service must be whitelisted by chemist-dev@google.com in order\nto use this level."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "resourceContainer": {
|
| + "description": "The 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"
|
| + },
|
| "labels": {
|
| "additionalProperties": {
|
| "type": "string"
|
| @@ -1286,38 +1071,6 @@
|
| "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"
|
| - },
|
| - "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"
|
| - },
|
| - "operationName": {
|
| - "description": "Fully qualified name of the operation. Reserved for future use.",
|
| - "type": "string"
|
| - },
|
| - "startTime": {
|
| - "description": "Required. Start time of the operation.",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| - },
|
| - "importance": {
|
| - "description": "DO NOT USE. This is an experimental field.",
|
| - "enum": [
|
| - "LOW",
|
| - "HIGH",
|
| - "DEBUG"
|
| - ],
|
| - "enumDescriptions": [
|
| - "The API implementation may cache and aggregate the data.\nThe data may be lost when rare and unexpected system failures occur.",
|
| - "The API implementation doesn't cache and aggregate the data.\nIf the method returns successfully, it's guaranteed that the data has\nbeen persisted in durable storage.",
|
| - "In addition to the behavior described in HIGH, DEBUG enables\nadditional validation logic that is only useful during the onboarding\nprocess. This is only available to Google internal services and\nthe service must be whitelisted by chemist-dev@google.com in order\nto use this level."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "resourceContainer": {
|
| - "description": "The 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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1346,6 +1099,271 @@
|
| }
|
| },
|
| "type": "object"
|
| + },
|
| + "CheckResponse": {
|
| + "description": "Response message for the Check method.",
|
| + "id": "CheckResponse",
|
| + "properties": {
|
| + "checkInfo": {
|
| + "$ref": "CheckInfo",
|
| + "description": "Feedback data returned from the server during processing a Check request."
|
| + },
|
| + "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": "CheckError"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "operationId": {
|
| + "description": "The same operation_id value used in the CheckRequest.\nUsed for logging and diagnostics purposes.",
|
| + "type": "string"
|
| + },
|
| + "serviceConfigId": {
|
| + "description": "The actual config id used to process the request.",
|
| + "type": "string"
|
| + },
|
| + "quotaInfo": {
|
| + "$ref": "QuotaInfo",
|
| + "description": "Quota information for the check request associated with this response.\n"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Status": {
|
| + "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that 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.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
|
| + "id": "Status",
|
| + "properties": {
|
| + "details": {
|
| + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
|
| + "items": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "code": {
|
| + "description": "The status code, which should be an enum value of google.rpc.Code.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "message": {
|
| + "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ReportRequest": {
|
| + "description": "Request message for the Report method.",
|
| + "id": "ReportRequest",
|
| + "properties": {
|
| + "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"
|
| + },
|
| + "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": "Operation"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "AuditLog": {
|
| + "description": "Common audit log format for Google Cloud Platform API operations.\n\n",
|
| + "id": "AuditLog",
|
| + "properties": {
|
| + "request": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object.",
|
| + "type": "any"
|
| + },
|
| + "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": "RequestMetadata",
|
| + "description": "Metadata about the operation."
|
| + },
|
| + "serviceData": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| + },
|
| + "description": "Other service-specific data about the request, response, and other\nactivities.",
|
| + "type": "object"
|
| + },
|
| + "numResponseItems": {
|
| + "description": "The number of items returned from a List or Query API method,\nif applicable.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| + "status": {
|
| + "$ref": "Status",
|
| + "description": "The status of the overall operation."
|
| + },
|
| + "authenticationInfo": {
|
| + "$ref": "AuthenticationInfo",
|
| + "description": "Authentication information."
|
| + },
|
| + "serviceName": {
|
| + "description": "The name of the API service performing the operation. For example,\n`\"datastore.googleapis.com\"`.",
|
| + "type": "string"
|
| + },
|
| + "response": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object.",
|
| + "type": "any"
|
| + },
|
| + "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"
|
| + },
|
| + "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"
|
| + },
|
| + "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"
|
| + },
|
| + "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": "AuthorizationInfo"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "LogEntry": {
|
| + "description": "An individual log entry.",
|
| + "id": "LogEntry",
|
| + "properties": {
|
| + "labels": {
|
| + "additionalProperties": {
|
| + "type": "string"
|
| + },
|
| + "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.",
|
| + "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"
|
| + ],
|
| + "enumDescriptions": [
|
| + "(0) The log entry has no assigned severity level.",
|
| + "(100) Debug or trace information.",
|
| + "(200) Routine information, such as ongoing status or performance.",
|
| + "(300) Normal but significant events, such as start up, shut down, or\na configuration change.",
|
| + "(400) Warning events might cause problems.",
|
| + "(500) Error events are likely to cause problems.",
|
| + "(600) Critical events cause more severe problems or outages.",
|
| + "(700) A person must take an action immediately.",
|
| + "(800) One or more systems are unusable."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "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"
|
| + },
|
| + "name": {
|
| + "description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`,\n`\"book_log\"`.",
|
| + "type": "string"
|
| + },
|
| + "structPayload": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object.",
|
| + "type": "any"
|
| + },
|
| + "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"
|
| + },
|
| + "protoPayload": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| + },
|
| + "description": "The log entry payload, represented as a protocol buffer that is\nexpressed as a JSON object. You can only pass `protoPayload`\nvalues that belong to a set of approved types.",
|
| + "type": "object"
|
| + },
|
| + "timestamp": {
|
| + "description": "The time the event described by the log entry occurred. If\nomitted, defaults to operation start time.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "MetricValue": {
|
| + "description": "Represents a single metric value.",
|
| + "id": "MetricValue",
|
| + "properties": {
|
| + "boolValue": {
|
| + "description": "A boolean value.",
|
| + "type": "boolean"
|
| + },
|
| + "endTime": {
|
| + "description": "The end of the time period over which this metric value's measurement\napplies.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| + },
|
| + "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"
|
| + },
|
| + "moneyValue": {
|
| + "$ref": "Money",
|
| + "description": "A money value."
|
| + },
|
| + "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"
|
| + },
|
| + "stringValue": {
|
| + "description": "A text string value.",
|
| + "type": "string"
|
| + },
|
| + "doubleValue": {
|
| + "description": "A double precision floating point value.",
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "int64Value": {
|
| + "description": "A signed 64-bit integer value.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| + "distributionValue": {
|
| + "$ref": "Distribution",
|
| + "description": "A distribution value."
|
| + }
|
| + },
|
| + "type": "object"
|
| }
|
| },
|
| "servicePath": "",
|
|
|
Chromium Code Reviews
Issue 2987103002:
Api-Roll 52: 2017-07-31 (Closed)
