| OLD | NEW |
| (Empty) | |
| 1 { |
| 2 "auth": { |
| 3 "oauth2": { |
| 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/cloud-platform": { |
| 6 "description": "View and manage your data across Google Clou
d Platform services" |
| 7 }, |
| 8 "https://www.googleapis.com/auth/servicecontrol": { |
| 9 "description": "Manage your Google Service Control data" |
| 10 } |
| 11 } |
| 12 } |
| 13 }, |
| 14 "basePath": "", |
| 15 "baseUrl": "https://servicecontrol.googleapis.com/", |
| 16 "batchPath": "batch", |
| 17 "canonicalName": "Service Control", |
| 18 "description": "The Service Control API", |
| 19 "discoveryVersion": "v1", |
| 20 "documentationLink": "https://cloud.google.com/service-control/", |
| 21 "icons": { |
| 22 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 23 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 24 }, |
| 25 "id": "servicecontrol:v1", |
| 26 "kind": "discovery#restDescription", |
| 27 "name": "servicecontrol", |
| 28 "ownerDomain": "google.com", |
| 29 "ownerName": "Google", |
| 30 "parameters": { |
| 31 "access_token": { |
| 32 "description": "OAuth access token.", |
| 33 "location": "query", |
| 34 "type": "string" |
| 35 }, |
| 36 "prettyPrint": { |
| 37 "default": "true", |
| 38 "description": "Returns response with indentations and line breaks."
, |
| 39 "location": "query", |
| 40 "type": "boolean" |
| 41 }, |
| 42 "key": { |
| 43 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 44 "location": "query", |
| 45 "type": "string" |
| 46 }, |
| 47 "quotaUser": { |
| 48 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 49 "location": "query", |
| 50 "type": "string" |
| 51 }, |
| 52 "pp": { |
| 53 "default": "true", |
| 54 "description": "Pretty-print response.", |
| 55 "location": "query", |
| 56 "type": "boolean" |
| 57 }, |
| 58 "fields": { |
| 59 "description": "Selector specifying which fields to include in a par
tial response.", |
| 60 "location": "query", |
| 61 "type": "string" |
| 62 }, |
| 63 "alt": { |
| 64 "default": "json", |
| 65 "description": "Data format for response.", |
| 66 "enum": [ |
| 67 "json", |
| 68 "media", |
| 69 "proto" |
| 70 ], |
| 71 "enumDescriptions": [ |
| 72 "Responses with Content-Type of application/json", |
| 73 "Media download with context-dependent Content-Type", |
| 74 "Responses with Content-Type of application/x-protobuf" |
| 75 ], |
| 76 "location": "query", |
| 77 "type": "string" |
| 78 }, |
| 79 "$.xgafv": { |
| 80 "description": "V1 error format.", |
| 81 "enum": [ |
| 82 "1", |
| 83 "2" |
| 84 ], |
| 85 "enumDescriptions": [ |
| 86 "v1 error format", |
| 87 "v2 error format" |
| 88 ], |
| 89 "location": "query", |
| 90 "type": "string" |
| 91 }, |
| 92 "callback": { |
| 93 "description": "JSONP", |
| 94 "location": "query", |
| 95 "type": "string" |
| 96 }, |
| 97 "oauth_token": { |
| 98 "description": "OAuth 2.0 token for the current user.", |
| 99 "location": "query", |
| 100 "type": "string" |
| 101 }, |
| 102 "uploadType": { |
| 103 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 104 "location": "query", |
| 105 "type": "string" |
| 106 }, |
| 107 "bearer_token": { |
| 108 "description": "OAuth bearer token.", |
| 109 "location": "query", |
| 110 "type": "string" |
| 111 }, |
| 112 "upload_protocol": { |
| 113 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 114 "location": "query", |
| 115 "type": "string" |
| 116 } |
| 117 }, |
| 118 "protocol": "rest", |
| 119 "resources": { |
| 120 "services": { |
| 121 "methods": { |
| 122 "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\nThis method requires the `servicemanagement
.services.check` permission\non the specified service. For more information, see
\n[Google Cloud IAM](https://cloud.google.com/iam).", |
| 124 "httpMethod": "POST", |
| 125 "id": "servicecontrol.services.check", |
| 126 "parameterOrder": [ |
| 127 "serviceName" |
| 128 ], |
| 129 "parameters": { |
| 130 "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.", |
| 132 "location": "path", |
| 133 "required": true, |
| 134 "type": "string" |
| 135 } |
| 136 }, |
| 137 "path": "v1/services/{serviceName}:check", |
| 138 "request": { |
| 139 "$ref": "CheckRequest" |
| 140 }, |
| 141 "response": { |
| 142 "$ref": "CheckResponse" |
| 143 }, |
| 144 "scopes": [ |
| 145 "https://www.googleapis.com/auth/cloud-platform", |
| 146 "https://www.googleapis.com/auth/servicecontrol" |
| 147 ] |
| 148 }, |
| 149 "report": { |
| 150 "description": "Reports operations to Google Service Control
. It should be called\nafter the operation is completed.\n\nThis method requires
the `servicemanagement.services.report` permission\non the specified service. F
or more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).", |
| 151 "httpMethod": "POST", |
| 152 "id": "servicecontrol.services.report", |
| 153 "parameterOrder": [ |
| 154 "serviceName" |
| 155 ], |
| 156 "parameters": { |
| 157 "serviceName": { |
| 158 "description": "The service name as specified in its
service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google
.api.Service for the definition of a service name.", |
| 159 "location": "path", |
| 160 "required": true, |
| 161 "type": "string" |
| 162 } |
| 163 }, |
| 164 "path": "v1/services/{serviceName}:report", |
| 165 "request": { |
| 166 "$ref": "ReportRequest" |
| 167 }, |
| 168 "response": { |
| 169 "$ref": "ReportResponse" |
| 170 }, |
| 171 "scopes": [ |
| 172 "https://www.googleapis.com/auth/cloud-platform", |
| 173 "https://www.googleapis.com/auth/servicecontrol" |
| 174 ] |
| 175 } |
| 176 } |
| 177 } |
| 178 }, |
| 179 "revision": "20160801", |
| 180 "rootUrl": "https://servicecontrol.googleapis.com/", |
| 181 "schemas": { |
| 182 "CheckError": { |
| 183 "description": "Defines the errors to be returned in\ngoogle.api.ser
vicecontrol.v1.CheckResponse.check_errors.", |
| 184 "id": "CheckError", |
| 185 "properties": { |
| 186 "code": { |
| 187 "description": "The error code.", |
| 188 "enum": [ |
| 189 "ERROR_CODE_UNSPECIFIED", |
| 190 "NOT_FOUND", |
| 191 "PERMISSION_DENIED", |
| 192 "RESOURCE_EXHAUSTED", |
| 193 "SERVICE_NOT_ACTIVATED", |
| 194 "BILLING_DISABLED", |
| 195 "PROJECT_DELETED", |
| 196 "PROJECT_INVALID", |
| 197 "IP_ADDRESS_BLOCKED", |
| 198 "REFERER_BLOCKED", |
| 199 "CLIENT_APP_BLOCKED", |
| 200 "API_KEY_INVALID", |
| 201 "API_KEY_EXPIRED", |
| 202 "API_KEY_NOT_FOUND", |
| 203 "NAMESPACE_LOOKUP_UNAVAILABLE", |
| 204 "SERVICE_STATUS_UNAVAILABLE", |
| 205 "BILLING_STATUS_UNAVAILABLE" |
| 206 ], |
| 207 "enumDescriptions": [ |
| 208 "This is never used in `CheckResponse`.", |
| 209 "The consumer's project id was not found.\nSame as googl
e.rpc.Code.NOT_FOUND.", |
| 210 "The consumer doesn't have access to the specified resou
rce.\nSame as google.rpc.Code.PERMISSION_DENIED.", |
| 211 "Quota check failed. Same as google.rpc.Code.RESOURCE_EX
HAUSTED.", |
| 212 "The consumer hasn't activated the service.", |
| 213 "The consumer cannot access the service because billing
is disabled.", |
| 214 "The consumer's project has been marked as deleted (soft
deletion).", |
| 215 "The consumer's project number or id does not represent
a valid project.", |
| 216 "The IP address of the consumer is invalid for the speci
fic consumer\nproject.", |
| 217 "The referer address of the consumer request is invalid
for the specific\nconsumer project.", |
| 218 "The client application of the consumer request is inval
id for the\nspecific consumer project.", |
| 219 "The consumer's API key is invalid.", |
| 220 "The consumer's API Key has expired.", |
| 221 "The consumer's API Key was not found in config record."
, |
| 222 "The backend server for looking up project id/number is
unavailable.", |
| 223 "The backend server for checking service status is unava
ilable.", |
| 224 "The backend server for checking billing status is unava
ilable." |
| 225 ], |
| 226 "type": "string" |
| 227 }, |
| 228 "detail": { |
| 229 "description": "Free-form text providing details on the erro
r cause of the error.", |
| 230 "type": "string" |
| 231 } |
| 232 }, |
| 233 "type": "object" |
| 234 }, |
| 235 "Status": { |
| 236 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` which can be used for common error conditions.\n\n# Lan
guage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mes
sage is\nexposed in different client libraries and different wire protocols, it
can be\nmapped differently. For example, it will likely be mapped to some except
ions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\
n\nThe error model and the `Status` message can be used in a variety of\nenviron
ments, either with or without APIs, to provide a\nconsistent developer experienc
e across different environments.\n\nExample uses of this error model include:\n\
n- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step
may\n have a `Status` message for error reporting purpose.\n\n- Batch operati
ons. If a client uses batch request and batch response, the\n `Status` messag
e should be used directly inside batch response, one for\n each error sub-res
ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio
n\n results in its response, the status of those operations should be\n re
presented directly using the `Status` message.\n\n- Logging. If some API errors
are stored in logs, the message `Status` could\n be used directly after any s
tripping needed for security/privacy reasons.", |
| 237 "id": "Status", |
| 238 "properties": { |
| 239 "code": { |
| 240 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 241 "format": "int32", |
| 242 "type": "integer" |
| 243 }, |
| 244 "details": { |
| 245 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", |
| 246 "items": { |
| 247 "additionalProperties": { |
| 248 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 249 "type": "any" |
| 250 }, |
| 251 "type": "object" |
| 252 }, |
| 253 "type": "array" |
| 254 }, |
| 255 "message": { |
| 256 "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.", |
| 257 "type": "string" |
| 258 } |
| 259 }, |
| 260 "type": "object" |
| 261 }, |
| 262 "ReportError": { |
| 263 "description": "Represents the processing error of one `Operation` i
n the request.", |
| 264 "id": "ReportError", |
| 265 "properties": { |
| 266 "operationId": { |
| 267 "description": "The Operation.operation_id value from the re
quest.", |
| 268 "type": "string" |
| 269 }, |
| 270 "status": { |
| 271 "$ref": "Status", |
| 272 "description": "Details of the error when processing the `Op
eration`." |
| 273 } |
| 274 }, |
| 275 "type": "object" |
| 276 }, |
| 277 "ExponentialBuckets": { |
| 278 "description": "Describing buckets with exponentially growing width.
", |
| 279 "id": "ExponentialBuckets", |
| 280 "properties": { |
| 281 "growthFactor": { |
| 282 "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.", |
| 283 "format": "double", |
| 284 "type": "number" |
| 285 }, |
| 286 "scale": { |
| 287 "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.", |
| 288 "format": "double", |
| 289 "type": "number" |
| 290 }, |
| 291 "numFiniteBuckets": { |
| 292 "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.", |
| 293 "format": "int32", |
| 294 "type": "integer" |
| 295 } |
| 296 }, |
| 297 "type": "object" |
| 298 }, |
| 299 "Operation": { |
| 300 "description": "Represents information regarding an operation.", |
| 301 "id": "Operation", |
| 302 "properties": { |
| 303 "operationName": { |
| 304 "description": "Fully qualified name of the operation. Reser
ved for future use.", |
| 305 "type": "string" |
| 306 }, |
| 307 "operationId": { |
| 308 "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.", |
| 309 "type": "string" |
| 310 }, |
| 311 "endTime": { |
| 312 "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.", |
| 313 "format": "google-datetime", |
| 314 "type": "string" |
| 315 }, |
| 316 "labels": { |
| 317 "additionalProperties": { |
| 318 "type": "string" |
| 319 }, |
| 320 "description": "Labels describing the operation. Only the fo
llowing labels are allowed:\n\n- Labels describing monitored resources as define
d in\n the service configuration.\n- Default labels of metric values. When spec
ified, labels defined in the\n metric value override these default.\n- The foll
owing labels defined by Google Cloud Platform:\n - `cloud.googleapis.com/loca
tion` describing the location where the\n operation happened,\n - `serv
icecontrol.googleapis.com/user_agent` describing the user agent\n of the A
PI request,\n - `servicecontrol.googleapis.com/service_agent` describing the
service\n used to handle the API request (e.g. ESP),\n - `servicecontro
l.googleapis.com/platform` describing the platform\n where the API is serv
ed (e.g. GAE, GCE, GKE).", |
| 321 "type": "object" |
| 322 }, |
| 323 "importance": { |
| 324 "description": "The importance of the data contained in the
operation.", |
| 325 "enum": [ |
| 326 "LOW", |
| 327 "HIGH" |
| 328 ], |
| 329 "enumDescriptions": [ |
| 330 "The operation doesn't contain significant monetary valu
e or audit\ntrail. The API implementation may cache and aggregate the data.\nThe
re is no deduplication based on `operation_id`. The data\nmay be lost when rare
and unexpected system failures occur.", |
| 331 "The operation contains significant monetary value or au
dit trail.\nThe API implementation doesn't cache and aggregate the data.\nDedupl
ication based on `operation_id` is performed for monetary\nvalues. If the method
returns successfully, it's guaranteed that\nthe data are persisted in durable s
torage." |
| 332 ], |
| 333 "type": "string" |
| 334 }, |
| 335 "consumerId": { |
| 336 "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>.", |
| 337 "type": "string" |
| 338 }, |
| 339 "startTime": { |
| 340 "description": "Required. Start time of the operation.", |
| 341 "format": "google-datetime", |
| 342 "type": "string" |
| 343 }, |
| 344 "logEntries": { |
| 345 "description": "Represents information to be logged.", |
| 346 "items": { |
| 347 "$ref": "LogEntry" |
| 348 }, |
| 349 "type": "array" |
| 350 }, |
| 351 "metricValueSets": { |
| 352 "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."
, |
| 353 "items": { |
| 354 "$ref": "MetricValueSet" |
| 355 }, |
| 356 "type": "array" |
| 357 } |
| 358 }, |
| 359 "type": "object" |
| 360 }, |
| 361 "CheckRequest": { |
| 362 "description": "Request message for the Check method.", |
| 363 "id": "CheckRequest", |
| 364 "properties": { |
| 365 "operation": { |
| 366 "$ref": "Operation", |
| 367 "description": "The operation to be checked." |
| 368 } |
| 369 }, |
| 370 "type": "object" |
| 371 }, |
| 372 "LogEntry": { |
| 373 "description": "An individual log entry.", |
| 374 "id": "LogEntry", |
| 375 "properties": { |
| 376 "textPayload": { |
| 377 "description": "The log entry payload, represented as a Unic
ode string (UTF-8).", |
| 378 "type": "string" |
| 379 }, |
| 380 "structPayload": { |
| 381 "additionalProperties": { |
| 382 "description": "Properties of the object.", |
| 383 "type": "any" |
| 384 }, |
| 385 "description": "The log entry payload, represented as a stru
cture that\nis expressed as a JSON object.", |
| 386 "type": "object" |
| 387 }, |
| 388 "labels": { |
| 389 "additionalProperties": { |
| 390 "type": "string" |
| 391 }, |
| 392 "description": "A set of user-defined (key, value) data that
provides additional\ninformation about the log entry.", |
| 393 "type": "object" |
| 394 }, |
| 395 "severity": { |
| 396 "description": "The severity of the log entry. The default v
alue is\n`LogSeverity.DEFAULT`.", |
| 397 "enum": [ |
| 398 "DEFAULT", |
| 399 "DEBUG", |
| 400 "INFO", |
| 401 "NOTICE", |
| 402 "WARNING", |
| 403 "ERROR", |
| 404 "CRITICAL", |
| 405 "ALERT", |
| 406 "EMERGENCY" |
| 407 ], |
| 408 "enumDescriptions": [ |
| 409 "The log entry has no assigned severity level.", |
| 410 "Debug or trace information.", |
| 411 "Routine information, such as ongoing status or performa
nce.", |
| 412 "Normal but significant events, such as start up, shut d
own, or\nconfiguration.", |
| 413 "Warning events might cause problems.", |
| 414 "Error events are likely to cause problems.", |
| 415 "Critical events cause more severe problems or brief out
ages.", |
| 416 "A person must take an action immediately.", |
| 417 "One or more systems are unusable." |
| 418 ], |
| 419 "type": "string" |
| 420 }, |
| 421 "name": { |
| 422 "description": "Required. The log to which this log entry be
longs. Examples: `\"syslog\"`,\n`\"book_log\"`.", |
| 423 "type": "string" |
| 424 }, |
| 425 "protoPayload": { |
| 426 "additionalProperties": { |
| 427 "description": "Properties of the object. Contains field
@type with type URL.", |
| 428 "type": "any" |
| 429 }, |
| 430 "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.", |
| 431 "type": "object" |
| 432 }, |
| 433 "timestamp": { |
| 434 "description": "The time the event described by the log entr
y occurred. If\nomitted, defaults to operation start time.", |
| 435 "format": "google-datetime", |
| 436 "type": "string" |
| 437 }, |
| 438 "insertId": { |
| 439 "description": "A unique ID for the log entry used for dedup
lication. If omitted,\nthe implementation will generate one based on operation_i
d.", |
| 440 "type": "string" |
| 441 } |
| 442 }, |
| 443 "type": "object" |
| 444 }, |
| 445 "ReportRequest": { |
| 446 "description": "Request message for the Report method.", |
| 447 "id": "ReportRequest", |
| 448 "properties": { |
| 449 "operations": { |
| 450 "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.", |
| 451 "items": { |
| 452 "$ref": "Operation" |
| 453 }, |
| 454 "type": "array" |
| 455 } |
| 456 }, |
| 457 "type": "object" |
| 458 }, |
| 459 "MetricValueSet": { |
| 460 "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.", |
| 461 "id": "MetricValueSet", |
| 462 "properties": { |
| 463 "metricName": { |
| 464 "description": "The metric name defined in the service confi
guration.", |
| 465 "type": "string" |
| 466 }, |
| 467 "metricValues": { |
| 468 "description": "The values in this metric.", |
| 469 "items": { |
| 470 "$ref": "MetricValue" |
| 471 }, |
| 472 "type": "array" |
| 473 } |
| 474 }, |
| 475 "type": "object" |
| 476 }, |
| 477 "LinearBuckets": { |
| 478 "description": "Describing buckets with constant width.", |
| 479 "id": "LinearBuckets", |
| 480 "properties": { |
| 481 "width": { |
| 482 "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.", |
| 483 "format": "double", |
| 484 "type": "number" |
| 485 }, |
| 486 "offset": { |
| 487 "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.", |
| 488 "format": "double", |
| 489 "type": "number" |
| 490 }, |
| 491 "numFiniteBuckets": { |
| 492 "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.", |
| 493 "format": "int32", |
| 494 "type": "integer" |
| 495 } |
| 496 }, |
| 497 "type": "object" |
| 498 }, |
| 499 "CheckResponse": { |
| 500 "description": "Response message for the Check method.", |
| 501 "id": "CheckResponse", |
| 502 "properties": { |
| 503 "checkErrors": { |
| 504 "description": "Indicate the decision of the check.\n\nIf no
check errors are present, the service should process the operation.\nOtherwise
the service should use the list of errors to determine the\nappropriate action."
, |
| 505 "items": { |
| 506 "$ref": "CheckError" |
| 507 }, |
| 508 "type": "array" |
| 509 }, |
| 510 "operationId": { |
| 511 "description": "The same operation_id value used in the Chec
kRequest.\nUsed for logging and diagnostics purposes.", |
| 512 "type": "string" |
| 513 } |
| 514 }, |
| 515 "type": "object" |
| 516 }, |
| 517 "ReportResponse": { |
| 518 "description": "Response message for the Report method.", |
| 519 "id": "ReportResponse", |
| 520 "properties": { |
| 521 "reportErrors": { |
| 522 "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 complete failure where none of the\n `Operations` in the reques
t succeeded.", |
| 523 "items": { |
| 524 "$ref": "ReportError" |
| 525 }, |
| 526 "type": "array" |
| 527 } |
| 528 }, |
| 529 "type": "object" |
| 530 }, |
| 531 "Distribution": { |
| 532 "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", |
| 533 "id": "Distribution", |
| 534 "properties": { |
| 535 "bucketCounts": { |
| 536 "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.", |
| 537 "items": { |
| 538 "format": "int64", |
| 539 "type": "string" |
| 540 }, |
| 541 "type": "array" |
| 542 }, |
| 543 "exponentialBuckets": { |
| 544 "$ref": "ExponentialBuckets", |
| 545 "description": "Buckets with exponentially growing width." |
| 546 }, |
| 547 "explicitBuckets": { |
| 548 "$ref": "ExplicitBuckets", |
| 549 "description": "Buckets with arbitrary user-provided width." |
| 550 }, |
| 551 "maximum": { |
| 552 "description": "The maximum of the population of values. Ign
ored if `count` is zero.", |
| 553 "format": "double", |
| 554 "type": "number" |
| 555 }, |
| 556 "count": { |
| 557 "description": "The total number of samples in the distribut
ion. Must be >= 0.", |
| 558 "format": "int64", |
| 559 "type": "string" |
| 560 }, |
| 561 "linearBuckets": { |
| 562 "$ref": "LinearBuckets", |
| 563 "description": "Buckets with constant width." |
| 564 }, |
| 565 "sumOfSquaredDeviation": { |
| 566 "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.", |
| 567 "format": "double", |
| 568 "type": "number" |
| 569 }, |
| 570 "minimum": { |
| 571 "description": "The minimum of the population of values. Ign
ored if `count` is zero.", |
| 572 "format": "double", |
| 573 "type": "number" |
| 574 }, |
| 575 "mean": { |
| 576 "description": "The arithmetic mean of the samples in the di
stribution. If `count` is\nzero then this field must be zero.", |
| 577 "format": "double", |
| 578 "type": "number" |
| 579 } |
| 580 }, |
| 581 "type": "object" |
| 582 }, |
| 583 "ExplicitBuckets": { |
| 584 "description": "Describing buckets with arbitrary user-provided widt
h.", |
| 585 "id": "ExplicitBuckets", |
| 586 "properties": { |
| 587 "bounds": { |
| 588 "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", |
| 589 "items": { |
| 590 "format": "double", |
| 591 "type": "number" |
| 592 }, |
| 593 "type": "array" |
| 594 } |
| 595 }, |
| 596 "type": "object" |
| 597 }, |
| 598 "MetricValue": { |
| 599 "description": "Represents a single metric value.", |
| 600 "id": "MetricValue", |
| 601 "properties": { |
| 602 "stringValue": { |
| 603 "description": "A text string value.", |
| 604 "type": "string" |
| 605 }, |
| 606 "doubleValue": { |
| 607 "description": "A double precision floating point value.", |
| 608 "format": "double", |
| 609 "type": "number" |
| 610 }, |
| 611 "boolValue": { |
| 612 "description": "A boolean value.", |
| 613 "type": "boolean" |
| 614 }, |
| 615 "endTime": { |
| 616 "description": "The end of the time period over which this m
etric value's measurement\napplies.", |
| 617 "format": "google-datetime", |
| 618 "type": "string" |
| 619 }, |
| 620 "labels": { |
| 621 "additionalProperties": { |
| 622 "type": "string" |
| 623 }, |
| 624 "description": "The labels describing the metric value.\nSee
comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding r
elationship.", |
| 625 "type": "object" |
| 626 }, |
| 627 "distributionValue": { |
| 628 "$ref": "Distribution", |
| 629 "description": "A distribution value." |
| 630 }, |
| 631 "startTime": { |
| 632 "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.", |
| 633 "format": "google-datetime", |
| 634 "type": "string" |
| 635 }, |
| 636 "int64Value": { |
| 637 "description": "A signed 64-bit integer value.", |
| 638 "format": "int64", |
| 639 "type": "string" |
| 640 } |
| 641 }, |
| 642 "type": "object" |
| 643 } |
| 644 }, |
| 645 "servicePath": "", |
| 646 "title": "Google Service Control API", |
| 647 "version": "v1" |
| 648 } |
| OLD | NEW |