Service Control API V1 API - Class Google::Cloud::ServiceControl::V1::Operation (v1.1.0)

Reference documentation and code samples for the Service Control API V1 API class Google::Cloud::ServiceControl::V1::Operation.

Represents information regarding an operation.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#consumer_id

def consumer_id() -> ::String

Returns

(::String) —
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.

#consumer_id=

def consumer_id=(value) -> ::String

Parameter

value (::String) —
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.

Returns

(::String) —
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.

#end_time

def end_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.

#end_time=

def end_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.

Returns

(::Google::Protobuf::Timestamp) — End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.

#extensions

def extensions() -> ::Array<::Google::Protobuf::Any>

Returns

(::Array<::Google::Protobuf::Any>) — Unimplemented.

#extensions=

def extensions=(value) -> ::Array<::Google::Protobuf::Any>

Parameter

value (::Array<::Google::Protobuf::Any>) — Unimplemented.

Returns

(::Array<::Google::Protobuf::Any>) — Unimplemented.

#importance

def importance() -> ::Google::Cloud::ServiceControl::V1::Operation::Importance

Returns

(::Google::Cloud::ServiceControl::V1::Operation::Importance) — DO NOT USE. This is an experimental field.

#importance=

def importance=(value) -> ::Google::Cloud::ServiceControl::V1::Operation::Importance

Parameter

value (::Google::Cloud::ServiceControl::V1::Operation::Importance) — DO NOT USE. This is an experimental field.

Returns

(::Google::Cloud::ServiceControl::V1::Operation::Importance) — DO NOT USE. This is an experimental field.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) —
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:
  - cloud.googleapis.com/location describing the location where the operation happened,
  - servicecontrol.googleapis.com/user_agent describing the user agent of the API request,
  - servicecontrol.googleapis.com/service_agent describing the service used to handle the API request (e.g. ESP),
  - servicecontrol.googleapis.com/platform describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) —
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:
  - cloud.googleapis.com/location describing the location where the operation happened,
  - servicecontrol.googleapis.com/user_agent describing the user agent of the API request,
  - servicecontrol.googleapis.com/service_agent describing the service used to handle the API request (e.g. ESP),
  - servicecontrol.googleapis.com/platform describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.

Returns

(::Google::Protobuf::Map{::String => ::String}) —
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:
  - cloud.googleapis.com/location describing the location where the operation happened,
  - servicecontrol.googleapis.com/user_agent describing the user agent of the API request,
  - servicecontrol.googleapis.com/service_agent describing the service used to handle the API request (e.g. ESP),
  - servicecontrol.googleapis.com/platform describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.

#log_entries

def log_entries() -> ::Array<::Google::Cloud::ServiceControl::V1::LogEntry>

Returns

(::Array<::Google::Cloud::ServiceControl::V1::LogEntry>) — Represents information to be logged.

#log_entries=

def log_entries=(value) -> ::Array<::Google::Cloud::ServiceControl::V1::LogEntry>

Parameter

value (::Array<::Google::Cloud::ServiceControl::V1::LogEntry>) — Represents information to be logged.

Returns

(::Array<::Google::Cloud::ServiceControl::V1::LogEntry>) — Represents information to be logged.

#metric_value_sets

def metric_value_sets() -> ::Array<::Google::Cloud::ServiceControl::V1::MetricValueSet>

Returns

(::Array<::Google::Cloud::ServiceControl::V1::MetricValueSet>) — 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.

#metric_value_sets=

def metric_value_sets=(value) -> ::Array<::Google::Cloud::ServiceControl::V1::MetricValueSet>

Parameter

value (::Array<::Google::Cloud::ServiceControl::V1::MetricValueSet>) — 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.

Returns

(::Array<::Google::Cloud::ServiceControl::V1::MetricValueSet>) — 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.

#operation_id

def operation_id() -> ::String

Returns

(::String) — 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_id=

def operation_id=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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

def operation_name() -> ::String

Returns

(::String) — Fully qualified name of the operation. Reserved for future use.

#operation_name=

def operation_name=(value) -> ::String

Parameter

value (::String) — Fully qualified name of the operation. Reserved for future use.

Returns

(::String) — Fully qualified name of the operation. Reserved for future use.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Required. Start time of the operation.

#start_time=

def start_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — Required. Start time of the operation.

Returns

(::Google::Protobuf::Timestamp) — Required. Start time of the operation.