As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Servicecontrol v1 API¶

class google.cloud.servicecontrol_v1.types.AllocateQuotaRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for the AllocateQuota method.

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

allocate_operation¶

Operation that describes the quota allocation.

Type: google.cloud.servicecontrol_v1.types.QuotaOperation

service_config_id¶

Specifies which version of service configuration should be used to process the request. If unspecified or no matching version can be found, the latest one will be used.

Type: str

class google.cloud.servicecontrol_v1.types.AllocateQuotaResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for the AllocateQuota method.

operation_id¶

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

Type: str

allocate_errors¶

Indicates the decision of the allocate.

Type: MutableSequence[google.cloud.servicecontrol_v1.types.QuotaError]

quota_metrics¶

Quota metrics to indicate the result of allocation. Depending on the request, one or more of the following metrics will be included:

Per quota group or per quota metric incremental usage will be specified using the following delta metric : “serviceruntime.googleapis.com/api/consumer/quota_used_count”
The quota limit reached condition will be specified using the following boolean metric : “serviceruntime.googleapis.com/quota/exceeded”.

Type: MutableSequence[google.cloud.servicecontrol_v1.types.MetricValueSet]

service_config_id¶

ID of the actual config used to process the request.

Type: str

class google.cloud.servicecontrol_v1.types.CheckError(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

code¶

The error code.

Type: google.cloud.servicecontrol_v1.types.CheckError.Code

subject¶

Subject to whom this error applies. See the specific code enum for more details on this field. For example:

“project:<project-id or project-number>”
“folder:<folder-id>”
“organization:<organization-id>”.

Type: str

detail¶

Free-form text providing details on the error cause of the error.

Type: str

status¶

Contains public information about the check error. If available, status.code will be non zero and client can propagate it out as public error.

Type: google.rpc.status_pb2.Status

class Code(value)[source]¶

Bases: proto.enums.Enum

Error codes for Check responses.

Values:

ERROR_CODE_UNSPECIFIED (0):: This is never used in CheckResponse.
NOT_FOUND (5):: The consumer’s project id, network container, or resource container was not found. Same as [google.rpc.Code.NOT_FOUND][google.rpc.Code.NOT_FOUND].
PERMISSION_DENIED (7):: The consumer doesn’t have access to the specified resource. Same as [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED].
RESOURCE_EXHAUSTED (8):: Quota check failed. Same as [google.rpc.Code.RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED].
SERVICE_NOT_ACTIVATED (104):: The consumer hasn’t activated the service.
BILLING_DISABLED (107):: The consumer cannot access the service because billing is disabled.
PROJECT_DELETED (108):: The consumer’s project has been marked as deleted (soft deletion).
PROJECT_INVALID (114):: The consumer’s project number or id does not represent a valid project.
CONSUMER_INVALID (125):: The input consumer info does not represent a valid consumer folder or organization.
IP_ADDRESS_BLOCKED (109):: The IP address of the consumer is invalid for the specific consumer project.
REFERER_BLOCKED (110):: The referer address of the consumer request is invalid for the specific consumer project.
CLIENT_APP_BLOCKED (111):: The client application of the consumer request is invalid for the specific consumer project.
API_TARGET_BLOCKED (122):: The API targeted by this request is invalid for the specified consumer project.
API_KEY_INVALID (105):: The consumer’s API key is invalid.
API_KEY_EXPIRED (112):: The consumer’s API Key has expired.
API_KEY_NOT_FOUND (113):: The consumer’s API Key was not found in config record.
INVALID_CREDENTIAL (123):: The credential in the request can not be verified.
NAMESPACE_LOOKUP_UNAVAILABLE (300):: The backend server for looking up project id/number is unavailable.
SERVICE_STATUS_UNAVAILABLE (301):: The backend server for checking service status is unavailable.
BILLING_STATUS_UNAVAILABLE (302):: The backend server for checking billing status is unavailable.
CLOUD_RESOURCE_MANAGER_BACKEND_UNAVAILABLE (305):: Cloud Resource Manager backend server is unavailable.

class google.cloud.servicecontrol_v1.types.CheckRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for the Check method.

service_name¶

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

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

Type: str

operation¶

The operation to be checked.

Type: google.cloud.servicecontrol_v1.types.Operation

service_config_id¶

Specifies which version of service configuration should be used to process the request.

If unspecified or no matching version can be found, the latest one will be used.

Type: str

class google.cloud.servicecontrol_v1.types.CheckResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for the Check method.

operation_id¶

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

Type: str

check_errors¶

Indicate the decision of the check.

If no check errors are present, the service should process the operation. Otherwise the service should use the list of errors to determine the appropriate action.

Type: MutableSequence[google.cloud.servicecontrol_v1.types.CheckError]

service_config_id¶

The actual config id used to process the request.

Type: str

service_rollout_id¶

The current service rollout id used to process the request.

Type: str

check_info¶

Feedback data returned from the server during processing a Check request.

Type: google.cloud.servicecontrol_v1.types.CheckResponse.CheckInfo

class CheckInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Contains additional information about the check operation.

unused_arguments¶

A list of fields and label keys that are ignored by the server. The client doesn’t need to send them for following requests to improve performance and allow better aggregation.

Type: MutableSequence[str]

consumer_info¶

Consumer info of this check.

Type: google.cloud.servicecontrol_v1.types.CheckResponse.ConsumerInfo

api_key_uid¶

The unique id of the api key in the format of “apikey:<UID>”. This field will be populated when the consumer passed to Service Control is an API key and all the API key related validations are successful.

Type: str

class ConsumerInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

ConsumerInfo provides information about the consumer.

project_number¶

The Google cloud project number, e.g. 1234567890. A value of 0 indicates no project number is found.

NOTE: This field is deprecated after we support flexible consumer id. New code should not depend on this field anymore.

Type: int

type_¶

The type of the consumer which should have been defined in Google Resource Manager.

Type: google.cloud.servicecontrol_v1.types.CheckResponse.ConsumerInfo.ConsumerType

consumer_number¶

The consumer identity number, can be Google cloud project number, folder number or organization number e.g. 1234567890. A value of 0 indicates no consumer number is found.

Type: int

class ConsumerType(value)[source]¶

Bases: proto.enums.Enum

The type of the consumer as defined in Google Resource Manager.

Values:

CONSUMER_TYPE_UNSPECIFIED (0):: This is never used.
PROJECT (1):: The consumer is a Google Cloud Project.
FOLDER (2):: The consumer is a Google Cloud Folder.
ORGANIZATION (3):: The consumer is a Google Cloud Organization.
SERVICE_SPECIFIC (4):: Service-specific resource container which is defined by the service producer to offer their users the ability to manage service control functionalities at a finer level of granularity than the PROJECT.

class google.cloud.servicecontrol_v1.types.Distribution(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Distribution represents a frequency distribution of double-valued 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

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

count¶

The total number of samples in the distribution. Must be >= 0.

Type: int

mean¶

The arithmetic mean of the samples in the distribution. If count is zero then this field must be zero.

Type: float

minimum¶

The minimum of the population of values. Ignored if count is zero.

Type: float

maximum¶

The maximum of the population of values. Ignored if count is zero.

Type: float

sum_of_squared_deviation¶

The sum of squared deviations from the mean: Sum[i=1..count]((x_i - mean)^2) where each x_i is a sample values. If count is zero then this field must be zero, otherwise validation of the request fails.

Type: float

bucket_counts¶

The number of samples in each histogram bucket. bucket_counts are optional. If present, they must sum to the count value.

The buckets are defined below in bucket_option. There are N buckets. bucket_counts[0] is the number of samples in the underflow bucket. bucket_counts[1] to bucket_counts[N-1] are the numbers of samples in each of the finite buckets. And bucket_counts[N] is the number of samples in the overflow bucket. See the comments ofbucket_option` below for more details.

Any suffix of trailing zeros may be omitted.

Type: MutableSequence[int]

linear_buckets¶

Buckets with constant width.

This field is a member of oneof bucket_option.

Type: google.cloud.servicecontrol_v1.types.Distribution.LinearBuckets

exponential_buckets¶

Buckets with exponentially growing width.

This field is a member of oneof bucket_option.

Type: google.cloud.servicecontrol_v1.types.Distribution.ExponentialBuckets

explicit_buckets¶

Buckets with arbitrary user-provided width.

This field is a member of oneof bucket_option.

Type: google.cloud.servicecontrol_v1.types.Distribution.ExplicitBuckets

exemplars¶

Example points. Must be in increasing order of value field.

Type: MutableSequence[google.api.distribution_pb2.Exemplar]

class ExplicitBuckets(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Describing buckets with arbitrary user-provided width.

bounds¶

‘bound’ is a list of strictly increasing boundaries between buckets. Note that a list of length N-1 defines N buckets because of fenceposting. See comments on bucket_options for details.

The i’th finite bucket covers the interval [bound[i-1], bound[i]) where i ranges from 1 to bound_size() - 1. Note that there are no finite buckets at all if ‘bound’ only contains a single element; in that special case the single bound defines the boundary between the underflow and overflow buckets.

bucket number lower bound upper bound i == 0 (underflow) -inf bound[i] 0 < i < bound_size() bound[i-1] bound[i] i == bound_size() (overflow) bound[i-1] +inf

Type: MutableSequence[float]

class ExponentialBuckets(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Describing buckets with exponentially growing width.

num_finite_buckets¶

The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is num_finite_buckets + 2. See comments on bucket_options for details.

Type: int

growth_factor¶

The i’th exponential bucket covers the interval [scale * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be larger than 1.0.

Type: float

scale¶

The i’th exponential bucket covers the interval [scale * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be > 0.

Type: float

class LinearBuckets(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Describing buckets with constant width.

num_finite_buckets¶

The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is num_finite_buckets + 2. See comments on bucket_options for details.

Type: int

width¶

The i’th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to num_finite_buckets, inclusive. Must be strictly positive.

Type: float

offset¶

The i’th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to num_finite_buckets, inclusive.

Type: float

class google.cloud.servicecontrol_v1.types.HttpRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

request_method¶

The request method. Examples: "GET", "HEAD", "PUT", "POST".

Type: str

request_url¶

The scheme (http, https), the host name, the path, and the query portion of the URL that was requested. Example: "http://example.com/some/info?color=red".

Type: str

request_size¶

The size of the HTTP request message in bytes, including the request headers and the request body.

Type: int

status¶

The response code indicating the status of the response. Examples: 200, 404.

Type: int

response_size¶

The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.

Type: int

user_agent¶

The user agent sent by the client. Example: "Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)".

Type: str

remote_ip¶

The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: "192.168.1.1", "FE80::0202:B3FF:FE1E:8329".

Type: str

server_ip¶

The IP address (IPv4 or IPv6) of the origin server that the request was sent to.

Type: str

referer¶

The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions.

Type: str

latency¶

The request processing latency on the server, from the time the request was received until the response was sent.

Type: google.protobuf.duration_pb2.Duration

cache_lookup¶

Whether or not a cache lookup was attempted.

Type: bool

cache_hit¶

Whether or not an entity was served from cache (with or without validation).

Type: bool

cache_validated_with_origin_server¶

Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.

Type: bool

cache_fill_bytes¶

The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.

Type: int

protocol¶

Protocol used for the request. Examples: “HTTP/1.1”, “HTTP/2”, “websocket”.

Type: str

class google.cloud.servicecontrol_v1.types.LogEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

An individual log entry.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

name¶

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

Type: str

timestamp¶

The time the event described by the log entry occurred. If omitted, defaults to operation start time.

Type: google.protobuf.timestamp_pb2.Timestamp

severity¶

The severity of the log entry. The default value is LogSeverity.DEFAULT.

Type: google.logging.type.log_severity_pb2.LogSeverity

http_request¶

Optional. Information about the HTTP request associated with this log entry, if applicable.

Type: google.cloud.servicecontrol_v1.types.HttpRequest

trace¶

Optional. Resource name of the trace associated with the log entry, if any. If this field contains a relative resource name, you can assume the name is relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824

Type: str

insert_id¶

A unique ID for the log entry used for deduplication. If omitted, the implementation will generate one based on operation_id.

Type: str

labels¶

A set of user-defined (key, value) data that provides additional information about the log entry.

Type: MutableMapping[str, str]

proto_payload¶

The log entry payload, represented as a protocol buffer that is expressed as a JSON object. The only accepted type currently is [AuditLog][google.cloud.audit.AuditLog].

This field is a member of oneof payload.

Type: google.protobuf.any_pb2.Any

text_payload¶

The log entry payload, represented as a Unicode string (UTF-8).

This field is a member of oneof payload.

Type: str

struct_payload¶

The log entry payload, represented as a structure that is expressed as a JSON object.

This field is a member of oneof payload.

Type: google.protobuf.struct_pb2.Struct

operation¶

Optional. Information about an operation associated with the log entry, if applicable.

Type: google.cloud.servicecontrol_v1.types.LogEntryOperation

source_location¶

Optional. Source code location information associated with the log entry, if any.

Type: google.cloud.servicecontrol_v1.types.LogEntrySourceLocation

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.servicecontrol_v1.types.LogEntryOperation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

id¶

Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.

Type: str

producer¶

Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: "MyDivision.MyBigCompany.com", "github.com/MyProject/MyApplication".

Type: str

first¶

Optional. Set this to True if this is the first log entry in the operation.

Type: bool

last¶

Optional. Set this to True if this is the last log entry in the operation.

Type: bool

class google.cloud.servicecontrol_v1.types.LogEntrySourceLocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

file¶

Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.

Type: str

line¶

Optional. Line within the source file. 1-based; 0 indicates no line number available.

Type: int

function¶

Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).

Type: str

class google.cloud.servicecontrol_v1.types.MetricValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Represents a single metric value.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

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: MutableMapping[str, str]

start_time¶

The start of the time period over which this metric value’s measurement applies. The time period has different semantics for different metric types (cumulative, delta, and gauge). See the metric definition documentation in the service configuration for details. If not specified, [google.api.servicecontrol.v1.Operation.start_time][google.api.servicecontrol.v1.Operation.start_time] will be used.

Type: google.protobuf.timestamp_pb2.Timestamp

end_time¶

The end of the time period over which this metric value’s measurement applies. If not specified, [google.api.servicecontrol.v1.Operation.end_time][google.api.servicecontrol.v1.Operation.end_time] will be used.

Type: google.protobuf.timestamp_pb2.Timestamp

bool_value¶

A boolean value.