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

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

[diff] [blame]

561

# log entry, if applicable.

562

# defined by the HTTP specification. Product-specific logging

563

# information MUST be defined in a separate message.

Bu Sun Kim

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

[diff] [blame^]

564

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

565

# [HTTP/1.1 Header Field

566

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

Bu Sun Kim

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

[diff] [blame]

567

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

568

# received until the response was sent.

569

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

570

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

571

# CLR 1.0.3705)"`.

572

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

573

# cache fill was attempted.

574

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

575

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

576

# headers and the request body.

577

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

578

# including the response headers and the response body.

579

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

580

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

581

# portion of the URL that was requested.

582

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

583

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

584

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

585

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

586

# sent to.

587

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

588

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

589

# (with or without validation).

590

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

591

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

592

# True.

Bu Sun Kim

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

[diff] [blame]

593

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

594

# Examples: 200, 404.

Bu Sun Kim

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

[diff] [blame]

595

},

Bu Sun Kim

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

[diff] [blame]

596

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

597

# applicable.

598

# a log entry is associated.

Bu Sun Kim

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

[diff] [blame]

599

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

600

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

601

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

602

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

603

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

604

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

Bu Sun Kim

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

[diff] [blame^]

605

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

Bu Sun Kim

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

[diff] [blame]

606

},

Bu Sun Kim

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

[diff] [blame^]

607

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

608

# `"book_log"`.

609

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

610

# the implementation will generate one based on operation_id.

Bu Sun Kim

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

[diff] [blame]

611

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

612

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

613

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

614

# AuditLog.

615

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

616

},

Bu Sun Kim

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

[diff] [blame]

617

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

Jon Wayne Parrott

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

[diff] [blame]

618

# information about the log entry.

Bu Sun Kim

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

[diff] [blame]

619

"a_key": "A String",

Jon Wayne Parrott

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

[diff] [blame]

620

},

Bu Sun Kim

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

[diff] [blame^]

621

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

622

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

623

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

624

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

Bu Sun Kim

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

[diff] [blame]

625

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

626

# `LogSeverity.DEFAULT`.

627

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

628

# if any.

629

# entry.

Bu Sun Kim

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

[diff] [blame^]

630

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

631

# available.

Bu Sun Kim

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

[diff] [blame]

632

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

633

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

634

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

635

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

636

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

637

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

638

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

639

# (Python).

Dan O'Meara

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

[diff] [blame]

640

},

Bu Sun Kim

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

[diff] [blame]

641

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

642

# is expressed as a JSON object.

643

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

644

},

Bu Sun Kim

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

[diff] [blame^]

645

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

646

# omitted, defaults to operation start time.

Jon Wayne Parrott

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

[diff] [blame]

647

},

648

],

Bu Sun Kim

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

[diff] [blame]

649

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

650

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

651

# allowed.

652

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

653

},

Bu Sun Kim

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

[diff] [blame]

654

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

655

# corresponds to a metric defined in the service configuration.

656

# The data type used in the MetricValueSet must agree with

657

# the data type specified in the metric definition.

Dan O'Meara

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

[diff] [blame]

658

#

Bu Sun Kim

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

[diff] [blame]

659

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

660

# MetricValue instances that have the same metric names and identical

661

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

662

# instances, the entire request is rejected with

663

# an invalid argument error.

Sai Cheemalapati

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

[diff] [blame]

664

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

665

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

666

# end time, and label values.

Bu Sun Kim

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

[diff] [blame^]

667

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

Bu Sun Kim

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

[diff] [blame]

668

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

Sai Cheemalapati

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

[diff] [blame]

669

{ # Represents a single metric value.

Bu Sun Kim

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

[diff] [blame]

670

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

671

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

672

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

673

# documentation in the service configuration for details.

674

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

Bu Sun Kim

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

[diff] [blame]

675

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

Sai Cheemalapati

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

[diff] [blame]

676

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

677

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

678

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

679

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

680

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

Bu Sun Kim

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

[diff] [blame^]

681

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

682

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

683

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

Sai Cheemalapati

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

[diff] [blame]

684

},

Bu Sun Kim

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

[diff] [blame]

685

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

Sai Cheemalapati

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

[diff] [blame]

686

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

687

# the overriding relationship.

Dan O'Meara

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

[diff] [blame]

688

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

Bu Sun Kim

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

[diff] [blame]

689

"a_key": "A String",

Sai Cheemalapati

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

[diff] [blame]

690

},

Bu Sun Kim

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

[diff] [blame^]

691

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

Bu Sun Kim

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

[diff] [blame]

692

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

693

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

694

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

Sai Cheemalapati

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

[diff] [blame]

695

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

696

# additional optional information:

697

#

698

# - the arithmetic mean of the samples

699

# - the minimum and maximum of the samples

700

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

701

# - a histogram of the values of the sample points

Bu Sun Kim

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

[diff] [blame]

702

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

Dan O'Meara

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

[diff] [blame]

703

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

704

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

705

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

Bu Sun Kim

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

[diff] [blame]

706

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

Dan O'Meara

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

[diff] [blame]

707

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

708

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

709

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

710

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

711

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

Bu Sun Kim

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

[diff] [blame]

712

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

713

# exemplar belongs.

714

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

715

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

Dan O'Meara

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

[diff] [blame]

716

#

717

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

718

#

719

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

720

#

721

# Labels dropped during aggregation:

722

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

723

#

724

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

725

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

726

{

Bu Sun Kim

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

[diff] [blame]

727

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

Dan O'Meara

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

[diff] [blame]

728

},

729

],

Dan O'Meara

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

[diff] [blame]

730

},

731

],

Bu Sun Kim

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

[diff] [blame]

732

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

733

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

734

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

735

# where i ranges from 1 to num_finite_buckets inclusive.

736

# Must be larger than 1.0.

737

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

738

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

739

# where i ranges from 1 to num_finite_buckets inclusive.

740

# Must be > 0.

741

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

742

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

743

# See comments on `bucket_options` for details.

744

},

745

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

746

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

Bu Sun Kim

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

[diff] [blame^]

747

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

748

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

749

# See comments on `bucket_options` for details.

Bu Sun Kim

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

[diff] [blame]

750

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

Sai Cheemalapati

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

[diff] [blame]

751

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

752

# where i ranges from 1 to num_finite_buckets, inclusive.

753

# Must be strictly positive.

Bu Sun Kim

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

[diff] [blame]

754

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

Sai Cheemalapati

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

[diff] [blame]

755

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

756

# where i ranges from 1 to num_finite_buckets, inclusive.

757

},

Bu Sun Kim

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

[diff] [blame]

758

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

759

# zero then this field must be zero.

760

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

761

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

762

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

763

#

764

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

765

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

766

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

767

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

768

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

769

# below for more details.

770

#

771

# Any suffix of trailing zeros may be omitted.

772

"A String",

773

],

Bu Sun Kim

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

[diff] [blame^]

774

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

775

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

776

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

777

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

778

#

779

# The i'th finite bucket covers the interval

780

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

781

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

782

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

783

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

784

# underflow and overflow buckets.

785

#

786

# bucket number lower bound upper bound

787

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

788

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

789

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

Bu Sun Kim

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

[diff] [blame]

794

},

795

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

Bu Sun Kim

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

[diff] [blame^]

796

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

797

# applies.

Bu Sun Kim

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

[diff] [blame]

798

},

799

],

Bu Sun Kim

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

[diff] [blame]

800

},

801

],

Bu Sun Kim

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

[diff] [blame^]

802

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

803

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

804

# consumer project.

805

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

806

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

807

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

808

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

809

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

810

# gaps or overlaps between spans in a trace.

811

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

812

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

813

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

814

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

815

# Stackdriver Trace is unable to take advantage of this helpful

816

# information.

817

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

818

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

819

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

820

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

821

#

822

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

823

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

824

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

825

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

826

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

827

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

828

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

829

# message types for APIs to use.

830

{

831

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

},

],

},

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

836

#

837

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

838

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

839

#

840

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

841

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

842

"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

843

# span.

844

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

845

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

846

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

847

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

848

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

849

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

850

#

851

# "/instance_id": "my-instance"

852

# "/http/user_agent": ""

853

# "/http/request_bytes": 300

854

# "abc.com/myattribute": true

855

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

856

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

857

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

858

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

859

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

860

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

861

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

862

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

863

#

864

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

865

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

866

# shortened string might be less than the size limit.

867

},

868

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

},

},

},

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

873

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

874

# then this field must be empty.

875

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

876

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

877

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

878

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

879

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

880

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

881

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

882

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

883

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

884

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

885

# Stackdriver Trace displays the description in the

886

# Google Cloud Platform Console.

887

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

888

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

889

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

890

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

891

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

892

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

893

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

894

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

895

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

896

#

897

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

898

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

899

# shortened string might be less than the size limit.

},

},

],

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

904

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

905

# check will be performed.

906

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

907

},

908

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

909

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

910

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

911

# not related to a specific consumer.

912

#

913

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

914

# - project:PROJECT_ID,

915

# - project`_`number:PROJECT_NUMBER,

916

# - projects/PROJECT_ID or PROJECT_NUMBER,

917

# - folders/FOLDER_NUMBER,

918

# - organizations/ORGANIZATION_NUMBER,

919

# - api`_`key:API_KEY.

Bu Sun Kim

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

[diff] [blame]

920

},

921

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

Bu Sun Kim

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

[diff] [blame^]

938

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

939

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

940

# Used for logging and diagnostics purposes.

941

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

942

#

943

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

944

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

945

# appropriate action.

946

{ # Defines the errors to be returned in

947

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

948

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

949

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

950

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

951

# error.

952

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

953

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

954

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

955

#

956

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

957

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

958

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

959

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

960

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

961

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

962

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

963

# message types for APIs to use.

964

{

965

"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

970

# details on this field. For example:

971

#

972

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

973

# - "folder:<folder-id>"

974

# - "organization:<organization-id>"

975

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

976

},

977

],

Bu Sun Kim

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

[diff] [blame]

978

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

979

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

980

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

981

# performance and allow better aggregation.

982

"A String",

983

],

984

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

Bu Sun Kim

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

[diff] [blame]

985

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

986

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

987

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

988

# no project number is found.

989

#

990

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

991

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

Bu Sun Kim

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

[diff] [blame^]

992

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

993

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

994

# consumer number is found.

Bu Sun Kim

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

[diff] [blame]

995

},

996

},

Bu Sun Kim

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

[diff] [blame^]

997

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

Bu Sun Kim

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

[diff] [blame]

998

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

999

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

1000

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

1001

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

1002

# See: google.api.Quota

1003

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

1004

"A String",

1005

],

1006

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

1007

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

1008

# quota consumption.

1009

#

1010

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

1011

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

1012

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

1013

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

1014

"a_key": 42,

1015

},

1016

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

1017

# more of the following metrics will be included:

1018

#

1019

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

1020

# will be specified using the following delta metric:

1021

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

1022

#

1023

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

1024

# using the following gauge metric:

1025

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

1026

#

1027

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

1028

# condition will be specified using the following boolean metric:

1029

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

1030

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

1031

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

1032

# end time, and label values.

Bu Sun Kim

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

[diff] [blame^]

1033

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

Bu Sun Kim

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

[diff] [blame]

1034

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

1035

{ # Represents a single metric value.

Bu Sun Kim

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

[diff] [blame]

1036

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

1037

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

1038

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

1039

# documentation in the service configuration for details.

1040

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

Bu Sun Kim

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

[diff] [blame]

1041

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

1042

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

1043

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

1044

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

1045

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

1046

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

Bu Sun Kim

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

[diff] [blame^]

1047

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

1048

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

1049

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

Bu Sun Kim

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

[diff] [blame]

1050

},

Bu Sun Kim

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

[diff] [blame]

1051

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

1052

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

1053

# the overriding relationship.

1054

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

1055

"a_key": "A String",

1056

},

Bu Sun Kim

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

[diff] [blame^]

1057

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

Bu Sun Kim

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

[diff] [blame]

1058

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

1059

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

1060

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

1061

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

1062

# additional optional information:

1063

#

1064

# - the arithmetic mean of the samples

1065

# - the minimum and maximum of the samples

1066

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

1067

# - a histogram of the values of the sample points

Bu Sun Kim

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

[diff] [blame]

1068

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

1069

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

1070

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

1071

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

1072

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

1073

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

1074

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

1075

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

1076

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

1077

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

1078

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

1079

# exemplar belongs.

1080

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

1081

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

1082

#

1083

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

1084

#

1085

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

1086

#

1087

# Labels dropped during aggregation:

1088

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

1089

#

1090

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

1091

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

1092

{

1093

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

},

],

},

],

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

1099

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

1100

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

1101

# where i ranges from 1 to num_finite_buckets inclusive.

1102

# Must be larger than 1.0.

1103

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

1104

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

1105

# where i ranges from 1 to num_finite_buckets inclusive.

1106

# Must be > 0.

1107

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

1108

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

1109

# See comments on `bucket_options` for details.

1110

},

1111

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

1112

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

Bu Sun Kim

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

[diff] [blame^]

1113

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

1114

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

1115

# See comments on `bucket_options` for details.

Bu Sun Kim

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

[diff] [blame]

1116

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

1117

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

1118

# where i ranges from 1 to num_finite_buckets, inclusive.

1119

# Must be strictly positive.

1120

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

1121

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

1122

# where i ranges from 1 to num_finite_buckets, inclusive.

Bu Sun Kim

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

[diff] [blame]

1123

},

1124

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

1125

# zero then this field must be zero.

Bu Sun Kim

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

[diff] [blame]

1126

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

1127

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

1128

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

1129

#

1130

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

1131

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

1132

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

1133

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

1134

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

1135

# below for more details.

1136

#

1137

# Any suffix of trailing zeros may be omitted.

1138

"A String",

1139

],

Bu Sun Kim

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

[diff] [blame^]

1140

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

1141

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

1142

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

1143

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

1144

#

1145

# The i'th finite bucket covers the interval

1146

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

1147

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

1148

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

1149

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

1150

# underflow and overflow buckets.

1151

#

1152

# bucket number lower bound upper bound

1153

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

1154

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

1155

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

Sai Cheemalapati

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

[diff] [blame]

1160

},

Bu Sun Kim

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

[diff] [blame]

1161

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

Bu Sun Kim

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

[diff] [blame^]

1162

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

1163

# applies.

Sai Cheemalapati

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

[diff] [blame]

1164

},

1165

],

Sai Cheemalapati

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

[diff] [blame]

1166

},

1167

],

Sai Cheemalapati

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

[diff] [blame]

1168

},

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]

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

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

1213

# service that generated the operation. If the service calls

1214

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

1215

# the same id.

1216

#

1217

# UUID version 4 is recommended, though not required.

1218

# In scenarios where an operation is computed from existing information

1219

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

1220

# is recommended. See RFC 4122 for details.

1221

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

1222

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

1223

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

1224

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

1225

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

1226

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

1227

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

Bu Sun Kim

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

[diff] [blame]

1228

#

1229

# - Labels describing monitored resources as defined in

1230

# the service configuration.

1231

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

1232

# metric value override these default.

1233

# - The following labels defined by Google Cloud Platform:

1234

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

1235

# operation happened,

1236

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

1237

# of the API request,

1238

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

1239

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

1240

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

1241

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

1242

# Kubernetes Engine.

Bu Sun Kim

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

[diff] [blame]

1243

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1244

},

Bu Sun Kim

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

[diff] [blame]

1245

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

1246

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

1247

{ # Describes a resource associated with this operation.

Bu Sun Kim

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

[diff] [blame^]

1248

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

1249

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

1250

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

1251

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

Bu Sun Kim

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

[diff] [blame]

1252

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

1253

# Must be in one of the following formats:

1254

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

1255

# - “folders/<folder-id>”

1256

# - “organizations/<organization-id>”

Bu Sun Kim

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

[diff] [blame]

1257

},

1258

],

1259

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

Jon Wayne Parrott

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

[diff] [blame]

1260

{ # An individual log entry.

Bu Sun Kim

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

[diff] [blame]

1261

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

1262

# log entry, if applicable.

1263

# defined by the HTTP specification. Product-specific logging

1264

# information MUST be defined in a separate message.

Bu Sun Kim

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

[diff] [blame^]

1265

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

1266

# [HTTP/1.1 Header Field

1267

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

Bu Sun Kim

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

[diff] [blame]

1268

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

1269

# received until the response was sent.

1270

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

1271

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

1272

# CLR 1.0.3705)"`.

1273

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

1274

# cache fill was attempted.

1275

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

1276

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

1277

# headers and the request body.

1278

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

1279

# including the response headers and the response body.

1280

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

1281

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

1282

# portion of the URL that was requested.

1283

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

1284

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

1285

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

1286

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

1287

# sent to.

1288

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

1289

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

1290

# (with or without validation).

1291

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

1292

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

1293

# True.

Bu Sun Kim

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

[diff] [blame]

1294

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

1295

# Examples: 200, 404.

Bu Sun Kim

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

[diff] [blame]

1296

},

Bu Sun Kim

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

[diff] [blame]

1297

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

1298

# applicable.

1299

# a log entry is associated.

Bu Sun Kim

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

[diff] [blame]

1300

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

1301

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

1302

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

1303

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

1304

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

1305

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

Bu Sun Kim

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

[diff] [blame^]

1306

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

Bu Sun Kim

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

[diff] [blame]

1307

},

Bu Sun Kim

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

[diff] [blame^]

1308

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

1309

# `"book_log"`.

1310

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

1311

# the implementation will generate one based on operation_id.

Bu Sun Kim

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

[diff] [blame]

1312

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

1313

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

1314

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

1315

# AuditLog.

1316

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

1317

},

Bu Sun Kim

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

[diff] [blame]

1318

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

Jon Wayne Parrott

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

[diff] [blame]

1319

# information about the log entry.

Bu Sun Kim

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

[diff] [blame]

1320

"a_key": "A String",

Jon Wayne Parrott

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

[diff] [blame]

1321

},

Bu Sun Kim

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

[diff] [blame^]

1322

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

1323

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

1324

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

1325

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

Bu Sun Kim

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

[diff] [blame]

1326

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

1327

# `LogSeverity.DEFAULT`.

1328

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

1329

# if any.

1330

# entry.

Bu Sun Kim

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

[diff] [blame^]

1331

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

1332

# available.

Bu Sun Kim

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

[diff] [blame]

1333

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

1334

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

1335

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

1336

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

1337

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

1338

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

1339

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

1340

# (Python).

Dan O'Meara

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

[diff] [blame]

1341

},

Bu Sun Kim

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

[diff] [blame]

1342

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

1343

# is expressed as a JSON object.

1344

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

1345

},

Bu Sun Kim

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

[diff] [blame^]

1346

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

1347

# omitted, defaults to operation start time.

Jon Wayne Parrott

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

[diff] [blame]

1348

},

1349

],

Bu Sun Kim

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

[diff] [blame]

1350

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

1351

# 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

1356

# corresponds to a metric defined in the service configuration.

1357

# The data type used in the MetricValueSet must agree with

1358

# the data type specified in the metric definition.

Jon Wayne Parrott

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

[diff] [blame]

1359

#

Bu Sun Kim

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

[diff] [blame]

1360

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

1361

# MetricValue instances that have the same metric names and identical

1362

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

1363

# instances, the entire request is rejected with

1364

# an invalid argument error.

1365

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

1366

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

1367

# end time, and label values.

Bu Sun Kim

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

[diff] [blame^]

1368

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

Bu Sun Kim

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

[diff] [blame]

1369

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

1370

{ # Represents a single metric value.

Bu Sun Kim

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

[diff] [blame]

1371

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

1372

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

1373

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

1374

# documentation in the service configuration for details.

1375

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

Bu Sun Kim

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

[diff] [blame]

1376

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

1377

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

1378

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

1379

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

1380

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

1381

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

Bu Sun Kim

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

[diff] [blame^]

1382

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

1383

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

1384

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

Bu Sun Kim

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

[diff] [blame]

1385

},

Bu Sun Kim

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

[diff] [blame]

1386

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

1387

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

1388

# the overriding relationship.

1389

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

1390

"a_key": "A String",

1391

},

Bu Sun Kim

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

[diff] [blame^]

1392

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

Bu Sun Kim

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

[diff] [blame]

1393

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

1394

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

1395

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

1396

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

1397

# additional optional information:

1398

#

1399

# - the arithmetic mean of the samples

1400

# - the minimum and maximum of the samples

1401

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

1402

# - a histogram of the values of the sample points

Bu Sun Kim

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

[diff] [blame]

1403

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

1404

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

1405

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

1406

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

1407

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

1408

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

1409

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

1410

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

1411

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

1412

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

1413

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

1414

# exemplar belongs.

1415

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

1416

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

1417

#

1418

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

1419

#

1420

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

1421

#

1422

# Labels dropped during aggregation:

1423

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

1424

#

1425

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

1426

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

1427

{

1428

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

},

],

},

],

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

1434

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

1435

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

1436

# where i ranges from 1 to num_finite_buckets inclusive.

1437

# Must be larger than 1.0.

1438

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

1439

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

1440

# where i ranges from 1 to num_finite_buckets inclusive.

1441

# Must be > 0.

1442

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

1443

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

1444

# See comments on `bucket_options` for details.

1445

},

1446

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

1447

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

Bu Sun Kim

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

[diff] [blame^]

1448

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

1449

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

1450

# See comments on `bucket_options` for details.

Bu Sun Kim

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

[diff] [blame]

1451

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

1452

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

1453

# where i ranges from 1 to num_finite_buckets, inclusive.

1454

# Must be strictly positive.

1455

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

1456

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

1457

# where i ranges from 1 to num_finite_buckets, inclusive.

Bu Sun Kim

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

[diff] [blame]

1458

},

1459

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

1460

# zero then this field must be zero.

1461

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

1462

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

1463

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

1464

#

1465

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

1466

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

1467

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

1468

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

1469

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

1470

# below for more details.

1471

#

1472

# Any suffix of trailing zeros may be omitted.

1473

"A String",

1474

],

Bu Sun Kim

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

[diff] [blame^]

1475

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

1476

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

1477

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

1478

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

1479

#

1480

# The i'th finite bucket covers the interval

1481

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

1482

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

1483

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

1484

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

1485

# underflow and overflow buckets.

1486

#

1487

# bucket number lower bound upper bound

1488

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

1489

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

1490

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

Bu Sun Kim

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

[diff] [blame]

1495

},

1496

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

Bu Sun Kim

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

[diff] [blame^]

1497

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

1498

# applies.

Bu Sun Kim

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

[diff] [blame]

1499

},

1500

],

Bu Sun Kim

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

[diff] [blame]

1501

},

1502

],

Bu Sun Kim

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

[diff] [blame^]

1503

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

1504

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

1505

# consumer project.

1506

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

1507

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

1508

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

1509

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

1510

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

1511

# gaps or overlaps between spans in a trace.

1512

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

1513

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

1514

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

1515

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

1516

# Stackdriver Trace is unable to take advantage of this helpful

1517

# information.

1518

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

1519

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

1520

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

1521

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

1522

#

1523

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

1524

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

1525

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

1526

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

1527

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

1528

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

1529

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

1530

# message types for APIs to use.

1531

{

1532

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

},

],

},

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

1537

#

1538

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

1539

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

1540

#

1541

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

1542

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

1543

"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

1544

# span.

1545

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

1546

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

1547

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

1548

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

1549

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

1550

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

1551

#

1552

# "/instance_id": "my-instance"

1553

# "/http/user_agent": ""

1554

# "/http/request_bytes": 300

1555

# "abc.com/myattribute": true

1556

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

1557

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

1558

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

1559

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

1560

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

1561

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

1562

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

1563

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

1564

#

1565

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

1566

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

1567

# shortened string might be less than the size limit.

1568

},

1569

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

},

},

},

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

1574

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

1575

# then this field must be empty.

1576

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

1577

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

1578

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

1579

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

1580

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

1581

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

1582

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

1583

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

1584

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

1585

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

1586

# Stackdriver Trace displays the description in the

1587

# Google Cloud Platform Console.

1588

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

1589

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

1590

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

1591

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

1592

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

1593

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

1594

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

1595

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

1596

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

1597

#

1598

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

1599

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

1600

# shortened string might be less than the size limit.

},

},

],

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

1605

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

1606

# check will be performed.

1607

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

1608

},

1609

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

1610

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

1611

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

1612

# not related to a specific consumer.

1613

#

1614

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

1615

# - project:PROJECT_ID,

1616

# - project`_`number:PROJECT_NUMBER,

1617

# - projects/PROJECT_ID or PROJECT_NUMBER,

1618

# - folders/FOLDER_NUMBER,

1619

# - organizations/ORGANIZATION_NUMBER,

1620

# - api`_`key:API_KEY.

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

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

1640

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

Sai Cheemalapati

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

[diff] [blame]

1641

#

1642

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

1643

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

1644

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

1645

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

1646

#

1647

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

1648

{ # Contains additional info about the report operation.

Bu Sun Kim

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

[diff] [blame]

1649

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

1650

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

1651

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

1652

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

1653

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

1654

# See: google.api.Quota

1655

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

1656

"A String",

1657

],

1658

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

1659

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

1660

# quota consumption.

1661

#

Bu Sun Kim

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

[diff] [blame]

1662

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

1663

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

Bu Sun Kim

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

[diff] [blame]

1664

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

1665

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

1666

"a_key": 42,

Dan O'Meara

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

[diff] [blame]

1667

},

Bu Sun Kim

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

[diff] [blame]

1668

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

1669

# more of the following metrics will be included:

1670

#

1671

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

1672

# will be specified using the following delta metric:

Bu Sun Kim

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

[diff] [blame]

1673

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

Sai Cheemalapati

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

[diff] [blame]

1674

#

1675

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

1676

# using the following gauge metric:

Bu Sun Kim

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

[diff] [blame]

1677

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

Sai Cheemalapati

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

[diff] [blame]

1678

#

1679

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

1680

# condition will be specified using the following boolean metric:

Bu Sun Kim

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

[diff] [blame]

1681

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

Sai Cheemalapati

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

[diff] [blame]

1682

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

1683

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

1684

# end time, and label values.

Bu Sun Kim

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

[diff] [blame^]

1685

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

Bu Sun Kim

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

[diff] [blame]

1686

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

Sai Cheemalapati

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

[diff] [blame]

1687

{ # Represents a single metric value.

Bu Sun Kim

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

[diff] [blame]

1688

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

1689

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

1690

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

1691

# documentation in the service configuration for details.

1692

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

Bu Sun Kim

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

[diff] [blame]

1693

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

Sai Cheemalapati

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

[diff] [blame]

1694

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

1695

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

1696

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

1697

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

1698

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

Bu Sun Kim

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

[diff] [blame^]

1699

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

1700

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

1701

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

Sai Cheemalapati

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

[diff] [blame]

1702

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1703

"labels": { # The labels describing the metric value.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1704

# See comments on google.api.servicecontrol.v1.Operation.labels for

1705

# the overriding relationship.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1706

# Note that this map must not contain monitored resource labels.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1707

"a_key": "A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1708

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1709

"stringValue": "A String", # A text string value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1710

"doubleValue": 3.14, # A double precision floating point value.

1711

"int64Value": "A String", # A signed 64-bit integer value.

1712

"distributionValue": { # Distribution represents a frequency distribution of double-valued sample # A distribution value.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1713

# points. It contains the size of the population of sample points plus

1714

# additional optional information:

1715

#

1716

# - the arithmetic mean of the samples

1717

# - the minimum and maximum of the samples

1718

# - the sum-squared-deviation of the samples, used to compute variance

1719

# - a histogram of the values of the sample points

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1720

"sumOfSquaredDeviation": 3.14, # The sum of squared deviations from the mean:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1721

# Sum[i=1..count]((x_i - mean)^2)

1722

# where each x_i is a sample values. If `count` is zero then this field

1723

# must be zero, otherwise validation of the request fails.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1724

"exemplars": [ # Example points. Must be in increasing order of `value` field.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1725

{ # Exemplars are example points that may be used to annotate aggregated

1726

# distribution values. They are metadata that gives information about a

1727

# particular value added to a Distribution bucket, such as a trace ID that

1728

# was active when a value was added. They may contain further information,

1729

# such as a example values and timestamps, origin, etc.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1730

"value": 3.14, # Value of the exemplar point. This value determines to which bucket the

1731

# exemplar belongs.

1732

"timestamp": "A String", # The observation (sampling) time of the above value.

1733

"attachments": [ # Contextual information about the example value. Examples are:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1734

#

1735

# Trace: type.googleapis.com/google.monitoring.v3.SpanContext

1736

#

1737

# Literal string: type.googleapis.com/google.protobuf.StringValue

1738

#

1739

# Labels dropped during aggregation:

1740

# type.googleapis.com/google.monitoring.v3.DroppedLabels

1741

#

1742

# There may be only a single attachment of any given message type in a

1743

# single exemplar, and this is enforced by the system.

1744

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1745

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1746

},

1747

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1748

},

1749

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1750

"exponentialBuckets": { # Describing buckets with exponentially growing width. # Buckets with exponentially growing width.

1751

"growthFactor": 3.14, # The i'th exponential bucket covers the interval

1752

# [scale * growth_factor^(i-1), scale * growth_factor^i)

1753

# where i ranges from 1 to num_finite_buckets inclusive.

1754

# Must be larger than 1.0.

1755

"scale": 3.14, # The i'th exponential bucket covers the interval

1756

# [scale * growth_factor^(i-1), scale * growth_factor^i)

1757

# where i ranges from 1 to num_finite_buckets inclusive.

1758

# Must be > 0.

1759

"numFiniteBuckets": 42, # The number of finite buckets. With the underflow and overflow buckets,

1760

# the total number of buckets is `num_finite_buckets` + 2.

1761

# See comments on `bucket_options` for details.

1762

},

1763

"minimum": 3.14, # The minimum of the population of values. Ignored if `count` is zero.

1764

"linearBuckets": { # Describing buckets with constant width. # Buckets with constant width.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1765

"numFiniteBuckets": 42, # The number of finite buckets. With the underflow and overflow buckets,

1766

# the total number of buckets is `num_finite_buckets` + 2.

1767

# See comments on `bucket_options` for details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1768

"width": 3.14, # The i'th linear bucket covers the interval

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1769

# [offset + (i-1) * width, offset + i * width)

1770

# where i ranges from 1 to num_finite_buckets, inclusive.

1771

# Must be strictly positive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1772

"offset": 3.14, # The i'th linear bucket covers the interval

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1773

# [offset + (i-1) * width, offset + i * width)

1774

# where i ranges from 1 to num_finite_buckets, inclusive.

1775

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1776

"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]

1777

# zero then this field must be zero.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1778

"count": "A String", # The total number of samples in the distribution. Must be >= 0.

1779

"bucketCounts": [ # The number of samples in each histogram bucket. `bucket_counts` are

1780

# optional. If present, they must sum to the `count` value.

1781

#

1782

# The buckets are defined below in `bucket_option`. There are N buckets.

1783

# `bucket_counts[0]` is the number of samples in the underflow bucket.

1784

# `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples

1785

# in each of the finite buckets. And `bucket_counts[N] is the number

1786

# of samples in the overflow bucket. See the comments of `bucket_option`

1787

# below for more details.

1788

#

1789

# Any suffix of trailing zeros may be omitted.

1790

"A String",

1791

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1792

"explicitBuckets": { # Describing buckets with arbitrary user-provided width. # Buckets with arbitrary user-provided width.

1793

"bounds": [ # 'bound' is a list of strictly increasing boundaries between

1794

# buckets. Note that a list of length N-1 defines N buckets because

1795

# of fenceposting. See comments on `bucket_options` for details.

1796

#

1797

# The i'th finite bucket covers the interval

1798

# [bound[i-1], bound[i])

1799

# where i ranges from 1 to bound_size() - 1. Note that there are no

1800

# finite buckets at all if 'bound' only contains a single element; in

1801

# that special case the single bound defines the boundary between the

1802

# underflow and overflow buckets.

1803

#

1804

# bucket number lower bound upper bound

1805

# i == 0 (underflow) -inf bound[i]

1806

# 0 < i < bound_size() bound[i-1] bound[i]

1807

# 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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1812

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1813

"boolValue": True or False, # A boolean value.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1814

"endTime": "A String", # The end of the time period over which this metric value's measurement

1815

# applies.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1816

},

1817

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1818

},

1819

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1820

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1821

},

1822

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1823

"serviceConfigId": "A String", # The actual config id used to process the request.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1824

"reportErrors": [ # Partial failures, one for each `Operation` in the request that failed

1825

# processing. There are three possible combinations of the RPC status:

1826

#

1827

# 1. The combination of a successful RPC status and an empty `report_errors`

1828

# list indicates a complete success where all `Operations` in the

1829

# request are processed successfully.

1830

# 2. The combination of a successful RPC status and a non-empty

1831

# `report_errors` list indicates a partial success where some

1832

# `Operations` in the request succeeded. Each

1833

# `Operation` that failed processing has a corresponding item

1834

# in this list.

1835

# 3. A failed RPC status indicates a general non-deterministic failure.

1836

# When this happens, it's impossible to know which of the

1837

# 'Operations' in the request succeeded or failed.

1838

{ # Represents the processing error of one Operation in the request.

1839

"operationId": "A String", # The Operation.operation_id value from the request.

1840

"status": { # The `Status` type defines a logical error model that is suitable for # Details of the error when processing the Operation.

1841

# different programming environments, including REST APIs and RPC APIs. It is

1842

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1843

# three pieces of data: error code, error message, and error details.

1844

#

1845

# You can find out more about this error model and how to work with it in the

1846

# [API Design Guide](https://cloud.google.com/apis/design/errors).

1847

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1848

"message": "A String", # A developer-facing error message, which should be in English. Any

1849

# user-facing error message should be localized and sent in the

1850

# google.rpc.Status.details field, or localized by the client.

1851

"details": [ # A list of messages that carry the error details. There is a common set of

1852

# message types for APIs to use.

1853

{

1854

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

},

],

Sai Cheemalapati