Reference documentation and code samples for the Google Cloud Deploy V1 API class Google::Cloud::Deploy::V1::Rollout.
A Rollout
resource in the Cloud Deploy API.
A Rollout
contains information around a specific deployment to a Target
.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#annotations
def annotations() -> ::Google::Protobuf::Map{::String => ::String}
- (::Google::Protobuf::Map{::String => ::String}) — User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
#annotations=
def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
- value (::Google::Protobuf::Map{::String => ::String}) — User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
- (::Google::Protobuf::Map{::String => ::String}) — User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
#approval_state
def approval_state() -> ::Google::Cloud::Deploy::V1::Rollout::ApprovalState
-
(::Google::Cloud::Deploy::V1::Rollout::ApprovalState) — Output only. Approval state of the
Rollout
.
#approve_time
def approve_time() -> ::Google::Protobuf::Timestamp
-
(::Google::Protobuf::Timestamp) — Output only. Time at which the
Rollout
was approved.
#controller_rollout
def controller_rollout() -> ::String
-
(::String) — Output only. Name of the
ControllerRollout
. Format isprojects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/[a-z][a-z0-9\-]{0,62}
.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
-
(::Google::Protobuf::Timestamp) — Output only. Time at which the
Rollout
was created.
#deploy_end_time
def deploy_end_time() -> ::Google::Protobuf::Timestamp
-
(::Google::Protobuf::Timestamp) — Output only. Time at which the
Rollout
finished deploying.
#deploy_failure_cause
def deploy_failure_cause() -> ::Google::Cloud::Deploy::V1::Rollout::FailureCause
- (::Google::Cloud::Deploy::V1::Rollout::FailureCause) — Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.
#deploy_start_time
def deploy_start_time() -> ::Google::Protobuf::Timestamp
-
(::Google::Protobuf::Timestamp) — Output only. Time at which the
Rollout
started deploying.
#deploying_build
def deploying_build() -> ::String
-
(::String) — Output only. The resource name of the Cloud Build
Build
object that is used to deploy the Rollout. Format isprojects/{project}/locations/{location}/builds/{build}
.
#description
def description() -> ::String
-
(::String) — Description of the
Rollout
for user purposes. Max length is 255 characters.
#description=
def description=(value) -> ::String
-
value (::String) — Description of the
Rollout
for user purposes. Max length is 255 characters.
-
(::String) — Description of the
Rollout
for user purposes. Max length is 255 characters.
#enqueue_time
def enqueue_time() -> ::Google::Protobuf::Timestamp
-
(::Google::Protobuf::Timestamp) — Output only. Time at which the
Rollout
was enqueued.
#etag
def etag() -> ::String
- (::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.
#etag=
def etag=(value) -> ::String
- value (::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.
- (::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.
#failure_reason
def failure_reason() -> ::String
- (::String) — Output only. Additional information about the rollout failure, if available.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::Map{::String => ::String}) — Labels are attributes that can be set and used by both the
user and by 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.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::String => ::String}) — Labels are attributes that can be set and used by both the
user and by 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.
-
(::Google::Protobuf::Map{::String => ::String}) — Labels are attributes that can be set and used by both the
user and by 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.
#metadata
def metadata() -> ::Google::Cloud::Deploy::V1::Metadata
- (::Google::Cloud::Deploy::V1::Metadata) — Output only. Metadata contains information about the rollout.
#name
def name() -> ::String
-
(::String) — Optional. Name of the
Rollout
. Format isprojects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/[a-z][a-z0-9\-]{0,62}
.
#name=
def name=(value) -> ::String
-
value (::String) — Optional. Name of the
Rollout
. Format isprojects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/[a-z][a-z0-9\-]{0,62}
.
-
(::String) — Optional. Name of the
Rollout
. Format isprojects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/[a-z][a-z0-9\-]{0,62}
.
#phases
def phases() -> ::Array<::Google::Cloud::Deploy::V1::Phase>
-
(::Array<::Google::Cloud::Deploy::V1::Phase>) — Output only. The phases that represent the workflows of this
Rollout
.
#rollback_of_rollout
def rollback_of_rollout() -> ::String
-
(::String) — Output only. Name of the
Rollout
that is rolled back by thisRollout
. Empty if thisRollout
wasn't created as a rollback.
#rolled_back_by_rollouts
def rolled_back_by_rollouts() -> ::Array<::String>
-
(::Array<::String>) — Output only. Names of
Rollouts
that rolled back thisRollout
.
#state
def state() -> ::Google::Cloud::Deploy::V1::Rollout::State
-
(::Google::Cloud::Deploy::V1::Rollout::State) — Output only. Current state of the
Rollout
.
#target_id
def target_id() -> ::String
-
(::String) — Required. The ID of Target to which this
Rollout
is deploying.
#target_id=
def target_id=(value) -> ::String
-
value (::String) — Required. The ID of Target to which this
Rollout
is deploying.
-
(::String) — Required. The ID of Target to which this
Rollout
is deploying.
#uid
def uid() -> ::String
-
(::String) — Output only. Unique identifier of the
Rollout
.