Google Cloud Sql Admin V1 Client - Class DeploymentTask (1.13.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class DeploymentTask.

Represents a task executed as part of the deployment on a target instance.

Generated from protobuf message google.cloud.sql.v1.BlueGreenDeployment.SourceTargetPairedNode.DeploymentTask

Namespace

Google \ Cloud \ Sql \ V1 \ BlueGreenDeployment \ SourceTargetPairedNode

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ type int

Output only. The type of the task.

↳ state int

Output only. The current state of the task.

↳ start_time Google\Protobuf\Timestamp

Output only. Task start time.

↳ end_time Google\Protobuf\Timestamp

Output only. Task end time (if completed).

↳ error_message string

Output only. Optional error details if the task state is FAILED.

getType

Output only. The type of the task.

Returns
Type Description
int Enum of type Type.

setType

Output only. The type of the task.

Parameter
Name Description
var int

Enum of type Type.

Returns
Type Description
$this

getState

Output only. The current state of the task.

Returns
Type Description
int Enum of type State.

setState

Output only. The current state of the task.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this

getStartTime

Output only. Task start time.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Output only. Task start time.

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

getEndTime

Output only. Task end time (if completed).

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

Output only. Task end time (if completed).

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

getErrorMessage

Output only. Optional error details if the task state is FAILED.

Returns
Type Description
string

setErrorMessage

Output only. Optional error details if the task state is FAILED.

Parameter
Name Description
var string
Returns
Type Description
$this