Google Cloud Game Servers V1 Client - Class OperationMetadata (1.2.3)

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 \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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 Code.CANCELLED.

↳ 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
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time the operation was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEndTime

Output only. The time the operation finished running.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

Output only. The time the operation finished running.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getTarget

Output only. Server-defined resource path for the target of the operation.

Returns
TypeDescription
string

setTarget

Output only. Server-defined resource path for the target of the operation.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getVerb

Output only. Name of the verb executed by the operation.

Returns
TypeDescription
string

setVerb

Output only. Name of the verb executed by the operation.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStatusMessage

Output only. Human-readable status of the operation, if any.

Returns
TypeDescription
string

setStatusMessage

Output only. Human-readable status of the operation, if any.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$this

getApiVersion

Output only. API version used to start the operation.

Returns
TypeDescription
string

setApiVersion

Output only. API version used to start the operation.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUnreachable

Output only. List of Locations that could not be reached.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setUnreachable

Output only. List of Locations that could not be reached.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this