Package types (1.0.3)

API documentation for servicecontrol_v1.types package.

Classes

AllocateQuotaRequest

Request message for the AllocateQuota method. .. attribute:: service_name

Name of the service as specified in the service configuration. For example, "pubsub.googleapis.com".

See google.api.Service][google.api.Service] for the definition of a service name.

:type: str

AllocateQuotaResponse

Response message for the AllocateQuota method. .. attribute:: operation_id

The same operation_id value used in the AllocateQuotaRequest. Used for logging and diagnostics purposes.

:type: str

CheckError

Defines the errors to be returned in google.api.servicecontrol.v1.CheckResponse.check_errors][google.api.servicecontrol.v1.CheckResponse.check_errors].

CheckRequest

Request message for the Check method. .. attribute:: service_name

The service name as specified in its service configuration. For example, "pubsub.googleapis.com".

See google.api.Service <https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service>__ for the definition of a service name.

:type: str

CheckResponse

Response message for the Check method. .. attribute:: operation_id

The same operation_id value used in the CheckRequest][google.api.servicecontrol.v1.CheckRequest]. Used for logging and diagnostics purposes.

:type: str

Distribution

Distribution represents a frequency distribution of double- alued sample points. It contains the size of the population of sample points plus additional optional information:

  • the arithmetic mean of the samples
  • the minimum and maximum of the samples
  • the sum-squared-deviation of the samples, used to compute variance
  • a histogram of the values of the sample points

HttpRequest

A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.

LogEntry

An individual log entry. .. attribute:: name

Required. The log to which this log entry belongs. Examples: "syslog", "book_log".

:type: str

LogEntryOperation

Additional information about a potentially long-running operation with which a log entry is associated.

LogEntrySourceLocation

Additional information about the source code location that produced the log entry.

MetricValue

Represents a single metric value. .. attribute:: labels

The labels describing the metric value. See comments on google.api.servicecontrol.v1.Operation.labels][google.api.servicecontrol.v1.Operation.labels] for the overriding relationship. Note that this map must not contain monitored resource labels.

:type: Sequence[google.cloud.servicecontrol_v1.types.MetricValue.LabelsEntry]

MetricValueSet

Represents a set of metric values in the same metric. Each metric value in the set should have a unique combination of start time, end time, and label values.

Operation

Represents information regarding an operation. .. attribute:: operation_id

Identity of the operation. This must be unique within the scope of the service that generated the operation. If the service calls Check() and Report() on the same operation, the two calls should carry the same id.

UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details.

:type: str

QuotaError

Represents error information for QuotaOperation][google.api.servicecontrol.v1.QuotaOperation].

QuotaOperation

Represents information regarding a quota operation. .. attribute:: operation_id

Identity of the operation. This is expected to be unique within the scope of the service that generated the operation, and guarantees idempotency in case of retries.

In order to ensure best performance and latency in the Quota backends, operation_ids are optimally associated with time, so that related operations can be accessed fast in storage. For this reason, the recommended token for services that intend to operate at a high QPS is Unix time in nanos + UUID

:type: str

ReportRequest

Request message for the Report method. .. attribute:: service_name

The service name as specified in its service configuration. For example, "pubsub.googleapis.com".

See google.api.Service <https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service>__ for the definition of a service name.

:type: str

ReportResponse

Response message for the Report method. .. attribute:: report_errors

Partial failures, one for each Operation in the request that failed processing. There are three possible combinations of the RPC status:

  1. The combination of a successful RPC status and an empty report_errors list indicates a complete success where all Operations in the request are processed successfully.
  2. The combination of a successful RPC status and a non-empty report_errors list indicates a partial success where some Operations in the request succeeded. Each Operation that failed processing has a corresponding item in this list.

  3. A failed RPC status indicates a general non-deterministic failure. When this happens, it's impossible to know which of the 'Operations' in the request succeeded or failed.

    :type: Sequence[google.cloud.servicecontrol_v1.types.ReportResponse.ReportError]