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

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

Issue 2936613002: Api-Roll 50: 2017-06-12 (Closed)
Patch Set: Created 3 years, 6 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/servicecontrol": { 5 "https://www.googleapis.com/auth/servicecontrol": {
6 "description": "Manage your Google Service Control data" 6 "description": "Manage your Google Service Control data"
7 }, 7 },
8 "https://www.googleapis.com/auth/cloud-platform": { 8 "https://www.googleapis.com/auth/cloud-platform": {
9 "description": "View and manage your data across Google Clou d Platform services" 9 "description": "View and manage your data across Google Clou d Platform services"
10 } 10 }
(...skipping 10 matching lines...) Expand all
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 "uploadType": { 31 "upload_protocol": {
32 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
33 "location": "query", 33 "location": "query",
34 "type": "string" 34 "type": "string"
35 }, 35 },
36 "prettyPrint": {
37 "default": "true",
38 "description": "Returns response with indentations and line breaks." ,
39 "location": "query",
40 "type": "boolean"
41 },
36 "fields": { 42 "fields": {
37 "description": "Selector specifying which fields to include in a par tial response.", 43 "description": "Selector specifying which fields to include in a par tial response.",
38 "location": "query", 44 "location": "query",
39 "type": "string" 45 "type": "string"
40 }, 46 },
41 "callback": { 47 "uploadType": {
42 "description": "JSONP", 48 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
43 "location": "query", 49 "location": "query",
44 "type": "string" 50 "type": "string"
45 }, 51 },
46 "$.xgafv": { 52 "$.xgafv": {
47 "description": "V1 error format.", 53 "description": "V1 error format.",
48 "enum": [ 54 "enum": [
49 "1", 55 "1",
50 "2" 56 "2"
51 ], 57 ],
52 "enumDescriptions": [ 58 "enumDescriptions": [
53 "v1 error format", 59 "v1 error format",
54 "v2 error format" 60 "v2 error format"
55 ], 61 ],
56 "location": "query", 62 "location": "query",
57 "type": "string" 63 "type": "string"
58 }, 64 },
65 "callback": {
66 "description": "JSONP",
67 "location": "query",
68 "type": "string"
69 },
59 "alt": { 70 "alt": {
60 "default": "json", 71 "default": "json",
61 "description": "Data format for response.", 72 "description": "Data format for response.",
62 "enum": [ 73 "enum": [
63 "json", 74 "json",
64 "media", 75 "media",
65 "proto" 76 "proto"
66 ], 77 ],
67 "enumDescriptions": [ 78 "enumDescriptions": [
68 "Responses with Content-Type of application/json", 79 "Responses with Content-Type of application/json",
(...skipping 17 matching lines...) Expand all
86 "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.",
87 "location": "query", 98 "location": "query",
88 "type": "string" 99 "type": "string"
89 }, 100 },
90 "pp": { 101 "pp": {
91 "default": "true", 102 "default": "true",
92 "description": "Pretty-print response.", 103 "description": "Pretty-print response.",
93 "location": "query", 104 "location": "query",
94 "type": "boolean" 105 "type": "boolean"
95 }, 106 },
96 "bearer_token": {
97 "description": "OAuth bearer token.",
98 "location": "query",
99 "type": "string"
100 },
101 "oauth_token": { 107 "oauth_token": {
102 "description": "OAuth 2.0 token for the current user.", 108 "description": "OAuth 2.0 token for the current user.",
103 "location": "query", 109 "location": "query",
104 "type": "string" 110 "type": "string"
105 }, 111 },
106 "upload_protocol": { 112 "bearer_token": {
107 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 113 "description": "OAuth bearer token.",
108 "location": "query", 114 "location": "query",
109 "type": "string" 115 "type": "string"
110 },
111 "prettyPrint": {
112 "default": "true",
113 "description": "Returns response with indentations and line breaks." ,
114 "location": "query",
115 "type": "boolean"
116 } 116 }
117 }, 117 },
118 "protocol": "rest", 118 "protocol": "rest",
119 "resources": { 119 "resources": {
120 "services": { 120 "services": {
121 "methods": { 121 "methods": {
122 "startReconciliation": {
123 "description": "Unlike rate quota, allocation quota does not get refilled periodically.\nSo, it is possible that the quota usage as seen by the service differs from\nwhat the One Platform considers the usage is. This is expected to happen\nonly rarely, but over time this can accumulate. Services can invoke\nStartReconciliation and EndReconciliation to correct this usage drift, as\ndescribed below:\n1. Service sends StartReconciliation with a timestamp in f uture for each\n metric that needs to be reconciled. The timestamp being in fu ture allows\n to account for in-flight AllocateQuota and ReleaseQuota requests for the\n same metric.\n2. One Platform records this timestamp and starts tra cking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconcilia tion is\n called.\n3. At or after the time specified in the StartReconciliatio n, service\n sends EndReconciliation with the usage that needs to be reconcile d to.\n4. One Platform adjusts its own record of usage for that metric to the\n value specified in EndReconciliation by taking in to account any\n allocatio n or release between StartReconciliation and EndReconciliation.\n\nSignals the q uota controller that the service wants to perform a usage\nreconciliation as spe cified in the request.\n\nThis method requires the `servicemanagement.services.q uota`\npermission on the specified service. For more information, see\n[Google C loud IAM](https://cloud.google.com/iam).",
124 "httpMethod": "POST",
125 "id": "servicecontrol.services.startReconciliation",
126 "parameterOrder": [
127 "serviceName"
128 ],
129 "parameters": {
130 "serviceName": {
131 "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee goo gle.api.Service for the definition of a service name.",
132 "location": "path",
133 "required": true,
134 "type": "string"
135 }
136 },
137 "path": "v1/services/{serviceName}:startReconciliation",
138 "request": {
139 "$ref": "StartReconciliationRequest"
140 },
141 "response": {
142 "$ref": "StartReconciliationResponse"
143 },
144 "scopes": [
145 "https://www.googleapis.com/auth/cloud-platform",
146 "https://www.googleapis.com/auth/servicecontrol"
147 ]
148 },
122 "check": { 149 "check": {
123 "description": "Checks an operation with Google Service Cont rol to decide whether\nthe given operation should proceed. It should be called b efore the\noperation is executed.\n\nIf feasible, the client should cache the ch eck results and reuse them for\n60 seconds. In case of server errors, the client can rely on the cached\nresults for longer time.\n\nNOTE: the `CheckRequest` ha s the size limit of 64KB.\n\nThis method requires the `servicemanagement.service s.check` permission\non the specified service. For more information, see\n[Googl e Cloud IAM](https://cloud.google.com/iam).", 150 "description": "Checks an operation with Google Service Cont rol to decide whether\nthe given operation should proceed. It should be called b efore the\noperation is executed.\n\nIf feasible, the client should cache the ch eck results and reuse them for\n60 seconds. In case of server errors, the client can rely on the cached\nresults for longer time.\n\nNOTE: the `CheckRequest` ha s the size limit of 64KB.\n\nThis method requires the `servicemanagement.service s.check` permission\non the specified service. For more information, see\n[Googl e Cloud IAM](https://cloud.google.com/iam).",
124 "httpMethod": "POST", 151 "httpMethod": "POST",
125 "id": "servicecontrol.services.check", 152 "id": "servicecontrol.services.check",
126 "parameterOrder": [ 153 "parameterOrder": [
127 "serviceName" 154 "serviceName"
128 ], 155 ],
129 "parameters": { 156 "parameters": {
130 "serviceName": { 157 "serviceName": {
131 "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google .api.Service for the definition of a service name.", 158 "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google .api.Service for the definition of a service name.",
(...skipping 114 matching lines...) Expand 10 before | Expand all | Expand 10 after
246 "request": { 273 "request": {
247 "$ref": "AllocateQuotaRequest" 274 "$ref": "AllocateQuotaRequest"
248 }, 275 },
249 "response": { 276 "response": {
250 "$ref": "AllocateQuotaResponse" 277 "$ref": "AllocateQuotaResponse"
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 "startReconciliation": {
258 "description": "Unlike rate quota, allocation quota does not get refilled periodically.\nSo, it is possible that the quota usage as seen by the service differs from\nwhat the One Platform considers the usage is. This is expected to happen\nonly rarely, but over time this can accumulate. Services can invoke\nStartReconciliation and EndReconciliation to correct this usage drift, as\ndescribed below:\n1. Service sends StartReconciliation with a timestamp in f uture for each\n metric that needs to be reconciled. The timestamp being in fu ture allows\n to account for in-flight AllocateQuota and ReleaseQuota requests for the\n same metric.\n2. One Platform records this timestamp and starts tra cking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconcilia tion is\n called.\n3. At or after the time specified in the StartReconciliatio n, service\n sends EndReconciliation with the usage that needs to be reconcile d to.\n4. One Platform adjusts its own record of usage for that metric to the\n value specified in EndReconciliation by taking in to account any\n allocatio n or release between StartReconciliation and EndReconciliation.\n\nSignals the q uota controller that the service wants to perform a usage\nreconciliation as spe cified in the request.\n\nThis method requires the `servicemanagement.services.q uota`\npermission on the specified service. For more information, see\n[Google C loud IAM](https://cloud.google.com/iam).",
259 "httpMethod": "POST",
260 "id": "servicecontrol.services.startReconciliation",
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}:startReconciliation",
273 "request": {
274 "$ref": "StartReconciliationRequest"
275 },
276 "response": {
277 "$ref": "StartReconciliationResponse"
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": "20170515", 287 "revision": "20170529",
288 "rootUrl": "https://servicecontrol.googleapis.com/", 288 "rootUrl": "https://servicecontrol.googleapis.com/",
289 "schemas": { 289 "schemas": {
290 "Money": {
291 "description": "Represents an amount of money with its currency type .",
292 "id": "Money",
293 "properties": {
294 "currencyCode": {
295 "description": "The 3-letter currency code defined in ISO 42 17.",
296 "type": "string"
297 },
298 "nanos": {
299 "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.",
300 "format": "int32",
301 "type": "integer"
302 },
303 "units": {
304 "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
305 "format": "int64",
306 "type": "string"
307 }
308 },
309 "type": "object"
310 },
311 "EndReconciliationResponse": {
312 "id": "EndReconciliationResponse",
313 "properties": {
314 "quotaMetrics": {
315 "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.",
316 "items": {
317 "$ref": "MetricValueSet"
318 },
319 "type": "array"
320 },
321 "operationId": {
322 "description": "The same operation_id value used in the EndR econciliationRequest. Used for\nlogging and diagnostics purposes.",
323 "type": "string"
324 },
325 "reconciliationErrors": {
326 "description": "Indicates the decision of the reconciliation end.",
327 "items": {
328 "$ref": "QuotaError"
329 },
330 "type": "array"
331 },
332 "serviceConfigId": {
333 "description": "ID of the actual config used to process the request.",
334 "type": "string"
335 }
336 },
337 "type": "object"
338 },
339 "ExplicitBuckets": {
340 "description": "Describing buckets with arbitrary user-provided widt h.",
341 "id": "ExplicitBuckets",
342 "properties": {
343 "bounds": {
344 "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",
345 "items": {
346 "format": "double",
347 "type": "number"
348 },
349 "type": "array"
350 }
351 },
352 "type": "object"
353 },
354 "Distribution": {
355 "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",
356 "id": "Distribution",
357 "properties": {
358 "exponentialBuckets": {
359 "$ref": "ExponentialBuckets",
360 "description": "Buckets with exponentially growing width."
361 },
362 "linearBuckets": {
363 "$ref": "LinearBuckets",
364 "description": "Buckets with constant width."
365 },
366 "minimum": {
367 "description": "The minimum of the population of values. Ign ored if `count` is zero.",
368 "format": "double",
369 "type": "number"
370 },
371 "mean": {
372 "description": "The arithmetic mean of the samples in the di stribution. If `count` is\nzero then this field must be zero.",
373 "format": "double",
374 "type": "number"
375 },
376 "count": {
377 "description": "The total number of samples in the distribut ion. Must be >= 0.",
378 "format": "int64",
379 "type": "string"
380 },
381 "bucketCounts": {
382 "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.",
383 "items": {
384 "format": "int64",
385 "type": "string"
386 },
387 "type": "array"
388 },
389 "explicitBuckets": {
390 "$ref": "ExplicitBuckets",
391 "description": "Buckets with arbitrary user-provided width."
392 },
393 "maximum": {
394 "description": "The maximum of the population of values. Ign ored if `count` is zero.",
395 "format": "double",
396 "type": "number"
397 },
398 "sumOfSquaredDeviation": {
399 "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.",
400 "format": "double",
401 "type": "number"
402 }
403 },
404 "type": "object"
405 },
406 "ExponentialBuckets": {
407 "description": "Describing buckets with exponentially growing width. ",
408 "id": "ExponentialBuckets",
409 "properties": {
410 "growthFactor": {
411 "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.",
412 "format": "double",
413 "type": "number"
414 },
415 "scale": {
416 "description": "The i'th exponential bucket covers the inter val\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges fr om 1 to num_finite_buckets inclusive.\nMust be > 0.",
417 "format": "double",
418 "type": "number"
419 },
420 "numFiniteBuckets": {
421 "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.",
422 "format": "int32",
423 "type": "integer"
424 }
425 },
426 "type": "object"
427 },
428 "AuthorizationInfo": {
429 "description": "Authorization information for the operation.",
430 "id": "AuthorizationInfo",
431 "properties": {
432 "granted": {
433 "description": "Whether or not authorization for `resource` and `permission`\nwas granted.",
434 "type": "boolean"
435 },
436 "permission": {
437 "description": "The required IAM permission.",
438 "type": "string"
439 },
440 "resource": {
441 "description": "The resource being accessed, as a REST-style string. For example:\n\n bigquery.googlapis.com/projects/PROJECTID/datasets/ DATASETID",
442 "type": "string"
443 }
444 },
445 "type": "object"
446 },
447 "StartReconciliationResponse": {
448 "id": "StartReconciliationResponse",
449 "properties": {
450 "quotaMetrics": {
451 "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\"",
452 "items": {
453 "$ref": "MetricValueSet"
454 },
455 "type": "array"
456 },
457 "operationId": {
458 "description": "The same operation_id value used in the Star tReconciliationRequest. Used\nfor logging and diagnostics purposes.",
459 "type": "string"
460 },
461 "reconciliationErrors": {
462 "description": "Indicates the decision of the reconciliation start.",
463 "items": {
464 "$ref": "QuotaError"
465 },
466 "type": "array"
467 },
468 "serviceConfigId": {
469 "description": "ID of the actual config used to process the request.",
470 "type": "string"
471 }
472 },
473 "type": "object"
474 },
290 "QuotaProperties": { 475 "QuotaProperties": {
291 "description": "Represents the properties needed for quota operation s.", 476 "description": "Represents the properties needed for quota operation s.",
292 "id": "QuotaProperties", 477 "id": "QuotaProperties",
293 "properties": { 478 "properties": {
294 "limitByIds": { 479 "limitByIds": {
295 "additionalProperties": { 480 "additionalProperties": {
296 "type": "string" 481 "type": "string"
297 }, 482 },
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.", 483 "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.",
299 "type": "object" 484 "type": "object"
(...skipping 14 matching lines...) Expand all
314 ], 499 ],
315 "type": "string" 500 "type": "string"
316 } 501 }
317 }, 502 },
318 "type": "object" 503 "type": "object"
319 }, 504 },
320 "LinearBuckets": { 505 "LinearBuckets": {
321 "description": "Describing buckets with constant width.", 506 "description": "Describing buckets with constant width.",
322 "id": "LinearBuckets", 507 "id": "LinearBuckets",
323 "properties": { 508 "properties": {
509 "width": {
510 "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.",
511 "format": "double",
512 "type": "number"
513 },
514 "offset": {
515 "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.",
516 "format": "double",
517 "type": "number"
518 },
324 "numFiniteBuckets": { 519 "numFiniteBuckets": {
325 "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.", 520 "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.",
326 "format": "int32", 521 "format": "int32",
327 "type": "integer" 522 "type": "integer"
328 },
329 "width": {
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.\nMust be strictly positive.",
331 "format": "double",
332 "type": "number"
333 },
334 "offset": {
335 "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.",
336 "format": "double",
337 "type": "number"
338 } 523 }
339 }, 524 },
340 "type": "object" 525 "type": "object"
341 }, 526 },
342 "AuthenticationInfo": { 527 "AuthenticationInfo": {
343 "description": "Authentication information for the operation.", 528 "description": "Authentication information for the operation.",
344 "id": "AuthenticationInfo", 529 "id": "AuthenticationInfo",
345 "properties": { 530 "properties": {
531 "authoritySelector": {
532 "description": "The authority selector specified by the requ estor, if any.\nIt is not guaranteed that the principal was allowed to use this authority.",
533 "type": "string"
534 },
346 "principalEmail": { 535 "principalEmail": {
347 "description": "The email address of the authenticated user making the request.", 536 "description": "The email address of the authenticated user making the request.",
348 "type": "string" 537 "type": "string"
349 },
350 "authoritySelector": {
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.",
352 "type": "string"
353 } 538 }
354 }, 539 },
355 "type": "object" 540 "type": "object"
356 }, 541 },
357 "AllocateQuotaResponse": { 542 "AllocateQuotaResponse": {
358 "description": "Response message for the AllocateQuota method.", 543 "description": "Response message for the AllocateQuota method.",
359 "id": "AllocateQuotaResponse", 544 "id": "AllocateQuotaResponse",
360 "properties": { 545 "properties": {
361 "operationId": { 546 "operationId": {
362 "description": "The same operation_id value used in the Allo cateQuotaRequest. Used for\nlogging and diagnostics purposes.", 547 "description": "The same operation_id value used in the Allo cateQuotaRequest. Used for\nlogging and diagnostics purposes.",
(...skipping 28 matching lines...) Expand all
391 "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.", 576 "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.",
392 "type": "string" 577 "type": "string"
393 }, 578 },
394 "releaseOperation": { 579 "releaseOperation": {
395 "$ref": "QuotaOperation", 580 "$ref": "QuotaOperation",
396 "description": "Operation that describes the quota release." 581 "description": "Operation that describes the quota release."
397 } 582 }
398 }, 583 },
399 "type": "object" 584 "type": "object"
400 }, 585 },
586 "RequestMetadata": {
587 "description": "Metadata about the request.",
588 "id": "RequestMetadata",
589 "properties": {
590 "callerSuppliedUserAgent": {
591 "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.\n\nNOLINT",
592 "type": "string"
593 },
594 "callerIp": {
595 "description": "The IP address of the caller.",
596 "type": "string"
597 }
598 },
599 "type": "object"
600 },
401 "QuotaError": { 601 "QuotaError": {
402 "id": "QuotaError", 602 "id": "QuotaError",
403 "properties": { 603 "properties": {
404 "subject": { 604 "subject": {
405 "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>\".", 605 "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>\".",
406 "type": "string" 606 "type": "string"
407 }, 607 },
408 "description": { 608 "description": {
409 "description": "Free-form text that provides details on the cause of the error.", 609 "description": "Free-form text that provides details on the cause of the error.",
410 "type": "string" 610 "type": "string"
411 }, 611 },
412 "code": { 612 "code": {
413 "description": "Error code.", 613 "description": "Error code.",
414 "enum": [ 614 "enum": [
415 "UNSPECIFIED", 615 "UNSPECIFIED",
416 "RESOURCE_EXHAUSTED", 616 "RESOURCE_EXHAUSTED",
417 "PROJECT_SUSPENDED",
418 "SERVICE_NOT_ENABLED",
419 "BILLING_NOT_ACTIVE", 617 "BILLING_NOT_ACTIVE",
420 "PROJECT_DELETED", 618 "PROJECT_DELETED",
421 "PROJECT_INVALID",
422 "IP_ADDRESS_BLOCKED",
423 "REFERER_BLOCKED",
424 "CLIENT_APP_BLOCKED",
425 "API_KEY_INVALID", 619 "API_KEY_INVALID",
426 "API_KEY_EXPIRED", 620 "API_KEY_EXPIRED",
427 "SPATULA_HEADER_INVALID", 621 "SPATULA_HEADER_INVALID",
428 "LOAS_ROLE_INVALID", 622 "LOAS_ROLE_INVALID",
429 "NO_LOAS_PROJECT", 623 "NO_LOAS_PROJECT",
430 "PROJECT_STATUS_UNAVAILABLE", 624 "PROJECT_STATUS_UNAVAILABLE",
431 "SERVICE_STATUS_UNAVAILABLE", 625 "SERVICE_STATUS_UNAVAILABLE",
432 "BILLING_STATUS_UNAVAILABLE", 626 "BILLING_STATUS_UNAVAILABLE",
433 "QUOTA_SYSTEM_UNAVAILABLE" 627 "QUOTA_SYSTEM_UNAVAILABLE"
434 ], 628 ],
435 "enumDescriptions": [ 629 "enumDescriptions": [
436 "This is never used.", 630 "This is never used.",
437 "Quota allocation failed.\nSame as google.rpc.Code.RESOU RCE_EXHAUSTED.", 631 "Quota allocation failed.\nSame as google.rpc.Code.RESOU RCE_EXHAUSTED.",
438 "Consumer project has been suspended.", 632 "Consumer cannot access the service because the service requires active\nbilling.",
439 "Consumer has not enabled the service.",
440 "Consumer cannot access the service because billing is d isabled.",
441 "Consumer's project has been marked as deleted (soft del etion).", 633 "Consumer's project has been marked as deleted (soft del etion).",
442 "Consumer's project number or ID does not represent a va lid project.",
443 "IP address of the consumer is invalid for the specific consumer\nproject.",
444 "Referer address of the consumer request is invalid for the specific\nconsumer project.",
445 "Client application of the consumer request is invalid f or the\nspecific consumer project.",
446 "Specified API key is invalid.", 634 "Specified API key is invalid.",
447 "Specified API Key has expired.", 635 "Specified API Key has expired.",
448 "Consumer's spatula header is invalid.", 636 "Consumer's spatula header is invalid.",
449 "The consumer's LOAS role is invalid.", 637 "The consumer's LOAS role is invalid.",
450 "The consumer's LOAS role has no associated project.", 638 "The consumer's LOAS role has no associated project.",
451 "The backend server for looking up project id/number is unavailable.", 639 "The backend server for looking up project id/number is unavailable.",
452 "The backend server for checking service status is unava ilable.", 640 "The backend server for checking service status is unava ilable.",
453 "The backend server for checking billing status is unava ilable.", 641 "The backend server for checking billing status is unava ilable.",
454 "The backend server for checking quota limits is unavail able." 642 "The backend server for checking quota limits is unavail able."
455 ], 643 ],
456 "type": "string" 644 "type": "string"
457 } 645 }
458 }, 646 },
459 "type": "object" 647 "type": "object"
460 }, 648 },
461 "RequestMetadata": {
462 "description": "Metadata about the request.",
463 "id": "RequestMetadata",
464 "properties": {
465 "callerIp": {
466 "description": "The IP address of the caller.",
467 "type": "string"
468 },
469 "callerSuppliedUserAgent": {
470 "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.",
471 "type": "string"
472 }
473 },
474 "type": "object"
475 },
476 "CheckInfo": { 649 "CheckInfo": {
477 "id": "CheckInfo", 650 "id": "CheckInfo",
478 "properties": { 651 "properties": {
479 "unusedArguments": { 652 "unusedArguments": {
480 "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.", 653 "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.",
481 "items": { 654 "items": {
482 "type": "string" 655 "type": "string"
483 }, 656 },
484 "type": "array" 657 "type": "array"
485 } 658 }
486 }, 659 },
487 "type": "object" 660 "type": "object"
488 }, 661 },
489 "ReleaseQuotaResponse": {
490 "description": "Response message for the ReleaseQuota method.",
491 "id": "ReleaseQuotaResponse",
492 "properties": {
493 "releaseErrors": {
494 "description": "Indicates the decision of the release.",
495 "items": {
496 "$ref": "QuotaError"
497 },
498 "type": "array"
499 },
500 "quotaMetrics": {
501 "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\"",
502 "items": {
503 "$ref": "MetricValueSet"
504 },
505 "type": "array"
506 },
507 "operationId": {
508 "description": "The same operation_id value used in the Rele aseQuotaRequest. Used for\nlogging and diagnostics purposes.",
509 "type": "string"
510 },
511 "serviceConfigId": {
512 "description": "ID of the actual config used to process the request.",
513 "type": "string"
514 }
515 },
516 "type": "object"
517 },
518 "AllocateQuotaRequest": { 662 "AllocateQuotaRequest": {
519 "description": "Request message for the AllocateQuota method.", 663 "description": "Request message for the AllocateQuota method.",
520 "id": "AllocateQuotaRequest", 664 "id": "AllocateQuotaRequest",
521 "properties": { 665 "properties": {
522 "allocateOperation": { 666 "allocateOperation": {
523 "$ref": "QuotaOperation", 667 "$ref": "QuotaOperation",
524 "description": "Operation that describes the quota allocatio n." 668 "description": "Operation that describes the quota allocatio n."
525 }, 669 },
526 "allocationMode": { 670 "allocationMode": {
527 "description": "Allocation mode for this operation.\nDepreca ted: use QuotaMode inside the QuotaOperation.", 671 "description": "Allocation mode for this operation.\nDepreca ted: use QuotaMode inside the QuotaOperation.",
(...skipping 11 matching lines...) Expand all
539 ], 683 ],
540 "type": "string" 684 "type": "string"
541 }, 685 },
542 "serviceConfigId": { 686 "serviceConfigId": {
543 "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.", 687 "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.",
544 "type": "string" 688 "type": "string"
545 } 689 }
546 }, 690 },
547 "type": "object" 691 "type": "object"
548 }, 692 },
693 "ReleaseQuotaResponse": {
694 "description": "Response message for the ReleaseQuota method.",
695 "id": "ReleaseQuotaResponse",
696 "properties": {
697 "operationId": {
698 "description": "The same operation_id value used in the Rele aseQuotaRequest. Used for\nlogging and diagnostics purposes.",
699 "type": "string"
700 },
701 "serviceConfigId": {
702 "description": "ID of the actual config used to process the request.",
703 "type": "string"
704 },
705 "releaseErrors": {
706 "description": "Indicates the decision of the release.",
707 "items": {
708 "$ref": "QuotaError"
709 },
710 "type": "array"
711 },
712 "quotaMetrics": {
713 "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\"",
714 "items": {
715 "$ref": "MetricValueSet"
716 },
717 "type": "array"
718 }
719 },
720 "type": "object"
721 },
549 "MetricValueSet": { 722 "MetricValueSet": {
550 "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.", 723 "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.",
551 "id": "MetricValueSet", 724 "id": "MetricValueSet",
552 "properties": { 725 "properties": {
553 "metricName": { 726 "metricName": {
554 "description": "The metric name defined in the service confi guration.", 727 "description": "The metric name defined in the service confi guration.",
555 "type": "string" 728 "type": "string"
556 }, 729 },
557 "metricValues": { 730 "metricValues": {
558 "description": "The values in this metric.", 731 "description": "The values in this metric.",
559 "items": { 732 "items": {
560 "$ref": "MetricValue" 733 "$ref": "MetricValue"
561 }, 734 },
562 "type": "array" 735 "type": "array"
563 } 736 }
564 }, 737 },
565 "type": "object" 738 "type": "object"
566 }, 739 },
567 "ReportError": { 740 "ReportError": {
568 "description": "Represents the processing error of one `Operation` i n the request.", 741 "description": "Represents the processing error of one `Operation` i n the request.",
569 "id": "ReportError", 742 "id": "ReportError",
570 "properties": { 743 "properties": {
744 "operationId": {
745 "description": "The Operation.operation_id value from the re quest.",
746 "type": "string"
747 },
571 "status": { 748 "status": {
572 "$ref": "Status", 749 "$ref": "Status",
573 "description": "Details of the error when processing the `Op eration`." 750 "description": "Details of the error when processing the `Op eration`."
751 }
752 },
753 "type": "object"
754 },
755 "StartReconciliationRequest": {
756 "id": "StartReconciliationRequest",
757 "properties": {
758 "reconciliationOperation": {
759 "$ref": "QuotaOperation",
760 "description": "Operation that describes the quota reconcili ation."
574 }, 761 },
575 "operationId": { 762 "serviceConfigId": {
576 "description": "The Operation.operation_id value from the re quest.", 763 "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.",
577 "type": "string" 764 "type": "string"
578 } 765 }
579 }, 766 },
580 "type": "object" 767 "type": "object"
581 }, 768 },
582 "CheckError": { 769 "CheckError": {
583 "description": "Defines the errors to be returned in\ngoogle.api.ser vicecontrol.v1.CheckResponse.check_errors.", 770 "description": "Defines the errors to be returned in\ngoogle.api.ser vicecontrol.v1.CheckResponse.check_errors.",
584 "id": "CheckError", 771 "id": "CheckError",
585 "properties": { 772 "properties": {
773 "detail": {
774 "description": "Free-form text providing details on the erro r cause of the error.",
775 "type": "string"
776 },
586 "code": { 777 "code": {
587 "description": "The error code.", 778 "description": "The error code.",
588 "enum": [ 779 "enum": [
589 "ERROR_CODE_UNSPECIFIED", 780 "ERROR_CODE_UNSPECIFIED",
590 "NOT_FOUND", 781 "NOT_FOUND",
591 "PERMISSION_DENIED", 782 "PERMISSION_DENIED",
592 "RESOURCE_EXHAUSTED", 783 "RESOURCE_EXHAUSTED",
593 "BUDGET_EXCEEDED", 784 "BUDGET_EXCEEDED",
594 "DENIAL_OF_SERVICE_DETECTED", 785 "DENIAL_OF_SERVICE_DETECTED",
595 "LOAD_SHEDDING", 786 "LOAD_SHEDDING",
(...skipping 51 matching lines...) Expand 10 before | Expand all | Expand 10 after
647 "Request is not allowed as per security policies defined in Org Policy.", 838 "Request is not allowed as per security policies defined in Org Policy.",
648 "The backend server for looking up project id/number is unavailable.", 839 "The backend server for looking up project id/number is unavailable.",
649 "The backend server for checking service status is unava ilable.", 840 "The backend server for checking service status is unava ilable.",
650 "The backend server for checking billing status is unava ilable.", 841 "The backend server for checking billing status is unava ilable.",
651 "The backend server for checking quota limits is unavail able.", 842 "The backend server for checking quota limits is unavail able.",
652 "The Spanner for looking up LOAS project is unavailable. ", 843 "The Spanner for looking up LOAS project is unavailable. ",
653 "Cloud Resource Manager backend server is unavailable.", 844 "Cloud Resource Manager backend server is unavailable.",
654 "Backend server for evaluating security policy is unavai lable." 845 "Backend server for evaluating security policy is unavai lable."
655 ], 846 ],
656 "type": "string" 847 "type": "string"
657 },
658 "detail": {
659 "description": "Free-form text providing details on the erro r cause of the error.",
660 "type": "string"
661 } 848 }
662 }, 849 },
663 "type": "object" 850 "type": "object"
664 },
665 "StartReconciliationRequest": {
666 "id": "StartReconciliationRequest",
667 "properties": {
668 "reconciliationOperation": {
669 "$ref": "QuotaOperation",
670 "description": "Operation that describes the quota reconcili ation."
671 },
672 "serviceConfigId": {
673 "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.",
674 "type": "string"
675 }
676 },
677 "type": "object"
678 }, 851 },
679 "QuotaInfo": { 852 "QuotaInfo": {
680 "description": "Contains the quota information for a quota check res ponse.", 853 "description": "Contains the quota information for a quota check res ponse.",
681 "id": "QuotaInfo", 854 "id": "QuotaInfo",
682 "properties": { 855 "properties": {
683 "limitExceeded": { 856 "limitExceeded": {
684 "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.", 857 "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.",
685 "items": { 858 "items": {
686 "type": "string" 859 "type": "string"
687 }, 860 },
(...skipping 52 matching lines...) Expand 10 before | Expand all | Expand 10 after
740 "type": "object" 913 "type": "object"
741 }, 914 },
742 "consumerId": { 915 "consumerId": {
743 "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> .", 916 "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> .",
744 "type": "string" 917 "type": "string"
745 }, 918 },
746 "operationId": { 919 "operationId": {
747 "description": "Identity of the operation. This must be uniq ue within the scope of the\nservice that generated the operation. If the service calls AllocateQuota\nand ReleaseQuota on the same operation, the two calls shou ld carry the\nsame ID.\n\nUUID version 4 is recommended, though not required. In scenarios where an\noperation is computed from existing information and an idem potent id is\ndesirable for deduplication purpose, UUID version 5 is recommended . See\nRFC 4122 for details.", 920 "description": "Identity of the operation. This must be uniq ue within the scope of the\nservice that generated the operation. If the service calls AllocateQuota\nand ReleaseQuota on the same operation, the two calls shou ld carry the\nsame ID.\n\nUUID version 4 is recommended, though not required. In scenarios where an\noperation is computed from existing information and an idem potent id is\ndesirable for deduplication purpose, UUID version 5 is recommended . See\nRFC 4122 for details.",
748 "type": "string" 921 "type": "string"
749 }, 922 },
750 "methodName": {
751 "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",
752 "type": "string"
753 },
754 "quotaMode": { 923 "quotaMode": {
755 "description": "Quota mode for this operation.", 924 "description": "Quota mode for this operation.",
756 "enum": [ 925 "enum": [
757 "UNSPECIFIED", 926 "UNSPECIFIED",
758 "NORMAL", 927 "NORMAL",
759 "BEST_EFFORT", 928 "BEST_EFFORT",
760 "CHECK_ONLY" 929 "CHECK_ONLY"
761 ], 930 ],
762 "enumDescriptions": [ 931 "enumDescriptions": [
763 "", 932 "",
764 "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.", 933 "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.",
765 "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.", 934 "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.",
766 "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." 935 "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."
767 ], 936 ],
768 "type": "string" 937 "type": "string"
769 }, 938 },
939 "methodName": {
940 "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",
941 "type": "string"
942 },
770 "quotaMetrics": { 943 "quotaMetrics": {
771 "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." , 944 "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." ,
772 "items": { 945 "items": {
773 "$ref": "MetricValueSet" 946 "$ref": "MetricValueSet"
774 }, 947 },
775 "type": "array" 948 "type": "array"
776 } 949 }
777 }, 950 },
778 "type": "object" 951 "type": "object"
779 }, 952 },
(...skipping 22 matching lines...) Expand all
802 "$ref": "QuotaInfo", 975 "$ref": "QuotaInfo",
803 "description": "Quota usage info when processing the `Operat ion`." 976 "description": "Quota usage info when processing the `Operat ion`."
804 } 977 }
805 }, 978 },
806 "type": "object" 979 "type": "object"
807 }, 980 },
808 "Operation": { 981 "Operation": {
809 "description": "Represents information regarding an operation.", 982 "description": "Represents information regarding an operation.",
810 "id": "Operation", 983 "id": "Operation",
811 "properties": { 984 "properties": {
812 "quotaProperties": {
813 "$ref": "QuotaProperties",
814 "description": "Represents the properties needed for quota c heck. Applicable only if this\noperation is for a quota check request."
815 },
816 "consumerId": { 985 "consumerId": {
817 "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>.", 986 "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>.",
818 "type": "string" 987 "type": "string"
819 }, 988 },
820 "operationId": { 989 "operationId": {
821 "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.", 990 "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.",
822 "type": "string" 991 "type": "string"
823 }, 992 },
993 "operationName": {
994 "description": "Fully qualified name of the operation. Reser ved for future use.",
995 "type": "string"
996 },
824 "endTime": { 997 "endTime": {
825 "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.", 998 "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.",
826 "format": "google-datetime", 999 "format": "google-datetime",
827 "type": "string" 1000 "type": "string"
828 }, 1001 },
829 "operationName": {
830 "description": "Fully qualified name of the operation. Reser ved for future use.",
831 "type": "string"
832 },
833 "startTime": { 1002 "startTime": {
834 "description": "Required. Start time of the operation.", 1003 "description": "Required. Start time of the operation.",
835 "format": "google-datetime", 1004 "format": "google-datetime",
836 "type": "string" 1005 "type": "string"
837 }, 1006 },
838 "importance": { 1007 "importance": {
839 "description": "DO NOT USE. This is an experimental field.", 1008 "description": "DO NOT USE. This is an experimental field.",
840 "enum": [ 1009 "enum": [
841 "LOW", 1010 "LOW",
842 "HIGH", 1011 "HIGH",
(...skipping 30 matching lines...) Expand all
873 }, 1042 },
874 "description": "User defined labels for the resource that th is operation is associated\nwith.", 1043 "description": "User defined labels for the resource that th is operation is associated\nwith.",
875 "type": "object" 1044 "type": "object"
876 }, 1045 },
877 "metricValueSets": { 1046 "metricValueSets": {
878 "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." , 1047 "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." ,
879 "items": { 1048 "items": {
880 "$ref": "MetricValueSet" 1049 "$ref": "MetricValueSet"
881 }, 1050 },
882 "type": "array" 1051 "type": "array"
1052 },
1053 "quotaProperties": {
1054 "$ref": "QuotaProperties",
1055 "description": "Represents the properties needed for quota c heck. Applicable only if this\noperation is for a quota check request."
883 } 1056 }
884 }, 1057 },
885 "type": "object" 1058 "type": "object"
886 }, 1059 },
887 "ReportResponse": { 1060 "ReportResponse": {
888 "description": "Response message for the Report method.", 1061 "description": "Response message for the Report method.",
889 "id": "ReportResponse", 1062 "id": "ReportResponse",
890 "properties": { 1063 "properties": {
891 "reportErrors": { 1064 "reportErrors": {
892 "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.", 1065 "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.",
(...skipping 39 matching lines...) Expand 10 before | Expand all | Expand 10 after
932 "$ref": "QuotaInfo", 1105 "$ref": "QuotaInfo",
933 "description": "Quota information for the check request asso ciated with this response.\n" 1106 "description": "Quota information for the check request asso ciated with this response.\n"
934 }, 1107 },
935 "serviceConfigId": { 1108 "serviceConfigId": {
936 "description": "The actual config id used to process the req uest.", 1109 "description": "The actual config id used to process the req uest.",
937 "type": "string" 1110 "type": "string"
938 } 1111 }
939 }, 1112 },
940 "type": "object" 1113 "type": "object"
941 }, 1114 },
1115 "ReportRequest": {
1116 "description": "Request message for the Report method.",
1117 "id": "ReportRequest",
1118 "properties": {
1119 "operations": {
1120 "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.",
1121 "items": {
1122 "$ref": "Operation"
1123 },
1124 "type": "array"
1125 },
1126 "serviceConfigId": {
1127 "description": "Specifies which version of service config sh ould be used to process the\nrequest.\n\nIf unspecified or no matching version c an be found, the\nlatest one will be used.",
1128 "type": "string"
1129 }
1130 },
1131 "type": "object"
1132 },
942 "Status": { 1133 "Status": {
943 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Lang uage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n \nThe error model and the `Status` message can be used in a variety of\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n - Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.", 1134 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Lang uage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n \nThe error model and the `Status` message can be used in a variety of\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n - Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
944 "id": "Status", 1135 "id": "Status",
945 "properties": { 1136 "properties": {
946 "message": { 1137 "message": {
947 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", 1138 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
948 "type": "string" 1139 "type": "string"
949 }, 1140 },
950 "details": { 1141 "details": {
951 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.", 1142 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.",
952 "items": { 1143 "items": {
953 "additionalProperties": { 1144 "additionalProperties": {
954 "description": "Properties of the object. Contains f ield @type with type URL.", 1145 "description": "Properties of the object. Contains f ield @type with type URL.",
955 "type": "any" 1146 "type": "any"
956 }, 1147 },
957 "type": "object" 1148 "type": "object"
958 }, 1149 },
959 "type": "array" 1150 "type": "array"
960 }, 1151 },
961 "code": { 1152 "code": {
962 "description": "The status code, which should be an enum val ue of google.rpc.Code.", 1153 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
963 "format": "int32", 1154 "format": "int32",
964 "type": "integer" 1155 "type": "integer"
965 } 1156 }
966 }, 1157 },
967 "type": "object" 1158 "type": "object"
968 }, 1159 },
969 "ReportRequest": {
970 "description": "Request message for the Report method.",
971 "id": "ReportRequest",
972 "properties": {
973 "operations": {
974 "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.",
975 "items": {
976 "$ref": "Operation"
977 },
978 "type": "array"
979 },
980 "serviceConfigId": {
981 "description": "Specifies which version of service config sh ould be used to process the\nrequest.\n\nIf unspecified or no matching version c an be found, the\nlatest one will be used.",
982 "type": "string"
983 }
984 },
985 "type": "object"
986 },
987 "AuditLog": {
988 "description": "Common audit log format for Google Cloud Platform AP I operations.\n\n",
989 "id": "AuditLog",
990 "properties": {
991 "response": {
992 "additionalProperties": {
993 "description": "Properties of the object.",
994 "type": "any"
995 },
996 "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.",
997 "type": "object"
998 },
999 "serviceName": {
1000 "description": "The name of the API service performing the o peration. For example,\n`\"datastore.googleapis.com\"`.",
1001 "type": "string"
1002 },
1003 "methodName": {
1004 "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\"",
1005 "type": "string"
1006 },
1007 "resourceName": {
1008 "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\"",
1009 "type": "string"
1010 },
1011 "authorizationInfo": {
1012 "description": "Authorization information. If there are mult iple\nresources or permissions involved, then there is\none AuthorizationInfo el ement for each {resource, permission} tuple.",
1013 "items": {
1014 "$ref": "AuthorizationInfo"
1015 },
1016 "type": "array"
1017 },
1018 "request": {
1019 "additionalProperties": {
1020 "description": "Properties of the object.",
1021 "type": "any"
1022 },
1023 "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.",
1024 "type": "object"
1025 },
1026 "serviceData": {
1027 "additionalProperties": {
1028 "description": "Properties of the object. Contains field @type with type URL.",
1029 "type": "any"
1030 },
1031 "description": "Other service-specific data about the reques t, response, and other\nactivities.",
1032 "type": "object"
1033 },
1034 "requestMetadata": {
1035 "$ref": "RequestMetadata",
1036 "description": "Metadata about the operation."
1037 },
1038 "numResponseItems": {
1039 "description": "The number of items returned from a List or Query API method,\nif applicable.",
1040 "format": "int64",
1041 "type": "string"
1042 },
1043 "authenticationInfo": {
1044 "$ref": "AuthenticationInfo",
1045 "description": "Authentication information."
1046 },
1047 "status": {
1048 "$ref": "Status",
1049 "description": "The status of the overall operation."
1050 }
1051 },
1052 "type": "object"
1053 },
1054 "LogEntry": { 1160 "LogEntry": {
1055 "description": "An individual log entry.", 1161 "description": "An individual log entry.",
1056 "id": "LogEntry", 1162 "id": "LogEntry",
1057 "properties": { 1163 "properties": {
1164 "protoPayload": {
1165 "additionalProperties": {
1166 "description": "Properties of the object. Contains field @type with type URL.",
1167 "type": "any"
1168 },
1169 "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.",
1170 "type": "object"
1171 },
1172 "timestamp": {
1173 "description": "The time the event described by the log entr y occurred. If\nomitted, defaults to operation start time.",
1174 "format": "google-datetime",
1175 "type": "string"
1176 },
1177 "labels": {
1178 "additionalProperties": {
1179 "type": "string"
1180 },
1181 "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.",
1182 "type": "object"
1183 },
1058 "severity": { 1184 "severity": {
1059 "description": "The severity of the log entry. The default v alue is\n`LogSeverity.DEFAULT`.", 1185 "description": "The severity of the log entry. The default v alue is\n`LogSeverity.DEFAULT`.",
1060 "enum": [ 1186 "enum": [
1061 "DEFAULT", 1187 "DEFAULT",
1062 "DEBUG", 1188 "DEBUG",
1063 "INFO", 1189 "INFO",
1064 "NOTICE", 1190 "NOTICE",
1065 "WARNING", 1191 "WARNING",
1066 "ERROR", 1192 "ERROR",
1067 "CRITICAL", 1193 "CRITICAL",
1068 "ALERT", 1194 "ALERT",
1069 "EMERGENCY" 1195 "EMERGENCY"
1070 ], 1196 ],
1071 "enumDescriptions": [ 1197 "enumDescriptions": [
1072 "(0) The log entry has no assigned severity level.", 1198 "(0) The log entry has no assigned severity level.",
1073 "(100) Debug or trace information.", 1199 "(100) Debug or trace information.",
1074 "(200) Routine information, such as ongoing status or pe rformance.", 1200 "(200) Routine information, such as ongoing status or pe rformance.",
1075 "(300) Normal but significant events, such as start up, shut down, or\na configuration change.", 1201 "(300) Normal but significant events, such as start up, shut down, or\na configuration change.",
1076 "(400) Warning events might cause problems.", 1202 "(400) Warning events might cause problems.",
1077 "(500) Error events are likely to cause problems.", 1203 "(500) Error events are likely to cause problems.",
1078 "(600) Critical events cause more severe problems or out ages.", 1204 "(600) Critical events cause more severe problems or out ages.",
1079 "(700) A person must take an action immediately.", 1205 "(700) A person must take an action immediately.",
1080 "(800) One or more systems are unusable." 1206 "(800) One or more systems are unusable."
1081 ], 1207 ],
1082 "type": "string" 1208 "type": "string"
1083 }, 1209 },
1210 "name": {
1211 "description": "Required. The log to which this log entry be longs. Examples: `\"syslog\"`,\n`\"book_log\"`.",
1212 "type": "string"
1213 },
1084 "insertId": { 1214 "insertId": {
1085 "description": "A unique ID for the log entry used for dedup lication. If omitted,\nthe implementation will generate one based on operation_i d.", 1215 "description": "A unique ID for the log entry used for dedup lication. If omitted,\nthe implementation will generate one based on operation_i d.",
1086 "type": "string" 1216 "type": "string"
1087 }, 1217 },
1088 "name": {
1089 "description": "Required. The log to which this log entry be longs. Examples: `\"syslog\"`,\n`\"book_log\"`.",
1090 "type": "string"
1091 },
1092 "structPayload": { 1218 "structPayload": {
1093 "additionalProperties": { 1219 "additionalProperties": {
1094 "description": "Properties of the object.", 1220 "description": "Properties of the object.",
1095 "type": "any" 1221 "type": "any"
1096 }, 1222 },
1097 "description": "The log entry payload, represented as a stru cture that\nis expressed as a JSON object.", 1223 "description": "The log entry payload, represented as a stru cture that\nis expressed as a JSON object.",
1098 "type": "object" 1224 "type": "object"
1099 }, 1225 },
1100 "textPayload": { 1226 "textPayload": {
1101 "description": "The log entry payload, represented as a Unic ode string (UTF-8).", 1227 "description": "The log entry payload, represented as a Unic ode string (UTF-8).",
1102 "type": "string" 1228 "type": "string"
1229 }
1230 },
1231 "type": "object"
1232 },
1233 "AuditLog": {
1234 "description": "Common audit log format for Google Cloud Platform AP I operations.\n\n",
1235 "id": "AuditLog",
1236 "properties": {
1237 "methodName": {
1238 "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\"",
1239 "type": "string"
1103 }, 1240 },
1104 "protoPayload": { 1241 "resourceName": {
1242 "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\"",
1243 "type": "string"
1244 },
1245 "authorizationInfo": {
1246 "description": "Authorization information. If there are mult iple\nresources or permissions involved, then there is\none AuthorizationInfo el ement for each {resource, permission} tuple.",
1247 "items": {
1248 "$ref": "AuthorizationInfo"
1249 },
1250 "type": "array"
1251 },
1252 "request": {
1253 "additionalProperties": {
1254 "description": "Properties of the object.",
1255 "type": "any"
1256 },
1257 "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.",
1258 "type": "object"
1259 },
1260 "requestMetadata": {
1261 "$ref": "RequestMetadata",
1262 "description": "Metadata about the operation."
1263 },
1264 "serviceData": {
1105 "additionalProperties": { 1265 "additionalProperties": {
1106 "description": "Properties of the object. Contains field @type with type URL.", 1266 "description": "Properties of the object. Contains field @type with type URL.",
1107 "type": "any" 1267 "type": "any"
1108 }, 1268 },
1109 "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.", 1269 "description": "Other service-specific data about the reques t, response, and other\nactivities.",
1110 "type": "object" 1270 "type": "object"
1111 }, 1271 },
1112 "timestamp": { 1272 "numResponseItems": {
1113 "description": "The time the event described by the log entr y occurred. If\nomitted, defaults to operation start time.", 1273 "description": "The number of items returned from a List or Query API method,\nif applicable.",
1114 "format": "google-datetime", 1274 "format": "int64",
1115 "type": "string" 1275 "type": "string"
1116 }, 1276 },
1117 "labels": { 1277 "authenticationInfo": {
1278 "$ref": "AuthenticationInfo",
1279 "description": "Authentication information."
1280 },
1281 "status": {
1282 "$ref": "Status",
1283 "description": "The status of the overall operation."
1284 },
1285 "response": {
1118 "additionalProperties": { 1286 "additionalProperties": {
1119 "type": "string" 1287 "description": "Properties of the object.",
1288 "type": "any"
1120 }, 1289 },
1121 "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.", 1290 "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.",
1122 "type": "object" 1291 "type": "object"
1292 },
1293 "serviceName": {
1294 "description": "The name of the API service performing the o peration. For example,\n`\"datastore.googleapis.com\"`.",
1295 "type": "string"
1123 } 1296 }
1124 }, 1297 },
1125 "type": "object" 1298 "type": "object"
1126 }, 1299 },
1127 "MetricValue": { 1300 "MetricValue": {
1128 "description": "Represents a single metric value.", 1301 "description": "Represents a single metric value.",
1129 "id": "MetricValue", 1302 "id": "MetricValue",
1130 "properties": { 1303 "properties": {
1131 "stringValue": {
1132 "description": "A text string value.",
1133 "type": "string"
1134 },
1135 "labels": {
1136 "additionalProperties": {
1137 "type": "string"
1138 },
1139 "description": "The labels describing the metric value.\nSee comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding r elationship.",
1140 "type": "object"
1141 },
1142 "doubleValue": { 1304 "doubleValue": {
1143 "description": "A double precision floating point value.", 1305 "description": "A double precision floating point value.",
1144 "format": "double", 1306 "format": "double",
1145 "type": "number" 1307 "type": "number"
1146 }, 1308 },
1147 "int64Value": { 1309 "int64Value": {
1148 "description": "A signed 64-bit integer value.", 1310 "description": "A signed 64-bit integer value.",
1149 "format": "int64", 1311 "format": "int64",
1150 "type": "string" 1312 "type": "string"
1151 }, 1313 },
(...skipping 11 matching lines...) Expand all
1163 "type": "string" 1325 "type": "string"
1164 }, 1326 },
1165 "startTime": { 1327 "startTime": {
1166 "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.", 1328 "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.",
1167 "format": "google-datetime", 1329 "format": "google-datetime",
1168 "type": "string" 1330 "type": "string"
1169 }, 1331 },
1170 "moneyValue": { 1332 "moneyValue": {
1171 "$ref": "Money", 1333 "$ref": "Money",
1172 "description": "A money value." 1334 "description": "A money value."
1335 },
1336 "stringValue": {
1337 "description": "A text string value.",
1338 "type": "string"
1339 },
1340 "labels": {
1341 "additionalProperties": {
1342 "type": "string"
1343 },
1344 "description": "The labels describing the metric value.\nSee comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding r elationship.",
1345 "type": "object"
1173 } 1346 }
1174 }, 1347 },
1175 "type": "object" 1348 "type": "object"
1176 },
1177 "Money": {
1178 "description": "Represents an amount of money with its currency type .",
1179 "id": "Money",
1180 "properties": {
1181 "units": {
1182 "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
1183 "format": "int64",
1184 "type": "string"
1185 },
1186 "currencyCode": {
1187 "description": "The 3-letter currency code defined in ISO 42 17.",
1188 "type": "string"
1189 },
1190 "nanos": {
1191 "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.",
1192 "format": "int32",
1193 "type": "integer"
1194 }
1195 },
1196 "type": "object"
1197 },
1198 "EndReconciliationResponse": {
1199 "id": "EndReconciliationResponse",
1200 "properties": {
1201 "quotaMetrics": {
1202 "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.",
1203 "items": {
1204 "$ref": "MetricValueSet"
1205 },
1206 "type": "array"
1207 },
1208 "operationId": {
1209 "description": "The same operation_id value used in the EndR econciliationRequest. Used for\nlogging and diagnostics purposes.",
1210 "type": "string"
1211 },
1212 "reconciliationErrors": {
1213 "description": "Indicates the decision of the reconciliation end.",
1214 "items": {
1215 "$ref": "QuotaError"
1216 },
1217 "type": "array"
1218 },
1219 "serviceConfigId": {
1220 "description": "ID of the actual config used to process the request.",
1221 "type": "string"
1222 }
1223 },
1224 "type": "object"
1225 },
1226 "ExplicitBuckets": {
1227 "description": "Describing buckets with arbitrary user-provided widt h.",
1228 "id": "ExplicitBuckets",
1229 "properties": {
1230 "bounds": {
1231 "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",
1232 "items": {
1233 "format": "double",
1234 "type": "number"
1235 },
1236 "type": "array"
1237 }
1238 },
1239 "type": "object"
1240 },
1241 "Distribution": {
1242 "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",
1243 "id": "Distribution",
1244 "properties": {
1245 "count": {
1246 "description": "The total number of samples in the distribut ion. Must be >= 0.",
1247 "format": "int64",
1248 "type": "string"
1249 },
1250 "mean": {
1251 "description": "The arithmetic mean of the samples in the di stribution. If `count` is\nzero then this field must be zero.",
1252 "format": "double",
1253 "type": "number"
1254 },
1255 "bucketCounts": {
1256 "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.",
1257 "items": {
1258 "format": "int64",
1259 "type": "string"
1260 },
1261 "type": "array"
1262 },
1263 "explicitBuckets": {
1264 "$ref": "ExplicitBuckets",
1265 "description": "Buckets with arbitrary user-provided width."
1266 },
1267 "maximum": {
1268 "description": "The maximum of the population of values. Ign ored if `count` is zero.",
1269 "format": "double",
1270 "type": "number"
1271 },
1272 "sumOfSquaredDeviation": {
1273 "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.",
1274 "format": "double",
1275 "type": "number"
1276 },
1277 "exponentialBuckets": {
1278 "$ref": "ExponentialBuckets",
1279 "description": "Buckets with exponentially growing width."
1280 },
1281 "linearBuckets": {
1282 "$ref": "LinearBuckets",
1283 "description": "Buckets with constant width."
1284 },
1285 "minimum": {
1286 "description": "The minimum of the population of values. Ign ored if `count` is zero.",
1287 "format": "double",
1288 "type": "number"
1289 }
1290 },
1291 "type": "object"
1292 },
1293 "ExponentialBuckets": {
1294 "description": "Describing buckets with exponentially growing width. ",
1295 "id": "ExponentialBuckets",
1296 "properties": {
1297 "scale": {
1298 "description": "The i'th exponential bucket covers the inter val\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges fr om 1 to num_finite_buckets inclusive.\nMust be > 0.",
1299 "format": "double",
1300 "type": "number"
1301 },
1302 "numFiniteBuckets": {
1303 "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.",
1304 "format": "int32",
1305 "type": "integer"
1306 },
1307 "growthFactor": {
1308 "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.",
1309 "format": "double",
1310 "type": "number"
1311 }
1312 },
1313 "type": "object"
1314 },
1315 "AuthorizationInfo": {
1316 "description": "Authorization information for the operation.",
1317 "id": "AuthorizationInfo",
1318 "properties": {
1319 "resource": {
1320 "description": "The resource being accessed, as a REST-style string. For example:\n\n bigquery.googlapis.com/projects/PROJECTID/datasets/ DATASETID",
1321 "type": "string"
1322 },
1323 "granted": {
1324 "description": "Whether or not authorization for `resource` and `permission`\nwas granted.",
1325 "type": "boolean"
1326 },
1327 "permission": {
1328 "description": "The required IAM permission.",
1329 "type": "string"
1330 }
1331 },
1332 "type": "object"
1333 },
1334 "StartReconciliationResponse": {
1335 "id": "StartReconciliationResponse",
1336 "properties": {
1337 "operationId": {
1338 "description": "The same operation_id value used in the Star tReconciliationRequest. Used\nfor logging and diagnostics purposes.",
1339 "type": "string"
1340 },
1341 "reconciliationErrors": {
1342 "description": "Indicates the decision of the reconciliation start.",
1343 "items": {
1344 "$ref": "QuotaError"
1345 },
1346 "type": "array"
1347 },
1348 "serviceConfigId": {
1349 "description": "ID of the actual config used to process the request.",
1350 "type": "string"
1351 },
1352 "quotaMetrics": {
1353 "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\"",
1354 "items": {
1355 "$ref": "MetricValueSet"
1356 },
1357 "type": "array"
1358 }
1359 },
1360 "type": "object"
1361 } 1349 }
1362 }, 1350 },
1363 "servicePath": "", 1351 "servicePath": "",
1364 "title": "Google Service Control API", 1352 "title": "Google Service Control API",
1365 "version": "v1" 1353 "version": "v1"
1366 } 1354 }
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