Google Cloud Config V1 Client - Class DeploymentUnitProgress (1.8.0)

Reference documentation and code samples for the Google Cloud Config V1 Client class DeploymentUnitProgress.

The progress of a deployment unit provisioning or deprovisioning.

Generated from protobuf message google.cloud.config.v1.DeploymentUnitProgress

Namespace

Google \ Cloud \ Config \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ unit_id string

Output only. The unit id of the deployment unit to be provisioned.

↳ deployment string

Output only. The name of the deployment to be provisioned. Format: 'projects/{project}/locations/{location}/deployments/{deployment}'.

↳ state int

Output only. The current step of the deployment unit provisioning.

↳ state_description string

Output only. Additional information regarding the current state.

↳ deployment_operation_summary DeploymentOperationSummary

Output only. The summary of the deployment operation.

↳ error Google\Rpc\Status

Output only. Holds the error status of the deployment unit provisioning.

↳ intent int

Output only. The intent of the deployment unit.

getUnitId

Output only. The unit id of the deployment unit to be provisioned.

Returns
Type Description
string

setUnitId

Output only. The unit id of the deployment unit to be provisioned.

Parameter
Name Description
var string
Returns
Type Description
$this

getDeployment

Output only. The name of the deployment to be provisioned.

Format: 'projects/{project}/locations/{location}/deployments/{deployment}'.

Returns
Type Description
string

setDeployment

Output only. The name of the deployment to be provisioned.

Format: 'projects/{project}/locations/{location}/deployments/{deployment}'.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. The current step of the deployment unit provisioning.

Returns
Type Description
int Enum of type State.

setState

Output only. The current step of the deployment unit provisioning.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this

getStateDescription

Output only. Additional information regarding the current state.

Returns
Type Description
string

setStateDescription

Output only. Additional information regarding the current state.

Parameter
Name Description
var string
Returns
Type Description
$this

getDeploymentOperationSummary

Output only. The summary of the deployment operation.

Returns
Type Description
DeploymentOperationSummary|null

hasDeploymentOperationSummary

clearDeploymentOperationSummary

setDeploymentOperationSummary

Output only. The summary of the deployment operation.

Parameter
Name Description
var DeploymentOperationSummary
Returns
Type Description
$this

getError

Output only. Holds the error status of the deployment unit provisioning.

Returns
Type Description
Google\Rpc\Status|null

hasError

clearError

setError

Output only. Holds the error status of the deployment unit provisioning.

Parameter
Name Description
var Google\Rpc\Status
Returns
Type Description
$this

getIntent

Output only. The intent of the deployment unit.

Returns
Type Description
int Enum of type Intent.

setIntent

Output only. The intent of the deployment unit.

Parameter
Name Description
var int

Enum of type Intent.

Returns
Type Description
$this