OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/servicecontrol": { |
| 6 "description": "Manage your Google Service Control data" |
| 7 }, |
5 "https://www.googleapis.com/auth/cloud-platform": { | 8 "https://www.googleapis.com/auth/cloud-platform": { |
6 "description": "View and manage your data across Google Clou
d Platform services" | 9 "description": "View and manage your data across Google Clou
d Platform services" |
7 }, | |
8 "https://www.googleapis.com/auth/servicecontrol": { | |
9 "description": "Manage your Google Service Control data" | |
10 } | 10 } |
11 } | 11 } |
12 } | 12 } |
13 }, | 13 }, |
14 "basePath": "", | 14 "basePath": "", |
15 "baseUrl": "https://servicecontrol.googleapis.com/", | 15 "baseUrl": "https://servicecontrol.googleapis.com/", |
16 "batchPath": "batch", | 16 "batchPath": "batch", |
17 "canonicalName": "Service Control", | 17 "canonicalName": "Service Control", |
18 "description": "Google Service Control provides control plane functionality
to managed services, such as logging, monitoring, and status checks.", | 18 "description": "Google Service Control provides control plane functionality
to managed services, such as logging, monitoring, and status checks.", |
19 "discoveryVersion": "v1", | 19 "discoveryVersion": "v1", |
20 "documentationLink": "https://cloud.google.com/service-control/", | 20 "documentationLink": "https://cloud.google.com/service-control/", |
21 "icons": { | 21 "icons": { |
22 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 22 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
23 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 23 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
24 }, | 24 }, |
25 "id": "servicecontrol:v1", | 25 "id": "servicecontrol:v1", |
26 "kind": "discovery#restDescription", | 26 "kind": "discovery#restDescription", |
27 "name": "servicecontrol", | 27 "name": "servicecontrol", |
28 "ownerDomain": "google.com", | 28 "ownerDomain": "google.com", |
29 "ownerName": "Google", | 29 "ownerName": "Google", |
30 "parameters": { | 30 "parameters": { |
31 "access_token": { | 31 "upload_protocol": { |
32 "description": "OAuth access token.", | 32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
33 "location": "query", | 33 "location": "query", |
34 "type": "string" | 34 "type": "string" |
35 }, | 35 }, |
36 "prettyPrint": { | 36 "prettyPrint": { |
37 "default": "true", | 37 "default": "true", |
38 "description": "Returns response with indentations and line breaks."
, | 38 "description": "Returns response with indentations and line breaks."
, |
39 "location": "query", | 39 "location": "query", |
40 "type": "boolean" | 40 "type": "boolean" |
41 }, | 41 }, |
42 "key": { | 42 "uploadType": { |
43 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | 43 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
44 "location": "query", | 44 "location": "query", |
45 "type": "string" | 45 "type": "string" |
46 }, | 46 }, |
47 "quotaUser": { | |
48 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | |
49 "location": "query", | |
50 "type": "string" | |
51 }, | |
52 "pp": { | |
53 "default": "true", | |
54 "description": "Pretty-print response.", | |
55 "location": "query", | |
56 "type": "boolean" | |
57 }, | |
58 "fields": { | 47 "fields": { |
59 "description": "Selector specifying which fields to include in a par
tial response.", | 48 "description": "Selector specifying which fields to include in a par
tial response.", |
60 "location": "query", | 49 "location": "query", |
61 "type": "string" | 50 "type": "string" |
62 }, | 51 }, |
| 52 "$.xgafv": { |
| 53 "description": "V1 error format.", |
| 54 "enum": [ |
| 55 "1", |
| 56 "2" |
| 57 ], |
| 58 "enumDescriptions": [ |
| 59 "v1 error format", |
| 60 "v2 error format" |
| 61 ], |
| 62 "location": "query", |
| 63 "type": "string" |
| 64 }, |
| 65 "callback": { |
| 66 "description": "JSONP", |
| 67 "location": "query", |
| 68 "type": "string" |
| 69 }, |
63 "alt": { | 70 "alt": { |
64 "default": "json", | 71 "default": "json", |
65 "description": "Data format for response.", | 72 "description": "Data format for response.", |
66 "enum": [ | 73 "enum": [ |
67 "json", | 74 "json", |
68 "media", | 75 "media", |
69 "proto" | 76 "proto" |
70 ], | 77 ], |
71 "enumDescriptions": [ | 78 "enumDescriptions": [ |
72 "Responses with Content-Type of application/json", | 79 "Responses with Content-Type of application/json", |
73 "Media download with context-dependent Content-Type", | 80 "Media download with context-dependent Content-Type", |
74 "Responses with Content-Type of application/x-protobuf" | 81 "Responses with Content-Type of application/x-protobuf" |
75 ], | 82 ], |
76 "location": "query", | 83 "location": "query", |
77 "type": "string" | 84 "type": "string" |
78 }, | 85 }, |
79 "$.xgafv": { | 86 "key": { |
80 "description": "V1 error format.", | 87 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
81 "enum": [ | |
82 "1", | |
83 "2" | |
84 ], | |
85 "enumDescriptions": [ | |
86 "v1 error format", | |
87 "v2 error format" | |
88 ], | |
89 "location": "query", | 88 "location": "query", |
90 "type": "string" | 89 "type": "string" |
91 }, | 90 }, |
92 "callback": { | 91 "access_token": { |
93 "description": "JSONP", | 92 "description": "OAuth access token.", |
94 "location": "query", | 93 "location": "query", |
95 "type": "string" | 94 "type": "string" |
96 }, | 95 }, |
97 "oauth_token": { | 96 "quotaUser": { |
98 "description": "OAuth 2.0 token for the current user.", | 97 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
99 "location": "query", | 98 "location": "query", |
100 "type": "string" | 99 "type": "string" |
101 }, | 100 }, |
102 "uploadType": { | 101 "pp": { |
103 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 102 "default": "true", |
| 103 "description": "Pretty-print response.", |
| 104 "location": "query", |
| 105 "type": "boolean" |
| 106 }, |
| 107 "oauth_token": { |
| 108 "description": "OAuth 2.0 token for the current user.", |
104 "location": "query", | 109 "location": "query", |
105 "type": "string" | 110 "type": "string" |
106 }, | 111 }, |
107 "bearer_token": { | 112 "bearer_token": { |
108 "description": "OAuth bearer token.", | 113 "description": "OAuth bearer token.", |
109 "location": "query", | 114 "location": "query", |
110 "type": "string" | 115 "type": "string" |
111 }, | |
112 "upload_protocol": { | |
113 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
114 "location": "query", | |
115 "type": "string" | |
116 } | 116 } |
117 }, | 117 }, |
118 "protocol": "rest", | 118 "protocol": "rest", |
119 "resources": { | 119 "resources": { |
120 "services": { | 120 "services": { |
121 "methods": { | 121 "methods": { |
| 122 "startReconciliation": { |
| 123 "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 f
uture for each\n metric that needs to be reconciled. The timestamp being in fu
ture allows\n to account for in-flight AllocateQuota and ReleaseQuota requests
for the\n same metric.\n2. One Platform records this timestamp and starts tra
cking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconcilia
tion is\n called.\n3. At or after the time specified in the StartReconciliatio
n, service\n sends EndReconciliation with the usage that needs to be reconcile
d 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 allocatio
n or release between StartReconciliation and EndReconciliation.\n\nSignals the q
uota controller that the service wants to perform a usage\nreconciliation as spe
cified in the request.\n\nThis method requires the `servicemanagement.services.q
uota`\npermission on the specified service. For more information, see\n[Google C
loud IAM](https://cloud.google.com/iam).", |
| 124 "httpMethod": "POST", |
| 125 "id": "servicecontrol.services.startReconciliation", |
| 126 "parameterOrder": [ |
| 127 "serviceName" |
| 128 ], |
| 129 "parameters": { |
| 130 "serviceName": { |
| 131 "description": "Name of the service as specified in
the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee goo
gle.api.Service for the definition of a service name.", |
| 132 "location": "path", |
| 133 "required": true, |
| 134 "type": "string" |
| 135 } |
| 136 }, |
| 137 "path": "v1/services/{serviceName}:startReconciliation", |
| 138 "request": { |
| 139 "$ref": "StartReconciliationRequest" |
| 140 }, |
| 141 "response": { |
| 142 "$ref": "StartReconciliationResponse" |
| 143 }, |
| 144 "scopes": [ |
| 145 "https://www.googleapis.com/auth/cloud-platform", |
| 146 "https://www.googleapis.com/auth/servicecontrol" |
| 147 ] |
| 148 }, |
122 "check": { | 149 "check": { |
123 "description": "Checks an operation with Google Service Cont
rol to decide whether\nthe given operation should proceed. It should be called b
efore the\noperation is executed.\n\nIf feasible, the client should cache the ch
eck 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` ha
s the size limit of 64KB.\n\nThis method requires the `servicemanagement.service
s.check` permission\non the specified service. For more information, see\n[Googl
e Cloud IAM](https://cloud.google.com/iam).", | 150 "description": "Checks an operation with Google Service Cont
rol to decide whether\nthe given operation should proceed. It should be called b
efore the\noperation is executed.\n\nIf feasible, the client should cache the ch
eck 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` ha
s the size limit of 64KB.\n\nThis method requires the `servicemanagement.service
s.check` permission\non the specified service. For more information, see\n[Googl
e Cloud IAM](https://cloud.google.com/iam).", |
124 "httpMethod": "POST", | 151 "httpMethod": "POST", |
125 "id": "servicecontrol.services.check", | 152 "id": "servicecontrol.services.check", |
126 "parameterOrder": [ | 153 "parameterOrder": [ |
127 "serviceName" | 154 "serviceName" |
128 ], | 155 ], |
129 "parameters": { | 156 "parameters": { |
130 "serviceName": { | 157 "serviceName": { |
131 "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.", | 158 "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.", |
132 "location": "path", | 159 "location": "path", |
133 "required": true, | 160 "required": true, |
134 "type": "string" | 161 "type": "string" |
135 } | 162 } |
136 }, | 163 }, |
137 "path": "v1/services/{serviceName}:check", | 164 "path": "v1/services/{serviceName}:check", |
138 "request": { | 165 "request": { |
139 "$ref": "CheckRequest" | 166 "$ref": "CheckRequest" |
140 }, | 167 }, |
141 "response": { | 168 "response": { |
142 "$ref": "CheckResponse" | 169 "$ref": "CheckResponse" |
143 }, | 170 }, |
144 "scopes": [ | 171 "scopes": [ |
145 "https://www.googleapis.com/auth/cloud-platform", | 172 "https://www.googleapis.com/auth/cloud-platform", |
146 "https://www.googleapis.com/auth/servicecontrol" | 173 "https://www.googleapis.com/auth/servicecontrol" |
147 ] | 174 ] |
148 }, | 175 }, |
| 176 "releaseQuota": { |
| 177 "description": "Releases previously allocated quota done thr
ough AllocateQuota method.\n\nThis method requires the `servicemanagement.servic
es.quota`\npermission on the specified service. For more information, see\n[Goog
le Cloud IAM](https://cloud.google.com/iam).", |
| 178 "httpMethod": "POST", |
| 179 "id": "servicecontrol.services.releaseQuota", |
| 180 "parameterOrder": [ |
| 181 "serviceName" |
| 182 ], |
| 183 "parameters": { |
| 184 "serviceName": { |
| 185 "description": "Name of the service as specified in
the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee goo
gle.api.Service for the definition of a service name.", |
| 186 "location": "path", |
| 187 "required": true, |
| 188 "type": "string" |
| 189 } |
| 190 }, |
| 191 "path": "v1/services/{serviceName}:releaseQuota", |
| 192 "request": { |
| 193 "$ref": "ReleaseQuotaRequest" |
| 194 }, |
| 195 "response": { |
| 196 "$ref": "ReleaseQuotaResponse" |
| 197 }, |
| 198 "scopes": [ |
| 199 "https://www.googleapis.com/auth/cloud-platform", |
| 200 "https://www.googleapis.com/auth/servicecontrol" |
| 201 ] |
| 202 }, |
| 203 "endReconciliation": { |
| 204 "description": "Signals the quota controller that service en
ds the ongoing usage\nreconciliation.\n\nThis method requires the `servicemanage
ment.services.quota`\npermission on the specified service. For more information,
see\n[Google Cloud IAM](https://cloud.google.com/iam).", |
| 205 "httpMethod": "POST", |
| 206 "id": "servicecontrol.services.endReconciliation", |
| 207 "parameterOrder": [ |
| 208 "serviceName" |
| 209 ], |
| 210 "parameters": { |
| 211 "serviceName": { |
| 212 "description": "Name of the service as specified in
the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee goo
gle.api.Service for the definition of a service name.", |
| 213 "location": "path", |
| 214 "required": true, |
| 215 "type": "string" |
| 216 } |
| 217 }, |
| 218 "path": "v1/services/{serviceName}:endReconciliation", |
| 219 "request": { |
| 220 "$ref": "EndReconciliationRequest" |
| 221 }, |
| 222 "response": { |
| 223 "$ref": "EndReconciliationResponse" |
| 224 }, |
| 225 "scopes": [ |
| 226 "https://www.googleapis.com/auth/cloud-platform", |
| 227 "https://www.googleapis.com/auth/servicecontrol" |
| 228 ] |
| 229 }, |
149 "report": { | 230 "report": { |
150 "description": "Reports operation results to Google Service
Control, such as logs and\nmetrics. It should be called after an operation is co
mpleted.\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 aggregatio
n time window to avoid data loss risk more than 0.01%\nfor business and complian
ce reasons.\n\nNOTE: the `ReportRequest` has the size limit of 1MB.\n\nThis meth
od requires the `servicemanagement.services.report` permission\non the specified
service. For more information, see\n[Google Cloud IAM](https://cloud.google.com
/iam).", | 231 "description": "Reports operation results to Google Service
Control, such as logs and\nmetrics. It should be called after an operation is co
mpleted.\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 aggregatio
n time window to avoid data loss risk more than 0.01%\nfor business and complian
ce reasons.\n\nNOTE: the `ReportRequest` has the size limit of 1MB.\n\nThis meth
od requires the `servicemanagement.services.report` permission\non the specified
service. For more information, see\n[Google Cloud IAM](https://cloud.google.com
/iam).", |
151 "httpMethod": "POST", | 232 "httpMethod": "POST", |
152 "id": "servicecontrol.services.report", | 233 "id": "servicecontrol.services.report", |
153 "parameterOrder": [ | 234 "parameterOrder": [ |
154 "serviceName" | 235 "serviceName" |
155 ], | 236 ], |
156 "parameters": { | 237 "parameters": { |
157 "serviceName": { | 238 "serviceName": { |
158 "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.", | 239 "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.", |
159 "location": "path", | 240 "location": "path", |
160 "required": true, | 241 "required": true, |
161 "type": "string" | 242 "type": "string" |
162 } | 243 } |
163 }, | 244 }, |
164 "path": "v1/services/{serviceName}:report", | 245 "path": "v1/services/{serviceName}:report", |
165 "request": { | 246 "request": { |
166 "$ref": "ReportRequest" | 247 "$ref": "ReportRequest" |
167 }, | 248 }, |
168 "response": { | 249 "response": { |
169 "$ref": "ReportResponse" | 250 "$ref": "ReportResponse" |
170 }, | 251 }, |
171 "scopes": [ | 252 "scopes": [ |
172 "https://www.googleapis.com/auth/cloud-platform", | 253 "https://www.googleapis.com/auth/cloud-platform", |
173 "https://www.googleapis.com/auth/servicecontrol" | 254 "https://www.googleapis.com/auth/servicecontrol" |
174 ] | 255 ] |
| 256 }, |
| 257 "allocateQuota": { |
| 258 "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 se
rvice. For more information, see\n[Google Cloud IAM](https://cloud.google.com/ia
m).", |
| 259 "httpMethod": "POST", |
| 260 "id": "servicecontrol.services.allocateQuota", |
| 261 "parameterOrder": [ |
| 262 "serviceName" |
| 263 ], |
| 264 "parameters": { |
| 265 "serviceName": { |
| 266 "description": "Name of the service as specified in
the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee goo
gle.api.Service for the definition of a service name.", |
| 267 "location": "path", |
| 268 "required": true, |
| 269 "type": "string" |
| 270 } |
| 271 }, |
| 272 "path": "v1/services/{serviceName}:allocateQuota", |
| 273 "request": { |
| 274 "$ref": "AllocateQuotaRequest" |
| 275 }, |
| 276 "response": { |
| 277 "$ref": "AllocateQuotaResponse" |
| 278 }, |
| 279 "scopes": [ |
| 280 "https://www.googleapis.com/auth/cloud-platform", |
| 281 "https://www.googleapis.com/auth/servicecontrol" |
| 282 ] |
175 } | 283 } |
176 } | 284 } |
177 } | 285 } |
178 }, | 286 }, |
179 "revision": "20170117", | 287 "revision": "20170206", |
180 "rootUrl": "https://servicecontrol.googleapis.com/", | 288 "rootUrl": "https://servicecontrol.googleapis.com/", |
181 "schemas": { | 289 "schemas": { |
182 "CheckError": { | 290 "EndReconciliationRequest": { |
183 "description": "Defines the errors to be returned in\ngoogle.api.ser
vicecontrol.v1.CheckResponse.check_errors.", | 291 "id": "EndReconciliationRequest", |
184 "id": "CheckError", | |
185 "properties": { | 292 "properties": { |
186 "code": { | 293 "reconciliationOperation": { |
187 "description": "The error code.", | 294 "$ref": "QuotaOperation", |
188 "enum": [ | 295 "description": "Operation that describes the quota reconcili
ation." |
189 "ERROR_CODE_UNSPECIFIED", | |
190 "NOT_FOUND", | |
191 "PERMISSION_DENIED", | |
192 "RESOURCE_EXHAUSTED", | |
193 "SERVICE_NOT_ACTIVATED", | |
194 "BILLING_DISABLED", | |
195 "PROJECT_DELETED", | |
196 "PROJECT_INVALID", | |
197 "IP_ADDRESS_BLOCKED", | |
198 "REFERER_BLOCKED", | |
199 "CLIENT_APP_BLOCKED", | |
200 "API_TARGET_BLOCKED", | |
201 "API_KEY_INVALID", | |
202 "API_KEY_EXPIRED", | |
203 "API_KEY_NOT_FOUND", | |
204 "NAMESPACE_LOOKUP_UNAVAILABLE", | |
205 "SERVICE_STATUS_UNAVAILABLE", | |
206 "BILLING_STATUS_UNAVAILABLE" | |
207 ], | |
208 "enumDescriptions": [ | |
209 "This is never used in `CheckResponse`.", | |
210 "The consumer's project id was not found.\nSame as googl
e.rpc.Code.NOT_FOUND.", | |
211 "The consumer doesn't have access to the specified resou
rce.\nSame as google.rpc.Code.PERMISSION_DENIED.", | |
212 "Quota check failed. Same as google.rpc.Code.RESOURCE_EX
HAUSTED.", | |
213 "The consumer hasn't activated the service.", | |
214 "The consumer cannot access the service because billing
is disabled.", | |
215 "The consumer's project has been marked as deleted (soft
deletion).", | |
216 "The consumer's project number or id does not represent
a valid project.", | |
217 "The IP address of the consumer is invalid for the speci
fic consumer\nproject.", | |
218 "The referer address of the consumer request is invalid
for the specific\nconsumer project.", | |
219 "The client application of the consumer request is inval
id for the\nspecific consumer project.", | |
220 "The API targeted by this request is invalid for the spe
cified consumer\nproject.", | |
221 "The consumer's API key is invalid.", | |
222 "The consumer's API Key has expired.", | |
223 "The consumer's API Key was not found in config record."
, | |
224 "The backend server for looking up project id/number is
unavailable.", | |
225 "The backend server for checking service status is unava
ilable.", | |
226 "The backend server for checking billing status is unava
ilable." | |
227 ], | |
228 "type": "string" | |
229 }, | 296 }, |
230 "detail": { | 297 "serviceConfigId": { |
231 "description": "Free-form text providing details on the erro
r cause of the error.", | 298 "description": "Specifies which version of service configura
tion should be used to process\nthe request. If unspecified or no matching versi
on can be found, the latest\none will be used.", |
232 "type": "string" | 299 "type": "string" |
233 } | 300 } |
234 }, | 301 }, |
235 "type": "object" | 302 "type": "object" |
236 }, | 303 }, |
237 "Status": { | 304 "ReportInfo": { |
238 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d 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 tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\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\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` which can be used for common error conditions.\n\n# Lan
guage 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` mes
sage is\nexposed in different client libraries and different wire protocols, it
can be\nmapped differently. For example, it will likely be mapped to some except
ions\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\nenviron
ments, either with or without APIs, to provide a\nconsistent developer experienc
e across different environments.\n\nExample uses of this error model include:\n\
n- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step
may\n have a `Status` message for error reporting purpose.\n\n- Batch operati
ons. If a client uses batch request and batch response, the\n `Status` messag
e should be used directly inside batch response, one for\n each error sub-res
ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio
n\n results in its response, the status of those operations should be\n re
presented 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 s
tripping needed for security/privacy reasons.", | 305 "id": "ReportInfo", |
239 "id": "Status", | |
240 "properties": { | |
241 "code": { | |
242 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | |
243 "format": "int32", | |
244 "type": "integer" | |
245 }, | |
246 "details": { | |
247 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", | |
248 "items": { | |
249 "additionalProperties": { | |
250 "description": "Properties of the object. Contains f
ield @type with type URL.", | |
251 "type": "any" | |
252 }, | |
253 "type": "object" | |
254 }, | |
255 "type": "array" | |
256 }, | |
257 "message": { | |
258 "description": "A developer-facing error message, which shou
ld 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.", | |
259 "type": "string" | |
260 } | |
261 }, | |
262 "type": "object" | |
263 }, | |
264 "ReportError": { | |
265 "description": "Represents the processing error of one `Operation` i
n the request.", | |
266 "id": "ReportError", | |
267 "properties": { | 306 "properties": { |
268 "operationId": { | 307 "operationId": { |
269 "description": "The Operation.operation_id value from the re
quest.", | 308 "description": "The Operation.operation_id value from the re
quest.", |
270 "type": "string" | 309 "type": "string" |
271 }, | 310 }, |
272 "status": { | 311 "quotaInfo": { |
273 "$ref": "Status", | 312 "$ref": "QuotaInfo", |
274 "description": "Details of the error when processing the `Op
eration`." | 313 "description": "Quota usage info when processing the `Operat
ion`." |
275 } | 314 } |
276 }, | 315 }, |
277 "type": "object" | 316 "type": "object" |
278 }, | 317 }, |
279 "ExponentialBuckets": { | 318 "ReportResponse": { |
280 "description": "Describing buckets with exponentially growing width.
", | 319 "description": "Response message for the Report method.", |
281 "id": "ExponentialBuckets", | 320 "id": "ReportResponse", |
282 "properties": { | 321 "properties": { |
283 "growthFactor": { | 322 "reportInfos": { |
284 "description": "The i'th exponential bucket covers the inter
val\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges fr
om 1 to num_finite_buckets inclusive.\nMust be larger than 1.0.", | 323 "description": "Quota usage for each quota release `Operatio
n` request.\n\nFully or partially failed quota release request may or may not be
present\nin `report_quota_info`. For example, a failed quota release request wi
ll\nhave the current quota usage info when precise quota library returns the\nin
fo. A deadline exceeded quota request will not have quota usage info.\n\nIf ther
e is no quota release request, report_quota_info will be empty.\n", |
285 "format": "double", | 324 "items": { |
286 "type": "number" | 325 "$ref": "ReportInfo" |
| 326 }, |
| 327 "type": "array" |
287 }, | 328 }, |
288 "scale": { | 329 "serviceConfigId": { |
289 "description": "The i'th exponential bucket covers the inter
val\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges fr
om 1 to num_finite_buckets inclusive.\nMust be > 0.", | 330 "description": "The actual config id used to process the req
uest.", |
290 "format": "double", | 331 "type": "string" |
291 "type": "number" | |
292 }, | 332 }, |
293 "numFiniteBuckets": { | 333 "reportErrors": { |
294 "description": "The number of finite buckets. With the under
flow and overflow buckets,\nthe total number of buckets is `num_finite_buckets`
+ 2.\nSee comments on `bucket_options` for details.", | 334 "description": "Partial failures, one for each `Operation` i
n the request that failed\nprocessing. There are three possible combinations of
the RPC status:\n\n1. The combination of a successful RPC status and an empty `r
eport_errors`\n list indicates a complete success where all `Operations` in th
e\n request are processed successfully.\n2. The combination of a successful RP
C status and a non-empty\n `report_errors` list indicates a partial success wh
ere some\n `Operations` in the request succeeded. Each\n `Operation` that fa
iled processing has a corresponding item\n in this list.\n3. A failed RPC stat
us indicates a general non-deterministic failure.\n When this happens, it's im
possible to know which of the\n 'Operations' in the request succeeded or faile
d.", |
295 "format": "int32", | 335 "items": { |
296 "type": "integer" | 336 "$ref": "ReportError" |
| 337 }, |
| 338 "type": "array" |
297 } | 339 } |
298 }, | 340 }, |
299 "type": "object" | 341 "type": "object" |
300 }, | 342 }, |
301 "Operation": { | 343 "Operation": { |
302 "description": "Represents information regarding an operation.", | 344 "description": "Represents information regarding an operation.", |
303 "id": "Operation", | 345 "id": "Operation", |
304 "properties": { | 346 "properties": { |
305 "operationName": { | 347 "operationName": { |
306 "description": "Fully qualified name of the operation. Reser
ved for future use.", | 348 "description": "Fully qualified name of the operation. Reser
ved for future use.", |
307 "type": "string" | 349 "type": "string" |
308 }, | 350 }, |
309 "operationId": { | |
310 "description": "Identity of the operation. This must be uniq
ue 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\n
the same id.\n\nUUID version 4 is recommended, though not required.\nIn scenario
s 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.", | |
311 "type": "string" | |
312 }, | |
313 "endTime": { | 351 "endTime": { |
314 "description": "End time of the operation.\nRequired when th
e operation is used in ServiceController.Report,\nbut optional when the operatio
n is used in ServiceController.Check.", | 352 "description": "End time of the operation.\nRequired when th
e operation is used in ServiceController.Report,\nbut optional when the operatio
n is used in ServiceController.Check.", |
315 "format": "google-datetime", | 353 "format": "google-datetime", |
316 "type": "string" | 354 "type": "string" |
317 }, | 355 }, |
| 356 "startTime": { |
| 357 "description": "Required. Start time of the operation.", |
| 358 "format": "google-datetime", |
| 359 "type": "string" |
| 360 }, |
| 361 "importance": { |
| 362 "description": "DO NOT USE. This is an experimental field.", |
| 363 "enum": [ |
| 364 "LOW", |
| 365 "HIGH", |
| 366 "DEBUG" |
| 367 ], |
| 368 "enumDescriptions": [ |
| 369 "The API implementation may cache and aggregate the data
.\nThe data may be lost when rare and unexpected system failures occur.", |
| 370 "The API implementation doesn't cache and aggregate the
data.\nIf the method returns successfully, it's guaranteed that the data has\nbe
en persisted in durable storage.", |
| 371 "In addition to the behavior described in HIGH, DEBUG en
ables\nadditional validation logic that is only useful during the onboarding\npr
ocess. 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." |
| 372 ], |
| 373 "type": "string" |
| 374 }, |
| 375 "resourceContainer": { |
| 376 "description": "The resource name of the parent of a resourc
e 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>”", |
| 377 "type": "string" |
| 378 }, |
318 "labels": { | 379 "labels": { |
319 "additionalProperties": { | 380 "additionalProperties": { |
320 "type": "string" | 381 "type": "string" |
321 }, | 382 }, |
322 "description": "Labels describing the operation. Only the fo
llowing labels are allowed:\n\n- Labels describing monitored resources as define
d in\n the service configuration.\n- Default labels of metric values. When spec
ified, labels defined in the\n metric value override these default.\n- The foll
owing labels defined by Google Cloud Platform:\n - `cloud.googleapis.com/loca
tion` describing the location where the\n operation happened,\n - `serv
icecontrol.googleapis.com/user_agent` describing the user agent\n of the A
PI request,\n - `servicecontrol.googleapis.com/service_agent` describing the
service\n used to handle the API request (e.g. ESP),\n - `servicecontro
l.googleapis.com/platform` describing the platform\n where the API is serv
ed (e.g. GAE, GCE, GKE).", | 383 "description": "Labels describing the operation. Only the fo
llowing labels are allowed:\n\n- Labels describing monitored resources as define
d in\n the service configuration.\n- Default labels of metric values. When spec
ified, labels defined in the\n metric value override these default.\n- The foll
owing labels defined by Google Cloud Platform:\n - `cloud.googleapis.com/loca
tion` describing the location where the\n operation happened,\n - `serv
icecontrol.googleapis.com/user_agent` describing the user agent\n of the A
PI request,\n - `servicecontrol.googleapis.com/service_agent` describing the
service\n used to handle the API request (e.g. ESP),\n - `servicecontro
l.googleapis.com/platform` describing the platform\n where the API is serv
ed (e.g. GAE, GCE, GKE).", |
323 "type": "object" | 384 "type": "object" |
324 }, | 385 }, |
325 "importance": { | |
326 "description": "DO NOT USE. This is an experimental field.", | |
327 "enum": [ | |
328 "LOW", | |
329 "HIGH" | |
330 ], | |
331 "enumDescriptions": [ | |
332 "The API implementation may cache and aggregate the data
.\nThe data may be lost when rare and unexpected system failures occur.", | |
333 "The API implementation doesn't cache and aggregate the
data.\nIf the method returns successfully, it's guaranteed that the data has\nbe
en persisted in durable storage." | |
334 ], | |
335 "type": "string" | |
336 }, | |
337 "consumerId": { | |
338 "description": "Identity of the consumer who is using the se
rvice.\nThis field should be filled in for the operations initiated by a\nconsum
er, but not for service-initiated operations that are\nnot related to a specific
consumer.\n\nThis can be in one of the following formats:\n project:<project_i
d>,\n project_number:<project_number>,\n api_key:<api_key>.", | |
339 "type": "string" | |
340 }, | |
341 "startTime": { | |
342 "description": "Required. Start time of the operation.", | |
343 "format": "google-datetime", | |
344 "type": "string" | |
345 }, | |
346 "logEntries": { | 386 "logEntries": { |
347 "description": "Represents information to be logged.", | 387 "description": "Represents information to be logged.", |
348 "items": { | 388 "items": { |
349 "$ref": "LogEntry" | 389 "$ref": "LogEntry" |
350 }, | 390 }, |
351 "type": "array" | 391 "type": "array" |
352 }, | 392 }, |
| 393 "userLabels": { |
| 394 "additionalProperties": { |
| 395 "type": "string" |
| 396 }, |
| 397 "description": "User defined labels for the resource that th
is operation is associated\nwith.", |
| 398 "type": "object" |
| 399 }, |
353 "metricValueSets": { | 400 "metricValueSets": { |
354 "description": "Represents information about this operation.
Each MetricValueSet\ncorresponds to a metric defined in the service configurati
on.\nThe data type used in the MetricValueSet must agree with\nthe data type spe
cified 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 an
d identical\nlabel value combinations. If a request has such duplicated MetricVa
lue\ninstances, the entire request is rejected with\nan invalid argument error."
, | 401 "description": "Represents information about this operation.
Each MetricValueSet\ncorresponds to a metric defined in the service configurati
on.\nThe data type used in the MetricValueSet must agree with\nthe data type spe
cified 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 an
d identical\nlabel value combinations. If a request has such duplicated MetricVa
lue\ninstances, the entire request is rejected with\nan invalid argument error."
, |
355 "items": { | 402 "items": { |
356 "$ref": "MetricValueSet" | 403 "$ref": "MetricValueSet" |
357 }, | 404 }, |
358 "type": "array" | 405 "type": "array" |
| 406 }, |
| 407 "quotaProperties": { |
| 408 "$ref": "QuotaProperties", |
| 409 "description": "Represents the properties needed for quota c
heck. Applicable only if this\noperation is for a quota check request." |
| 410 }, |
| 411 "consumerId": { |
| 412 "description": "Identity of the consumer who is using the se
rvice.\nThis field should be filled in for the operations initiated by a\nconsum
er, but not for service-initiated operations that are\nnot related to a specific
consumer.\n\nThis can be in one of the following formats:\n project:<project_i
d>,\n project_number:<project_number>,\n api_key:<api_key>.", |
| 413 "type": "string" |
| 414 }, |
| 415 "operationId": { |
| 416 "description": "Identity of the operation. This must be uniq
ue 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\n
the same id.\n\nUUID version 4 is recommended, though not required.\nIn scenario
s 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.", |
| 417 "type": "string" |
359 } | 418 } |
360 }, | 419 }, |
361 "type": "object" | 420 "type": "object" |
362 }, | 421 }, |
363 "CheckRequest": { | 422 "CheckResponse": { |
364 "description": "Request message for the Check method.", | 423 "description": "Response message for the Check method.", |
365 "id": "CheckRequest", | 424 "id": "CheckResponse", |
366 "properties": { | 425 "properties": { |
367 "operation": { | 426 "operationId": { |
368 "$ref": "Operation", | 427 "description": "The same operation_id value used in the Chec
kRequest.\nUsed for logging and diagnostics purposes.", |
369 "description": "The operation to be checked." | 428 "type": "string" |
| 429 }, |
| 430 "checkErrors": { |
| 431 "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."
, |
| 432 "items": { |
| 433 "$ref": "CheckError" |
| 434 }, |
| 435 "type": "array" |
| 436 }, |
| 437 "checkInfo": { |
| 438 "$ref": "CheckInfo", |
| 439 "description": "Feedback data returned from the server durin
g processing a Check request." |
| 440 }, |
| 441 "quotaInfo": { |
| 442 "$ref": "QuotaInfo", |
| 443 "description": "Quota information for the check request asso
ciated with this response.\n" |
370 }, | 444 }, |
371 "serviceConfigId": { | 445 "serviceConfigId": { |
372 "description": "Specifies which version of service configura
tion should be used to process\nthe request.\n\nIf unspecified or no matching ve
rsion can be found, the\nlatest one will be used.", | 446 "description": "The actual config id used to process the req
uest.", |
373 "type": "string" | 447 "type": "string" |
374 } | 448 } |
375 }, | 449 }, |
376 "type": "object" | 450 "type": "object" |
| 451 }, |
| 452 "ReportRequest": { |
| 453 "description": "Request message for the Report method.", |
| 454 "id": "ReportRequest", |
| 455 "properties": { |
| 456 "operations": { |
| 457 "description": "Operations to be reported.\n\nTypically the
service should report one operation per request.\nPutting multiple operations in
to a single request is allowed, but should\nbe used only when multiple operation
s are natually available at the time\nof the report.\n\nIf multiple operations a
re in a single request, the total request size\nshould be no larger than 1MB. Se
e ReportResponse.report_errors for\npartial failure behavior.", |
| 458 "items": { |
| 459 "$ref": "Operation" |
| 460 }, |
| 461 "type": "array" |
| 462 }, |
| 463 "serviceConfigId": { |
| 464 "description": "Specifies which version of service config sh
ould be used to process the\nrequest.\n\nIf unspecified or no matching version c
an be found, the\nlatest one will be used.", |
| 465 "type": "string" |
| 466 } |
| 467 }, |
| 468 "type": "object" |
| 469 }, |
| 470 "Status": { |
| 471 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d 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 tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\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\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` which can be used for common error conditions.\n\n# Lan
guage 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` mes
sage is\nexposed in different client libraries and different wire protocols, it
can be\nmapped differently. For example, it will likely be mapped to some except
ions\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\nenviron
ments, either with or without APIs, to provide a\nconsistent developer experienc
e across different environments.\n\nExample uses of this error model include:\n\
n- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step
may\n have a `Status` message for error reporting purpose.\n\n- Batch operati
ons. If a client uses batch request and batch response, the\n `Status` messag
e should be used directly inside batch response, one for\n each error sub-res
ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio
n\n results in its response, the status of those operations should be\n re
presented 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 s
tripping needed for security/privacy reasons.", |
| 472 "id": "Status", |
| 473 "properties": { |
| 474 "details": { |
| 475 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", |
| 476 "items": { |
| 477 "additionalProperties": { |
| 478 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 479 "type": "any" |
| 480 }, |
| 481 "type": "object" |
| 482 }, |
| 483 "type": "array" |
| 484 }, |
| 485 "code": { |
| 486 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 487 "format": "int32", |
| 488 "type": "integer" |
| 489 }, |
| 490 "message": { |
| 491 "description": "A developer-facing error message, which shou
ld 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.", |
| 492 "type": "string" |
| 493 } |
| 494 }, |
| 495 "type": "object" |
| 496 }, |
| 497 "AuditLog": { |
| 498 "description": "Common audit log format for Google Cloud Platform AP
I operations.\n\n", |
| 499 "id": "AuditLog", |
| 500 "properties": { |
| 501 "request": { |
| 502 "additionalProperties": { |
| 503 "description": "Properties of the object.", |
| 504 "type": "any" |
| 505 }, |
| 506 "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-generate
d data, such as file contents.\nWhen the JSON object represented here has a prot
o equivalent, the proto\nname will be indicated in the `@type` property.", |
| 507 "type": "object" |
| 508 }, |
| 509 "serviceData": { |
| 510 "additionalProperties": { |
| 511 "description": "Properties of the object. Contains field
@type with type URL.", |
| 512 "type": "any" |
| 513 }, |
| 514 "description": "Other service-specific data about the reques
t, response, and other\nactivities.", |
| 515 "type": "object" |
| 516 }, |
| 517 "requestMetadata": { |
| 518 "$ref": "RequestMetadata", |
| 519 "description": "Metadata about the operation." |
| 520 }, |
| 521 "numResponseItems": { |
| 522 "description": "The number of items returned from a List or
Query API method,\nif applicable.", |
| 523 "format": "int64", |
| 524 "type": "string" |
| 525 }, |
| 526 "authenticationInfo": { |
| 527 "$ref": "AuthenticationInfo", |
| 528 "description": "Authentication information." |
| 529 }, |
| 530 "status": { |
| 531 "$ref": "Status", |
| 532 "description": "The status of the overall operation." |
| 533 }, |
| 534 "response": { |
| 535 "additionalProperties": { |
| 536 "description": "Properties of the object.", |
| 537 "type": "any" |
| 538 }, |
| 539 "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-generate
d data, such as file contents.\nWhen the JSON object represented here has a prot
o equivalent, the proto\nname will be indicated in the `@type` property.", |
| 540 "type": "object" |
| 541 }, |
| 542 "serviceName": { |
| 543 "description": "The name of the API service performing the o
peration. For example,\n`\"datastore.googleapis.com\"`.", |
| 544 "type": "string" |
| 545 }, |
| 546 "methodName": { |
| 547 "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.LoggingServ
ice.DeleteLog\"", |
| 548 "type": "string" |
| 549 }, |
| 550 "resourceName": { |
| 551 "description": "The resource or collection that is the targe
t of the operation.\nThe name is a scheme-less URI, not including the API servic
e name.\nFor example:\n\n \"shelves/SHELF_ID/books\"\n \"shelves/SHELF_ID/
books/BOOK_ID\"", |
| 552 "type": "string" |
| 553 }, |
| 554 "authorizationInfo": { |
| 555 "description": "Authorization information. If there are mult
iple\nresources or permissions involved, then there is\none AuthorizationInfo el
ement for each {resource, permission} tuple.", |
| 556 "items": { |
| 557 "$ref": "AuthorizationInfo" |
| 558 }, |
| 559 "type": "array" |
| 560 } |
| 561 }, |
| 562 "type": "object" |
377 }, | 563 }, |
378 "LogEntry": { | 564 "LogEntry": { |
379 "description": "An individual log entry.", | 565 "description": "An individual log entry.", |
380 "id": "LogEntry", | 566 "id": "LogEntry", |
381 "properties": { | 567 "properties": { |
382 "textPayload": { | |
383 "description": "The log entry payload, represented as a Unic
ode string (UTF-8).", | |
384 "type": "string" | |
385 }, | |
386 "structPayload": { | 568 "structPayload": { |
387 "additionalProperties": { | 569 "additionalProperties": { |
388 "description": "Properties of the object.", | 570 "description": "Properties of the object.", |
389 "type": "any" | 571 "type": "any" |
390 }, | 572 }, |
391 "description": "The log entry payload, represented as a stru
cture that\nis expressed as a JSON object.", | 573 "description": "The log entry payload, represented as a stru
cture that\nis expressed as a JSON object.", |
392 "type": "object" | 574 "type": "object" |
393 }, | 575 }, |
| 576 "textPayload": { |
| 577 "description": "The log entry payload, represented as a Unic
ode string (UTF-8).", |
| 578 "type": "string" |
| 579 }, |
| 580 "protoPayload": { |
| 581 "additionalProperties": { |
| 582 "description": "Properties of the object. Contains field
@type with type URL.", |
| 583 "type": "any" |
| 584 }, |
| 585 "description": "The log entry payload, represented as a prot
ocol buffer that is\nexpressed as a JSON object. You can only pass `protoPayload
`\nvalues that belong to a set of approved types.", |
| 586 "type": "object" |
| 587 }, |
| 588 "timestamp": { |
| 589 "description": "The time the event described by the log entr
y occurred. If\nomitted, defaults to operation start time.", |
| 590 "format": "google-datetime", |
| 591 "type": "string" |
| 592 }, |
394 "labels": { | 593 "labels": { |
395 "additionalProperties": { | 594 "additionalProperties": { |
396 "type": "string" | 595 "type": "string" |
397 }, | 596 }, |
398 "description": "A set of user-defined (key, value) data that
provides additional\ninformation about the log entry.", | 597 "description": "A set of user-defined (key, value) data that
provides additional\ninformation about the log entry.", |
399 "type": "object" | 598 "type": "object" |
400 }, | 599 }, |
401 "severity": { | 600 "severity": { |
402 "description": "The severity of the log entry. The default v
alue is\n`LogSeverity.DEFAULT`.", | 601 "description": "The severity of the log entry. The default v
alue is\n`LogSeverity.DEFAULT`.", |
403 "enum": [ | 602 "enum": [ |
(...skipping 13 matching lines...) Expand all Loading... |
417 "(200) Routine information, such as ongoing status or pe
rformance.", | 616 "(200) Routine information, such as ongoing status or pe
rformance.", |
418 "(300) Normal but significant events, such as start up,
shut down, or\na configuration change.", | 617 "(300) Normal but significant events, such as start up,
shut down, or\na configuration change.", |
419 "(400) Warning events might cause problems.", | 618 "(400) Warning events might cause problems.", |
420 "(500) Error events are likely to cause problems.", | 619 "(500) Error events are likely to cause problems.", |
421 "(600) Critical events cause more severe problems or out
ages.", | 620 "(600) Critical events cause more severe problems or out
ages.", |
422 "(700) A person must take an action immediately.", | 621 "(700) A person must take an action immediately.", |
423 "(800) One or more systems are unusable." | 622 "(800) One or more systems are unusable." |
424 ], | 623 ], |
425 "type": "string" | 624 "type": "string" |
426 }, | 625 }, |
| 626 "insertId": { |
| 627 "description": "A unique ID for the log entry used for dedup
lication. If omitted,\nthe implementation will generate one based on operation_i
d.", |
| 628 "type": "string" |
| 629 }, |
427 "name": { | 630 "name": { |
428 "description": "Required. The log to which this log entry be
longs. Examples: `\"syslog\"`,\n`\"book_log\"`.", | 631 "description": "Required. The log to which this log entry be
longs. Examples: `\"syslog\"`,\n`\"book_log\"`.", |
429 "type": "string" | 632 "type": "string" |
| 633 } |
| 634 }, |
| 635 "type": "object" |
| 636 }, |
| 637 "MetricValue": { |
| 638 "description": "Represents a single metric value.", |
| 639 "id": "MetricValue", |
| 640 "properties": { |
| 641 "stringValue": { |
| 642 "description": "A text string value.", |
| 643 "type": "string" |
430 }, | 644 }, |
431 "protoPayload": { | 645 "labels": { |
432 "additionalProperties": { | 646 "additionalProperties": { |
433 "description": "Properties of the object. Contains field
@type with type URL.", | 647 "type": "string" |
434 "type": "any" | |
435 }, | 648 }, |
436 "description": "The log entry payload, represented as a prot
ocol buffer that is\nexpressed as a JSON object. You can only pass `protoPayload
`\nvalues that belong to a set of approved types.", | 649 "description": "The labels describing the metric value.\nSee
comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding r
elationship.", |
437 "type": "object" | 650 "type": "object" |
438 }, | 651 }, |
439 "timestamp": { | 652 "doubleValue": { |
440 "description": "The time the event described by the log entr
y occurred. If\nomitted, defaults to operation start time.", | 653 "description": "A double precision floating point value.", |
| 654 "format": "double", |
| 655 "type": "number" |
| 656 }, |
| 657 "int64Value": { |
| 658 "description": "A signed 64-bit integer value.", |
| 659 "format": "int64", |
| 660 "type": "string" |
| 661 }, |
| 662 "distributionValue": { |
| 663 "$ref": "Distribution", |
| 664 "description": "A distribution value." |
| 665 }, |
| 666 "boolValue": { |
| 667 "description": "A boolean value.", |
| 668 "type": "boolean" |
| 669 }, |
| 670 "endTime": { |
| 671 "description": "The end of the time period over which this m
etric value's measurement\napplies.", |
441 "format": "google-datetime", | 672 "format": "google-datetime", |
442 "type": "string" | 673 "type": "string" |
443 }, | 674 }, |
444 "insertId": { | 675 "startTime": { |
445 "description": "A unique ID for the log entry used for dedup
lication. If omitted,\nthe implementation will generate one based on operation_i
d.", | 676 "description": "The start of the time period over which this
metric value's measurement\napplies. The time period has different semantics fo
r different metric\ntypes (cumulative, delta, and gauge). See the metric definit
ion\ndocumentation in the service configuration for details.", |
| 677 "format": "google-datetime", |
| 678 "type": "string" |
| 679 }, |
| 680 "moneyValue": { |
| 681 "$ref": "Money", |
| 682 "description": "A money value." |
| 683 } |
| 684 }, |
| 685 "type": "object" |
| 686 }, |
| 687 "EndReconciliationResponse": { |
| 688 "id": "EndReconciliationResponse", |
| 689 "properties": { |
| 690 "quotaMetrics": { |
| 691 "description": "Metric values as tracked by One Platform bef
ore the adjustment was made.", |
| 692 "items": { |
| 693 "$ref": "MetricValueSet" |
| 694 }, |
| 695 "type": "array" |
| 696 }, |
| 697 "operationId": { |
| 698 "description": "The same operation_id value used in the EndR
econciliationRequest. Used for\nlogging and diagnostics purposes.", |
| 699 "type": "string" |
| 700 }, |
| 701 "reconciliationErrors": { |
| 702 "description": "Indicates the decision of the reconciliation
end.", |
| 703 "items": { |
| 704 "$ref": "QuotaError" |
| 705 }, |
| 706 "type": "array" |
| 707 }, |
| 708 "serviceConfigId": { |
| 709 "description": "ID of the actual config used to process the
request.", |
446 "type": "string" | 710 "type": "string" |
447 } | 711 } |
448 }, | 712 }, |
449 "type": "object" | 713 "type": "object" |
450 }, | 714 }, |
451 "ReportRequest": { | 715 "Money": { |
452 "description": "Request message for the Report method.", | 716 "description": "Represents an amount of money with its currency type
.", |
453 "id": "ReportRequest", | 717 "id": "Money", |
454 "properties": { | 718 "properties": { |
455 "operations": { | 719 "currencyCode": { |
456 "description": "Operations to be reported.\n\nTypically the
service should report one operation per request.\nPutting multiple operations in
to a single request is allowed, but should\nbe used only when multiple operation
s are natually available at the time\nof the report.\n\nIf multiple operations a
re in a single request, the total request size\nshould be no larger than 1MB. Se
e ReportResponse.report_errors for\npartial failure behavior.", | 720 "description": "The 3-letter currency code defined in ISO 42
17.", |
457 "items": { | 721 "type": "string" |
458 "$ref": "Operation" | |
459 }, | |
460 "type": "array" | |
461 }, | 722 }, |
462 "serviceConfigId": { | 723 "nanos": { |
463 "description": "Specifies which version of service config sh
ould be used to process the\nrequest.\n\nIf unspecified or no matching version c
an be found, the\nlatest one will be used.", | 724 "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 negativ
e or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000
,000.", |
| 725 "format": "int32", |
| 726 "type": "integer" |
| 727 }, |
| 728 "units": { |
| 729 "description": "The whole units of the amount.\nFor example
if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", |
| 730 "format": "int64", |
464 "type": "string" | 731 "type": "string" |
465 } | 732 } |
466 }, | 733 }, |
467 "type": "object" | 734 "type": "object" |
468 }, | 735 }, |
469 "MetricValueSet": { | 736 "ExplicitBuckets": { |
470 "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.", | 737 "description": "Describing buckets with arbitrary user-provided widt
h.", |
471 "id": "MetricValueSet", | 738 "id": "ExplicitBuckets", |
472 "properties": { | 739 "properties": { |
473 "metricName": { | 740 "bounds": { |
474 "description": "The metric name defined in the service confi
guration.", | 741 "description": "'bound' is a list of strictly increasing bou
ndaries between\nbuckets. Note that a list of length N-1 defines N buckets becau
se\nof fenceposting. See comments on `bucket_options` for details.\n\nThe i'th f
inite 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 t
he 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", |
475 "type": "string" | |
476 }, | |
477 "metricValues": { | |
478 "description": "The values in this metric.", | |
479 "items": { | 742 "items": { |
480 "$ref": "MetricValue" | 743 "format": "double", |
| 744 "type": "number" |
481 }, | 745 }, |
482 "type": "array" | 746 "type": "array" |
483 } | 747 } |
484 }, | 748 }, |
485 "type": "object" | 749 "type": "object" |
486 }, | 750 }, |
487 "LinearBuckets": { | 751 "Distribution": { |
488 "description": "Describing buckets with constant width.", | 752 "description": "Distribution represents a frequency distribution of
double-valued sample\npoints. It contains the size of the population of sample p
oints plus\nadditional optional information:\n\n - the arithmetic mean of the s
amples\n - the minimum and maximum of the samples\n - the sum-squared-deviatio
n of the samples, used to compute variance\n - a histogram of the values of the
sample points", |
489 "id": "LinearBuckets", | 753 "id": "Distribution", |
490 "properties": { | 754 "properties": { |
491 "width": { | 755 "explicitBuckets": { |
492 "description": "The i'th linear bucket covers the interval\n
[offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_fin
ite_buckets, inclusive.\nMust be strictly positive.", | 756 "$ref": "ExplicitBuckets", |
| 757 "description": "Buckets with arbitrary user-provided width." |
| 758 }, |
| 759 "maximum": { |
| 760 "description": "The maximum of the population of values. Ign
ored if `count` is zero.", |
493 "format": "double", | 761 "format": "double", |
494 "type": "number" | 762 "type": "number" |
495 }, | 763 }, |
496 "offset": { | 764 "sumOfSquaredDeviation": { |
497 "description": "The i'th linear bucket covers the interval\n
[offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_fin
ite_buckets, inclusive.", | 765 "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 `coun
t` is zero then this field\nmust be zero, otherwise validation of the request fa
ils.", |
498 "format": "double", | 766 "format": "double", |
499 "type": "number" | 767 "type": "number" |
500 }, | 768 }, |
| 769 "exponentialBuckets": { |
| 770 "$ref": "ExponentialBuckets", |
| 771 "description": "Buckets with exponentially growing width." |
| 772 }, |
| 773 "minimum": { |
| 774 "description": "The minimum of the population of values. Ign
ored if `count` is zero.", |
| 775 "format": "double", |
| 776 "type": "number" |
| 777 }, |
| 778 "linearBuckets": { |
| 779 "$ref": "LinearBuckets", |
| 780 "description": "Buckets with constant width." |
| 781 }, |
| 782 "mean": { |
| 783 "description": "The arithmetic mean of the samples in the di
stribution. If `count` is\nzero then this field must be zero.", |
| 784 "format": "double", |
| 785 "type": "number" |
| 786 }, |
| 787 "count": { |
| 788 "description": "The total number of samples in the distribut
ion. Must be >= 0.", |
| 789 "format": "int64", |
| 790 "type": "string" |
| 791 }, |
| 792 "bucketCounts": { |
| 793 "description": "The number of samples in each histogram buck
et. `bucket_counts` are\noptional. If present, they must sum to the `count` valu
e.\n\nThe buckets are defined below in `bucket_option`. There are N buckets.\n`b
ucket_counts[0]` is the number of samples in the underflow bucket.\n`bucket_coun
ts[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.", |
| 794 "items": { |
| 795 "format": "int64", |
| 796 "type": "string" |
| 797 }, |
| 798 "type": "array" |
| 799 } |
| 800 }, |
| 801 "type": "object" |
| 802 }, |
| 803 "ExponentialBuckets": { |
| 804 "description": "Describing buckets with exponentially growing width.
", |
| 805 "id": "ExponentialBuckets", |
| 806 "properties": { |
| 807 "growthFactor": { |
| 808 "description": "The i'th exponential bucket covers the inter
val\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges fr
om 1 to num_finite_buckets inclusive.\nMust be larger than 1.0.", |
| 809 "format": "double", |
| 810 "type": "number" |
| 811 }, |
| 812 "scale": { |
| 813 "description": "The i'th exponential bucket covers the inter
val\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges fr
om 1 to num_finite_buckets inclusive.\nMust be > 0.", |
| 814 "format": "double", |
| 815 "type": "number" |
| 816 }, |
501 "numFiniteBuckets": { | 817 "numFiniteBuckets": { |
502 "description": "The number of finite buckets. With the under
flow and overflow buckets,\nthe total number of buckets is `num_finite_buckets`
+ 2.\nSee comments on `bucket_options` for details.", | 818 "description": "The number of finite buckets. With the under
flow and overflow buckets,\nthe total number of buckets is `num_finite_buckets`
+ 2.\nSee comments on `bucket_options` for details.", |
503 "format": "int32", | 819 "format": "int32", |
504 "type": "integer" | 820 "type": "integer" |
505 } | 821 } |
506 }, | 822 }, |
507 "type": "object" | 823 "type": "object" |
508 }, | 824 }, |
509 "CheckResponse": { | 825 "AuthorizationInfo": { |
510 "description": "Response message for the Check method.", | 826 "description": "Authorization information for the operation.", |
511 "id": "CheckResponse", | 827 "id": "AuthorizationInfo", |
512 "properties": { | 828 "properties": { |
513 "checkErrors": { | 829 "resource": { |
514 "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."
, | 830 "description": "The resource being accessed, as a REST-style
string. For example:\n\n bigquery.googlapis.com/projects/PROJECTID/datasets/
DATASETID", |
515 "items": { | 831 "type": "string" |
516 "$ref": "CheckError" | 832 }, |
| 833 "granted": { |
| 834 "description": "Whether or not authorization for `resource`
and `permission`\nwas granted.", |
| 835 "type": "boolean" |
| 836 }, |
| 837 "permission": { |
| 838 "description": "The required IAM permission.", |
| 839 "type": "string" |
| 840 } |
| 841 }, |
| 842 "type": "object" |
| 843 }, |
| 844 "StartReconciliationResponse": { |
| 845 "id": "StartReconciliationResponse", |
| 846 "properties": { |
| 847 "quotaMetrics": { |
| 848 "description": "Metric values as tracked by One Platform bef
ore the start of\nreconciliation.", |
| 849 "items": { |
| 850 "$ref": "MetricValueSet" |
517 }, | 851 }, |
518 "type": "array" | 852 "type": "array" |
519 }, | 853 }, |
520 "operationId": { | 854 "operationId": { |
521 "description": "The same operation_id value used in the Chec
kRequest.\nUsed for logging and diagnostics purposes.", | 855 "description": "The same operation_id value used in the Star
tReconciliationRequest. Used\nfor logging and diagnostics purposes.", |
522 "type": "string" | 856 "type": "string" |
523 }, | 857 }, |
524 "serviceConfigId": { | 858 "reconciliationErrors": { |
525 "description": "The actual config id used to process the req
uest.", | 859 "description": "Indicates the decision of the reconciliation
start.", |
526 "type": "string" | 860 "items": { |
527 } | 861 "$ref": "QuotaError" |
528 }, | 862 }, |
529 "type": "object" | 863 "type": "array" |
530 }, | 864 }, |
531 "ReportResponse": { | 865 "serviceConfigId": { |
532 "description": "Response message for the Report method.", | 866 "description": "ID of the actual config used to process the
request.", |
533 "id": "ReportResponse", | 867 "type": "string" |
534 "properties": { | 868 } |
535 "reportErrors": { | 869 }, |
536 "description": "Partial failures, one for each `Operation` i
n the request that failed\nprocessing. There are three possible combinations of
the RPC status:\n\n1. The combination of a successful RPC status and an empty `r
eport_errors`\n list indicates a complete success where all `Operations` in th
e\n request are processed successfully.\n2. The combination of a successful RP
C status and a non-empty\n `report_errors` list indicates a partial success wh
ere some\n `Operations` in the request succeeded. Each\n `Operation` that fa
iled processing has a corresponding item\n in this list.\n3. A failed RPC stat
us indicates a general non-deterministic failure.\n When this happens, it's im
possible to know which of the\n 'Operations' in the request succeeded or faile
d.", | 870 "type": "object" |
537 "items": { | 871 }, |
538 "$ref": "ReportError" | 872 "QuotaProperties": { |
539 }, | 873 "description": "Represents the properties needed for quota operation
s.\n\nUse the metric_value_sets field in Operation message to provide cost\nover
ride with metric_name in <service_name>/quota/<quota_group_name>/cost\nformat. O
verrides for unmatched quota groups will be ignored.\nCosts are expected to be >
= 0. Cost 0 will cause no quota check,\nbut still traffic restrictions will be e
nforced.", |
540 "type": "array" | 874 "id": "QuotaProperties", |
541 }, | 875 "properties": { |
542 "serviceConfigId": { | 876 "limitByIds": { |
543 "description": "The actual config id used to process the req
uest.", | 877 "additionalProperties": { |
544 "type": "string" | |
545 } | |
546 }, | |
547 "type": "object" | |
548 }, | |
549 "Distribution": { | |
550 "description": "Distribution represents a frequency distribution of
double-valued sample\npoints. It contains the size of the population of sample p
oints plus\nadditional optional information:\n\n - the arithmetic mean of the s
amples\n - the minimum and maximum of the samples\n - the sum-squared-deviatio
n of the samples, used to compute variance\n - a histogram of the values of the
sample points", | |
551 "id": "Distribution", | |
552 "properties": { | |
553 "bucketCounts": { | |
554 "description": "The number of samples in each histogram buck
et. `bucket_counts` are\noptional. If present, they must sum to the `count` valu
e.\n\nThe buckets are defined below in `bucket_option`. There are N buckets.\n`b
ucket_counts[0]` is the number of samples in the underflow bucket.\n`bucket_coun
ts[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.", | |
555 "items": { | |
556 "format": "int64", | |
557 "type": "string" | 878 "type": "string" |
558 }, | 879 }, |
559 "type": "array" | 880 "description": "LimitType IDs that should be used for checki
ng 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 b
e used for enforcing user-level quota\n limits. If none specified, caller I
P passed in the\n servicecontrol.googleapis.com/caller_ip label will be use
d instead.\n If the server cannot resolve a value for this LimitType, an er
ror\n will be thrown. No validation will be performed on this ID.\nDeprecat
ed: use servicecontrol.googleapis.com/user label to send user ID.", |
560 }, | 881 "type": "object" |
561 "exponentialBuckets": { | 882 }, |
562 "$ref": "ExponentialBuckets", | 883 "quotaMode": { |
563 "description": "Buckets with exponentially growing width." | 884 "description": "Quota mode for this operation.", |
564 }, | 885 "enum": [ |
565 "explicitBuckets": { | 886 "ACQUIRE", |
566 "$ref": "ExplicitBuckets", | 887 "ACQUIRE_BEST_EFFORT", |
567 "description": "Buckets with arbitrary user-provided width." | 888 "CHECK", |
568 }, | 889 "RELEASE" |
569 "maximum": { | 890 ], |
570 "description": "The maximum of the population of values. Ign
ored if `count` is zero.", | 891 "enumDescriptions": [ |
| 892 "Decreases available quota by the cost specified for the
operation.\nIf cost is higher than available quota, operation fails and returns
\nerror.", |
| 893 "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.", |
| 894 "Does not change any available quota. Only checks if the
re is enough\nquota.\nNo lock is placed on the checked tokens neither.", |
| 895 "Increases available quota by the operation cost specifi
ed for the\noperation." |
| 896 ], |
| 897 "type": "string" |
| 898 } |
| 899 }, |
| 900 "type": "object" |
| 901 }, |
| 902 "LinearBuckets": { |
| 903 "description": "Describing buckets with constant width.", |
| 904 "id": "LinearBuckets", |
| 905 "properties": { |
| 906 "offset": { |
| 907 "description": "The i'th linear bucket covers the interval\n
[offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_fin
ite_buckets, inclusive.", |
571 "format": "double", | 908 "format": "double", |
572 "type": "number" | 909 "type": "number" |
573 }, | 910 }, |
574 "count": { | 911 "numFiniteBuckets": { |
575 "description": "The total number of samples in the distribut
ion. Must be >= 0.", | 912 "description": "The number of finite buckets. With the under
flow and overflow buckets,\nthe total number of buckets is `num_finite_buckets`
+ 2.\nSee comments on `bucket_options` for details.", |
576 "format": "int64", | 913 "format": "int32", |
577 "type": "string" | 914 "type": "integer" |
578 }, | 915 }, |
579 "linearBuckets": { | 916 "width": { |
580 "$ref": "LinearBuckets", | 917 "description": "The i'th linear bucket covers the interval\n
[offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_fin
ite_buckets, inclusive.\nMust be strictly positive.", |
581 "description": "Buckets with constant width." | |
582 }, | |
583 "sumOfSquaredDeviation": { | |
584 "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 `coun
t` is zero then this field\nmust be zero, otherwise validation of the request fa
ils.", | |
585 "format": "double", | 918 "format": "double", |
586 "type": "number" | 919 "type": "number" |
587 }, | 920 } |
588 "minimum": { | 921 }, |
589 "description": "The minimum of the population of values. Ign
ored if `count` is zero.", | 922 "type": "object" |
590 "format": "double", | 923 }, |
591 "type": "number" | 924 "AuthenticationInfo": { |
592 }, | 925 "description": "Authentication information for the operation.", |
593 "mean": { | 926 "id": "AuthenticationInfo", |
594 "description": "The arithmetic mean of the samples in the di
stribution. If `count` is\nzero then this field must be zero.", | 927 "properties": { |
595 "format": "double", | 928 "principalEmail": { |
596 "type": "number" | 929 "description": "The email address of the authenticated user
making the request.", |
597 } | 930 "type": "string" |
598 }, | 931 }, |
599 "type": "object" | 932 "authoritySelector": { |
600 }, | 933 "description": "The authority selector specified by the requ
estor, if any.\nIt is not guaranteed that the principal was allowed to use this
authority.", |
601 "ExplicitBuckets": { | 934 "type": "string" |
602 "description": "Describing buckets with arbitrary user-provided widt
h.", | 935 } |
603 "id": "ExplicitBuckets", | 936 }, |
604 "properties": { | 937 "type": "object" |
605 "bounds": { | 938 }, |
606 "description": "'bound' is a list of strictly increasing bou
ndaries between\nbuckets. Note that a list of length N-1 defines N buckets becau
se\nof fenceposting. See comments on `bucket_options` for details.\n\nThe i'th f
inite 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 t
he 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", | 939 "AllocateQuotaResponse": { |
607 "items": { | 940 "description": "Response message for the AllocateQuota method.", |
608 "format": "double", | 941 "id": "AllocateQuotaResponse", |
609 "type": "number" | 942 "properties": { |
610 }, | 943 "quotaMetrics": { |
611 "type": "array" | 944 "description": "Quota metrics to indicate the result of allo
cation. 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.g
oogleapis.com/api/consumer/quota_used_count\"\n\n2. For allocation quota, per qu
ota 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.co
m/quota/exceeded\"", |
612 } | 945 "items": { |
613 }, | 946 "$ref": "MetricValueSet" |
614 "type": "object" | 947 }, |
615 }, | 948 "type": "array" |
616 "MetricValue": { | 949 }, |
617 "description": "Represents a single metric value.", | 950 "operationId": { |
618 "id": "MetricValue", | 951 "description": "The same operation_id value used in the Allo
cateQuotaRequest. Used for\nlogging and diagnostics purposes.", |
619 "properties": { | 952 "type": "string" |
620 "stringValue": { | 953 }, |
621 "description": "A text string value.", | 954 "serviceConfigId": { |
622 "type": "string" | 955 "description": "ID of the actual config used to process the
request.", |
623 }, | 956 "type": "string" |
624 "doubleValue": { | 957 }, |
625 "description": "A double precision floating point value.", | 958 "allocateErrors": { |
626 "format": "double", | 959 "description": "Indicates the decision of the allocate.", |
627 "type": "number" | 960 "items": { |
628 }, | 961 "$ref": "QuotaError" |
629 "boolValue": { | 962 }, |
630 "description": "A boolean value.", | 963 "type": "array" |
| 964 } |
| 965 }, |
| 966 "type": "object" |
| 967 }, |
| 968 "ReleaseQuotaRequest": { |
| 969 "description": "Request message for the ReleaseQuota method.", |
| 970 "id": "ReleaseQuotaRequest", |
| 971 "properties": { |
| 972 "serviceConfigId": { |
| 973 "description": "Specifies which version of service configura
tion should be used to process\nthe request. If unspecified or no matching versi
on can be found, the latest\none will be used.", |
| 974 "type": "string" |
| 975 }, |
| 976 "releaseOperation": { |
| 977 "$ref": "QuotaOperation", |
| 978 "description": "Operation that describes the quota release." |
| 979 } |
| 980 }, |
| 981 "type": "object" |
| 982 }, |
| 983 "RequestMetadata": { |
| 984 "description": "Metadata about the request.", |
| 985 "id": "RequestMetadata", |
| 986 "properties": { |
| 987 "callerIp": { |
| 988 "description": "The IP address of the caller.", |
| 989 "type": "string" |
| 990 }, |
| 991 "callerSuppliedUserAgent": { |
| 992 "description": "The user agent of the caller.\nThis informat
ion 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 c
lient 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+ `Ap
pEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`:\n T
he request was made from the `my-project` App Engine app.", |
| 993 "type": "string" |
| 994 } |
| 995 }, |
| 996 "type": "object" |
| 997 }, |
| 998 "QuotaError": { |
| 999 "id": "QuotaError", |
| 1000 "properties": { |
| 1001 "subject": { |
| 1002 "description": "Subject to whom this error applies. See the
specific enum for more details\non this field. For example, \"clientip:<ip addre
ss of client>\" or\n\"project:<Google developer project id>\".", |
| 1003 "type": "string" |
| 1004 }, |
| 1005 "description": { |
| 1006 "description": "Free-form text that provides details on the
cause of the error.", |
| 1007 "type": "string" |
| 1008 }, |
| 1009 "code": { |
| 1010 "description": "Error code.", |
| 1011 "enum": [ |
| 1012 "UNSPECIFIED", |
| 1013 "RESOURCE_EXHAUSTED", |
| 1014 "PROJECT_SUSPENDED", |
| 1015 "SERVICE_NOT_ENABLED", |
| 1016 "BILLING_NOT_ACTIVE", |
| 1017 "PROJECT_DELETED", |
| 1018 "PROJECT_INVALID", |
| 1019 "IP_ADDRESS_BLOCKED", |
| 1020 "REFERER_BLOCKED", |
| 1021 "CLIENT_APP_BLOCKED", |
| 1022 "API_KEY_INVALID", |
| 1023 "API_KEY_EXPIRED", |
| 1024 "SPATULA_HEADER_INVALID", |
| 1025 "LOAS_ROLE_INVALID", |
| 1026 "NO_LOAS_PROJECT", |
| 1027 "PROJECT_STATUS_UNVAILABLE", |
| 1028 "SERVICE_STATUS_UNAVAILABLE", |
| 1029 "BILLING_STATUS_UNAVAILABLE", |
| 1030 "QUOTA_SYSTEM_UNAVAILABLE" |
| 1031 ], |
| 1032 "enumDescriptions": [ |
| 1033 "This is never used.", |
| 1034 "Quota allocation failed.\nSame as google.rpc.Code.RESOU
RCE_EXHAUSTED.", |
| 1035 "Consumer project has been suspended.", |
| 1036 "Consumer has not enabled the service.", |
| 1037 "Consumer cannot access the service because billing is d
isabled.", |
| 1038 "Consumer's project has been marked as deleted (soft del
etion).", |
| 1039 "Consumer's project number or ID does not represent a va
lid project.", |
| 1040 "IP address of the consumer is invalid for the specific
consumer\nproject.", |
| 1041 "Referer address of the consumer request is invalid for
the specific\nconsumer project.", |
| 1042 "Client application of the consumer request is invalid f
or the\nspecific consumer project.", |
| 1043 "Specified API key is invalid.", |
| 1044 "Specified API Key has expired.", |
| 1045 "Consumer's spatula header is invalid.", |
| 1046 "The consumer's LOAS role is invalid.", |
| 1047 "The consumer's LOAS role has no associated project.", |
| 1048 "The backend server for looking up project id/number is
unavailable.", |
| 1049 "The backend server for checking service status is unava
ilable.", |
| 1050 "The backend server for checking billing status is unava
ilable.", |
| 1051 "The backend server for checking quota limits is unavail
able." |
| 1052 ], |
| 1053 "type": "string" |
| 1054 } |
| 1055 }, |
| 1056 "type": "object" |
| 1057 }, |
| 1058 "CheckInfo": { |
| 1059 "id": "CheckInfo", |
| 1060 "properties": { |
| 1061 "unusedArguments": { |
| 1062 "description": "A list of fields and label keys that are ign
ored by the server.\nThe client doesn't need to send them for following requests
to improve\nperformance and allow better aggregation.", |
| 1063 "items": { |
| 1064 "type": "string" |
| 1065 }, |
| 1066 "type": "array" |
| 1067 } |
| 1068 }, |
| 1069 "type": "object" |
| 1070 }, |
| 1071 "ReleaseQuotaResponse": { |
| 1072 "description": "Response message for the ReleaseQuota method.", |
| 1073 "id": "ReleaseQuotaResponse", |
| 1074 "properties": { |
| 1075 "operationId": { |
| 1076 "description": "The same operation_id value used in the Rele
aseQuotaRequest. Used for\nlogging and diagnostics purposes.", |
| 1077 "type": "string" |
| 1078 }, |
| 1079 "serviceConfigId": { |
| 1080 "description": "ID of the actual config used to process the
request.", |
| 1081 "type": "string" |
| 1082 }, |
| 1083 "releaseErrors": { |
| 1084 "description": "Indicates the decision of the release.", |
| 1085 "items": { |
| 1086 "$ref": "QuotaError" |
| 1087 }, |
| 1088 "type": "array" |
| 1089 }, |
| 1090 "quotaMetrics": { |
| 1091 "description": "Quota metrics to indicate the result of rele
ase. Depending on the\nrequest, one or more of the following metrics will be inc
luded:\n\n1. For rate quota, per quota group or per quota metric released amount
\nwill be specified using the following delta metric:\n \"serviceruntime.google
apis.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 \"se
rviceruntime.googleapis.com/allocation/consumer/quota_used_count\"", |
| 1092 "items": { |
| 1093 "$ref": "MetricValueSet" |
| 1094 }, |
| 1095 "type": "array" |
| 1096 } |
| 1097 }, |
| 1098 "type": "object" |
| 1099 }, |
| 1100 "AllocateQuotaRequest": { |
| 1101 "description": "Request message for the AllocateQuota method.", |
| 1102 "id": "AllocateQuotaRequest", |
| 1103 "properties": { |
| 1104 "serviceConfigId": { |
| 1105 "description": "Specifies which version of service configura
tion should be used to process\nthe request. If unspecified or no matching versi
on can be found, the latest\none will be used.", |
| 1106 "type": "string" |
| 1107 }, |
| 1108 "allocateOperation": { |
| 1109 "$ref": "QuotaOperation", |
| 1110 "description": "Operation that describes the quota allocatio
n." |
| 1111 }, |
| 1112 "allocationMode": { |
| 1113 "description": "Allocation mode for this operation.\nDepreca
ted: use QuotaMode inside the QuotaOperation.", |
| 1114 "enum": [ |
| 1115 "UNSPECIFIED", |
| 1116 "NORMAL", |
| 1117 "BEST_EFFORT", |
| 1118 "CHECK_ONLY" |
| 1119 ], |
| 1120 "enumDescriptions": [ |
| 1121 "", |
| 1122 "Allocates quota for the amount specified in the service
configuration or\nspecified using the quota_metrics. If the amount is higher th
an the\navailable quota, allocation error will be returned and no quota will be\
nallocated.", |
| 1123 "Allocates quota for the amount specified in the service
configuration or\nspecified using the quota_metrics. If the amount is higher th
an the\navailable quota, request does not fail but all available quota will be\n
allocated.", |
| 1124 "Only checks if there is enough quota available and does
not change the\navailable quota. No lock is placed on the available quota eithe
r." |
| 1125 ], |
| 1126 "type": "string" |
| 1127 } |
| 1128 }, |
| 1129 "type": "object" |
| 1130 }, |
| 1131 "MetricValueSet": { |
| 1132 "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.", |
| 1133 "id": "MetricValueSet", |
| 1134 "properties": { |
| 1135 "metricValues": { |
| 1136 "description": "The values in this metric.", |
| 1137 "items": { |
| 1138 "$ref": "MetricValue" |
| 1139 }, |
| 1140 "type": "array" |
| 1141 }, |
| 1142 "metricName": { |
| 1143 "description": "The metric name defined in the service confi
guration.", |
| 1144 "type": "string" |
| 1145 } |
| 1146 }, |
| 1147 "type": "object" |
| 1148 }, |
| 1149 "ReportError": { |
| 1150 "description": "Represents the processing error of one `Operation` i
n the request.", |
| 1151 "id": "ReportError", |
| 1152 "properties": { |
| 1153 "operationId": { |
| 1154 "description": "The Operation.operation_id value from the re
quest.", |
| 1155 "type": "string" |
| 1156 }, |
| 1157 "status": { |
| 1158 "$ref": "Status", |
| 1159 "description": "Details of the error when processing the `Op
eration`." |
| 1160 } |
| 1161 }, |
| 1162 "type": "object" |
| 1163 }, |
| 1164 "CheckError": { |
| 1165 "description": "Defines the errors to be returned in\ngoogle.api.ser
vicecontrol.v1.CheckResponse.check_errors.", |
| 1166 "id": "CheckError", |
| 1167 "properties": { |
| 1168 "detail": { |
| 1169 "description": "Free-form text providing details on the erro
r cause of the error.", |
| 1170 "type": "string" |
| 1171 }, |
| 1172 "code": { |
| 1173 "description": "The error code.", |
| 1174 "enum": [ |
| 1175 "ERROR_CODE_UNSPECIFIED", |
| 1176 "NOT_FOUND", |
| 1177 "PERMISSION_DENIED", |
| 1178 "RESOURCE_EXHAUSTED", |
| 1179 "BUDGET_EXCEEDED", |
| 1180 "DENIAL_OF_SERVICE_DETECTED", |
| 1181 "LOAD_SHEDDING", |
| 1182 "ABUSER_DETECTED", |
| 1183 "SERVICE_NOT_ACTIVATED", |
| 1184 "VISIBILITY_DENIED", |
| 1185 "BILLING_DISABLED", |
| 1186 "PROJECT_DELETED", |
| 1187 "PROJECT_INVALID", |
| 1188 "IP_ADDRESS_BLOCKED", |
| 1189 "REFERER_BLOCKED", |
| 1190 "CLIENT_APP_BLOCKED", |
| 1191 "API_TARGET_BLOCKED", |
| 1192 "API_KEY_INVALID", |
| 1193 "API_KEY_EXPIRED", |
| 1194 "API_KEY_NOT_FOUND", |
| 1195 "SPATULA_HEADER_INVALID", |
| 1196 "LOAS_ROLE_INVALID", |
| 1197 "NO_LOAS_PROJECT", |
| 1198 "LOAS_PROJECT_DISABLED", |
| 1199 "SECURITY_POLICY_VIOLATED", |
| 1200 "NAMESPACE_LOOKUP_UNAVAILABLE", |
| 1201 "SERVICE_STATUS_UNAVAILABLE", |
| 1202 "BILLING_STATUS_UNAVAILABLE", |
| 1203 "QUOTA_CHECK_UNAVAILABLE", |
| 1204 "LOAS_PROJECT_LOOKUP_UNAVAILABLE", |
| 1205 "CLOUD_RESOURCE_MANAGER_BACKEND_UNAVAILABLE", |
| 1206 "SECURITY_POLICY_BACKEND_UNAVAILABLE" |
| 1207 ], |
| 1208 "enumDescriptions": [ |
| 1209 "This is never used in `CheckResponse`.", |
| 1210 "The consumer's project id was not found.\nSame as googl
e.rpc.Code.NOT_FOUND.", |
| 1211 "The consumer doesn't have access to the specified resou
rce.\nSame as google.rpc.Code.PERMISSION_DENIED.", |
| 1212 "Quota check failed. Same as google.rpc.Code.RESOURCE_EX
HAUSTED.", |
| 1213 "Budget check failed.", |
| 1214 "The consumer's request has been flagged as a DoS attack
.", |
| 1215 "The consumer's request should be rejected in order to p
rotect the service\nfrom being overloaded.", |
| 1216 "The consumer has been flagged as an abuser.", |
| 1217 "The consumer hasn't activated the service.", |
| 1218 "The consumer cannot access the service due to visibilit
y configuration.", |
| 1219 "The consumer cannot access the service because billing
is disabled.", |
| 1220 "The consumer's project has been marked as deleted (soft
deletion).", |
| 1221 "The consumer's project number or id does not represent
a valid project.", |
| 1222 "The IP address of the consumer is invalid for the speci
fic consumer\nproject.", |
| 1223 "The referer address of the consumer request is invalid
for the specific\nconsumer project.", |
| 1224 "The client application of the consumer request is inval
id for the\nspecific consumer project.", |
| 1225 "The API targeted by this request is invalid for the spe
cified consumer\nproject.", |
| 1226 "The consumer's API key is invalid.", |
| 1227 "The consumer's API Key has expired.", |
| 1228 "The consumer's API Key was not found in config record."
, |
| 1229 "The consumer's spatula header is invalid.", |
| 1230 "The consumer's LOAS role is invalid.", |
| 1231 "The consumer's LOAS role has no associated project.", |
| 1232 "The consumer's LOAS project is not `ACTIVE` in LoquatV2
.", |
| 1233 "Request is not allowed as per security policies defined
in Org Policy.", |
| 1234 "The backend server for looking up project id/number is
unavailable.", |
| 1235 "The backend server for checking service status is unava
ilable.", |
| 1236 "The backend server for checking billing status is unava
ilable.", |
| 1237 "The backend server for checking quota limits is unavail
able.", |
| 1238 "The Spanner for looking up LOAS project is unavailable.
", |
| 1239 "Cloud Resource Manager backend server is unavailable.", |
| 1240 "Backend server for evaluating security policy is unavai
lable." |
| 1241 ], |
| 1242 "type": "string" |
| 1243 } |
| 1244 }, |
| 1245 "type": "object" |
| 1246 }, |
| 1247 "StartReconciliationRequest": { |
| 1248 "id": "StartReconciliationRequest", |
| 1249 "properties": { |
| 1250 "reconciliationOperation": { |
| 1251 "$ref": "QuotaOperation", |
| 1252 "description": "Operation that describes the quota reconcili
ation." |
| 1253 }, |
| 1254 "serviceConfigId": { |
| 1255 "description": "Specifies which version of service configura
tion should be used to process\nthe request. If unspecified or no matching versi
on can be found, the latest\none will be used.", |
| 1256 "type": "string" |
| 1257 } |
| 1258 }, |
| 1259 "type": "object" |
| 1260 }, |
| 1261 "QuotaInfo": { |
| 1262 "description": "Contains the quota information for a quota check res
ponse.", |
| 1263 "id": "QuotaInfo", |
| 1264 "properties": { |
| 1265 "limitExceeded": { |
| 1266 "description": "Quota Metrics that have exceeded quota limit
s.\nFor QuotaGroup-based quota, this is QuotaGroup.name\nFor QuotaLimit-based qu
ota, this is QuotaLimit.name\nSee: google.api.Quota\nDeprecated: Use quota_metri
cs to get per quota group limit exceeded status.", |
| 1267 "items": { |
| 1268 "type": "string" |
| 1269 }, |
| 1270 "type": "array" |
| 1271 }, |
| 1272 "quotaConsumed": { |
| 1273 "additionalProperties": { |
| 1274 "format": "int32", |
| 1275 "type": "integer" |
| 1276 }, |
| 1277 "description": "Map of quota group name to the actual number
of tokens consumed. If the\nquota check was not successful, then this will not
be populated due to no\nquota consumption.\nDeprecated: Use quota_metrics to get
per quota group usage.", |
| 1278 "type": "object" |
| 1279 }, |
| 1280 "quotaMetrics": { |
| 1281 "description": "Quota metrics to indicate the usage. Dependi
ng on the check request, one or\nmore of the following metrics will be included:
\n\n1. For rate quota, per quota group or per quota metric incremental usage\nwi
ll be specified using the following delta metric:\n \"serviceruntime.googleapis
.com/api/consumer/quota_used_count\"\n\n2. For allocation quota, per quota metri
c total usage will be specified\nusing the following gauge metric:\n \"servicer
untime.googleapis.com/allocation/consumer/quota_used_count\"\n\n3. For both rate
quota and allocation quota, the quota limit reached\ncondition will be specifie
d using the following boolean metric:\n \"serviceruntime.googleapis.com/quota/e
xceeded\"", |
| 1282 "items": { |
| 1283 "$ref": "MetricValueSet" |
| 1284 }, |
| 1285 "type": "array" |
| 1286 } |
| 1287 }, |
| 1288 "type": "object" |
| 1289 }, |
| 1290 "CheckRequest": { |
| 1291 "description": "Request message for the Check method.", |
| 1292 "id": "CheckRequest", |
| 1293 "properties": { |
| 1294 "serviceConfigId": { |
| 1295 "description": "Specifies which version of service configura
tion should be used to process\nthe request.\n\nIf unspecified or no matching ve
rsion can be found, the\nlatest one will be used.", |
| 1296 "type": "string" |
| 1297 }, |
| 1298 "skipActivationCheck": { |
| 1299 "description": "Indicates if service activation check should
be skipped for this request.\nDefault behavior is to perform the check and appl
y relevant quota.", |
631 "type": "boolean" | 1300 "type": "boolean" |
632 }, | 1301 }, |
633 "endTime": { | 1302 "operation": { |
634 "description": "The end of the time period over which this m
etric value's measurement\napplies.", | 1303 "$ref": "Operation", |
635 "format": "google-datetime", | 1304 "description": "The operation to be checked." |
636 "type": "string" | 1305 }, |
| 1306 "requestProjectSettings": { |
| 1307 "description": "Requests the project settings to be returned
as part of the check response.", |
| 1308 "type": "boolean" |
| 1309 } |
| 1310 }, |
| 1311 "type": "object" |
| 1312 }, |
| 1313 "QuotaOperation": { |
| 1314 "description": "Represents information regarding a quota operation."
, |
| 1315 "id": "QuotaOperation", |
| 1316 "properties": { |
| 1317 "quotaMetrics": { |
| 1318 "description": "Represents information about this operation.
Each MetricValueSet\ncorresponds to a metric defined in the service configurati
on.\nThe data type used in the MetricValueSet must agree with\nthe data type spe
cified 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 an
d identical\nlabel value combinations. If a request has such duplicated MetricVa
lue\ninstances, the entire request is rejected with\nan invalid argument error."
, |
| 1319 "items": { |
| 1320 "$ref": "MetricValueSet" |
| 1321 }, |
| 1322 "type": "array" |
637 }, | 1323 }, |
638 "labels": { | 1324 "labels": { |
639 "additionalProperties": { | 1325 "additionalProperties": { |
640 "type": "string" | 1326 "type": "string" |
641 }, | 1327 }, |
642 "description": "The labels describing the metric value.\nSee
comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding r
elationship.", | 1328 "description": "Labels describing the operation.", |
643 "type": "object" | 1329 "type": "object" |
644 }, | 1330 }, |
645 "distributionValue": { | 1331 "consumerId": { |
646 "$ref": "Distribution", | 1332 "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>
.", |
647 "description": "A distribution value." | 1333 "type": "string" |
648 }, | 1334 }, |
649 "startTime": { | 1335 "operationId": { |
650 "description": "The start of the time period over which this
metric value's measurement\napplies. The time period has different semantics fo
r different metric\ntypes (cumulative, delta, and gauge). See the metric definit
ion\ndocumentation in the service configuration for details.", | 1336 "description": "Identity of the operation. This must be uniq
ue within the scope of the\nservice that generated the operation. If the service
calls AllocateQuota\nand ReleaseQuota on the same operation, the two calls shou
ld 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 idem
potent id is\ndesirable for deduplication purpose, UUID version 5 is recommended
. See\nRFC 4122 for details.", |
651 "format": "google-datetime", | 1337 "type": "string" |
652 "type": "string" | 1338 }, |
653 }, | 1339 "quotaMode": { |
654 "int64Value": { | 1340 "description": "Quota mode for this operation.", |
655 "description": "A signed 64-bit integer value.", | 1341 "enum": [ |
656 "format": "int64", | 1342 "UNSPECIFIED", |
657 "type": "string" | 1343 "NORMAL", |
658 } | 1344 "BEST_EFFORT", |
659 }, | 1345 "CHECK_ONLY" |
| 1346 ], |
| 1347 "enumDescriptions": [ |
| 1348 "", |
| 1349 "For AllocateQuota request, allocates quota for the amou
nt specified in\nthe service configuration or specified using the quota metrics.
If the\namount is higher than the available quota, allocation error will be\nre
turned and no quota will be allocated.\nFor ReleaseQuota request, this mode is s
upported only for precise quota\nlimits. In this case, this operation releases q
uota for the amount\nspecified in the service configuration or specified using t
he quota\nmetrics. If the release can make available quota negative, release err
or\nwill be returned and no quota will be released.", |
| 1350 "For AllocateQuota request, this mode is supported only
for imprecise\nquota limits. In this case, the operation allocates quota for the
amount\nspecified in the service configuration or specified using the quota\nme
trics. If the amount is higher than the available quota, request does\nnot fail
but all available quota will be allocated.\nFor ReleaseQuota request, this mode
is supported for both precise quota\nlimits and imprecise quota limits. In this
case, this operation releases\nquota for the amount specified in the service con
figuration or specified\nusing the quota metrics. If the release can make availa
ble quota\nnegative, request does not fail but only the available quota will be\
nreleased. After the ReleaseQuota request completes, the available quota\nwill b
e 0, and never goes to negative.", |
| 1351 "For AllocateQuota request, only checks if there is enou
gh quota\navailable and does not change the available quota. No lock is placed o
n\nthe available quota either. Not supported for ReleaseQuota request." |
| 1352 ], |
| 1353 "type": "string" |
| 1354 }, |
| 1355 "methodName": { |
| 1356 "description": "Fully qualified name of the API method for w
hich this quota operation is\nrequested. This name is used for matching quota ru
les 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 resou
rces.\n\nExample of an RPC method name:\n google.example.library.v1.LibrarySe
rvice.CreateShelf", |
| 1357 "type": "string" |
| 1358 } |
| 1359 }, |
660 "type": "object" | 1360 "type": "object" |
661 } | 1361 } |
662 }, | 1362 }, |
663 "servicePath": "", | 1363 "servicePath": "", |
664 "title": "Google Service Control API", | 1364 "title": "Google Service Control API", |
665 "version": "v1" | 1365 "version": "v1" |
666 } | 1366 } |
OLD | NEW |