Google Cloud Service Control V1 Client - Class Operation (2.0.2)

Reference documentation and code samples for the Google Cloud Service Control V1 Client class Operation.

Represents information regarding an operation.

Generated from protobuf message google.api.servicecontrol.v1.Operation

Namespace

Google \ Cloud \ ServiceControl \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ operation_id 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 string

Fully qualified name of the operation. Reserved for future use.
↳ consumer_id 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.
↳ start_time Google\Protobuf\Timestamp

Required. Start time of the operation.
↳ end_time 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.
↳ labels array|Google\Protobuf\Internal\MapField

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.
↳ metric_value_sets array<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.
↳ log_entries array<LogEntry>

Represents information to be logged.
↳ importance int

DO NOT USE. This is an experimental field.
↳ extensions array<Google\Protobuf\Any>

Unimplemented.

getOperationId

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
Type Description
string

setOperationId

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getOperationName

Fully qualified name of the operation. Reserved for future use.

Returns
Type Description
string

setOperationName

Fully qualified name of the operation. Reserved for future use.

Parameter
Name Description
var string
Returns
Type Description
$this

getConsumerId

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
Type Description
string

setConsumerId

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.
Parameter
Name Description
var string
Returns
Type Description
$this

getStartTime

Required. Start time of the operation.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Required. Start time of the operation.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getEndTime

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
Type Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

End time of the operation.

Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLabels

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
Type Description
Google\Protobuf\Internal\MapField

setLabels

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.
Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getMetricValueSets

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
Type Description
Google\Protobuf\Internal\RepeatedField

setMetricValueSets

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.

Parameter
Name Description
var array<MetricValueSet>
Returns
Type Description
$this

getLogEntries

Represents information to be logged.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setLogEntries

Represents information to be logged.

Parameter
Name Description
var array<LogEntry>
Returns
Type Description
$this

getImportance

DO NOT USE. This is an experimental field.

Returns
Type Description
int

setImportance

DO NOT USE. This is an experimental field.

Parameter
Name Description
var int
Returns
Type Description
$this

getExtensions

Unimplemented.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setExtensions

Unimplemented.

Parameter
Name Description
var array<Google\Protobuf\Any>
Returns
Type Description
$this