Reference documentation and code samples for the Google Cloud Storage Batch Operations V1 Client class OperationMetadata.
Represents the metadata of the long-running operation.
Generated from protobuf message google.cloud.storagebatchoperations.v1.OperationMetadata
Namespace
Google \ Cloud \ StorageBatchOperations \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ operation |
string
Output only. The unique operation resource name. Format: projects/{project}/locations/global/operations/{operation}. |
↳ 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. |
↳ requested_cancellation |
bool
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.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. |
↳ job |
Job
Output only. The Job associated with the operation. |
getOperation
Output only. The unique operation resource name.
Format: projects/{project}/locations/global/operations/{operation}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOperation
Output only. The unique operation resource name.
Format: projects/{project}/locations/global/operations/{operation}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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 |
|
getRequestedCancellation
Output only. Identifies whether the user has requested cancellation
of the operation. Operations that have been cancelled successfully
have
google.longrunning.Operation.error
value with a google.rpc.Status.code of 1,
corresponding to
<xref uid="\Google\Rpc\Code::CANCELLED">Code.CANCELLED</xref>.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setRequestedCancellation
Output only. Identifies whether the user has requested cancellation
of the operation. Operations that have been cancelled successfully
have
google.longrunning.Operation.error
value with a google.rpc.Status.code of 1,
corresponding to
<xref uid="\Google\Rpc\Code::CANCELLED">Code.CANCELLED</xref>.
| 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 |
|
getJob
Output only. The Job associated with the operation.
| Returns | |
|---|---|
| Type | Description |
Job|null |
|
hasJob
clearJob
setJob
Output only. The Job associated with the operation.
| Parameter | |
|---|---|
| Name | Description |
var |
Job
|
| Returns | |
|---|---|
| Type | Description |
$this |
|