Reference documentation and code samples for the Google Cloud Deploy V1 Client class Rollout.
A Rollout
resource in the Google Cloud Deploy API.
A Rollout
contains information around a specific deployment to a Target
.
Generated from protobuf message google.cloud.deploy.v1.Rollout
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Optional. Name of the Rollout
. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/[a-z][a-z0-9-]{0,62}.
↳ uid
string
Output only. Unique identifier of the Rollout
.
↳ description
string
Description of the Rollout
for user purposes. Max length is 255 characters.
↳ annotations
array| Google\Protobuf\Internal\MapField
User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
↳ labels
array| Google\Protobuf\Internal\MapField
Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
↳ create_time
↳ approve_time
↳ enqueue_time
↳ deploy_start_time
↳ deploy_end_time
↳ target_id
string
Required. The ID of Target to which this Rollout
is deploying.
↳ approval_state
int
Output only. Approval state of the Rollout
.
↳ state
int
Output only. Current state of the Rollout
.
↳ failure_reason
string
Output only. Additional information about the rollout failure, if available.
↳ deploying_build
string
Output only. The resource name of the Cloud Build Build
object that is used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}
.
↳ etag
string
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
↳ deploy_failure_cause
int
Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.
↳ phases
array< Google\Cloud\Deploy\V1\Phase
>
Output only. The phases that represent the workflows of this Rollout
.
↳ metadata
↳ controller_rollout
string
Output only. Name of the ControllerRollout
. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/[a-z][a-z0-9-]{0,62}.
getName
Optional. Name of the Rollout
. Format is projects/{project}/
locations/{location}/deliveryPipelines/{deliveryPipeline}/
releases/{release}/rollouts/[a-z][a-z0-9-]{0,62}.
string
setName
Optional. Name of the Rollout
. Format is projects/{project}/
locations/{location}/deliveryPipelines/{deliveryPipeline}/
releases/{release}/rollouts/[a-z][a-z0-9-]{0,62}.
var
string
$this
getUid
Output only. Unique identifier of the Rollout
.
string
setUid
Output only. Unique identifier of the Rollout
.
var
string
$this
getDescription
Description of the Rollout
for user purposes. Max length is 255
characters.
string
setDescription
Description of the Rollout
for user purposes. Max length is 255
characters.
var
string
$this
getAnnotations
User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
setAnnotations
User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
$this
getLabels
Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints:
-
Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
-
All characters must use UTF-8 encoding, and international characters are allowed.
- Keys must start with a lowercase letter or international character.
- Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
setLabels
Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints:
-
Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
-
All characters must use UTF-8 encoding, and international characters are allowed.
- Keys must start with a lowercase letter or international character.
- Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
$this
getCreateTime
Output only. Time at which the Rollout
was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time at which the Rollout
was created.
$this
getApproveTime
Output only. Time at which the Rollout
was approved.
hasApproveTime
clearApproveTime
setApproveTime
Output only. Time at which the Rollout
was approved.
$this
getEnqueueTime
Output only. Time at which the Rollout
was enqueued.
hasEnqueueTime
clearEnqueueTime
setEnqueueTime
Output only. Time at which the Rollout
was enqueued.
$this
getDeployStartTime
Output only. Time at which the Rollout
started deploying.
hasDeployStartTime
clearDeployStartTime
setDeployStartTime
Output only. Time at which the Rollout
started deploying.
$this
getDeployEndTime
Output only. Time at which the Rollout
finished deploying.
hasDeployEndTime
clearDeployEndTime
setDeployEndTime
Output only. Time at which the Rollout
finished deploying.
$this
getTargetId
Required. The ID of Target to which this Rollout
is deploying.
string
setTargetId
Required. The ID of Target to which this Rollout
is deploying.
var
string
$this
getApprovalState
Output only. Approval state of the Rollout
.
int
setApprovalState
Output only. Approval state of the Rollout
.
var
int
$this
getState
Output only. Current state of the Rollout
.
int
setState
Output only. Current state of the Rollout
.
var
int
$this
getFailureReason
Output only. Additional information about the rollout failure, if available.
string
setFailureReason
Output only. Additional information about the rollout failure, if available.
var
string
$this
getDeployingBuild
Output only. The resource name of the Cloud Build Build
object that is
used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}
.
string
setDeployingBuild
Output only. The resource name of the Cloud Build Build
object that is
used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}
.
var
string
$this
getEtag
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
string
setEtag
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
var
string
$this
getDeployFailureCause
Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.
int
setDeployFailureCause
Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.
var
int
$this
getPhases
Output only. The phases that represent the workflows of this Rollout
.
setPhases
Output only. The phases that represent the workflows of this Rollout
.
$this
getMetadata
Output only. Metadata contains information about the rollout.
hasMetadata
clearMetadata
setMetadata
Output only. Metadata contains information about the rollout.
$this
getControllerRollout
Output only. Name of the ControllerRollout
. Format is projects/{project}/
locations/{location}/deliveryPipelines/{deliveryPipeline}/
releases/{release}/rollouts/[a-z][a-z0-9-]{0,62}.
string
setControllerRollout
Output only. Name of the ControllerRollout
. Format is projects/{project}/
locations/{location}/deliveryPipelines/{deliveryPipeline}/
releases/{release}/rollouts/[a-z][a-z0-9-]{0,62}.
var
string
$this
