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

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

[diff] [blame]

621

#

Bu Sun Kim

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

[diff] [blame^]

622

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

623

# - project:PROJECT_ID,

624

# - project`_`number:PROJECT_NUMBER,

625

# - projects/PROJECT_ID or PROJECT_NUMBER,

626

# - folders/FOLDER_NUMBER,

627

# - organizations/ORGANIZATION_NUMBER,

628

# - api`_`key:API_KEY.

629

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

630

# service that generated the operation. If the service calls

631

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

632

# the same id.

633

#

634

# UUID version 4 is recommended, though not required.

635

# In scenarios where an operation is computed from existing information

636

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

637

# is recommended. See RFC 4122 for details.

638

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

639

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

640

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

641

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

642

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

643

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

644

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

Bu Sun Kim

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

[diff] [blame]

645

#

646

# - Labels describing monitored resources as defined in

647

# the service configuration.

648

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

649

# metric value override these default.

650

# - The following labels defined by Google Cloud Platform:

651

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

652

# operation happened,

653

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

654

# of the API request,

655

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

656

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

657

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

658

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

659

# Kubernetes Engine.

Bu Sun Kim

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

[diff] [blame^]

660

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

661

},

Bu Sun Kim

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

[diff] [blame^]

662

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

663

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

664

{ # Describes a resource associated with this operation.

665

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

666

# Must be in one of the following formats:

667

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

668

# - “folders/<folder-id>”

669

# - “organizations/<organization-id>”

670

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

671

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

672

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

673

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

674

},

675

],

676

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

Jon Wayne Parrott

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

[diff] [blame]

677

{ # An individual log entry.

Bu Sun Kim

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

[diff] [blame^]

678

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

679

# omitted, defaults to operation start time.

680

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

Bu Sun Kim

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

[diff] [blame]

681

# log entry, if applicable.

682

# defined by the HTTP specification. Product-specific logging

683

# information MUST be defined in a separate message.

Bu Sun Kim

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

[diff] [blame^]

684

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

685

# received until the response was sent.

686

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

687

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

688

# CLR 1.0.3705)"`.

689

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

690

# cache fill was attempted.

691

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

692

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

693

# headers and the request body.

694

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

695

# including the response headers and the response body.

696

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

697

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

698

# portion of the URL that was requested.

699

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

700

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

701

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

702

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

703

# sent to.

704

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

705

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

706

# (with or without validation).

707

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

Bu Sun Kim

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

[diff] [blame]

708

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

709

# True.

Bu Sun Kim

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

[diff] [blame^]

710

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

711

# Examples: 200, 404.

712

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

Bu Sun Kim

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

[diff] [blame]

713

# [HTTP/1.1 Header Field

714

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

Bu Sun Kim

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

[diff] [blame]

715

},

Bu Sun Kim

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

[diff] [blame^]

716

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

717

# `"book_log"`.

718

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

719

# the implementation will generate one based on operation_id.

720

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

721

# applicable.

722

# a log entry is associated.

723

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

724

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

725

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

726

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

727

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

728

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

729

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

730

},

731

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

732

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

733

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

734

# AuditLog.

735

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

736

},

737

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

Bu Sun Kim

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

[diff] [blame]

738

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

739

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

740

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

Bu Sun Kim

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

[diff] [blame^]

741

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

Jon Wayne Parrott

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

[diff] [blame]

742

# information about the log entry.

Bu Sun Kim

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

[diff] [blame^]

743

"a_key": "A String",

Jon Wayne Parrott

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

[diff] [blame]

744

},

Bu Sun Kim

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

[diff] [blame^]

745

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

746

# `LogSeverity.DEFAULT`.

747

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

Dan O'Meara

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

[diff] [blame]

748

# if any.

749

# entry.

Bu Sun Kim

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

[diff] [blame^]

750

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

751

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

752

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

Dan O'Meara

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

[diff] [blame]

753

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

754

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

755

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

756

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

757

# (Python).

Bu Sun Kim

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

[diff] [blame^]

758

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

Dan O'Meara

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

[diff] [blame]

759

# available.

Dan O'Meara

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

[diff] [blame]

760

},

Bu Sun Kim

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

[diff] [blame^]

761

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

762

# is expressed as a JSON object.

763

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

764

},

Jon Wayne Parrott

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

[diff] [blame]

765

},

766

],

Bu Sun Kim

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

[diff] [blame^]

767

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

768

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

769

# allowed.

770

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

771

},

Bu Sun Kim

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

[diff] [blame^]

772

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

773

# corresponds to a metric defined in the service configuration.

774

# The data type used in the MetricValueSet must agree with

775

# the data type specified in the metric definition.

Dan O'Meara

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

[diff] [blame]

776

#

Bu Sun Kim

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

[diff] [blame^]

777

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

778

# MetricValue instances that have the same metric names and identical

779

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

780

# instances, the entire request is rejected with

781

# an invalid argument error.

Sai Cheemalapati

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

[diff] [blame]

782

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

783

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

784

# end time, and label values.

Bu Sun Kim

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

[diff] [blame^]

785

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

Sai Cheemalapati

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

[diff] [blame]

786

{ # Represents a single metric value.

Bu Sun Kim

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

[diff] [blame^]

787

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

788

# applies.

789

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

790

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

791

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

792

# documentation in the service configuration for details.

793

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

794

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

795

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

796

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

797

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

Sai Cheemalapati

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

[diff] [blame]

798

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

799

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

800

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

801

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

802

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

Sai Cheemalapati

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

[diff] [blame]

803

},

Bu Sun Kim

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

[diff] [blame^]

804

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

805

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

Sai Cheemalapati

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

[diff] [blame]

806

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

807

# the overriding relationship.

Dan O'Meara

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

[diff] [blame]

808

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

Bu Sun Kim

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

[diff] [blame^]

809

"a_key": "A String",

Sai Cheemalapati

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

[diff] [blame]

810

},

Bu Sun Kim

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

[diff] [blame^]

811

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

812

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

813

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

Sai Cheemalapati

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

[diff] [blame]

814

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

815

# additional optional information:

816

#

817

# - the arithmetic mean of the samples

818

# - the minimum and maximum of the samples

819

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

820

# - a histogram of the values of the sample points

Bu Sun Kim

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

[diff] [blame^]

821

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

822

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

823

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

824

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

825

#

826

# The i'th finite bucket covers the interval

827

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

828

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

829

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

830

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

831

# underflow and overflow buckets.

832

#

833

# bucket number lower bound upper bound

834

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

835

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

836

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

3.14,

],

},

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

841

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

Dan O'Meara

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

[diff] [blame]

842

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

843

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

844

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

Bu Sun Kim

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

[diff] [blame^]

845

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

Dan O'Meara

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

[diff] [blame]

846

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

847

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

848

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

849

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

850

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

Bu Sun Kim

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

[diff] [blame^]

851

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

852

# exemplar belongs.

853

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

854

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

Dan O'Meara

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

[diff] [blame]

855

#

856

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

857

#

858

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

859

#

860

# Labels dropped during aggregation:

861

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

862

#

863

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

864

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

865

{

Bu Sun Kim

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

[diff] [blame^]

866

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

Dan O'Meara

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

[diff] [blame]

867

},

868

],

Dan O'Meara

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

[diff] [blame]

869

},

870

],

Bu Sun Kim

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

[diff] [blame^]

871

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

872

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

873

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

874

# where i ranges from 1 to num_finite_buckets inclusive.

875

# Must be larger than 1.0.

876

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

877

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

878

# where i ranges from 1 to num_finite_buckets inclusive.

879

# Must be > 0.

880

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

881

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

882

# See comments on `bucket_options` for details.

883

},

884

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

885

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

886

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

Sai Cheemalapati

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

[diff] [blame]

887

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

888

# where i ranges from 1 to num_finite_buckets, inclusive.

889

# Must be strictly positive.

Bu Sun Kim

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

[diff] [blame^]

890

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

Sai Cheemalapati

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

[diff] [blame]

891

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

892

# where i ranges from 1 to num_finite_buckets, inclusive.

Bu Sun Kim

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

[diff] [blame^]

893

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

894

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

895

# See comments on `bucket_options` for details.

Sai Cheemalapati

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

[diff] [blame]

896

},

Bu Sun Kim

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

[diff] [blame^]

897

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

898

# zero then this field must be zero.

899

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

900

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

901

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

902

#

903

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

904

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

905

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

906

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

907

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

908

# below for more details.

909

#

910

# Any suffix of trailing zeros may be omitted.

"A String",

],

},

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

915

},

916

],

917

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

},

],

},

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

922

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

923

# the request.

924

#

925

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

926

# latest one will be used.

927

}

928

929

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

936

937

{ # Response message for the Check method.

938

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

939

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

940

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

941

# performance and allow better aggregation.

942

"A String",

943

],

944

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

945

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

946

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

947

# consumer number is found.

948

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

949

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

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

},

957

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

958

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

959

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

960

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

961

# See: google.api.Quota

962

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

963

"A String",

964

],

965

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

966

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

967

# quota consumption.

968

#

969

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

970

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

971

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

972

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

973

"a_key": 42,

974

},

975

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

976

# more of the following metrics will be included:

977

#

978

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

979

# will be specified using the following delta metric:

980

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

981

#

982

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

983

# using the following gauge metric:

984

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

985

#

986

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

987

# condition will be specified using the following boolean metric:

988

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

989

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

990

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

991

# end time, and label values.

992

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

993

{ # Represents a single metric value.

994

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

995

# applies.

996

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

997

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

998

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

999

# documentation in the service configuration for details.

1000

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

1001

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

1002

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

1003

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

1004

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

1005

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

1006

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

1007

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

1008

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

1009

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

1010

},

1011

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

1012

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

1013

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

1014

# the overriding relationship.

1015

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

1016

"a_key": "A String",

1017

},

1018

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

1019

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

1020

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

1021

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

1022

# additional optional information:

1023

#

1024

# - the arithmetic mean of the samples

1025

# - the minimum and maximum of the samples

1026

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

1027

# - a histogram of the values of the sample points

1028

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

1029

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

Sai Cheemalapati

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

[diff] [blame]

1030

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

1031

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

1032

#

Bu Sun Kim

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

[diff] [blame^]

1033

# The i'th finite bucket covers the interval

Sai Cheemalapati

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

[diff] [blame]

1034

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

1035

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

Bu Sun Kim

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

[diff] [blame^]

1036

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

Sai Cheemalapati

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

[diff] [blame]

1037

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

1038

# underflow and overflow buckets.

1039

#

1040

# bucket number lower bound upper bound

1041

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

Dan O'Meara

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

[diff] [blame]

1042

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

Sai Cheemalapati

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

[diff] [blame]

1043

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

1044

3.14,

1045

],

1046

},

Bu Sun Kim

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

[diff] [blame^]

1047

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

1048

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

1049

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

1050

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

1051

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

1052

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

1053

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

1054

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

1055

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

1056

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

1057

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

1058

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

1059

# exemplar belongs.

1060

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

1061

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

1062

#

1063

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

1064

#

1065

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

1066

#

1067

# Labels dropped during aggregation:

1068

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

1069

#

1070

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

1071

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

1072

{

1073

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

},

],

},

],

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

1079

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

1080

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

1081

# where i ranges from 1 to num_finite_buckets inclusive.

1082

# Must be larger than 1.0.

1083

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

1084

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

1085

# where i ranges from 1 to num_finite_buckets inclusive.

1086

# Must be > 0.

1087

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

1088

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

1089

# See comments on `bucket_options` for details.

1090

},

1091

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

1092

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

1093

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

1094

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

1095

# where i ranges from 1 to num_finite_buckets, inclusive.

1096

# Must be strictly positive.

1097

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

1098

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

1099

# where i ranges from 1 to num_finite_buckets, inclusive.

1100

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

1101

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

1102

# See comments on `bucket_options` for details.

1103

},

1104

"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]

1105

# zero then this field must be zero.

Bu Sun Kim

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

[diff] [blame^]

1106

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

1107

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

1108

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

1109

#

1110

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

1111

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

1112

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

1113

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

1114

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

1115

# below for more details.

1116

#

1117

# Any suffix of trailing zeros may be omitted.

1118

"A String",

1119

],

Sai Cheemalapati

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

[diff] [blame]

1120

},

Bu Sun Kim

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

[diff] [blame^]

1121

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

Sai Cheemalapati

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

[diff] [blame]

1122

},

1123

],

Bu Sun Kim

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

[diff] [blame^]

1124

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

Sai Cheemalapati

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

[diff] [blame]

1125

},

1126

],

Sai Cheemalapati

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

[diff] [blame]

1127

},

Bu Sun Kim

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

[diff] [blame^]

1128

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

1129

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

1130

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

1131

#

1132

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

1133

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

1134

# appropriate action.

1135

{ # Defines the errors to be returned in

1136

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

1137

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

1138

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

1139

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

1140

# error.

1141

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

1142

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

1143

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

1144

#

1145

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

1146

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

1147

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

1148

# message types for APIs to use.

1149

{

1150

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

1151

},

1152

],

1153

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

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.

1157

},

1158

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

1159

# details on this field. For example:

1160

#

1161

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

1162

# - "folder:<folder-id>"

1163

# - "organization:<organization-id>"

1164

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

1165

},

1166

],

1167

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

Jon Wayne Parrott

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

[diff] [blame]

1168

# Used for logging and diagnostics purposes.

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1173

<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]

1174

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

1175

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

1176

1177

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

1178

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

1179

reduce data loss during client crashes. Clients should carefully choose

1180

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

1181

for business and compliance reasons.

1182

Dan O'Meara

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

[diff] [blame]

1183

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

1184

1MB.

Jon Wayne Parrott

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

[diff] [blame]

1185

1186

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

1187

on the specified service. For more information, see

1188

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

1189

1190

Args:

1191

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^]

1192

`"pubsub.googleapis.com"`.

Jon Wayne Parrott

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

[diff] [blame]

1193

Bu Sun Kim

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

[diff] [blame]

1194

See

1195

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

1196

for the definition of a service name. (required)

Dan O'Meara

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

[diff] [blame]

1197

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

1198

The object takes the form of:

1199

1200

{ # Request message for the Report method.

Bu Sun Kim

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

[diff] [blame^]

1201

"operations": [ # Operations to be reported.

Jon Wayne Parrott

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

[diff] [blame]

1202

#

1203

# Typically the service should report one operation per request.

1204

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

1205

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

1206

# of the report.

1207

#

Dan O'Meara

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

[diff] [blame]

1208

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

1209

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

1210

# ReportResponse.report_errors for partial failure behavior.

Jon Wayne Parrott

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

[diff] [blame]

1211

{ # Represents information regarding an operation.

Bu Sun Kim

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

[diff] [blame^]

1212

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

Dan O'Meara

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

[diff] [blame]

1213

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

1214

# consumer project.

1215

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

1216

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

1217

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

1218

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

1219

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

1220

# gaps or overlaps between spans in a trace.

Bu Sun Kim

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

[diff] [blame^]

1221

"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

Dan O'Meara

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

[diff] [blame]

1222

# span.

Bu Sun Kim

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

[diff] [blame^]

1223

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

Dan O'Meara

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

[diff] [blame]

1224

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

1225

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

Bu Sun Kim

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

[diff] [blame^]

1226

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

Dan O'Meara

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

[diff] [blame]

1227

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

1228

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

1229

#

Bu Sun Kim

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

[diff] [blame^]

1230

# "/instance_id": "my-instance"

1231

# "/http/user_agent": ""

1232

# "/http/request_bytes": 300

1233

# "abc.com/myattribute": true

1234

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

1235

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

1236

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

1237

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

1238

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

1239

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

Dan O'Meara

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

[diff] [blame]

1240

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

1241

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

1242

#

1243

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

1244

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

1245

# shortened string might be less than the size limit.

Dan O'Meara

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

[diff] [blame]

1246

},

Bu Sun Kim

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

[diff] [blame^]

1247

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

Dan O'Meara

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

[diff] [blame]

1248

},

1249

},

1250

},

Bu Sun Kim

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

[diff] [blame^]

1251

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

1252

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

1253

# then this field must be empty.

1254

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

Dan O'Meara

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

[diff] [blame]

1255

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

1256

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

Bu Sun Kim

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

[diff] [blame^]

1257

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

1258

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

1259

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

1260

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

1261

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

1262

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

1263

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

1264

# Stackdriver Trace displays the description in the

1265

# Google Cloud Platform Console.

1266

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

1267

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

1268

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

1269

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

1270

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

1271

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

1272

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

1273

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

1274

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

1275

#

1276

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

1277

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

1278

# shortened string might be less than the size limit.

1279

},

1280

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

1281

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

1282

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

Dan O'Meara

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

[diff] [blame]

1283

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

1284

# Stackdriver Trace is unable to take advantage of this helpful

1285

# information.

Bu Sun Kim

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

[diff] [blame^]

1286

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

1287

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

1288

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

1289

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

1290

#

1291

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

1292

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

1293

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

1294

# message types for APIs to use.

1295

{

1296

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

1297

},

1298

],

1299

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

1300

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

1301

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

1302

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

1303

},

1304

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

1305

#

1306

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

1307

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

1308

#

1309

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

1310

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

Dan O'Meara

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

[diff] [blame]

1311

},

1312

],

Bu Sun Kim

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

[diff] [blame^]

1313

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

1314

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

1315

# check will be performed.

1316

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

1317

},

1318

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

1319

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

1320

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

1321

# not related to a specific consumer.

Jon Wayne Parrott

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

[diff] [blame]

1322

#

Bu Sun Kim

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

[diff] [blame^]

1323

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

1324

# - project:PROJECT_ID,

1325

# - project`_`number:PROJECT_NUMBER,

1326

# - projects/PROJECT_ID or PROJECT_NUMBER,

1327

# - folders/FOLDER_NUMBER,

1328

# - organizations/ORGANIZATION_NUMBER,

1329

# - api`_`key:API_KEY.

1330

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

1331

# service that generated the operation. If the service calls

1332

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

1333

# the same id.

1334

#

1335

# UUID version 4 is recommended, though not required.

1336

# In scenarios where an operation is computed from existing information

1337

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

1338

# is recommended. See RFC 4122 for details.

1339

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

1340

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

1341

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

1342

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

1343

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

1344

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

1345

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

Bu Sun Kim

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

[diff] [blame]

1346

#

1347

# - Labels describing monitored resources as defined in

1348

# the service configuration.

1349

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

1350

# metric value override these default.

1351

# - The following labels defined by Google Cloud Platform:

1352

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

1353

# operation happened,

1354

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

1355

# of the API request,

1356

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

1357

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

1358

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

1359

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

1360

# Kubernetes Engine.

Bu Sun Kim

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

[diff] [blame^]

1361

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1362

},

Bu Sun Kim

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

[diff] [blame^]

1363

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

1364

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

1365

{ # Describes a resource associated with this operation.

1366

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

1367

# Must be in one of the following formats:

1368

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

1369

# - “folders/<folder-id>”

1370

# - “organizations/<organization-id>”

1371

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

1372

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

1373

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

1374

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

1375

},

1376

],

1377

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

Jon Wayne Parrott

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

[diff] [blame]

1378

{ # An individual log entry.

Bu Sun Kim

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

[diff] [blame^]

1379

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

1380

# omitted, defaults to operation start time.

1381

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

Bu Sun Kim

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

[diff] [blame]

1382

# log entry, if applicable.

1383

# defined by the HTTP specification. Product-specific logging

1384

# information MUST be defined in a separate message.

Bu Sun Kim

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

[diff] [blame^]

1385

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

1386

# received until the response was sent.

1387

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

1388

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

1389

# CLR 1.0.3705)"`.

1390

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

1391

# cache fill was attempted.

1392

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

1393

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

1394

# headers and the request body.

1395

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

1396

# including the response headers and the response body.

1397

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

1398

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

1399

# portion of the URL that was requested.

1400

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

1401

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

1402

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

1403

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

1404

# sent to.

1405

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

1406

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

1407

# (with or without validation).

1408

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

Bu Sun Kim

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

[diff] [blame]

1409

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

1410

# True.

Bu Sun Kim

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

[diff] [blame^]

1411

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

1412

# Examples: 200, 404.

1413

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

Bu Sun Kim

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

[diff] [blame]

1414

# [HTTP/1.1 Header Field

1415

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

Bu Sun Kim

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

[diff] [blame]

1416

},

Bu Sun Kim

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

[diff] [blame^]

1417

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

1418

# `"book_log"`.

1419

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

1420

# the implementation will generate one based on operation_id.

1421

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

1422

# applicable.

1423

# a log entry is associated.

1424

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

1425

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

1426

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

1427

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

1428

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

1429

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

1430

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

1431

},

1432

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

1433

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

1434

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

1435

# AuditLog.

1436

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

1437

},

1438

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

Bu Sun Kim

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

[diff] [blame]

1439

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

1440

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

1441

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

Bu Sun Kim

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

[diff] [blame^]

1442

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

Jon Wayne Parrott

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

[diff] [blame]

1443

# information about the log entry.

Bu Sun Kim

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

[diff] [blame^]

1444

"a_key": "A String",

Jon Wayne Parrott

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

[diff] [blame]

1445

},

Bu Sun Kim

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

[diff] [blame^]

1446

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

1447

# `LogSeverity.DEFAULT`.

1448

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

Dan O'Meara

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

[diff] [blame]

1449

# if any.

1450

# entry.

Bu Sun Kim

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

[diff] [blame^]

1451

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

1452

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

1453

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

Dan O'Meara

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

[diff] [blame]

1454

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

1455

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

1456

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

1457

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

1458

# (Python).

Bu Sun Kim

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

[diff] [blame^]

1459

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

Dan O'Meara

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

[diff] [blame]

1460

# available.

Dan O'Meara

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

[diff] [blame]

1461

},

Bu Sun Kim

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

[diff] [blame^]

1462

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

1463

# is expressed as a JSON object.

1464

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

1465

},

Jon Wayne Parrott

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

[diff] [blame]

1466

},

1467

],

Bu Sun Kim

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

[diff] [blame^]

1468

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

1469

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

# allowed.

"a_key": "A String",

},

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

1474

# corresponds to a metric defined in the service configuration.

1475

# The data type used in the MetricValueSet must agree with

1476

# the data type specified in the metric definition.

Jon Wayne Parrott

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

[diff] [blame]

1477

#

Bu Sun Kim

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

[diff] [blame^]

1478

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

1479

# MetricValue instances that have the same metric names and identical

1480

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

1481

# instances, the entire request is rejected with

1482

# an invalid argument error.

1483

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

1484

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

1485

# end time, and label values.

1486

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

1487

{ # Represents a single metric value.

1488

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

1489

# applies.

1490

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

1491

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

1492

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

1493

# documentation in the service configuration for details.

1494

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

1495

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

1496

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

1497

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

1498

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

1499

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

1500

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

1501

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

1502

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

1503

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

1504

},

1505

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

1506

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

1507

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

1508

# the overriding relationship.

1509

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

1510

"a_key": "A String",

1511

},

1512

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

1513

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

1514

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

1515

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

1516

# additional optional information:

1517

#

1518

# - the arithmetic mean of the samples

1519

# - the minimum and maximum of the samples

1520

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

1521

# - a histogram of the values of the sample points

1522

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

1523

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

1524

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

1525

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

1526

#

1527

# The i'th finite bucket covers the interval

1528

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

1529

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

1530

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

1531

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

1532

# underflow and overflow buckets.

1533

#

1534

# bucket number lower bound upper bound

1535

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

1536

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

1537

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

3.14,

],

},

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

1542

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

1543

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

1544

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

1545

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

1546

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

1547

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

1548

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

1549

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

1550

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

1551

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

1552

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

1553

# exemplar belongs.

1554

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

1555

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

1556

#

1557

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

1558

#

1559

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

1560

#

1561

# Labels dropped during aggregation:

1562

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

1563

#

1564

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

1565

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

1566

{

1567

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

},

],

},

],

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

1573

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

1574

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

1575

# where i ranges from 1 to num_finite_buckets inclusive.

1576

# Must be larger than 1.0.

1577

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

1578

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

1579

# where i ranges from 1 to num_finite_buckets inclusive.

1580

# Must be > 0.

1581

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

1582

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

1583

# See comments on `bucket_options` for details.

1584

},

1585

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

1586

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

1587

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

1588

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

1589

# where i ranges from 1 to num_finite_buckets, inclusive.

1590

# Must be strictly positive.

1591

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

1592

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

1593

# where i ranges from 1 to num_finite_buckets, inclusive.

1594

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

1595

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

1596

# See comments on `bucket_options` for details.

1597

},

1598

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

1599

# zero then this field must be zero.

1600

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

1601

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

1602

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

1603

#

1604

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

1605

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

1606

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

1607

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

1608

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

1609

# below for more details.

1610

#

1611

# Any suffix of trailing zeros may be omitted.

"A String",

],

},

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

1616

},

1617

],

1618

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

1619

},

1620

],

Jon Wayne Parrott

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

[diff] [blame]

1621

},

1622

],

Bu Sun Kim

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

[diff] [blame^]

1623

"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]

1624

# request.

1625

#

1626

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

1627

# latest one will be used.

Jon Wayne Parrott

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

[diff] [blame]

1628

}

1629

1630

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1637

1638

{ # Response message for the Report method.

Bu Sun Kim

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

[diff] [blame^]

1639

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1640

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

1641

#

1642

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

1643

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

1644

# request are processed successfully.

1645

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

1646

# `report_errors` list indicates a partial success where some

1647

# `Operations` in the request succeeded. Each

1648

# `Operation` that failed processing has a corresponding item

1649

# in this list.

1650

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

Bu Sun Kim

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

[diff] [blame^]

1651

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

1652

# 'Operations' in the request succeeded or failed.

Bu Sun Kim

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

[diff] [blame]

1653

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

Bu Sun Kim

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

[diff] [blame^]

1654

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

Bu Sun Kim

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

[diff] [blame]

1655

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

1656

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

1657

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1658

#

Bu Sun Kim

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

[diff] [blame]

1659

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

1660

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

Bu Sun Kim

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

[diff] [blame^]

1661

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

Bu Sun Kim

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

[diff] [blame]

1662

# message types for APIs to use.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1663

{

Bu Sun Kim

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

[diff] [blame^]

1664

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1665

},

1666

],

Bu Sun Kim

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

[diff] [blame^]

1667

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

1668

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

1669

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

1670

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1671

},

Bu Sun Kim

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

[diff] [blame^]

1672

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1673

},

1674

],

Bu Sun Kim

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

[diff] [blame^]

1675

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

1676

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

Sai Cheemalapati

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

[diff] [blame]

1677

#

1678

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

1679

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

1680

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

1681

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

1682

#

1683

# 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]

1684

{ # Contains additional info about the report operation.

Bu Sun Kim

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

[diff] [blame^]

1685

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

1686

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

1687

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

1688

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

1689

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

1690

# See: google.api.Quota

1691

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

1692

"A String",

1693

],

1694

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

Dan O'Meara

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

[diff] [blame]

1695

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

1696

# quota consumption.

1697

#

Bu Sun Kim

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

[diff] [blame^]

1698

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

Dan O'Meara

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

[diff] [blame]

1699

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

Bu Sun Kim

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

[diff] [blame^]

1700

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

1701

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

1702

"a_key": 42,

Dan O'Meara

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

[diff] [blame]

1703

},

Bu Sun Kim

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

[diff] [blame^]

1704

"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]

1705

# more of the following metrics will be included:

1706

#

1707

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

1708

# will be specified using the following delta metric:

Bu Sun Kim

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

[diff] [blame^]

1709

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

Sai Cheemalapati

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

[diff] [blame]

1710

#

1711

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

1712

# using the following gauge metric:

Bu Sun Kim

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

[diff] [blame^]

1713

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

Sai Cheemalapati

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

[diff] [blame]

1714

#

1715

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

1716

# condition will be specified using the following boolean metric:

Bu Sun Kim

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

[diff] [blame^]

1717

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

Sai Cheemalapati

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

[diff] [blame]

1718

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

1719

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

1720

# end time, and label values.

Bu Sun Kim

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

[diff] [blame^]

1721

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

Sai Cheemalapati

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

[diff] [blame]

1722

{ # Represents a single metric value.

Bu Sun Kim

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

[diff] [blame^]

1723

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

1724

# applies.

1725

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

1726

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

1727

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

1728

# documentation in the service configuration for details.

1729

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

1730

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

1731

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

1732

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

1733

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

Sai Cheemalapati

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

[diff] [blame]

1734

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

1735

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

1736

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

1737

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

1738

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

Sai Cheemalapati

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

[diff] [blame]

1739

},

Bu Sun Kim

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

[diff] [blame^]

1740

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

1741

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

Sai Cheemalapati

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

[diff] [blame]

1742

# See comments on google.api.servicecontrol.v1.Operation.labels for

1743

# the overriding relationship.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1744

# Note that this map must not contain monitored resource labels.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1745

"a_key": "A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1746

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1747

"doubleValue": 3.14, # A double precision floating point value.

1748

"int64Value": "A String", # A signed 64-bit integer value.

1749

"distributionValue": { # Distribution represents a frequency distribution of double-valued sample # A distribution value.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1750

# points. It contains the size of the population of sample points plus

1751

# additional optional information:

1752

#

1753

# - the arithmetic mean of the samples

1754

# - the minimum and maximum of the samples

1755

# - the sum-squared-deviation of the samples, used to compute variance

1756

# - a histogram of the values of the sample points

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1757

"explicitBuckets": { # Describing buckets with arbitrary user-provided width. # Buckets with arbitrary user-provided width.

1758

"bounds": [ # 'bound' is a list of strictly increasing boundaries between

1759

# buckets. Note that a list of length N-1 defines N buckets because

1760

# of fenceposting. See comments on `bucket_options` for details.

1761

#

1762

# The i'th finite bucket covers the interval

1763

# [bound[i-1], bound[i])

1764

# where i ranges from 1 to bound_size() - 1. Note that there are no

1765

# finite buckets at all if 'bound' only contains a single element; in

1766

# that special case the single bound defines the boundary between the

1767

# underflow and overflow buckets.

1768

#

1769

# bucket number lower bound upper bound

1770

# i == 0 (underflow) -inf bound[i]

1771

# 0 < i < bound_size() bound[i-1] bound[i]

1772

# i == bound_size() (overflow) bound[i-1] +inf

3.14,

],

},

"maximum": 3.14, # The maximum of the population of values. Ignored if `count` is zero.

1777

"sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1778

# Sum[i=1..count]((x_i - mean)^2)

1779

# where each x_i is a sample values. If `count` is zero then this field

1780

# must be zero, otherwise validation of the request fails.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1781

"exemplars": [ # Example points. Must be in increasing order of `value` field.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1782

{ # Exemplars are example points that may be used to annotate aggregated

1783

# distribution values. They are metadata that gives information about a

1784

# particular value added to a Distribution bucket, such as a trace ID that

1785

# was active when a value was added. They may contain further information,

1786

# such as a example values and timestamps, origin, etc.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1787

"value": 3.14, # Value of the exemplar point. This value determines to which bucket the

1788

# exemplar belongs.

1789

"timestamp": "A String", # The observation (sampling) time of the above value.

1790

"attachments": [ # Contextual information about the example value. Examples are:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1791

#

1792

# Trace: type.googleapis.com/google.monitoring.v3.SpanContext

1793

#

1794

# Literal string: type.googleapis.com/google.protobuf.StringValue

1795

#

1796

# Labels dropped during aggregation:

1797

# type.googleapis.com/google.monitoring.v3.DroppedLabels

1798

#

1799

# There may be only a single attachment of any given message type in a

1800

# single exemplar, and this is enforced by the system.

1801

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1802

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1803

},

1804

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1805

},

1806

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1807

"exponentialBuckets": { # Describing buckets with exponentially growing width. # Buckets with exponentially growing width.

1808

"growthFactor": 3.14, # The i'th exponential bucket covers the interval

1809

# [scale * growth_factor^(i-1), scale * growth_factor^i)

1810

# where i ranges from 1 to num_finite_buckets inclusive.

1811

# Must be larger than 1.0.

1812

"scale": 3.14, # The i'th exponential bucket covers the interval

1813

# [scale * growth_factor^(i-1), scale * growth_factor^i)

1814

# where i ranges from 1 to num_finite_buckets inclusive.

1815

# Must be > 0.

1816

"numFiniteBuckets": 42, # The number of finite buckets. With the underflow and overflow buckets,

1817

# the total number of buckets is `num_finite_buckets` + 2.

1818

# See comments on `bucket_options` for details.

1819

},

1820

"minimum": 3.14, # The minimum of the population of values. Ignored if `count` is zero.

1821

"linearBuckets": { # Describing buckets with constant width. # Buckets with constant width.

1822

"width": 3.14, # The i'th linear bucket covers the interval

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1823

# [offset + (i-1) * width, offset + i * width)

1824

# where i ranges from 1 to num_finite_buckets, inclusive.

1825

# Must be strictly positive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1826

"offset": 3.14, # The i'th linear bucket covers the interval

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1827

# [offset + (i-1) * width, offset + i * width)

1828

# where i ranges from 1 to num_finite_buckets, inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1829

"numFiniteBuckets": 42, # The number of finite buckets. With the underflow and overflow buckets,

1830

# the total number of buckets is `num_finite_buckets` + 2.

1831

# See comments on `bucket_options` for details.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1832

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1833

"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]

1834

# zero then this field must be zero.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1835

"count": "A String", # The total number of samples in the distribution. Must be >= 0.

1836

"bucketCounts": [ # The number of samples in each histogram bucket. `bucket_counts` are

1837

# optional. If present, they must sum to the `count` value.

1838

#

1839

# The buckets are defined below in `bucket_option`. There are N buckets.

1840

# `bucket_counts[0]` is the number of samples in the underflow bucket.

1841

# `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples

1842

# in each of the finite buckets. And `bucket_counts[N] is the number

1843

# of samples in the overflow bucket. See the comments of `bucket_option`

1844

# below for more details.

1845

#

1846

# Any suffix of trailing zeros may be omitted.

1847

"A String",

1848

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1849

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1850

"boolValue": True or False, # A boolean value.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1851

},

1852

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1853

"metricName": "A String", # The metric name defined in the service configuration.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1854

},

1855

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1856

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1857

},

1858

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1859

"serviceConfigId": "A String", # The actual config id used to process the request.

Sai Cheemalapati