Console
    Contact Us Start free

    Google Cloud Deploy V1 Client - Class Rollout (0.8.0)

    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

    Namespace

    Google \ Cloud \ Deploy \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    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
    Google\Protobuf\Timestamp

    Output only. Time at which the Rollout was created.

    ↳ approve_time
    Google\Protobuf\Timestamp

    Output only. Time at which the Rollout was approved.

    ↳ enqueue_time
    Google\Protobuf\Timestamp

    Output only. Time at which the Rollout was enqueued.

    ↳ deploy_start_time
    Google\Protobuf\Timestamp

    Output only. Time at which the Rollout started deploying.

    ↳ deploy_end_time
    Google\Protobuf\Timestamp

    Output only. Time at which the Rollout finished deploying.

    ↳ 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
    Google\Cloud\Deploy\V1\Metadata

    Output only. Metadata contains information about the rollout.

    ↳ 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}.

    Returns
    Type
    Description
    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}.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getUid

    Output only. Unique identifier of the Rollout .

    Returns
    Type
    Description
    string

    setUid

    Output only. Unique identifier of the Rollout .

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    Description of the Rollout for user purposes. Max length is 255 characters.

    Returns
    Type
    Description
    string

    setDescription

    Description of the Rollout for user purposes. Max length is 255 characters.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $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.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    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.

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $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.
    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    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.
    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. Time at which the Rollout was created.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. Time at which the Rollout was created.

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

    getApproveTime

    Output only. Time at which the Rollout was approved.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasApproveTime

    clearApproveTime

    setApproveTime

    Output only. Time at which the Rollout was approved.

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

    getEnqueueTime

    Output only. Time at which the Rollout was enqueued.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasEnqueueTime

    clearEnqueueTime

    setEnqueueTime

    Output only. Time at which the Rollout was enqueued.

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

    getDeployStartTime

    Output only. Time at which the Rollout started deploying.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasDeployStartTime

    clearDeployStartTime

    setDeployStartTime

    Output only. Time at which the Rollout started deploying.

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

    getDeployEndTime

    Output only. Time at which the Rollout finished deploying.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasDeployEndTime

    clearDeployEndTime

    setDeployEndTime

    Output only. Time at which the Rollout finished deploying.

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

    getTargetId

    Required. The ID of Target to which this Rollout is deploying.

    Returns
    Type
    Description
    string

    setTargetId

    Required. The ID of Target to which this Rollout is deploying.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getApprovalState

    Output only. Approval state of the Rollout .

    Returns
    Type
    Description
    int

    setApprovalState

    Output only. Approval state of the Rollout .

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getState

    Output only. Current state of the Rollout .

    Returns
    Type
    Description
    int

    setState

    Output only. Current state of the Rollout .

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getFailureReason

    Output only. Additional information about the rollout failure, if available.

    Returns
    Type
    Description
    string

    setFailureReason

    Output only. Additional information about the rollout failure, if available.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $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} .

    Returns
    Type
    Description
    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} .

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $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.

    Returns
    Type
    Description
    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDeployFailureCause

    Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.

    Returns
    Type
    Description
    int

    setDeployFailureCause

    Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getPhases

    Output only. The phases that represent the workflows of this Rollout .

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setPhases

    Output only. The phases that represent the workflows of this Rollout .

    Parameter
    Name
    Description
    var
    array< Google\Cloud\Deploy\V1\Phase >
    Returns
    Type
    Description
    $this

    getMetadata

    Output only. Metadata contains information about the rollout.

    Returns
    Type
    Description
    Google\Cloud\Deploy\V1\Metadata |null

    hasMetadata

    clearMetadata

    setMetadata

    Output only. Metadata contains information about the rollout.

    Parameter
    Name
    Description
    var
    Google\Cloud\Deploy\V1\Metadata
    Returns
    Type
    Description
    $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}.

    Returns
    Type
    Description
    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}.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: