Blame - docs/dyn/servicecontrol_v1.services.html - platform/external/python/google-api-python-client

2020-05-27 12:20:54 -0700

[diff] [blame]

811

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

812

"severity": "A String", # The severity of the log entry. The default value is

813

# `LogSeverity.DEFAULT`.

814

"structPayload": { # The log entry payload, represented as a structure that

815

# is expressed as a JSON object.

816

"a_key": "", # Properties of the object.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

817

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

818

"labels": { # A set of user-defined (key, value) data that provides additional

819

# information about the log entry.

820

"a_key": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

821

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

822

"protoPayload": { # The log entry payload, represented as a protocol buffer that is

823

# expressed as a JSON object. The only accepted type currently is

824

# AuditLog.

825

"a_key": "", # Properties of the object. Contains field @type with type URL.

826

},

827

"httpRequest": { # A common proto for logging HTTP requests. Only contains semantics # Optional. Information about the HTTP request associated with this

828

# log entry, if applicable.

829

# defined by the HTTP specification. Product-specific logging

830

# information MUST be defined in a separate message.

831

"protocol": "A String", # Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"

832

"cacheValidatedWithOriginServer": True or False, # Whether or not the response was validated with the origin server before

833

# being served from cache. This field is only meaningful if `cache_hit` is

834

# True.

835

"cacheFillBytes": "A String", # The number of HTTP response bytes inserted into cache. Set only when a

836

# cache fill was attempted.

837

"requestSize": "A String", # The size of the HTTP request message in bytes, including the request

838

# headers and the request body.

839

"responseSize": "A String", # The size of the HTTP response message sent back to the client, in bytes,

840

# including the response headers and the response body.

841

"serverIp": "A String", # The IP address (IPv4 or IPv6) of the origin server that the request was

842

# sent to.

843

"referer": "A String", # The referer URL of the request, as defined in

844

# [HTTP/1.1 Header Field

845

# Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).

846

"cacheHit": True or False, # Whether or not an entity was served from cache

847

# (with or without validation).

848

"latency": "A String", # The request processing latency on the server, from the time the request was

849

# received until the response was sent.

850

"requestUrl": "A String", # The scheme (http, https), the host name, the path, and the query

851

# portion of the URL that was requested.

852

# Example: `"http://example.com/some/info?color=red"`.

853

"cacheLookup": True or False, # Whether or not a cache lookup was attempted.

854

"requestMethod": "A String", # The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.

855

"remoteIp": "A String", # The IP address (IPv4 or IPv6) of the client that issued the HTTP

856

# request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.

857

"userAgent": "A String", # The user agent sent by the client. Example:

858

# `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET

859

# CLR 1.0.3705)"`.

860

"status": 42, # The response code indicating the status of the response.

861

# Examples: 200, 404.

862

},

863

"operation": { # Additional information about a potentially long-running operation with which # Optional. Information about an operation associated with the log entry, if

864

# applicable.

865

# a log entry is associated.

866

"first": True or False, # Optional. Set this to True if this is the first log entry in the operation.

867

"id": "A String", # Optional. An arbitrary operation identifier. Log entries with the

868

# same identifier are assumed to be part of the same operation.

869

"producer": "A String", # Optional. An arbitrary producer identifier. The combination of

870

# `id` and `producer` must be globally unique. Examples for `producer`:

871

# `"MyDivision.MyBigCompany.com"`, `"github.com/MyProject/MyApplication"`.

872

"last": True or False, # Optional. Set this to True if this is the last log entry in the operation.

873

},

874

"name": "A String", # Required. The log to which this log entry belongs. Examples: `"syslog"`,

875

# `"book_log"`.

876

"trace": "A String", # Optional. Resource name of the trace associated with the log entry, if any.

877

# If this field contains a relative resource name, you can assume the name is

878

# relative to `//tracing.googleapis.com`. Example:

879

# `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824`

880

"timestamp": "A String", # The time the event described by the log entry occurred. If

881

# omitted, defaults to operation start time.

882

"insertId": "A String", # A unique ID for the log entry used for deduplication. If omitted,

883

# the implementation will generate one based on operation_id.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

884

},

885

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

886

"importance": "A String", # DO NOT USE. This is an experimental field.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

887

"quotaProperties": { # Represents the properties needed for quota operations. # Represents the properties needed for quota check. Applicable only if this

888

# operation is for a quota check request. If this is not specified, no quota

889

# check will be performed.

890

"quotaMode": "A String", # Quota mode for this operation.

891

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

892

"operationName": "A String", # Fully qualified name of the operation. Reserved for future use.

893

"resources": [ # The resources that are involved in the operation.

894

# The maximum supported number of entries in this field is 100.

895

{ # Describes a resource associated with this operation.

896

"resourceContainer": "A String", # The identifier of the parent of this resource instance.

897

# Must be in one of the following formats:

898

# - “projects/<project-id or project-number>”

899

# - “folders/<folder-id>”

900

# - “organizations/<organization-id>”

901

"resourceName": "A String", # Name of the resource. This is used for auditing purposes.

902

"resourceLocation": "A String", # The location of the resource. If not empty, the resource will be checked

903

# against location policy. The value must be a valid zone, region or

904

# multiregion. For example: "europe-west4" or "northamerica-northeast1-a"

905

},

906

],

907

"endTime": "A String", # End time of the operation.

908

# Required when the operation is used in ServiceController.Report,

909

# but optional when the operation is used in ServiceController.Check.

910

"extensions": [ # Unimplemented.

911

{

912

"a_key": "", # Properties of the object. Contains field @type with type URL.

913

},

914

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

915

"consumerId": "A String", # Identity of the consumer who is using the service.

916

# This field should be filled in for the operations initiated by a

917

# consumer, but not for service-initiated operations that are

918

# not related to a specific consumer.

919

#

920

# - This can be in one of the following formats:

921

# - project:PROJECT_ID,

922

# - project`_`number:PROJECT_NUMBER,

923

# - projects/PROJECT_ID or PROJECT_NUMBER,

924

# - folders/FOLDER_NUMBER,

925

# - organizations/ORGANIZATION_NUMBER,

926

# - api`_`key:API_KEY.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

927

},

928

"requestProjectSettings": True or False, # Requests the project settings to be returned as part of the check response.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

929

"skipActivationCheck": True or False, # Indicates if service activation check should be skipped for this request.

930

# Default behavior is to perform the check and apply relevant quota.

931

# WARNING: Setting this flag to "true" will disable quota enforcement.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

932

}

933

934

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

941

942

{ # Response message for the Check method.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

943

"checkInfo": { # Contains additional information about the check operation. # Feedback data returned from the server during processing a Check request.

944

"consumerInfo": { # `ConsumerInfo` provides information about the consumer. # Consumer info of this check.

945

"type": "A String", # The type of the consumer which should have been defined in

946

# [Google Resource Manager](https://cloud.google.com/resource-manager/).

947

"consumerNumber": "A String", # The consumer identity number, can be Google cloud project number, folder

948

# number or organization number e.g. 1234567890. A value of 0 indicates no

949

# consumer number is found.

950

"projectNumber": "A String", # The Google cloud project number, e.g. 1234567890. A value of 0 indicates

951

# no project number is found.

952

#

953

# NOTE: This field is deprecated after Chemist support flexible consumer

954

# id. New code should not depend on this field anymore.

955

},

956

"unusedArguments": [ # A list of fields and label keys that are ignored by the server.

957

# The client doesn't need to send them for following requests to improve

958

# performance and allow better aggregation.

"A String",

],

},

"quotaInfo": { # Contains the quota information for a quota check response. # Quota information for the check request associated with this response.

963

"quotaMetrics": [ # Quota metrics to indicate the usage. Depending on the check request, one or

964

# more of the following metrics will be included:

965

#

966

# 1. For rate quota, per quota group or per quota metric incremental usage

967

# will be specified using the following delta metric:

968

# "serviceruntime.googleapis.com/api/consumer/quota_used_count"

969

#

970

# 2. For allocation quota, per quota metric total usage will be specified

971

# using the following gauge metric:

972

# "serviceruntime.googleapis.com/allocation/consumer/quota_used_count"

973

#

974

# 3. For both rate quota and allocation quota, the quota limit reached

975

# condition will be specified using the following boolean metric:

976

# "serviceruntime.googleapis.com/quota/exceeded"

977

{ # Represents a set of metric values in the same metric.

978

# Each metric value in the set should have a unique combination of start time,

979

# end time, and label values.

980

"metricValues": [ # The values in this metric.

981

{ # Represents a single metric value.

982

"startTime": "A String", # The start of the time period over which this metric value's measurement

983

# applies. The time period has different semantics for different metric

984

# types (cumulative, delta, and gauge). See the metric definition

985

# documentation in the service configuration for details.

986

"distributionValue": { # Distribution represents a frequency distribution of double-valued sample # A distribution value.

987

# points. It contains the size of the population of sample points plus

988

# additional optional information:

989

#

990

# - the arithmetic mean of the samples

991

# - the minimum and maximum of the samples

992

# - the sum-squared-deviation of the samples, used to compute variance

993

# - a histogram of the values of the sample points

994

"bucketCounts": [ # The number of samples in each histogram bucket. `bucket_counts` are

995

# optional. If present, they must sum to the `count` value.

996

#

997

# The buckets are defined below in `bucket_option`. There are N buckets.

998

# `bucket_counts[0]` is the number of samples in the underflow bucket.

999

# `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples

1000

# in each of the finite buckets. And `bucket_counts[N] is the number

1001

# of samples in the overflow bucket. See the comments of `bucket_option`

1002

# below for more details.

1003

#

1004

# Any suffix of trailing zeros may be omitted.

1005

"A String",

1006

],

1007

"count": "A String", # The total number of samples in the distribution. Must be >= 0.

1008

"sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean:

1009

# Sum[i=1..count]((x_i - mean)^2)

1010

# where each x_i is a sample values. If `count` is zero then this field

1011

# must be zero, otherwise validation of the request fails.

1012

"linearBuckets": { # Describing buckets with constant width. # Buckets with constant width.

1013

"numFiniteBuckets": 42, # The number of finite buckets. With the underflow and overflow buckets,

1014

# the total number of buckets is `num_finite_buckets` + 2.

1015

# See comments on `bucket_options` for details.

1016

"offset": 3.14, # The i'th linear bucket covers the interval

1017

# [offset + (i-1) * width, offset + i * width)

1018

# where i ranges from 1 to num_finite_buckets, inclusive.

1019

"width": 3.14, # The i'th linear bucket covers the interval

1020

# [offset + (i-1) * width, offset + i * width)

1021

# where i ranges from 1 to num_finite_buckets, inclusive.

1022

# Must be strictly positive.

1023

},

1024

"maximum": 3.14, # The maximum of the population of values. Ignored if `count` is zero.

1025

"exponentialBuckets": { # Describing buckets with exponentially growing width. # Buckets with exponentially growing width.

1026

"growthFactor": 3.14, # The i'th exponential bucket covers the interval

1027

# [scale * growth_factor^(i-1), scale * growth_factor^i)

1028

# where i ranges from 1 to num_finite_buckets inclusive.

1029

# Must be larger than 1.0.

1030

"scale": 3.14, # The i'th exponential bucket covers the interval

1031

# [scale * growth_factor^(i-1), scale * growth_factor^i)

1032

# where i ranges from 1 to num_finite_buckets inclusive.

1033

# Must be > 0.

1034

"numFiniteBuckets": 42, # The number of finite buckets. With the underflow and overflow buckets,

1035

# the total number of buckets is `num_finite_buckets` + 2.

1036

# See comments on `bucket_options` for details.

1037

},

1038

"minimum": 3.14, # The minimum of the population of values. Ignored if `count` is zero.

1039

"exemplars": [ # Example points. Must be in increasing order of `value` field.

1040

{ # Exemplars are example points that may be used to annotate aggregated

1041

# distribution values. They are metadata that gives information about a

1042

# particular value added to a Distribution bucket, such as a trace ID that

1043

# was active when a value was added. They may contain further information,

1044

# such as a example values and timestamps, origin, etc.

1045

"value": 3.14, # Value of the exemplar point. This value determines to which bucket the

1046

# exemplar belongs.

1047

"attachments": [ # Contextual information about the example value. Examples are:

1048

#

1049

# Trace: type.googleapis.com/google.monitoring.v3.SpanContext

1050

#

1051

# Literal string: type.googleapis.com/google.protobuf.StringValue

1052

#

1053

# Labels dropped during aggregation:

1054

# type.googleapis.com/google.monitoring.v3.DroppedLabels

1055

#

1056

# There may be only a single attachment of any given message type in a

1057

# single exemplar, and this is enforced by the system.

1058

{

1059

"a_key": "", # Properties of the object. Contains field @type with type URL.

1060

},

1061

],

1062

"timestamp": "A String", # The observation (sampling) time of the above value.

1063

},

1064

],

1065

"mean": 3.14, # The arithmetic mean of the samples in the distribution. If `count` is

1066

# zero then this field must be zero.

1067

"explicitBuckets": { # Describing buckets with arbitrary user-provided width. # Buckets with arbitrary user-provided width.

1068

"bounds": [ # 'bound' is a list of strictly increasing boundaries between

1069

# buckets. Note that a list of length N-1 defines N buckets because

1070

# of fenceposting. See comments on `bucket_options` for details.

1071

#

1072

# The i'th finite bucket covers the interval

1073

# [bound[i-1], bound[i])

1074

# where i ranges from 1 to bound_size() - 1. Note that there are no

1075

# finite buckets at all if 'bound' only contains a single element; in

1076

# that special case the single bound defines the boundary between the

1077

# underflow and overflow buckets.

1078

#

1079

# bucket number lower bound upper bound

1080

# i == 0 (underflow) -inf bound[i]

1081

# 0 < i < bound_size() bound[i-1] bound[i]

1082

# i == bound_size() (overflow) bound[i-1] +inf

3.14,

],

},

},

"labels": { # The labels describing the metric value.

1088

# See comments on google.api.servicecontrol.v1.Operation.labels for

1089

# the overriding relationship.

1090

# Note that this map must not contain monitored resource labels.

1091

"a_key": "A String",

1092

},

1093

"doubleValue": 3.14, # A double precision floating point value.

1094

"endTime": "A String", # The end of the time period over which this metric value's measurement

1095

# applies.

1096

"boolValue": True or False, # A boolean value.

1097

"int64Value": "A String", # A signed 64-bit integer value.

1098

"moneyValue": { # Represents an amount of money with its currency type. # A money value.

1099

"nanos": 42, # Number of nano (10^-9) units of the amount.

1100

# The value must be between -999,999,999 and +999,999,999 inclusive.

1101

# If `units` is positive, `nanos` must be positive or zero.

1102

# If `units` is zero, `nanos` can be positive, zero, or negative.

1103

# If `units` is negative, `nanos` must be negative or zero.

1104

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1105

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1106

"units": "A String", # The whole units of the amount.

1107

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1108

},

1109

"stringValue": "A String", # A text string value.

1110

},

1111

],

1112

"metricName": "A String", # The metric name defined in the service configuration.

1113

},

1114

],

1115

"limitExceeded": [ # Quota Metrics that have exceeded quota limits.

1116

# For QuotaGroup-based quota, this is QuotaGroup.name

1117

# For QuotaLimit-based quota, this is QuotaLimit.name

1118

# See: google.api.Quota

1119

# Deprecated: Use quota_metrics to get per quota group limit exceeded status.

1120

"A String",

1121

],

1122

"quotaConsumed": { # Map of quota group name to the actual number of tokens consumed. If the

1123

# quota check was not successful, then this will not be populated due to no

1124

# quota consumption.

1125

#

1126

# We are not merging this field with 'quota_metrics' field because of the

1127

# complexity of scaling in Chemist client code base. For simplicity, we will

1128

# keep this field for Castor (that scales quota usage) and 'quota_metrics'

1129

# for SuperQuota (that doesn't scale quota usage).

"a_key": 42,

},

},

"serviceConfigId": "A String", # The actual config id used to process the request.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1134

"serviceRolloutId": "A String", # The current service rollout id used to process the request.

1135

"operationId": "A String", # The same operation_id value used in the CheckRequest.

1136

# Used for logging and diagnostics purposes.

1137

"checkErrors": [ # Indicate the decision of the check.

1138

#

1139

# If no check errors are present, the service should process the operation.

1140

# Otherwise the service should use the list of errors to determine the

1141

# appropriate action.

1142

{ # Defines the errors to be returned in

1143

# google.api.servicecontrol.v1.CheckResponse.check_errors.

1144

"detail": "A String", # Free-form text providing details on the error cause of the error.

1145

"status": { # The `Status` type defines a logical error model that is suitable for # Contains public information about the check error. If available,

1146

# `status.code` will be non zero and client can propagate it out as public

1147

# error.

1148

# different programming environments, including REST APIs and RPC APIs. It is

1149

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1150

# three pieces of data: error code, error message, and error details.

1151

#

1152

# You can find out more about this error model and how to work with it in the

1153

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1154

"message": "A String", # A developer-facing error message, which should be in English. Any

1155

# user-facing error message should be localized and sent in the

1156

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1157

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1158

"details": [ # A list of messages that carry the error details. There is a common set of

1159

# message types for APIs to use.

1160

{

1161

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

"subject": "A String", # Subject to whom this error applies. See the specific code enum for more

1166

# details on this field. For example:

1167

#

1168

# - "project:<project-id or project-number>"

1169

# - "folder:<folder-id>"

1170

# - "organization:<organization-id>"

1171

"code": "A String", # The error code.

1172

},

1173

],

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1178

<code class="details" id="report">report(serviceName, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

1179

<pre>Reports operation results to Google Service Control, such as logs and

1180

metrics. It should be called after an operation is completed.

1181

1182

If feasible, the client should aggregate reporting data for up to 5

1183

seconds to reduce API traffic. Limiting aggregation to 5 seconds is to

1184

reduce data loss during client crashes. Clients should carefully choose

1185

the aggregation time window to avoid data loss risk more than 0.01%

1186

for business and compliance reasons.

1187

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1188

NOTE: the ReportRequest has the size limit (wire-format byte size) of

1189

1MB.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1190

1191

This method requires the `servicemanagement.services.report` permission

1192

on the specified service. For more information, see

1193

[Google Cloud IAM](https://cloud.google.com/iam).

1194

1195

Args:

1196

serviceName: string, The service name as specified in its service configuration. For example,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1197

`"pubsub.googleapis.com"`.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1198

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1199

See

1200

[google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)

1201

for the definition of a service name. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1202

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1203

The object takes the form of:

1204

1205

{ # Request message for the Report method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1206

"operations": [ # Operations to be reported.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1207

#

1208

# Typically the service should report one operation per request.

1209

# Putting multiple operations into a single request is allowed, but should

1210

# be used only when multiple operations are natually available at the time

1211

# of the report.

1212

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1213

# There is no limit on the number of operations in the same ReportRequest,

1214

# however the ReportRequest size should be no larger than 1MB. See

1215

# ReportResponse.report_errors for partial failure behavior.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1216

{ # Represents information regarding an operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1217

"startTime": "A String", # Required. Start time of the operation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1218

"traceSpans": [ # Unimplemented. A list of Cloud Trace spans. The span names shall contain

1219

# the id of the destination project which can be either the produce or the

1220

# consumer project.

1221

{ # A span represents a single operation within a trace. Spans can be

1222

# nested to form a trace tree. Often, a trace contains a root span

1223

# that describes the end-to-end latency, and one or more subspans for

1224

# its sub-operations. A trace can also contain multiple root spans,

1225

# or none at all. Spans do not need to be contiguous&mdash;there may be

1226

# gaps or overlaps between spans in a trace.

1227

"spanKind": "A String", # Distinguishes between spans generated in a particular context. For example,

1228

# two spans with the same name may be distinguished using `CLIENT` (caller)

1229

# and `SERVER` (callee) to identify an RPC call.

1230

"sameProcessAsParentSpan": True or False, # (Optional) Set this parameter to indicate whether this span is in

1231

# the same process as its parent. If you do not set this parameter,

1232

# Stackdriver Trace is unable to take advantage of this helpful

1233

# information.

1234

"childSpanCount": 42, # An optional number of child spans that were generated while this span

1235

# was active. If set, allows implementation to detect missing child spans.

1236

"startTime": "A String", # The start time of the span. On the client side, this is the time kept by

1237

# the local machine where the span execution starts. On the server side, this

1238

# is the time when the server's application handler starts running.

1239

"displayName": { # Represents a string that might be shortened to a specified length. # A description of the span's operation (up to 128 bytes).

1240

# Stackdriver Trace displays the description in the

1241

# Google Cloud Platform Console.

1242

# For example, the display name can be a qualified method name or a file name

1243

# and a line number where the operation is called. A best practice is to use

1244

# the same display name within an application and at the same call point.

1245

# This makes it easier to correlate spans in different traces.

1246

"value": "A String", # The shortened string. For example, if the original string is 500

1247

# bytes long and the limit of the string is 128 bytes, then

1248

# `value` contains the first 128 bytes of the 500-byte string.

1249

#

1250

# Truncation always happens on a UTF8 character boundary. If there

1251

# are multi-byte characters in the string, then the length of the

1252

# shortened string might be less than the size limit.

1253

"truncatedByteCount": 42, # The number of bytes removed from the original string. If this

1254

# value is 0, then the string was not shortened.

1255

},

1256

"endTime": "A String", # The end time of the span. On the client side, this is the time kept by

1257

# the local machine where the span execution ends. On the server side, this

1258

# is the time when the server application handler stops running.

1259

"attributes": { # A set of attributes, each in the format `[KEY]:[VALUE]`. # A set of attributes on the span. You can have up to 32 attributes per

1260

# span.

1261

"attributeMap": { # The set of attributes. Each attribute's key can be up to 128 bytes

1262

# long. The value can be a string up to 256 bytes, a signed 64-bit integer,

1263

# or the Boolean values `true` and `false`. For example:

1264

#

1265

# "/instance_id": "my-instance"

1266

# "/http/user_agent": ""

1267

# "/http/request_bytes": 300

1268

# "abc.com/myattribute": true

1269

"a_key": { # The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.

1270

"stringValue": { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long.

1271

"value": "A String", # The shortened string. For example, if the original string is 500

1272

# bytes long and the limit of the string is 128 bytes, then

1273

# `value` contains the first 128 bytes of the 500-byte string.

1274

#

1275

# Truncation always happens on a UTF8 character boundary. If there

1276

# are multi-byte characters in the string, then the length of the

1277

# shortened string might be less than the size limit.

1278

"truncatedByteCount": 42, # The number of bytes removed from the original string. If this

1279

# value is 0, then the string was not shortened.

1280

},

1281

"intValue": "A String", # A 64-bit signed integer.

1282

"boolValue": True or False, # A Boolean value represented by `true` or `false`.

1283

},

1284

},

1285

"droppedAttributesCount": 42, # The number of attributes that were discarded. Attributes can be discarded

1286

# because their keys are too long or because there are too many attributes.

1287

# If this value is 0 then all attributes are valid.

1288

},

1289

"parentSpanId": "A String", # The [SPAN_ID] of this span's parent span. If this is a root span,

1290

# then this field must be empty.

1291

"name": "A String", # The resource name of the span in the following format:

1292

#

1293

# projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project;

1294

# it is a 32-character hexadecimal encoding of a 16-byte array.

1295

#

1296

# [SPAN_ID] is a unique identifier for a span within a trace; it

1297

# is a 16-character hexadecimal encoding of an 8-byte array.

1298

"spanId": "A String", # The [SPAN_ID] portion of the span's resource name.

1299

"status": { # The `Status` type defines a logical error model that is suitable for # An optional final status for this span.

1300

# different programming environments, including REST APIs and RPC APIs. It is

1301

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1302

# three pieces of data: error code, error message, and error details.

1303

#

1304

# You can find out more about this error model and how to work with it in the

1305

# [API Design Guide](https://cloud.google.com/apis/design/errors).

1306

"message": "A String", # A developer-facing error message, which should be in English. Any

1307

# user-facing error message should be localized and sent in the

1308

# google.rpc.Status.details field, or localized by the client.

1309

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1310

"details": [ # A list of messages that carry the error details. There is a common set of

1311

# message types for APIs to use.

1312

{

1313

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1319

"labels": { # Labels describing the operation. Only the following labels are allowed:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1320

#

1321

# - Labels describing monitored resources as defined in

1322

# the service configuration.

1323

# - Default labels of metric values. When specified, labels defined in the

1324

# metric value override these default.

1325

# - The following labels defined by Google Cloud Platform:

1326

# - `cloud.googleapis.com/location` describing the location where the

1327

# operation happened,

1328

# - `servicecontrol.googleapis.com/user_agent` describing the user agent

1329

# of the API request,

1330

# - `servicecontrol.googleapis.com/service_agent` describing the service

1331

# used to handle the API request (e.g. ESP),

1332

# - `servicecontrol.googleapis.com/platform` describing the platform

1333

# where the API is served, such as App Engine, Compute Engine, or

1334

# Kubernetes Engine.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1335

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1336

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1337

"operationId": "A String", # Identity of the operation. This must be unique within the scope of the

1338

# service that generated the operation. If the service calls

1339

# Check() and Report() on the same operation, the two calls should carry

1340

# the same id.

1341

#

1342

# UUID version 4 is recommended, though not required.

1343

# In scenarios where an operation is computed from existing information

1344

# and an idempotent id is desirable for deduplication purpose, UUID version 5

1345

# is recommended. See RFC 4122 for details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1346

"metricValueSets": [ # Represents information about this operation. Each MetricValueSet

1347

# corresponds to a metric defined in the service configuration.

1348

# The data type used in the MetricValueSet must agree with

1349

# the data type specified in the metric definition.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1350

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1351

# Within a single operation, it is not allowed to have more than one

1352

# MetricValue instances that have the same metric names and identical

1353

# label value combinations. If a request has such duplicated MetricValue

1354

# instances, the entire request is rejected with

1355

# an invalid argument error.

1356

{ # Represents a set of metric values in the same metric.

1357

# Each metric value in the set should have a unique combination of start time,

1358

# end time, and label values.

1359

"metricValues": [ # The values in this metric.

1360

{ # Represents a single metric value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1361

"startTime": "A String", # The start of the time period over which this metric value's measurement

1362

# applies. The time period has different semantics for different metric

1363

# types (cumulative, delta, and gauge). See the metric definition

1364

# documentation in the service configuration for details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1365

"distributionValue": { # Distribution represents a frequency distribution of double-valued sample # A distribution value.

1366

# points. It contains the size of the population of sample points plus

1367

# additional optional information:

1368

#

1369

# - the arithmetic mean of the samples

1370

# - the minimum and maximum of the samples

1371

# - the sum-squared-deviation of the samples, used to compute variance

1372

# - a histogram of the values of the sample points

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1373

"bucketCounts": [ # The number of samples in each histogram bucket. `bucket_counts` are

1374

# optional. If present, they must sum to the `count` value.

1375

#

1376

# The buckets are defined below in `bucket_option`. There are N buckets.

1377

# `bucket_counts[0]` is the number of samples in the underflow bucket.

1378

# `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples

1379

# in each of the finite buckets. And `bucket_counts[N] is the number

1380

# of samples in the overflow bucket. See the comments of `bucket_option`

1381

# below for more details.

1382

#

1383

# Any suffix of trailing zeros may be omitted.

1384

"A String",

1385

],

1386

"count": "A String", # The total number of samples in the distribution. Must be >= 0.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1387

"sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean:

1388

# Sum[i=1..count]((x_i - mean)^2)

1389

# where each x_i is a sample values. If `count` is zero then this field

1390

# must be zero, otherwise validation of the request fails.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1391

"linearBuckets": { # Describing buckets with constant width. # Buckets with constant width.

1392

"numFiniteBuckets": 42, # The number of finite buckets. With the underflow and overflow buckets,

1393

# the total number of buckets is `num_finite_buckets` + 2.

1394

# See comments on `bucket_options` for details.

1395

"offset": 3.14, # The i'th linear bucket covers the interval

1396

# [offset + (i-1) * width, offset + i * width)

1397

# where i ranges from 1 to num_finite_buckets, inclusive.

1398

"width": 3.14, # The i'th linear bucket covers the interval

1399

# [offset + (i-1) * width, offset + i * width)

1400

# where i ranges from 1 to num_finite_buckets, inclusive.

1401

# Must be strictly positive.

1402

},

1403

"maximum": 3.14, # The maximum of the population of values. Ignored if `count` is zero.

1404

"exponentialBuckets": { # Describing buckets with exponentially growing width. # Buckets with exponentially growing width.

1405

"growthFactor": 3.14, # The i'th exponential bucket covers the interval

1406

# [scale * growth_factor^(i-1), scale * growth_factor^i)

1407

# where i ranges from 1 to num_finite_buckets inclusive.

1408

# Must be larger than 1.0.

1409

"scale": 3.14, # The i'th exponential bucket covers the interval

1410

# [scale * growth_factor^(i-1), scale * growth_factor^i)

1411

# where i ranges from 1 to num_finite_buckets inclusive.

1412

# Must be > 0.

1413

"numFiniteBuckets": 42, # The number of finite buckets. With the underflow and overflow buckets,

1414

# the total number of buckets is `num_finite_buckets` + 2.

1415

# See comments on `bucket_options` for details.

1416

},

1417

"minimum": 3.14, # The minimum of the population of values. Ignored if `count` is zero.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1418

"exemplars": [ # Example points. Must be in increasing order of `value` field.

1419

{ # Exemplars are example points that may be used to annotate aggregated

1420

# distribution values. They are metadata that gives information about a

1421

# particular value added to a Distribution bucket, such as a trace ID that

1422

# was active when a value was added. They may contain further information,

1423

# such as a example values and timestamps, origin, etc.

1424

"value": 3.14, # Value of the exemplar point. This value determines to which bucket the

1425

# exemplar belongs.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1426

"attachments": [ # Contextual information about the example value. Examples are:

1427

#

1428

# Trace: type.googleapis.com/google.monitoring.v3.SpanContext

1429

#

1430

# Literal string: type.googleapis.com/google.protobuf.StringValue

1431

#

1432

# Labels dropped during aggregation:

1433

# type.googleapis.com/google.monitoring.v3.DroppedLabels

1434

#

1435

# There may be only a single attachment of any given message type in a

1436

# single exemplar, and this is enforced by the system.

1437

{

1438

"a_key": "", # Properties of the object. Contains field @type with type URL.

1439

},

1440

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1441

"timestamp": "A String", # The observation (sampling) time of the above value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1442

},

1443

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1444

"mean": 3.14, # The arithmetic mean of the samples in the distribution. If `count` is

1445

# zero then this field must be zero.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1446

"explicitBuckets": { # Describing buckets with arbitrary user-provided width. # Buckets with arbitrary user-provided width.

1447

"bounds": [ # 'bound' is a list of strictly increasing boundaries between

1448

# buckets. Note that a list of length N-1 defines N buckets because

1449

# of fenceposting. See comments on `bucket_options` for details.

1450

#

1451

# The i'th finite bucket covers the interval

1452

# [bound[i-1], bound[i])

1453

# where i ranges from 1 to bound_size() - 1. Note that there are no

1454

# finite buckets at all if 'bound' only contains a single element; in

1455

# that special case the single bound defines the boundary between the

1456

# underflow and overflow buckets.

1457

#

1458

# bucket number lower bound upper bound

1459

# i == 0 (underflow) -inf bound[i]

1460

# 0 < i < bound_size() bound[i-1] bound[i]

1461

# i == bound_size() (overflow) bound[i-1] +inf

1462

3.14,

1463

],

1464

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1465

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1466

"labels": { # The labels describing the metric value.

1467

# See comments on google.api.servicecontrol.v1.Operation.labels for

1468

# the overriding relationship.

1469

# Note that this map must not contain monitored resource labels.

1470

"a_key": "A String",

1471

},

1472

"doubleValue": 3.14, # A double precision floating point value.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1473

"endTime": "A String", # The end of the time period over which this metric value's measurement

1474

# applies.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1475

"boolValue": True or False, # A boolean value.

1476

"int64Value": "A String", # A signed 64-bit integer value.

1477

"moneyValue": { # Represents an amount of money with its currency type. # A money value.

1478

"nanos": 42, # Number of nano (10^-9) units of the amount.

1479

# The value must be between -999,999,999 and +999,999,999 inclusive.

1480

# If `units` is positive, `nanos` must be positive or zero.

1481

# If `units` is zero, `nanos` can be positive, zero, or negative.

1482

# If `units` is negative, `nanos` must be negative or zero.

1483

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1484

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1485

"units": "A String", # The whole units of the amount.

1486

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1487

},

1488

"stringValue": "A String", # A text string value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1489

},

1490

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1491

"metricName": "A String", # The metric name defined in the service configuration.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1492

},

1493

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1494

"userLabels": { # User defined labels for the resource that this operation is associated

1495

# with. Only a combination of 1000 user labels per consumer project are

# allowed.

"a_key": "A String",

},

"logEntries": [ # Represents information to be logged.

1500

{ # An individual log entry.

1501

"textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8).

1502

"sourceLocation": { # Additional information about the source code location that produced the log # Optional. Source code location information associated with the log entry,

1503

# if any.

1504

# entry.

1505

"function": "A String", # Optional. Human-readable name of the function or method being invoked, with

1506

# optional context such as the class or package name. This information may be

1507

# used in contexts such as the logs viewer, where a file and line number are

1508

# less meaningful. The format can vary by language. For example:

1509

# `qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function`

1510

# (Python).

1511

"line": "A String", # Optional. Line within the source file. 1-based; 0 indicates no line number

1512

# available.

1513

"file": "A String", # Optional. Source file name. Depending on the runtime environment, this

1514

# might be a simple name or a fully-qualified name.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1515

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1516

"severity": "A String", # The severity of the log entry. The default value is

1517

# `LogSeverity.DEFAULT`.

1518

"structPayload": { # The log entry payload, represented as a structure that

1519

# is expressed as a JSON object.

1520

"a_key": "", # Properties of the object.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1521

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1522

"labels": { # A set of user-defined (key, value) data that provides additional

1523

# information about the log entry.

1524

"a_key": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1525

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1526

"protoPayload": { # The log entry payload, represented as a protocol buffer that is

1527

# expressed as a JSON object. The only accepted type currently is

1528

# AuditLog.

1529

"a_key": "", # Properties of the object. Contains field @type with type URL.

1530

},

1531

"httpRequest": { # A common proto for logging HTTP requests. Only contains semantics # Optional. Information about the HTTP request associated with this

1532

# log entry, if applicable.

1533

# defined by the HTTP specification. Product-specific logging

1534

# information MUST be defined in a separate message.

1535

"protocol": "A String", # Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"

1536

"cacheValidatedWithOriginServer": True or False, # Whether or not the response was validated with the origin server before

1537

# being served from cache. This field is only meaningful if `cache_hit` is

1538

# True.

1539

"cacheFillBytes": "A String", # The number of HTTP response bytes inserted into cache. Set only when a

1540

# cache fill was attempted.

1541

"requestSize": "A String", # The size of the HTTP request message in bytes, including the request

1542

# headers and the request body.

1543

"responseSize": "A String", # The size of the HTTP response message sent back to the client, in bytes,

1544

# including the response headers and the response body.

1545

"serverIp": "A String", # The IP address (IPv4 or IPv6) of the origin server that the request was

1546

# sent to.

1547

"referer": "A String", # The referer URL of the request, as defined in

1548

# [HTTP/1.1 Header Field

1549

# Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).

1550

"cacheHit": True or False, # Whether or not an entity was served from cache

1551

# (with or without validation).

1552

"latency": "A String", # The request processing latency on the server, from the time the request was

1553

# received until the response was sent.

1554

"requestUrl": "A String", # The scheme (http, https), the host name, the path, and the query

1555

# portion of the URL that was requested.

1556

# Example: `"http://example.com/some/info?color=red"`.

1557

"cacheLookup": True or False, # Whether or not a cache lookup was attempted.

1558

"requestMethod": "A String", # The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.

1559

"remoteIp": "A String", # The IP address (IPv4 or IPv6) of the client that issued the HTTP

1560

# request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.

1561

"userAgent": "A String", # The user agent sent by the client. Example:

1562

# `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET

1563

# CLR 1.0.3705)"`.

1564

"status": 42, # The response code indicating the status of the response.

1565

# Examples: 200, 404.

1566

},

1567

"operation": { # Additional information about a potentially long-running operation with which # Optional. Information about an operation associated with the log entry, if

1568

# applicable.

1569

# a log entry is associated.

1570

"first": True or False, # Optional. Set this to True if this is the first log entry in the operation.

1571

"id": "A String", # Optional. An arbitrary operation identifier. Log entries with the

1572

# same identifier are assumed to be part of the same operation.

1573

"producer": "A String", # Optional. An arbitrary producer identifier. The combination of

1574

# `id` and `producer` must be globally unique. Examples for `producer`:

1575

# `"MyDivision.MyBigCompany.com"`, `"github.com/MyProject/MyApplication"`.

1576

"last": True or False, # Optional. Set this to True if this is the last log entry in the operation.

1577

},

1578

"name": "A String", # Required. The log to which this log entry belongs. Examples: `"syslog"`,

1579

# `"book_log"`.

1580

"trace": "A String", # Optional. Resource name of the trace associated with the log entry, if any.

1581

# If this field contains a relative resource name, you can assume the name is

1582

# relative to `//tracing.googleapis.com`. Example:

1583

# `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824`

1584

"timestamp": "A String", # The time the event described by the log entry occurred. If

1585

# omitted, defaults to operation start time.

1586

"insertId": "A String", # A unique ID for the log entry used for deduplication. If omitted,

1587

# the implementation will generate one based on operation_id.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1588

},

1589

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1590

"importance": "A String", # DO NOT USE. This is an experimental field.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1591

"quotaProperties": { # Represents the properties needed for quota operations. # Represents the properties needed for quota check. Applicable only if this

1592

# operation is for a quota check request. If this is not specified, no quota

1593

# check will be performed.

1594

"quotaMode": "A String", # Quota mode for this operation.

1595

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1596

"operationName": "A String", # Fully qualified name of the operation. Reserved for future use.

1597

"resources": [ # The resources that are involved in the operation.

1598

# The maximum supported number of entries in this field is 100.

1599

{ # Describes a resource associated with this operation.

1600

"resourceContainer": "A String", # The identifier of the parent of this resource instance.

1601

# Must be in one of the following formats:

1602

# - “projects/<project-id or project-number>”

1603

# - “folders/<folder-id>”

1604

# - “organizations/<organization-id>”

1605

"resourceName": "A String", # Name of the resource. This is used for auditing purposes.

1606

"resourceLocation": "A String", # The location of the resource. If not empty, the resource will be checked

1607

# against location policy. The value must be a valid zone, region or

1608

# multiregion. For example: "europe-west4" or "northamerica-northeast1-a"

1609

},

1610

],

1611

"endTime": "A String", # End time of the operation.

1612

# Required when the operation is used in ServiceController.Report,

1613

# but optional when the operation is used in ServiceController.Check.

1614

"extensions": [ # Unimplemented.

1615

{

1616

"a_key": "", # Properties of the object. Contains field @type with type URL.

1617

},

1618

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1619

"consumerId": "A String", # Identity of the consumer who is using the service.

1620

# This field should be filled in for the operations initiated by a

1621

# consumer, but not for service-initiated operations that are

1622

# not related to a specific consumer.

1623

#

1624

# - This can be in one of the following formats:

1625

# - project:PROJECT_ID,

1626

# - project`_`number:PROJECT_NUMBER,

1627

# - projects/PROJECT_ID or PROJECT_NUMBER,

1628

# - folders/FOLDER_NUMBER,

1629

# - organizations/ORGANIZATION_NUMBER,

1630

# - api`_`key:API_KEY.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1631

},

1632

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1633

"serviceConfigId": "A String", # Specifies which version of service config should be used to process the

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

1634

# request.

1635

#

1636

# If unspecified or no matching version can be found, the

1637

# latest one will be used.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1638

}

1639

1640

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1647

1648

{ # Response message for the Report method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1649

"reportInfos": [ # Quota usage for each quota release `Operation` request.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1650

#

1651

# Fully or partially failed quota release request may or may not be present

1652

# in `report_quota_info`. For example, a failed quota release request will

1653

# have the current quota usage info when precise quota library returns the

1654

# info. A deadline exceeded quota request will not have quota usage info.

1655

#

1656

# If there is no quota release request, report_quota_info will be empty.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1657

{ # Contains additional info about the report operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1658

"quotaInfo": { # Contains the quota information for a quota check response. # Quota usage info when processing the `Operation`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1659

"quotaMetrics": [ # Quota metrics to indicate the usage. Depending on the check request, one or

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1660

# more of the following metrics will be included:

1661

#

1662

# 1. For rate quota, per quota group or per quota metric incremental usage

1663

# will be specified using the following delta metric:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1664

# "serviceruntime.googleapis.com/api/consumer/quota_used_count"

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1665

#

1666

# 2. For allocation quota, per quota metric total usage will be specified

1667

# using the following gauge metric:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1668

# "serviceruntime.googleapis.com/allocation/consumer/quota_used_count"

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1669

#

1670

# 3. For both rate quota and allocation quota, the quota limit reached

1671

# condition will be specified using the following boolean metric:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1672

# "serviceruntime.googleapis.com/quota/exceeded"

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1673

{ # Represents a set of metric values in the same metric.

1674

# Each metric value in the set should have a unique combination of start time,

1675

# end time, and label values.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1676

"metricValues": [ # The values in this metric.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1677

{ # Represents a single metric value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1678

"startTime": "A String", # The start of the time period over which this metric value's measurement

1679

# applies. The time period has different semantics for different metric

1680

# types (cumulative, delta, and gauge). See the metric definition

1681

# documentation in the service configuration for details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1682

"distributionValue": { # Distribution represents a frequency distribution of double-valued sample # A distribution value.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1683

# points. It contains the size of the population of sample points plus

1684

# additional optional information:

1685

#

1686

# - the arithmetic mean of the samples

1687

# - the minimum and maximum of the samples

1688

# - the sum-squared-deviation of the samples, used to compute variance

1689

# - a histogram of the values of the sample points

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1690

"bucketCounts": [ # The number of samples in each histogram bucket. `bucket_counts` are

1691

# optional. If present, they must sum to the `count` value.

1692

#

1693

# The buckets are defined below in `bucket_option`. There are N buckets.

1694

# `bucket_counts[0]` is the number of samples in the underflow bucket.

1695

# `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples

1696

# in each of the finite buckets. And `bucket_counts[N] is the number

1697

# of samples in the overflow bucket. See the comments of `bucket_option`

1698

# below for more details.

1699

#

1700

# Any suffix of trailing zeros may be omitted.

1701

"A String",

1702

],

1703

"count": "A String", # The total number of samples in the distribution. Must be >= 0.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1704

"sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1705

# Sum[i=1..count]((x_i - mean)^2)

1706

# where each x_i is a sample values. If `count` is zero then this field

1707

# must be zero, otherwise validation of the request fails.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1708

"linearBuckets": { # Describing buckets with constant width. # Buckets with constant width.

1709

"numFiniteBuckets": 42, # The number of finite buckets. With the underflow and overflow buckets,

1710

# the total number of buckets is `num_finite_buckets` + 2.

1711

# See comments on `bucket_options` for details.

1712

"offset": 3.14, # The i'th linear bucket covers the interval

1713

# [offset + (i-1) * width, offset + i * width)

1714

# where i ranges from 1 to num_finite_buckets, inclusive.

1715

"width": 3.14, # The i'th linear bucket covers the interval

1716

# [offset + (i-1) * width, offset + i * width)

1717

# where i ranges from 1 to num_finite_buckets, inclusive.

1718

# Must be strictly positive.

1719

},

1720

"maximum": 3.14, # The maximum of the population of values. Ignored if `count` is zero.

1721

"exponentialBuckets": { # Describing buckets with exponentially growing width. # Buckets with exponentially growing width.

1722

"growthFactor": 3.14, # The i'th exponential bucket covers the interval

1723

# [scale * growth_factor^(i-1), scale * growth_factor^i)

1724

# where i ranges from 1 to num_finite_buckets inclusive.

1725

# Must be larger than 1.0.

1726

"scale": 3.14, # The i'th exponential bucket covers the interval

1727

# [scale * growth_factor^(i-1), scale * growth_factor^i)

1728

# where i ranges from 1 to num_finite_buckets inclusive.

1729

# Must be > 0.

1730

"numFiniteBuckets": 42, # The number of finite buckets. With the underflow and overflow buckets,

1731

# the total number of buckets is `num_finite_buckets` + 2.

1732

# See comments on `bucket_options` for details.

1733

},

1734

"minimum": 3.14, # The minimum of the population of values. Ignored if `count` is zero.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1735

"exemplars": [ # Example points. Must be in increasing order of `value` field.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1736

{ # Exemplars are example points that may be used to annotate aggregated

1737

# distribution values. They are metadata that gives information about a

1738

# particular value added to a Distribution bucket, such as a trace ID that

1739

# was active when a value was added. They may contain further information,

1740

# such as a example values and timestamps, origin, etc.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1741

"value": 3.14, # Value of the exemplar point. This value determines to which bucket the

1742

# exemplar belongs.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1743

"attachments": [ # Contextual information about the example value. Examples are:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1744

#

1745

# Trace: type.googleapis.com/google.monitoring.v3.SpanContext

1746

#

1747

# Literal string: type.googleapis.com/google.protobuf.StringValue

1748

#

1749

# Labels dropped during aggregation:

1750

# type.googleapis.com/google.monitoring.v3.DroppedLabels

1751

#

1752

# There may be only a single attachment of any given message type in a

1753

# single exemplar, and this is enforced by the system.

1754

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1755

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1756

},

1757

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1758

"timestamp": "A String", # The observation (sampling) time of the above value.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1759

},

1760

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1761

"mean": 3.14, # The arithmetic mean of the samples in the distribution. If `count` is

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1762

# zero then this field must be zero.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1763

"explicitBuckets": { # Describing buckets with arbitrary user-provided width. # Buckets with arbitrary user-provided width.

1764

"bounds": [ # 'bound' is a list of strictly increasing boundaries between

1765

# buckets. Note that a list of length N-1 defines N buckets because

1766

# of fenceposting. See comments on `bucket_options` for details.

1767

#

1768

# The i'th finite bucket covers the interval

1769

# [bound[i-1], bound[i])

1770

# where i ranges from 1 to bound_size() - 1. Note that there are no

1771

# finite buckets at all if 'bound' only contains a single element; in

1772

# that special case the single bound defines the boundary between the

1773

# underflow and overflow buckets.

1774

#

1775

# bucket number lower bound upper bound

1776

# i == 0 (underflow) -inf bound[i]

1777

# 0 < i < bound_size() bound[i-1] bound[i]

1778

# i == bound_size() (overflow) bound[i-1] +inf

1779

3.14,

1780

],

1781

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1782

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1783

"labels": { # The labels describing the metric value.

1784

# See comments on google.api.servicecontrol.v1.Operation.labels for

1785

# the overriding relationship.

1786

# Note that this map must not contain monitored resource labels.

1787

"a_key": "A String",

1788

},

1789

"doubleValue": 3.14, # A double precision floating point value.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1790

"endTime": "A String", # The end of the time period over which this metric value's measurement

1791

# applies.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1792

"boolValue": True or False, # A boolean value.

1793

"int64Value": "A String", # A signed 64-bit integer value.

1794

"moneyValue": { # Represents an amount of money with its currency type. # A money value.

1795

"nanos": 42, # Number of nano (10^-9) units of the amount.

1796

# The value must be between -999,999,999 and +999,999,999 inclusive.

1797

# If `units` is positive, `nanos` must be positive or zero.

1798

# If `units` is zero, `nanos` can be positive, zero, or negative.

1799

# If `units` is negative, `nanos` must be negative or zero.

1800

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1801

"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.

1802

"units": "A String", # The whole units of the amount.

1803

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1804

},

1805

"stringValue": "A String", # A text string value.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1806

},

1807

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1808

"metricName": "A String", # The metric name defined in the service configuration.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1809

},

1810

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1811

"limitExceeded": [ # Quota Metrics that have exceeded quota limits.

1812

# For QuotaGroup-based quota, this is QuotaGroup.name

1813

# For QuotaLimit-based quota, this is QuotaLimit.name

1814

# See: google.api.Quota

1815

# Deprecated: Use quota_metrics to get per quota group limit exceeded status.

1816

"A String",

1817

],

1818

"quotaConsumed": { # Map of quota group name to the actual number of tokens consumed. If the

1819

# quota check was not successful, then this will not be populated due to no

1820

# quota consumption.

1821

#

1822

# We are not merging this field with 'quota_metrics' field because of the

1823

# complexity of scaling in Chemist client code base. For simplicity, we will

1824

# keep this field for Castor (that scales quota usage) and 'quota_metrics'

1825

# for SuperQuota (that doesn't scale quota usage).

1826

"a_key": 42,

1827

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1828

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1829

"operationId": "A String", # The Operation.operation_id value from the request.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1830

},

1831

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1832

"serviceRolloutId": "A String", # The current service rollout id used to process the request.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1833

"reportErrors": [ # Partial failures, one for each `Operation` in the request that failed

1834

# processing. There are three possible combinations of the RPC status:

1835

#

1836

# 1. The combination of a successful RPC status and an empty `report_errors`

1837

# list indicates a complete success where all `Operations` in the

1838

# request are processed successfully.

1839

# 2. The combination of a successful RPC status and a non-empty

1840

# `report_errors` list indicates a partial success where some

1841

# `Operations` in the request succeeded. Each

1842

# `Operation` that failed processing has a corresponding item

1843

# in this list.

1844

# 3. A failed RPC status indicates a general non-deterministic failure.

1845

# When this happens, it's impossible to know which of the

1846

# 'Operations' in the request succeeded or failed.

1847

{ # Represents the processing error of one Operation in the request.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1848

"status": { # The `Status` type defines a logical error model that is suitable for # Details of the error when processing the Operation.

1849

# different programming environments, including REST APIs and RPC APIs. It is

1850

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1851

# three pieces of data: error code, error message, and error details.

1852

#

1853

# You can find out more about this error model and how to work with it in the

1854

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1855

"message": "A String", # A developer-facing error message, which should be in English. Any

1856

# user-facing error message should be localized and sent in the

1857

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1858

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1859

"details": [ # A list of messages that carry the error details. There is a common set of

1860

# message types for APIs to use.

1861

{

1862

"a_key": "", # Properties of the object. Contains field @type with type URL.

1863

},

1864

],

1865

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1866

"operationId": "A String", # The Operation.operation_id value from the request.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1867

},

1868

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1869

"serviceConfigId": "A String", # The actual config id used to process the request.

Sai Cheemalapati