Reference documentation and code samples for the Google Cloud Audit Manager V1 Client class OperationMetadata.
Metadata for the long-running operation.
Generated from protobuf message google.cloud.auditmanager.v1.OperationMetadata
Namespace
Google \ Cloud \ AuditManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time that the operation was created. |
↳ end_time |
Google\Protobuf\Timestamp
Output only. Time that the operation finished running. |
↳ target |
string
Output only. A server-defined resource path for the target of the operation. |
↳ verb |
string
Output only. The name of the verb that was executed by the operation. |
↳ status_message |
string
Output only. A human-readable status of the operation, if any. |
↳ requested_cancellation |
bool
Output only. Whether you requested that the operation be cancelled. Operations that were cancelled successfully have an Operation.error value with a status code Code.CANCELLED. |
↳ api_version |
string
Output only. The API version used to start the operation. For example, |
getCreateTime
Output only. Time that the operation was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time that the operation was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTime
Output only. Time that the operation finished running.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEndTime
clearEndTime
setEndTime
Output only. Time that the operation finished running.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTarget
Output only. A server-defined resource path for the target of the operation.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTarget
Output only. A server-defined resource path for the target of the operation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVerb
Output only. The name of the verb that was executed by the operation.
| Returns | |
|---|---|
| Type | Description |
string |
|
setVerb
Output only. The name of the verb that was executed by the operation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatusMessage
Output only. A human-readable status of the operation, if any.
| Returns | |
|---|---|
| Type | Description |
string |
|
setStatusMessage
Output only. A human-readable status of the operation, if any.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequestedCancellation
Output only. Whether you requested that the operation be cancelled.
Operations that were cancelled successfully have an Operation.error value with a status code Code.CANCELLED.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setRequestedCancellation
Output only. Whether you requested that the operation be cancelled.
Operations that were cancelled successfully have an Operation.error value with a status code Code.CANCELLED.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getApiVersion
Output only. The API version used to start the operation. For example,
v1.
| Returns | |
|---|---|
| Type | Description |
string |
|
setApiVersion
Output only. The API version used to start the operation. For example,
v1.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|