Reference documentation and code samples for the Google Cloud Config V1 Client class OperationMetadata.
Represents the metadata of the long-running operation.
Generated from protobuf message google.cloud.config.v1.OperationMetadata
Namespace
Google \ Cloud \ Config \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ deployment_metadata |
DeploymentOperationMetadata
Output only. Metadata about the deployment operation state. |
↳ preview_metadata |
PreviewOperationMetadata
Output only. Metadata about the preview operation state. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time when the operation was created. |
↳ end_time |
Google\Protobuf\Timestamp
Output only. Time when 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 google.longrunning.Operation.error value with a google.rpc.Status.code of |
↳ api_version |
string
Output only. API version used to start the operation. |
getDeploymentMetadata
Output only. Metadata about the deployment operation state.
| Returns | |
|---|---|
| Type | Description |
DeploymentOperationMetadata|null |
|
hasDeploymentMetadata
setDeploymentMetadata
Output only. Metadata about the deployment operation state.
| Parameter | |
|---|---|
| Name | Description |
var |
DeploymentOperationMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPreviewMetadata
Output only. Metadata about the preview operation state.
| Returns | |
|---|---|
| Type | Description |
PreviewOperationMetadata|null |
|
hasPreviewMetadata
setPreviewMetadata
Output only. Metadata about the preview operation state.
| Parameter | |
|---|---|
| Name | Description |
var |
PreviewOperationMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Time when the operation was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when the operation was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTime
Output only. Time when the operation finished running.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEndTime
clearEndTime
setEndTime
Output only. Time when 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
google.longrunning.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
google.longrunning.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 |
|
getResourceMetadata
| Returns | |
|---|---|
| Type | Description |
string |
|