Google Cloud Storage Control V2 Client - Class CommonLongRunningOperationMetadata (1.0.1)

Reference documentation and code samples for the Google Cloud Storage Control V2 Client class CommonLongRunningOperationMetadata.

The message contains metadata that is common to all Storage Control long-running operations, present in its google.longrunning.Operation messages, and accessible via metadata.common_metadata.

Generated from protobuf message google.storage.control.v2.CommonLongRunningOperationMetadata

Namespace

Google \ Cloud \ Storage \ Control \ V2

Methods

__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.

↳ update_time Google\Protobuf\Timestamp

Output only. The time the operation was last modified.

↳ type string

Output only. The type of operation invoked.

↳ requested_cancellation bool

Output only. Identifies whether the user has requested cancellation.

↳ progress_percent int

Output only. The estimated progress of the operation in percentage [0, 100]. The value -1 means the progress is unknown.

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

getUpdateTime

Output only. The time the operation was last modified.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time the operation was last modified.

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

getType

Output only. The type of operation invoked.

Returns
Type Description
string

setType

Output only. The type of operation invoked.

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestedCancellation

Output only. Identifies whether the user has requested cancellation.

Returns
Type Description
bool

setRequestedCancellation

Output only. Identifies whether the user has requested cancellation.

Parameter
Name Description
var bool
Returns
Type Description
$this

getProgressPercent

Output only. The estimated progress of the operation in percentage [0, 100]. The value -1 means the progress is unknown.

Returns
Type Description
int

setProgressPercent

Output only. The estimated progress of the operation in percentage [0, 100]. The value -1 means the progress is unknown.

Parameter
Name Description
var int
Returns
Type Description
$this