Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(153)

Side by Side Diff: discovery/googleapis/servicecontrol__v1.json

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "View and manage your data across Google Clou d Platform services"
7 },
5 "https://www.googleapis.com/auth/servicecontrol": { 8 "https://www.googleapis.com/auth/servicecontrol": {
6 "description": "Manage your Google Service Control data" 9 "description": "Manage your Google Service Control data"
7 },
8 "https://www.googleapis.com/auth/cloud-platform": {
9 "description": "View and manage your data across Google Clou d Platform services"
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 "oauth_token": {
32 "description": "OAuth 2.0 token for the current user.",
33 "location": "query",
34 "type": "string"
35 },
36 "bearer_token": {
37 "description": "OAuth bearer token.",
38 "location": "query",
39 "type": "string"
40 },
41 "upload_protocol": { 31 "upload_protocol": {
42 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
43 "location": "query", 33 "location": "query",
44 "type": "string" 34 "type": "string"
45 }, 35 },
46 "prettyPrint": { 36 "prettyPrint": {
47 "default": "true", 37 "default": "true",
48 "description": "Returns response with indentations and line breaks." , 38 "description": "Returns response with indentations and line breaks." ,
49 "location": "query", 39 "location": "query",
50 "type": "boolean" 40 "type": "boolean"
51 }, 41 },
52 "uploadType": { 42 "uploadType": {
53 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 43 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
54 "location": "query", 44 "location": "query",
55 "type": "string" 45 "type": "string"
56 }, 46 },
57 "fields": { 47 "fields": {
58 "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.",
59 "location": "query", 49 "location": "query",
60 "type": "string" 50 "type": "string"
61 }, 51 },
62 "callback": {
63 "description": "JSONP",
64 "location": "query",
65 "type": "string"
66 },
67 "$.xgafv": { 52 "$.xgafv": {
68 "description": "V1 error format.", 53 "description": "V1 error format.",
69 "enum": [ 54 "enum": [
70 "1", 55 "1",
71 "2" 56 "2"
72 ], 57 ],
73 "enumDescriptions": [ 58 "enumDescriptions": [
74 "v1 error format", 59 "v1 error format",
75 "v2 error format" 60 "v2 error format"
76 ], 61 ],
77 "location": "query", 62 "location": "query",
78 "type": "string" 63 "type": "string"
79 }, 64 },
65 "callback": {
66 "description": "JSONP",
67 "location": "query",
68 "type": "string"
69 },
80 "alt": { 70 "alt": {
81 "default": "json", 71 "default": "json",
82 "description": "Data format for response.", 72 "description": "Data format for response.",
83 "enum": [ 73 "enum": [
84 "json", 74 "json",
85 "media", 75 "media",
86 "proto" 76 "proto"
87 ], 77 ],
88 "enumDescriptions": [ 78 "enumDescriptions": [
89 "Responses with Content-Type of application/json", 79 "Responses with Content-Type of application/json",
90 "Media download with context-dependent Content-Type", 80 "Media download with context-dependent Content-Type",
91 "Responses with Content-Type of application/x-protobuf" 81 "Responses with Content-Type of application/x-protobuf"
92 ], 82 ],
93 "location": "query", 83 "location": "query",
94 "type": "string" 84 "type": "string"
95 }, 85 },
86 "access_token": {
87 "description": "OAuth access token.",
88 "location": "query",
89 "type": "string"
90 },
96 "key": { 91 "key": {
97 "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.", 92 "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.",
98 "location": "query", 93 "location": "query",
99 "type": "string" 94 "type": "string"
100 }, 95 },
101 "access_token": {
102 "description": "OAuth access token.",
103 "location": "query",
104 "type": "string"
105 },
106 "quotaUser": { 96 "quotaUser": {
107 "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.", 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.",
108 "location": "query", 98 "location": "query",
109 "type": "string" 99 "type": "string"
110 }, 100 },
111 "pp": { 101 "pp": {
112 "default": "true", 102 "default": "true",
113 "description": "Pretty-print response.", 103 "description": "Pretty-print response.",
114 "location": "query", 104 "location": "query",
115 "type": "boolean" 105 "type": "boolean"
106 },
107 "bearer_token": {
108 "description": "OAuth bearer token.",
109 "location": "query",
110 "type": "string"
111 },
112 "oauth_token": {
113 "description": "OAuth 2.0 token for the current user.",
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 "endReconciliation": {
123 "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).",
124 "httpMethod": "POST",
125 "id": "servicecontrol.services.endReconciliation",
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}:endReconciliation",
138 "request": {
139 "$ref": "EndReconciliationRequest"
140 },
141 "response": {
142 "$ref": "EndReconciliationResponse"
143 },
144 "scopes": [
145 "https://www.googleapis.com/auth/cloud-platform",
146 "https://www.googleapis.com/auth/servicecontrol"
147 ]
148 },
122 "report": { 149 "report": {
123 "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).", 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 method requires the `servicemanagement.services.report` permission\non the specified s ervice. For more information, see\n[Google Cloud IAM](https://cloud.google.com/i am).",
124 "httpMethod": "POST", 151 "httpMethod": "POST",
125 "id": "servicecontrol.services.report", 152 "id": "servicecontrol.services.report",
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\n[goog le.api.Service](https://cloud.google.com/service-management/reference/rpc/google .api#google.api.Service)\nfor 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}:report", 164 "path": "v1/services/{serviceName}:report",
138 "request": { 165 "request": {
139 "$ref": "ReportRequest" 166 "$ref": "ReportRequest"
140 }, 167 },
141 "response": { 168 "response": {
(...skipping 52 matching lines...) Expand 10 before | Expand all | Expand 10 after
194 }, 221 },
195 "response": { 222 "response": {
196 "$ref": "StartReconciliationResponse" 223 "$ref": "StartReconciliationResponse"
197 }, 224 },
198 "scopes": [ 225 "scopes": [
199 "https://www.googleapis.com/auth/cloud-platform", 226 "https://www.googleapis.com/auth/cloud-platform",
200 "https://www.googleapis.com/auth/servicecontrol" 227 "https://www.googleapis.com/auth/servicecontrol"
201 ] 228 ]
202 }, 229 },
203 "check": { 230 "check": {
204 "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).", 231 "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 has the size limit of 64KB.\n\nThis method requires the `servicemanagement.services. check` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
205 "httpMethod": "POST", 232 "httpMethod": "POST",
206 "id": "servicecontrol.services.check", 233 "id": "servicecontrol.services.check",
207 "parameterOrder": [ 234 "parameterOrder": [
208 "serviceName" 235 "serviceName"
209 ], 236 ],
210 "parameters": { 237 "parameters": {
211 "serviceName": { 238 "serviceName": {
212 "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\n[goog le.api.Service](https://cloud.google.com/service-management/reference/rpc/google .api#google.api.Service)\nfor the definition of a service name.",
213 "location": "path", 240 "location": "path",
214 "required": true, 241 "required": true,
215 "type": "string" 242 "type": "string"
216 } 243 }
217 }, 244 },
218 "path": "v1/services/{serviceName}:check", 245 "path": "v1/services/{serviceName}:check",
219 "request": { 246 "request": {
220 "$ref": "CheckRequest" 247 "$ref": "CheckRequest"
221 }, 248 },
222 "response": { 249 "response": {
(...skipping 23 matching lines...) Expand all
246 "request": { 273 "request": {
247 "$ref": "ReleaseQuotaRequest" 274 "$ref": "ReleaseQuotaRequest"
248 }, 275 },
249 "response": { 276 "response": {
250 "$ref": "ReleaseQuotaResponse" 277 "$ref": "ReleaseQuotaResponse"
251 }, 278 },
252 "scopes": [ 279 "scopes": [
253 "https://www.googleapis.com/auth/cloud-platform", 280 "https://www.googleapis.com/auth/cloud-platform",
254 "https://www.googleapis.com/auth/servicecontrol" 281 "https://www.googleapis.com/auth/servicecontrol"
255 ] 282 ]
256 },
257 "endReconciliation": {
258 "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).",
259 "httpMethod": "POST",
260 "id": "servicecontrol.services.endReconciliation",
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}:endReconciliation",
273 "request": {
274 "$ref": "EndReconciliationRequest"
275 },
276 "response": {
277 "$ref": "EndReconciliationResponse"
278 },
279 "scopes": [
280 "https://www.googleapis.com/auth/cloud-platform",
281 "https://www.googleapis.com/auth/servicecontrol"
282 ]
283 } 283 }
284 } 284 }
285 } 285 }
286 }, 286 },
287 "revision": "20170813", 287 "revision": "20170904",
288 "rootUrl": "https://servicecontrol.googleapis.com/", 288 "rootUrl": "https://servicecontrol.googleapis.com/",
289 "schemas": { 289 "schemas": {
290 "StartReconciliationResponse": {
291 "id": "StartReconciliationResponse",
292 "properties": {
293 "quotaMetrics": {
294 "description": "Metric values as tracked by One Platform bef ore the start of\nreconciliation. The following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric :\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2 . Value for each quota limit associated with the metrics will be specified\nusin g the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"",
295 "items": {
296 "$ref": "MetricValueSet"
297 },
298 "type": "array"
299 },
300 "reconciliationErrors": {
301 "description": "Indicates the decision of the reconciliation start.",
302 "items": {
303 "$ref": "QuotaError"
304 },
305 "type": "array"
306 },
307 "operationId": {
308 "description": "The same operation_id value used in the Star tReconciliationRequest. Used\nfor logging and diagnostics purposes.",
309 "type": "string"
310 },
311 "serviceConfigId": {
312 "description": "ID of the actual config used to process the request.",
313 "type": "string"
314 }
315 },
316 "type": "object"
317 },
318 "QuotaProperties": { 290 "QuotaProperties": {
319 "description": "Represents the properties needed for quota operation s.", 291 "description": "Represents the properties needed for quota operation s.",
320 "id": "QuotaProperties", 292 "id": "QuotaProperties",
321 "properties": { 293 "properties": {
322 "limitByIds": { 294 "limitByIds": {
323 "additionalProperties": { 295 "additionalProperties": {
324 "type": "string" 296 "type": "string"
325 }, 297 },
326 "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.", 298 "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.",
327 "type": "object" 299 "type": "object"
(...skipping 14 matching lines...) Expand all
342 ], 314 ],
343 "type": "string" 315 "type": "string"
344 } 316 }
345 }, 317 },
346 "type": "object" 318 "type": "object"
347 }, 319 },
348 "LinearBuckets": { 320 "LinearBuckets": {
349 "description": "Describing buckets with constant width.", 321 "description": "Describing buckets with constant width.",
350 "id": "LinearBuckets", 322 "id": "LinearBuckets",
351 "properties": { 323 "properties": {
324 "width": {
325 "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.",
326 "format": "double",
327 "type": "number"
328 },
352 "offset": { 329 "offset": {
353 "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.", 330 "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.",
354 "format": "double", 331 "format": "double",
355 "type": "number" 332 "type": "number"
356 }, 333 },
357 "numFiniteBuckets": { 334 "numFiniteBuckets": {
358 "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.", 335 "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.",
359 "format": "int32", 336 "format": "int32",
360 "type": "integer" 337 "type": "integer"
361 },
362 "width": {
363 "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.",
364 "format": "double",
365 "type": "number"
366 } 338 }
367 }, 339 },
368 "type": "object" 340 "type": "object"
369 }, 341 },
370 "AuthenticationInfo": { 342 "AuthenticationInfo": {
371 "description": "Authentication information for the operation.", 343 "description": "Authentication information for the operation.",
372 "id": "AuthenticationInfo", 344 "id": "AuthenticationInfo",
373 "properties": { 345 "properties": {
374 "principalEmail": { 346 "principalEmail": {
375 "description": "The email address of the authenticated user making the request.\nFor privacy reasons, the principal email address is redacte d for all\nread-only operations that fail with a \"permission denied\" error.", 347 "description": "The email address of the authenticated user (or service account on behalf\nof third party principal) making the request. For privacy reasons, the\nprincipal email address is redacted for all read-only ope rations that fail\nwith a \"permission denied\" error.",
376 "type": "string" 348 "type": "string"
377 }, 349 },
378 "authoritySelector": { 350 "authoritySelector": {
379 "description": "The authority selector specified by the requ estor, if any.\nIt is not guaranteed that the principal was allowed to use this authority.", 351 "description": "The authority selector specified by the requ estor, if any.\nIt is not guaranteed that the principal was allowed to use this authority.",
380 "type": "string" 352 "type": "string"
353 },
354 "thirdPartyPrincipal": {
355 "additionalProperties": {
356 "description": "Properties of the object.",
357 "type": "any"
358 },
359 "description": "The third party identification (if any) of t he authenticated user making\nthe request.\nWhen the JSON object represented her e has a proto equivalent, the proto\nname will be indicated in the `@type` prope rty.",
360 "type": "object"
381 } 361 }
382 }, 362 },
383 "type": "object" 363 "type": "object"
384 }, 364 },
385 "AllocateQuotaResponse": { 365 "AllocateQuotaResponse": {
386 "description": "Response message for the AllocateQuota method.", 366 "description": "Response message for the AllocateQuota method.",
387 "id": "AllocateQuotaResponse", 367 "id": "AllocateQuotaResponse",
388 "properties": { 368 "properties": {
389 "quotaMetrics": { 369 "quotaMetrics": {
390 "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\"\n\n4. For allocation quota, value for each quota limit associ ated with\nthe metrics will be specified using the following gauge metric:\n \" serviceruntime.googleapis.com/quota/limit\"", 370 "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\"\n\n4. For allocation quota, value for each quota limit associ ated with\nthe metrics will be specified using the following gauge metric:\n \" serviceruntime.googleapis.com/quota/limit\"",
(...skipping 28 matching lines...) Expand all
419 "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.", 399 "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.",
420 "type": "string" 400 "type": "string"
421 }, 401 },
422 "releaseOperation": { 402 "releaseOperation": {
423 "$ref": "QuotaOperation", 403 "$ref": "QuotaOperation",
424 "description": "Operation that describes the quota release." 404 "description": "Operation that describes the quota release."
425 } 405 }
426 }, 406 },
427 "type": "object" 407 "type": "object"
428 }, 408 },
429 "RequestMetadata": {
430 "description": "Metadata about the request.",
431 "id": "RequestMetadata",
432 "properties": {
433 "callerIp": {
434 "description": "The IP address of the caller.\nFor caller fr om internet, this will be public IPv4 or IPv6 address.\nFor caller from GCE VM w ith external IP address, this will be the VM's\nexternal IP address. For caller from GCE VM without external IP address, if\nthe VM is in the same GCP organizat ion (or project) as the accessed\nresource, `caller_ip` will be the GCE VM's int ernal IPv4 address, otherwise\nit will be redacted to \"gce-internal-ip\".\nSee https://cloud.google.com/compute/docs/vpc/ for more information.",
435 "type": "string"
436 },
437 "callerSuppliedUserAgent": {
438 "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.\nNOLINT",
439 "type": "string"
440 }
441 },
442 "type": "object"
443 },
444 "QuotaError": { 409 "QuotaError": {
445 "id": "QuotaError", 410 "id": "QuotaError",
446 "properties": { 411 "properties": {
447 "description": {
448 "description": "Free-form text that provides details on the cause of the error.",
449 "type": "string"
450 },
451 "subject": {
452 "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>\".",
453 "type": "string"
454 },
455 "code": { 412 "code": {
456 "description": "Error code.", 413 "description": "Error code.",
457 "enum": [ 414 "enum": [
458 "UNSPECIFIED", 415 "UNSPECIFIED",
459 "RESOURCE_EXHAUSTED", 416 "RESOURCE_EXHAUSTED",
460 "OUT_OF_RANGE", 417 "OUT_OF_RANGE",
461 "BILLING_NOT_ACTIVE", 418 "BILLING_NOT_ACTIVE",
462 "PROJECT_DELETED", 419 "PROJECT_DELETED",
463 "API_KEY_INVALID", 420 "API_KEY_INVALID",
464 "API_KEY_EXPIRED", 421 "API_KEY_EXPIRED",
(...skipping 15 matching lines...) Expand all
480 "Specified API Key has expired.", 437 "Specified API Key has expired.",
481 "Consumer's spatula header is invalid.", 438 "Consumer's spatula header is invalid.",
482 "The consumer's LOAS role is invalid.", 439 "The consumer's LOAS role is invalid.",
483 "The consumer's LOAS role has no associated project.", 440 "The consumer's LOAS role has no associated project.",
484 "The backend server for looking up project id/number is unavailable.", 441 "The backend server for looking up project id/number is unavailable.",
485 "The backend server for checking service status is unava ilable.", 442 "The backend server for checking service status is unava ilable.",
486 "The backend server for checking billing status is unava ilable.", 443 "The backend server for checking billing status is unava ilable.",
487 "The backend server for checking quota limits is unavail able." 444 "The backend server for checking quota limits is unavail able."
488 ], 445 ],
489 "type": "string" 446 "type": "string"
447 },
448 "description": {
449 "description": "Free-form text that provides details on the cause of the error.",
450 "type": "string"
451 },
452 "subject": {
453 "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>\".",
454 "type": "string"
490 } 455 }
491 }, 456 },
492 "type": "object" 457 "type": "object"
458 },
459 "RequestMetadata": {
460 "description": "Metadata about the request.",
461 "id": "RequestMetadata",
462 "properties": {
463 "callerSuppliedUserAgent": {
464 "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.\nNOLINT",
465 "type": "string"
466 },
467 "callerIp": {
468 "description": "The IP address of the caller.\nFor caller fr om internet, this will be public IPv4 or IPv6 address.\nFor caller from GCE VM w ith external IP address, this will be the VM's\nexternal IP address. For caller from GCE VM without external IP address, if\nthe VM is in the same GCP organizat ion (or project) as the accessed\nresource, `caller_ip` will be the GCE VM's int ernal IPv4 address, otherwise\nit will be redacted to \"gce-internal-ip\".\nSee https://cloud.google.com/compute/docs/vpc/ for more information.",
469 "type": "string"
470 }
471 },
472 "type": "object"
493 }, 473 },
494 "CheckInfo": { 474 "CheckInfo": {
495 "id": "CheckInfo", 475 "id": "CheckInfo",
496 "properties": { 476 "properties": {
497 "unusedArguments": { 477 "unusedArguments": {
498 "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.", 478 "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.",
499 "items": { 479 "items": {
500 "type": "string" 480 "type": "string"
501 }, 481 },
502 "type": "array" 482 "type": "array"
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after
536 ], 516 ],
537 "type": "string" 517 "type": "string"
538 } 518 }
539 }, 519 },
540 "type": "object" 520 "type": "object"
541 }, 521 },
542 "ReleaseQuotaResponse": { 522 "ReleaseQuotaResponse": {
543 "description": "Response message for the ReleaseQuota method.", 523 "description": "Response message for the ReleaseQuota method.",
544 "id": "ReleaseQuotaResponse", 524 "id": "ReleaseQuotaResponse",
545 "properties": { 525 "properties": {
526 "quotaMetrics": {
527 "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\"\n\n3. For all ocation quota, value for each quota limit associated with\nthe metrics will be s pecified using the following gauge metric:\n \"serviceruntime.googleapis.com/qu ota/limit\"",
528 "items": {
529 "$ref": "MetricValueSet"
530 },
531 "type": "array"
532 },
546 "operationId": { 533 "operationId": {
547 "description": "The same operation_id value used in the Rele aseQuotaRequest. Used for\nlogging and diagnostics purposes.", 534 "description": "The same operation_id value used in the Rele aseQuotaRequest. Used for\nlogging and diagnostics purposes.",
548 "type": "string" 535 "type": "string"
549 }, 536 },
550 "serviceConfigId": { 537 "serviceConfigId": {
551 "description": "ID of the actual config used to process the request.", 538 "description": "ID of the actual config used to process the request.",
552 "type": "string" 539 "type": "string"
553 }, 540 },
554 "releaseErrors": { 541 "releaseErrors": {
555 "description": "Indicates the decision of the release.", 542 "description": "Indicates the decision of the release.",
556 "items": { 543 "items": {
557 "$ref": "QuotaError" 544 "$ref": "QuotaError"
558 }, 545 },
559 "type": "array" 546 "type": "array"
560 },
561 "quotaMetrics": {
562 "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\"\n\n3. For all ocation quota, value for each quota limit associated with\nthe metrics will be s pecified using the following gauge metric:\n \"serviceruntime.googleapis.com/qu ota/limit\"",
563 "items": {
564 "$ref": "MetricValueSet"
565 },
566 "type": "array"
567 } 547 }
568 }, 548 },
569 "type": "object" 549 "type": "object"
570 }, 550 },
571 "MetricValueSet": { 551 "MetricValueSet": {
572 "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.", 552 "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.",
573 "id": "MetricValueSet", 553 "id": "MetricValueSet",
574 "properties": { 554 "properties": {
555 "metricName": {
556 "description": "The metric name defined in the service confi guration.",
557 "type": "string"
558 },
575 "metricValues": { 559 "metricValues": {
576 "description": "The values in this metric.", 560 "description": "The values in this metric.",
577 "items": { 561 "items": {
578 "$ref": "MetricValue" 562 "$ref": "MetricValue"
579 }, 563 },
580 "type": "array" 564 "type": "array"
581 },
582 "metricName": {
583 "description": "The metric name defined in the service confi guration.",
584 "type": "string"
585 } 565 }
586 }, 566 },
587 "type": "object" 567 "type": "object"
588 }, 568 },
589 "ReportError": { 569 "ReportError": {
590 "description": "Represents the processing error of one `Operation` i n the request.", 570 "description": "Represents the processing error of one Operation in the request.",
591 "id": "ReportError", 571 "id": "ReportError",
592 "properties": { 572 "properties": {
573 "status": {
574 "$ref": "Status",
575 "description": "Details of the error when processing the Ope ration."
576 },
593 "operationId": { 577 "operationId": {
594 "description": "The Operation.operation_id value from the re quest.", 578 "description": "The Operation.operation_id value from the re quest.",
595 "type": "string" 579 "type": "string"
596 },
597 "status": {
598 "$ref": "Status",
599 "description": "Details of the error when processing the `Op eration`."
600 } 580 }
601 }, 581 },
602 "type": "object" 582 "type": "object"
603 }, 583 },
604 "StartReconciliationRequest": { 584 "StartReconciliationRequest": {
605 "id": "StartReconciliationRequest", 585 "id": "StartReconciliationRequest",
606 "properties": { 586 "properties": {
607 "reconciliationOperation": { 587 "reconciliationOperation": {
608 "$ref": "QuotaOperation", 588 "$ref": "QuotaOperation",
609 "description": "Operation that describes the quota reconcili ation." 589 "description": "Operation that describes the quota reconcili ation."
(...skipping 85 matching lines...) Expand 10 before | Expand all | Expand 10 after
695 "description": "Free-form text providing details on the erro r cause of the error.", 675 "description": "Free-form text providing details on the erro r cause of the error.",
696 "type": "string" 676 "type": "string"
697 } 677 }
698 }, 678 },
699 "type": "object" 679 "type": "object"
700 }, 680 },
701 "QuotaInfo": { 681 "QuotaInfo": {
702 "description": "Contains the quota information for a quota check res ponse.", 682 "description": "Contains the quota information for a quota check res ponse.",
703 "id": "QuotaInfo", 683 "id": "QuotaInfo",
704 "properties": { 684 "properties": {
685 "quotaMetrics": {
686 "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\"",
687 "items": {
688 "$ref": "MetricValueSet"
689 },
690 "type": "array"
691 },
705 "limitExceeded": { 692 "limitExceeded": {
706 "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.", 693 "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.",
707 "items": { 694 "items": {
708 "type": "string" 695 "type": "string"
709 }, 696 },
710 "type": "array" 697 "type": "array"
711 }, 698 },
712 "quotaConsumed": { 699 "quotaConsumed": {
713 "additionalProperties": { 700 "additionalProperties": {
714 "format": "int32", 701 "format": "int32",
715 "type": "integer" 702 "type": "integer"
716 }, 703 },
717 "description": "Map of quota group name to the actual number of tokens consumed. If the\nquota check was not successful, then this will not be populated due to no\nquota consumption.\n\nWe are not merging this field with 'quota_metrics' field because of the\ncomplexity of scaling in Chemist client c ode base. For simplicity, we will\nkeep this field for Castor (that scales quota usage) and 'quota_metrics'\nfor SuperQuota (that doesn't scale quota usage).\n" , 704 "description": "Map of quota group name to the actual number of tokens consumed. If the\nquota check was not successful, then this will not be populated due to no\nquota consumption.\n\nWe are not merging this field with 'quota_metrics' field because of the\ncomplexity of scaling in Chemist client c ode base. For simplicity, we will\nkeep this field for Castor (that scales quota usage) and 'quota_metrics'\nfor SuperQuota (that doesn't scale quota usage).\n" ,
718 "type": "object" 705 "type": "object"
719 },
720 "quotaMetrics": {
721 "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\"",
722 "items": {
723 "$ref": "MetricValueSet"
724 },
725 "type": "array"
726 } 706 }
727 }, 707 },
728 "type": "object" 708 "type": "object"
729 }, 709 },
730 "ConsumerInfo": { 710 "ConsumerInfo": {
731 "description": "`ConsumerInfo` provides information about the consum er project.", 711 "description": "`ConsumerInfo` provides information about the consum er project.",
732 "id": "ConsumerInfo", 712 "id": "ConsumerInfo",
733 "properties": { 713 "properties": {
734 "projectNumber": { 714 "projectNumber": {
735 "description": "The Google cloud project number, e.g. 123456 7890. A value of 0 indicates\nno project number is found.", 715 "description": "The Google cloud project number, e.g. 123456 7890. A value of 0 indicates\nno project number is found.",
736 "format": "int64", 716 "format": "int64",
737 "type": "string" 717 "type": "string"
738 } 718 }
739 }, 719 },
740 "type": "object" 720 "type": "object"
741 }, 721 },
742 "CheckRequest": { 722 "CheckRequest": {
743 "description": "Request message for the Check method.", 723 "description": "Request message for the Check method.",
744 "id": "CheckRequest", 724 "id": "CheckRequest",
745 "properties": { 725 "properties": {
726 "serviceConfigId": {
727 "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.",
728 "type": "string"
729 },
746 "skipActivationCheck": { 730 "skipActivationCheck": {
747 "description": "Indicates if service activation check should be skipped for this request.\nDefault behavior is to perform the check and appl y relevant quota.", 731 "description": "Indicates if service activation check should be skipped for this request.\nDefault behavior is to perform the check and appl y relevant quota.",
748 "type": "boolean" 732 "type": "boolean"
749 }, 733 },
750 "requestProjectSettings": { 734 "requestProjectSettings": {
751 "description": "Requests the project settings to be returned as part of the check response.", 735 "description": "Requests the project settings to be returned as part of the check response.",
752 "type": "boolean" 736 "type": "boolean"
753 }, 737 },
754 "operation": { 738 "operation": {
755 "$ref": "Operation", 739 "$ref": "Operation",
756 "description": "The operation to be checked." 740 "description": "The operation to be checked."
757 },
758 "serviceConfigId": {
759 "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.",
760 "type": "string"
761 } 741 }
762 }, 742 },
763 "type": "object" 743 "type": "object"
764 }, 744 },
765 "QuotaOperation": { 745 "QuotaOperation": {
766 "description": "Represents information regarding a quota operation." , 746 "description": "Represents information regarding a quota operation." ,
767 "id": "QuotaOperation", 747 "id": "QuotaOperation",
768 "properties": { 748 "properties": {
749 "quotaMetrics": {
750 "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." ,
751 "items": {
752 "$ref": "MetricValueSet"
753 },
754 "type": "array"
755 },
769 "labels": { 756 "labels": {
770 "additionalProperties": { 757 "additionalProperties": {
771 "type": "string" 758 "type": "string"
772 }, 759 },
773 "description": "Labels describing the operation.", 760 "description": "Labels describing the operation.",
774 "type": "object" 761 "type": "object"
775 }, 762 },
776 "consumerId": { 763 "consumerId": {
777 "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> .", 764 "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> .",
778 "type": "string" 765 "type": "string"
779 }, 766 },
780 "operationId": { 767 "operationId": {
781 "description": "Identity of the operation. This is expected to be unique within the scope\nof the service that generated the operation, and guarantees idempotency in\ncase of retries.\n\nUUID version 4 is recommended, th ough not required. In scenarios where an\noperation is computed from existing in formation and an idempotent id is\ndesirable for deduplication purpose, UUID ver sion 5 is recommended. See\nRFC 4122 for details.", 768 "description": "Identity of the operation. This is expected to be unique within the scope\nof the service that generated the operation, and guarantees idempotency in\ncase of retries.\n\nUUID version 4 is recommended, th ough not required. In scenarios where an\noperation is computed from existing in formation and an idempotent id is\ndesirable for deduplication purpose, UUID ver sion 5 is recommended. See\nRFC 4122 for details.",
782 "type": "string" 769 "type": "string"
783 }, 770 },
784 "methodName": {
785 "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",
786 "type": "string"
787 },
788 "quotaMode": { 771 "quotaMode": {
789 "description": "Quota mode for this operation.", 772 "description": "Quota mode for this operation.",
790 "enum": [ 773 "enum": [
791 "UNSPECIFIED", 774 "UNSPECIFIED",
792 "NORMAL", 775 "NORMAL",
793 "BEST_EFFORT", 776 "BEST_EFFORT",
794 "CHECK_ONLY" 777 "CHECK_ONLY"
795 ], 778 ],
796 "enumDescriptions": [ 779 "enumDescriptions": [
797 "", 780 "",
798 "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 used quota negative, release error\nw ill be returned and no quota will be released.", 781 "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 used quota negative, release error\nw ill be returned and no quota will be released.",
799 "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 used q uota\nnegative, request does not fail but only the used quota will be\nreleased. After the ReleaseQuota request completes, the used quota\nwill be 0, and never goes to negative.", 782 "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 used q uota\nnegative, request does not fail but only the used quota will be\nreleased. After the ReleaseQuota request completes, the used quota\nwill be 0, and never goes to negative.",
800 "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." 783 "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."
801 ], 784 ],
802 "type": "string" 785 "type": "string"
803 }, 786 },
804 "quotaMetrics": { 787 "methodName": {
805 "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." , 788 "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",
806 "items": { 789 "type": "string"
807 "$ref": "MetricValueSet"
808 },
809 "type": "array"
810 } 790 }
811 }, 791 },
812 "type": "object" 792 "type": "object"
813 }, 793 },
814 "EndReconciliationRequest": { 794 "EndReconciliationRequest": {
815 "id": "EndReconciliationRequest", 795 "id": "EndReconciliationRequest",
816 "properties": { 796 "properties": {
797 "serviceConfigId": {
798 "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.",
799 "type": "string"
800 },
817 "reconciliationOperation": { 801 "reconciliationOperation": {
818 "$ref": "QuotaOperation", 802 "$ref": "QuotaOperation",
819 "description": "Operation that describes the quota reconcili ation." 803 "description": "Operation that describes the quota reconcili ation."
820 },
821 "serviceConfigId": {
822 "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.",
823 "type": "string"
824 } 804 }
825 }, 805 },
826 "type": "object" 806 "type": "object"
827 }, 807 },
828 "ReportInfo": { 808 "ReportInfo": {
829 "id": "ReportInfo", 809 "id": "ReportInfo",
830 "properties": { 810 "properties": {
831 "operationId": {
832 "description": "The Operation.operation_id value from the re quest.",
833 "type": "string"
834 },
835 "quotaInfo": { 811 "quotaInfo": {
836 "$ref": "QuotaInfo", 812 "$ref": "QuotaInfo",
837 "description": "Quota usage info when processing the `Operat ion`." 813 "description": "Quota usage info when processing the `Operat ion`."
838 }
839 },
840 "type": "object"
841 },
842 "ReportResponse": {
843 "description": "Response message for the Report method.",
844 "id": "ReportResponse",
845 "properties": {
846 "reportErrors": {
847 "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.",
848 "items": {
849 "$ref": "ReportError"
850 },
851 "type": "array"
852 }, 814 },
853 "reportInfos": { 815 "operationId": {
854 "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", 816 "description": "The Operation.operation_id value from the re quest.",
855 "items": {
856 "$ref": "ReportInfo"
857 },
858 "type": "array"
859 },
860 "serviceConfigId": {
861 "description": "The actual config id used to process the req uest.",
862 "type": "string" 817 "type": "string"
863 } 818 }
864 }, 819 },
865 "type": "object" 820 "type": "object"
866 }, 821 },
867 "Operation": { 822 "Operation": {
868 "description": "Represents information regarding an operation.", 823 "description": "Represents information regarding an operation.",
869 "id": "Operation", 824 "id": "Operation",
870 "properties": { 825 "properties": {
826 "resourceContainer": {
827 "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>”",
828 "type": "string"
829 },
830 "labels": {
831 "additionalProperties": {
832 "type": "string"
833 },
834 "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).",
835 "type": "object"
836 },
837 "logEntries": {
838 "description": "Represents information to be logged.",
839 "items": {
840 "$ref": "LogEntry"
841 },
842 "type": "array"
843 },
844 "userLabels": {
845 "additionalProperties": {
846 "type": "string"
847 },
848 "description": "User defined labels for the resource that th is operation is associated\nwith.",
849 "type": "object"
850 },
851 "metricValueSets": {
852 "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." ,
853 "items": {
854 "$ref": "MetricValueSet"
855 },
856 "type": "array"
857 },
858 "quotaProperties": {
859 "$ref": "QuotaProperties",
860 "description": "Represents the properties needed for quota c heck. Applicable only if this\noperation is for a quota check request."
861 },
862 "consumerId": {
863 "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>.",
864 "type": "string"
865 },
871 "operationId": { 866 "operationId": {
872 "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.", 867 "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.",
873 "type": "string" 868 "type": "string"
874 }, 869 },
870 "operationName": {
871 "description": "Fully qualified name of the operation. Reser ved for future use.",
872 "type": "string"
873 },
875 "endTime": { 874 "endTime": {
876 "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.", 875 "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.",
877 "format": "google-datetime", 876 "format": "google-datetime",
878 "type": "string" 877 "type": "string"
879 }, 878 },
880 "operationName": {
881 "description": "Fully qualified name of the operation. Reser ved for future use.",
882 "type": "string"
883 },
884 "startTime": { 879 "startTime": {
885 "description": "Required. Start time of the operation.", 880 "description": "Required. Start time of the operation.",
886 "format": "google-datetime", 881 "format": "google-datetime",
887 "type": "string" 882 "type": "string"
888 }, 883 },
889 "importance": { 884 "importance": {
890 "description": "DO NOT USE. This is an experimental field.", 885 "description": "DO NOT USE. This is an experimental field.",
891 "enum": [ 886 "enum": [
892 "LOW", 887 "LOW",
893 "HIGH", 888 "HIGH",
894 "DEBUG" 889 "DEBUG"
895 ], 890 ],
896 "enumDescriptions": [ 891 "enumDescriptions": [
897 "The API implementation may cache and aggregate the data .\nThe data may be lost when rare and unexpected system failures occur.", 892 "The API implementation may cache and aggregate the data .\nThe data may be lost when rare and unexpected system failures occur.",
898 "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.", 893 "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.",
899 "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." 894 "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."
900 ], 895 ],
901 "type": "string" 896 "type": "string"
902 }, 897 },
903 "resourceContainer": { 898 "resourceContainers": {
904 "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>”", 899 "description": "DO NOT USE.\nThis field is not ready for use yet.",
905 "type": "string" 900 "items": {
906 },
907 "labels": {
908 "additionalProperties": {
909 "type": "string" 901 "type": "string"
910 }, 902 },
911 "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).", 903 "type": "array"
912 "type": "object" 904 }
913 }, 905 },
914 "logEntries": { 906 "type": "object"
915 "description": "Represents information to be logged.", 907 },
908 "ReportResponse": {
909 "description": "Response message for the Report method.",
910 "id": "ReportResponse",
911 "properties": {
912 "reportInfos": {
913 "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",
916 "items": { 914 "items": {
917 "$ref": "LogEntry" 915 "$ref": "ReportInfo"
918 }, 916 },
919 "type": "array" 917 "type": "array"
920 }, 918 },
921 "userLabels": { 919 "serviceConfigId": {
922 "additionalProperties": { 920 "description": "The actual config id used to process the req uest.",
923 "type": "string" 921 "type": "string"
924 },
925 "description": "User defined labels for the resource that th is operation is associated\nwith.",
926 "type": "object"
927 }, 922 },
928 "metricValueSets": { 923 "reportErrors": {
929 "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." , 924 "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.",
930 "items": { 925 "items": {
931 "$ref": "MetricValueSet" 926 "$ref": "ReportError"
932 }, 927 },
933 "type": "array" 928 "type": "array"
934 },
935 "quotaProperties": {
936 "$ref": "QuotaProperties",
937 "description": "Represents the properties needed for quota c heck. Applicable only if this\noperation is for a quota check request."
938 },
939 "consumerId": {
940 "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>.",
941 "type": "string"
942 } 929 }
943 }, 930 },
944 "type": "object" 931 "type": "object"
945 }, 932 },
946 "CheckResponse": { 933 "CheckResponse": {
947 "description": "Response message for the Check method.", 934 "description": "Response message for the Check method.",
948 "id": "CheckResponse", 935 "id": "CheckResponse",
949 "properties": { 936 "properties": {
950 "checkInfo": { 937 "checkInfo": {
951 "$ref": "CheckInfo", 938 "$ref": "CheckInfo",
(...skipping 59 matching lines...) Expand 10 before | Expand all | Expand 10 after
1011 "operations": { 998 "operations": {
1012 "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.", 999 "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.",
1013 "items": { 1000 "items": {
1014 "$ref": "Operation" 1001 "$ref": "Operation"
1015 }, 1002 },
1016 "type": "array" 1003 "type": "array"
1017 } 1004 }
1018 }, 1005 },
1019 "type": "object" 1006 "type": "object"
1020 }, 1007 },
1021 "AuditLog": {
1022 "description": "Common audit log format for Google Cloud Platform AP I operations.\n\n",
1023 "id": "AuditLog",
1024 "properties": {
1025 "authorizationInfo": {
1026 "description": "Authorization information. If there are mult iple\nresources or permissions involved, then there is\none AuthorizationInfo el ement for each {resource, permission} tuple.",
1027 "items": {
1028 "$ref": "AuthorizationInfo"
1029 },
1030 "type": "array"
1031 },
1032 "resourceName": {
1033 "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\"",
1034 "type": "string"
1035 },
1036 "request": {
1037 "additionalProperties": {
1038 "description": "Properties of the object.",
1039 "type": "any"
1040 },
1041 "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.",
1042 "type": "object"
1043 },
1044 "serviceData": {
1045 "additionalProperties": {
1046 "description": "Properties of the object. Contains field @type with type URL.",
1047 "type": "any"
1048 },
1049 "description": "Other service-specific data about the reques t, response, and other\nactivities.",
1050 "type": "object"
1051 },
1052 "requestMetadata": {
1053 "$ref": "RequestMetadata",
1054 "description": "Metadata about the operation."
1055 },
1056 "numResponseItems": {
1057 "description": "The number of items returned from a List or Query API method,\nif applicable.",
1058 "format": "int64",
1059 "type": "string"
1060 },
1061 "status": {
1062 "$ref": "Status",
1063 "description": "The status of the overall operation."
1064 },
1065 "authenticationInfo": {
1066 "$ref": "AuthenticationInfo",
1067 "description": "Authentication information."
1068 },
1069 "response": {
1070 "additionalProperties": {
1071 "description": "Properties of the object.",
1072 "type": "any"
1073 },
1074 "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.",
1075 "type": "object"
1076 },
1077 "serviceName": {
1078 "description": "The name of the API service performing the o peration. For example,\n`\"datastore.googleapis.com\"`.",
1079 "type": "string"
1080 },
1081 "methodName": {
1082 "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\"",
1083 "type": "string"
1084 }
1085 },
1086 "type": "object"
1087 },
1088 "LogEntry": { 1008 "LogEntry": {
1089 "description": "An individual log entry.", 1009 "description": "An individual log entry.",
1090 "id": "LogEntry", 1010 "id": "LogEntry",
1091 "properties": { 1011 "properties": {
1012 "textPayload": {
1013 "description": "The log entry payload, represented as a Unic ode string (UTF-8).",
1014 "type": "string"
1015 },
1016 "protoPayload": {
1017 "additionalProperties": {
1018 "description": "Properties of the object. Contains field @type with type URL.",
1019 "type": "any"
1020 },
1021 "description": "The log entry payload, represented as a prot ocol buffer that is\nexpressed as a JSON object. The only accepted type currentl y is\nAuditLog.",
1022 "type": "object"
1023 },
1024 "timestamp": {
1025 "description": "The time the event described by the log entr y occurred. If\nomitted, defaults to operation start time.",
1026 "format": "google-datetime",
1027 "type": "string"
1028 },
1092 "labels": { 1029 "labels": {
1093 "additionalProperties": { 1030 "additionalProperties": {
1094 "type": "string" 1031 "type": "string"
1095 }, 1032 },
1096 "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.", 1033 "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.",
1097 "type": "object" 1034 "type": "object"
1098 }, 1035 },
1099 "severity": { 1036 "severity": {
1100 "description": "The severity of the log entry. The default v alue is\n`LogSeverity.DEFAULT`.", 1037 "description": "The severity of the log entry. The default v alue is\n`LogSeverity.DEFAULT`.",
1101 "enum": [ 1038 "enum": [
(...skipping 13 matching lines...) Expand all
1115 "(200) Routine information, such as ongoing status or pe rformance.", 1052 "(200) Routine information, such as ongoing status or pe rformance.",
1116 "(300) Normal but significant events, such as start up, shut down, or\na configuration change.", 1053 "(300) Normal but significant events, such as start up, shut down, or\na configuration change.",
1117 "(400) Warning events might cause problems.", 1054 "(400) Warning events might cause problems.",
1118 "(500) Error events are likely to cause problems.", 1055 "(500) Error events are likely to cause problems.",
1119 "(600) Critical events cause more severe problems or out ages.", 1056 "(600) Critical events cause more severe problems or out ages.",
1120 "(700) A person must take an action immediately.", 1057 "(700) A person must take an action immediately.",
1121 "(800) One or more systems are unusable." 1058 "(800) One or more systems are unusable."
1122 ], 1059 ],
1123 "type": "string" 1060 "type": "string"
1124 }, 1061 },
1062 "name": {
1063 "description": "Required. The log to which this log entry be longs. Examples: `\"syslog\"`,\n`\"book_log\"`.",
1064 "type": "string"
1065 },
1125 "insertId": { 1066 "insertId": {
1126 "description": "A unique ID for the log entry used for dedup lication. If omitted,\nthe implementation will generate one based on operation_i d.", 1067 "description": "A unique ID for the log entry used for dedup lication. If omitted,\nthe implementation will generate one based on operation_i d.",
1127 "type": "string" 1068 "type": "string"
1128 }, 1069 },
1129 "name": {
1130 "description": "Required. The log to which this log entry be longs. Examples: `\"syslog\"`,\n`\"book_log\"`.",
1131 "type": "string"
1132 },
1133 "structPayload": { 1070 "structPayload": {
1134 "additionalProperties": { 1071 "additionalProperties": {
1135 "description": "Properties of the object.", 1072 "description": "Properties of the object.",
1136 "type": "any" 1073 "type": "any"
1137 }, 1074 },
1138 "description": "The log entry payload, represented as a stru cture that\nis expressed as a JSON object.", 1075 "description": "The log entry payload, represented as a stru cture that\nis expressed as a JSON object.",
1139 "type": "object" 1076 "type": "object"
1140 }, 1077 }
1141 "textPayload": { 1078 },
1142 "description": "The log entry payload, represented as a Unic ode string (UTF-8).", 1079 "type": "object"
1080 },
1081 "AuditLog": {
1082 "description": "Common audit log format for Google Cloud Platform AP I operations.\n\n",
1083 "id": "AuditLog",
1084 "properties": {
1085 "methodName": {
1086 "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\"",
1143 "type": "string" 1087 "type": "string"
1144 }, 1088 },
1145 "protoPayload": { 1089 "resourceName": {
1090 "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\"",
1091 "type": "string"
1092 },
1093 "authorizationInfo": {
1094 "description": "Authorization information. If there are mult iple\nresources or permissions involved, then there is\none AuthorizationInfo el ement for each {resource, permission} tuple.",
1095 "items": {
1096 "$ref": "AuthorizationInfo"
1097 },
1098 "type": "array"
1099 },
1100 "request": {
1101 "additionalProperties": {
1102 "description": "Properties of the object.",
1103 "type": "any"
1104 },
1105 "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.",
1106 "type": "object"
1107 },
1108 "requestMetadata": {
1109 "$ref": "RequestMetadata",
1110 "description": "Metadata about the operation."
1111 },
1112 "serviceData": {
1146 "additionalProperties": { 1113 "additionalProperties": {
1147 "description": "Properties of the object. Contains field @type with type URL.", 1114 "description": "Properties of the object. Contains field @type with type URL.",
1148 "type": "any" 1115 "type": "any"
1149 }, 1116 },
1150 "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.", 1117 "description": "Other service-specific data about the reques t, response, and other\nactivities.",
1151 "type": "object" 1118 "type": "object"
1152 }, 1119 },
1153 "timestamp": { 1120 "numResponseItems": {
1154 "description": "The time the event described by the log entr y occurred. If\nomitted, defaults to operation start time.", 1121 "description": "The number of items returned from a List or Query API method,\nif applicable.",
1155 "format": "google-datetime", 1122 "format": "int64",
1123 "type": "string"
1124 },
1125 "status": {
1126 "$ref": "Status",
1127 "description": "The status of the overall operation."
1128 },
1129 "authenticationInfo": {
1130 "$ref": "AuthenticationInfo",
1131 "description": "Authentication information."
1132 },
1133 "response": {
1134 "additionalProperties": {
1135 "description": "Properties of the object.",
1136 "type": "any"
1137 },
1138 "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.",
1139 "type": "object"
1140 },
1141 "serviceName": {
1142 "description": "The name of the API service performing the o peration. For example,\n`\"datastore.googleapis.com\"`.",
1156 "type": "string" 1143 "type": "string"
1157 } 1144 }
1158 }, 1145 },
1159 "type": "object" 1146 "type": "object"
1160 }, 1147 },
1161 "MetricValue": { 1148 "MetricValue": {
1162 "description": "Represents a single metric value.", 1149 "description": "Represents a single metric value.",
1163 "id": "MetricValue", 1150 "id": "MetricValue",
1164 "properties": { 1151 "properties": {
1152 "endTime": {
1153 "description": "The end of the time period over which this m etric value's measurement\napplies.",
1154 "format": "google-datetime",
1155 "type": "string"
1156 },
1157 "startTime": {
1158 "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.",
1159 "format": "google-datetime",
1160 "type": "string"
1161 },
1165 "moneyValue": { 1162 "moneyValue": {
1166 "$ref": "Money", 1163 "$ref": "Money",
1167 "description": "A money value." 1164 "description": "A money value."
1168 }, 1165 },
1169 "labels": { 1166 "labels": {
1170 "additionalProperties": { 1167 "additionalProperties": {
1171 "type": "string" 1168 "type": "string"
1172 }, 1169 },
1173 "description": "The labels describing the metric value.\nSee comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding r elationship.", 1170 "description": "The labels describing the metric value.\nSee comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding r elationship.",
1174 "type": "object" 1171 "type": "object"
(...skipping 12 matching lines...) Expand all
1187 "format": "int64", 1184 "format": "int64",
1188 "type": "string" 1185 "type": "string"
1189 }, 1186 },
1190 "distributionValue": { 1187 "distributionValue": {
1191 "$ref": "Distribution", 1188 "$ref": "Distribution",
1192 "description": "A distribution value." 1189 "description": "A distribution value."
1193 }, 1190 },
1194 "boolValue": { 1191 "boolValue": {
1195 "description": "A boolean value.", 1192 "description": "A boolean value.",
1196 "type": "boolean" 1193 "type": "boolean"
1197 }, 1194 }
1198 "endTime": { 1195 },
1199 "description": "The end of the time period over which this m etric value's measurement\napplies.", 1196 "type": "object"
1200 "format": "google-datetime", 1197 },
1198 "EndReconciliationResponse": {
1199 "id": "EndReconciliationResponse",
1200 "properties": {
1201 "serviceConfigId": {
1202 "description": "ID of the actual config used to process the request.",
1201 "type": "string" 1203 "type": "string"
1202 }, 1204 },
1203 "startTime": { 1205 "quotaMetrics": {
1204 "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.", 1206 "description": "Metric values as tracked by One Platform bef ore the adjustment was made.\nThe following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Va lue for each quota limit associated with the metrics will be specified\nusing th e following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"\n\n3. Delta value of the usage after the reconciliation for limits associated\nwith t he metrics will be specified using the following metric:\n \"serviceruntime.goo gleapis.com/allocation/reconciliation_delta\"\nThe delta value is defined as:\n new_usage_from_client - existing_value_in_spanner.\nThis metric is not defined in serviceruntime.yaml or in Cloud Monarch.\nThis metric is meant for callers' u se only. Since this metric is not\ndefined in the monitoring backend, reporting on this metric will result in\nan error.",
1205 "format": "google-datetime", 1207 "items": {
1208 "$ref": "MetricValueSet"
1209 },
1210 "type": "array"
1211 },
1212 "reconciliationErrors": {
1213 "description": "Indicates the decision of the reconciliation end.",
1214 "items": {
1215 "$ref": "QuotaError"
1216 },
1217 "type": "array"
1218 },
1219 "operationId": {
1220 "description": "The same operation_id value used in the EndR econciliationRequest. Used for\nlogging and diagnostics purposes.",
1206 "type": "string" 1221 "type": "string"
1207 } 1222 }
1208 }, 1223 },
1209 "type": "object" 1224 "type": "object"
1210 }, 1225 },
1211 "Money": { 1226 "Money": {
1212 "description": "Represents an amount of money with its currency type .", 1227 "description": "Represents an amount of money with its currency type .",
1213 "id": "Money", 1228 "id": "Money",
1214 "properties": { 1229 "properties": {
1215 "units": { 1230 "units": {
1216 "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", 1231 "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
1217 "format": "int64", 1232 "format": "int64",
1218 "type": "string" 1233 "type": "string"
1219 }, 1234 },
1220 "currencyCode": { 1235 "currencyCode": {
1221 "description": "The 3-letter currency code defined in ISO 42 17.", 1236 "description": "The 3-letter currency code defined in ISO 42 17.",
1222 "type": "string" 1237 "type": "string"
1223 }, 1238 },
1224 "nanos": { 1239 "nanos": {
1225 "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.", 1240 "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.",
1226 "format": "int32", 1241 "format": "int32",
1227 "type": "integer" 1242 "type": "integer"
1228 } 1243 }
1229 }, 1244 },
1230 "type": "object" 1245 "type": "object"
1231 }, 1246 },
1232 "EndReconciliationResponse": {
1233 "id": "EndReconciliationResponse",
1234 "properties": {
1235 "reconciliationErrors": {
1236 "description": "Indicates the decision of the reconciliation end.",
1237 "items": {
1238 "$ref": "QuotaError"
1239 },
1240 "type": "array"
1241 },
1242 "operationId": {
1243 "description": "The same operation_id value used in the EndR econciliationRequest. Used for\nlogging and diagnostics purposes.",
1244 "type": "string"
1245 },
1246 "serviceConfigId": {
1247 "description": "ID of the actual config used to process the request.",
1248 "type": "string"
1249 },
1250 "quotaMetrics": {
1251 "description": "Metric values as tracked by One Platform bef ore the adjustment was made.\nThe following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Va lue for each quota limit associated with the metrics will be specified\nusing th e following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"\n\n3. Delta value of the usage after the reconciliation for limits associated\nwith t he metrics will be specified using the following metric:\n \"serviceruntime.goo gleapis.com/allocation/reconciliation_delta\"\nThe delta value is defined as:\n new_usage_from_client - existing_value_in_spanner.\nThis metric is not defined in serviceruntime.yaml or in Cloud Monarch.\nThis metric is meant for callers' u se only. Since this metric is not\ndefined in the monitoring backend, reporting on this metric will result in\nan error.",
1252 "items": {
1253 "$ref": "MetricValueSet"
1254 },
1255 "type": "array"
1256 }
1257 },
1258 "type": "object"
1259 },
1260 "ExplicitBuckets": {
1261 "description": "Describing buckets with arbitrary user-provided widt h.",
1262 "id": "ExplicitBuckets",
1263 "properties": {
1264 "bounds": {
1265 "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",
1266 "items": {
1267 "format": "double",
1268 "type": "number"
1269 },
1270 "type": "array"
1271 }
1272 },
1273 "type": "object"
1274 },
1275 "Distribution": { 1247 "Distribution": {
1276 "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", 1248 "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",
1277 "id": "Distribution", 1249 "id": "Distribution",
1278 "properties": { 1250 "properties": {
1251 "sumOfSquaredDeviation": {
1252 "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.",
1253 "format": "double",
1254 "type": "number"
1255 },
1256 "exponentialBuckets": {
1257 "$ref": "ExponentialBuckets",
1258 "description": "Buckets with exponentially growing width."
1259 },
1260 "minimum": {
1261 "description": "The minimum of the population of values. Ign ored if `count` is zero.",
1262 "format": "double",
1263 "type": "number"
1264 },
1265 "linearBuckets": {
1266 "$ref": "LinearBuckets",
1267 "description": "Buckets with constant width."
1268 },
1279 "count": { 1269 "count": {
1280 "description": "The total number of samples in the distribut ion. Must be >= 0.", 1270 "description": "The total number of samples in the distribut ion. Must be >= 0.",
1281 "format": "int64", 1271 "format": "int64",
1282 "type": "string" 1272 "type": "string"
1283 }, 1273 },
1284 "mean": { 1274 "mean": {
1285 "description": "The arithmetic mean of the samples in the di stribution. If `count` is\nzero then this field must be zero.", 1275 "description": "The arithmetic mean of the samples in the di stribution. If `count` is\nzero then this field must be zero.",
1286 "format": "double", 1276 "format": "double",
1287 "type": "number" 1277 "type": "number"
1288 }, 1278 },
1289 "bucketCounts": { 1279 "bucketCounts": {
1290 "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.", 1280 "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.",
1291 "items": { 1281 "items": {
1292 "format": "int64", 1282 "format": "int64",
1293 "type": "string" 1283 "type": "string"
1294 }, 1284 },
1295 "type": "array" 1285 "type": "array"
1296 }, 1286 },
1297 "explicitBuckets": { 1287 "explicitBuckets": {
1298 "$ref": "ExplicitBuckets", 1288 "$ref": "ExplicitBuckets",
1299 "description": "Buckets with arbitrary user-provided width." 1289 "description": "Buckets with arbitrary user-provided width."
1300 }, 1290 },
1301 "maximum": { 1291 "maximum": {
1302 "description": "The maximum of the population of values. Ign ored if `count` is zero.", 1292 "description": "The maximum of the population of values. Ign ored if `count` is zero.",
1303 "format": "double", 1293 "format": "double",
1304 "type": "number" 1294 "type": "number"
1305 },
1306 "sumOfSquaredDeviation": {
1307 "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.",
1308 "format": "double",
1309 "type": "number"
1310 },
1311 "exponentialBuckets": {
1312 "$ref": "ExponentialBuckets",
1313 "description": "Buckets with exponentially growing width."
1314 },
1315 "linearBuckets": {
1316 "$ref": "LinearBuckets",
1317 "description": "Buckets with constant width."
1318 },
1319 "minimum": {
1320 "description": "The minimum of the population of values. Ign ored if `count` is zero.",
1321 "format": "double",
1322 "type": "number"
1323 } 1295 }
1324 }, 1296 },
1325 "type": "object" 1297 "type": "object"
1298 },
1299 "ExplicitBuckets": {
1300 "description": "Describing buckets with arbitrary user-provided widt h.",
1301 "id": "ExplicitBuckets",
1302 "properties": {
1303 "bounds": {
1304 "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",
1305 "items": {
1306 "format": "double",
1307 "type": "number"
1308 },
1309 "type": "array"
1310 }
1311 },
1312 "type": "object"
1326 }, 1313 },
1327 "ExponentialBuckets": { 1314 "ExponentialBuckets": {
1328 "description": "Describing buckets with exponentially growing width. ", 1315 "description": "Describing buckets with exponentially growing width. ",
1329 "id": "ExponentialBuckets", 1316 "id": "ExponentialBuckets",
1330 "properties": { 1317 "properties": {
1331 "growthFactor": { 1318 "growthFactor": {
1332 "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.", 1319 "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.",
1333 "format": "double", 1320 "format": "double",
1334 "type": "number" 1321 "type": "number"
1335 }, 1322 },
(...skipping 21 matching lines...) Expand all
1357 "granted": { 1344 "granted": {
1358 "description": "Whether or not authorization for `resource` and `permission`\nwas granted.", 1345 "description": "Whether or not authorization for `resource` and `permission`\nwas granted.",
1359 "type": "boolean" 1346 "type": "boolean"
1360 }, 1347 },
1361 "permission": { 1348 "permission": {
1362 "description": "The required IAM permission.", 1349 "description": "The required IAM permission.",
1363 "type": "string" 1350 "type": "string"
1364 } 1351 }
1365 }, 1352 },
1366 "type": "object" 1353 "type": "object"
1354 },
1355 "StartReconciliationResponse": {
1356 "id": "StartReconciliationResponse",
1357 "properties": {
1358 "serviceConfigId": {
1359 "description": "ID of the actual config used to process the request.",
1360 "type": "string"
1361 },
1362 "quotaMetrics": {
1363 "description": "Metric values as tracked by One Platform bef ore the start of\nreconciliation. The following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric :\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2 . Value for each quota limit associated with the metrics will be specified\nusin g the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"",
1364 "items": {
1365 "$ref": "MetricValueSet"
1366 },
1367 "type": "array"
1368 },
1369 "reconciliationErrors": {
1370 "description": "Indicates the decision of the reconciliation start.",
1371 "items": {
1372 "$ref": "QuotaError"
1373 },
1374 "type": "array"
1375 },
1376 "operationId": {
1377 "description": "The same operation_id value used in the Star tReconciliationRequest. Used\nfor logging and diagnostics purposes.",
1378 "type": "string"
1379 }
1380 },
1381 "type": "object"
1367 } 1382 }
1368 }, 1383 },
1369 "servicePath": "", 1384 "servicePath": "",
1370 "title": "Google Service Control API", 1385 "title": "Google Service Control API",
1371 "version": "v1" 1386 "version": "v1"
1372 } 1387 }
OLDNEW
« no previous file with comments | « discovery/googleapis/searchconsole__v1.json ('k') | discovery/googleapis/servicemanagement__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698