Class Operation (1.12.0)

Operation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents information regarding an operation.


operation_id str
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.
operation_name str
Fully qualified name of the operation. Reserved for future use.
consumer_id str
Identity of the consumer who is using the service. This field should be filled in for the operations initiated by a consumer, but not for service-initiated operations that are not related to a specific consumer. - This can be in one of the following formats: - project:PROJECT_ID, - project\ _\ number:PROJECT_NUMBER, - projects/PROJECT_ID or PROJECT_NUMBER, - folders/FOLDER_NUMBER, - organizations/ORGANIZATION_NUMBER, - api\ _\ key:API_KEY.
start_time google.protobuf.timestamp_pb2.Timestamp
Required. Start time of the operation.
end_time google.protobuf.timestamp_pb2.Timestamp
End time of the operation. Required when the operation is used in ServiceController.Report][google.api.servicecontrol.v1.ServiceController.Report], but optional when the operation is used in ServiceController.Check][google.api.servicecontrol.v1.ServiceController.Check].
labels MutableMapping[str, str]
Labels describing the operation. Only the following labels are allowed: - Labels describing monitored resources as defined in the service configuration. - Default labels of metric values. When specified, labels defined in the metric value override these default. - The following labels defined by Google Cloud Platform: - describing the location where the operation happened, - describing the user agent of the API request, - describing the service used to handle the API request (e.g. ESP), - describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.
metric_value_sets MutableSequence[]
Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition. Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.
log_entries MutableSequence[]
Represents information to be logged.
DO NOT USE. This is an experimental field.
extensions MutableSequence[google.protobuf.any_pb2.Any]




Defines the importance of the data contained in the operation.

Values: LOW (0): Allows data caching, batching, and aggregation. It provides higher performance with higher data loss risk. HIGH (1): Disables data aggregation to minimize data loss. It is for operations that contains significant monetary value or audit trail. This feature only applies to the client libraries.


LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.