Google Cloud Dataplex V1 Client - Class OperationMetadata (0.1.6)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Google Cloud Dataplex V1 Client class OperationMetadata.
Represents the metadata of a long-running operation.
Generated from protobuf message google.cloud.dataplex.v1.OperationMetadata
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. |
↳ 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 |
↳ api_version |
string
Output only. API version used to start the operation. |
getCreateTime
Output only. The time the operation was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time the operation was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTime
Output only. The time the operation finished running.
Generated from protobuf field .google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEndTime
clearEndTime
setEndTime
Output only. The time the operation finished running.
Generated from protobuf field .google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTarget
Output only. Server-defined resource path for the target of the operation.
Generated from protobuf field string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string |
|
setTarget
Output only. Server-defined resource path for the target of the operation.
Generated from protobuf field string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVerb
Output only. Name of the verb executed by the operation.
Generated from protobuf field string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string |
|
setVerb
Output only. Name of the verb executed by the operation.
Generated from protobuf field string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatusMessage
Output only. Human-readable status of the operation, if any.
Generated from protobuf field string status_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string |
|
setStatusMessage
Output only. Human-readable status of the operation, if any.
Generated from protobuf field string status_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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 Operation.error value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED.
Generated from protobuf field bool requested_cancellation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field bool requested_cancellation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getApiVersion
Output only. API version used to start the operation.
Generated from protobuf field string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string |
|
setApiVersion
Output only. API version used to start the operation.
Generated from protobuf field string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|