Reference documentation and code samples for the Google Cloud Game Servers V1 Client class OperationMetadata.
Represents the metadata of the long-running operation.
Generated from protobuf message google.cloud.gaming.v1.OperationMetadata
Namespace
Google \ Cloud \ Gaming \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time the operation was created. |
↳ end_time |
Google\Protobuf\Timestamp
Output only. The time the operation finished running. |
↳ target |
string
Output only. Server-defined resource path for the target of the operation. |
↳ verb |
string
Output only. Name of the verb executed by the operation. |
↳ status_message |
string
Output only. Human-readable status of the operation, if any. |
↳ requested_cancellation |
bool
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to |
↳ api_version |
string
Output only. API version used to start the operation. |
↳ unreachable |
array
Output only. List of Locations that could not be reached. |
↳ operation_status |
array|Google\Protobuf\Internal\MapField
Output only. Operation status for Game Services API operations. Operation status is in the form of key-value pairs where keys are resource IDs and the values show the status of the operation. In case of failures, the value includes an error code and error message. |
getCreateTime
Output only. The time the operation was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time the operation was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndTime
Output only. The time the operation finished running.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasEndTime
clearEndTime
setEndTime
Output only. The time the operation finished running.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTarget
Output only. Server-defined resource path for the target of the operation.
| Returns | |
|---|---|
| Type | Description |
string | |
setTarget
Output only. Server-defined resource path for the target of the operation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVerb
Output only. Name of the verb executed by the operation.
| Returns | |
|---|---|
| Type | Description |
string | |
setVerb
Output only. Name of the verb executed by the operation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatusMessage
Output only. Human-readable status of the operation, if any.
| Returns | |
|---|---|
| Type | Description |
string | |
setStatusMessage
Output only. Human-readable status of the operation, if any.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequestedCancellation
Output only. Identifies whether the user has requested cancellation
of the operation. Operations that have successfully been cancelled
have Operation.error value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED.
| Returns | |
|---|---|
| Type | Description |
bool | |
setRequestedCancellation
Output only. Identifies whether the user has requested cancellation
of the operation. Operations that have successfully been cancelled
have Operation.error value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getApiVersion
Output only. API version used to start the operation.
| Returns | |
|---|---|
| Type | Description |
string | |
setApiVersion
Output only. API version used to start the operation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUnreachable
Output only. List of Locations that could not be reached.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setUnreachable
Output only. List of Locations that could not be reached.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOperationStatus
Output only. Operation status for Game Services API operations. Operation status is in the form of key-value pairs where keys are resource IDs and the values show the status of the operation. In case of failures, the value includes an error code and error message.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setOperationStatus
Output only. Operation status for Game Services API operations. Operation status is in the form of key-value pairs where keys are resource IDs and the values show the status of the operation. In case of failures, the value includes an error code and error message.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |