Class: Google::Cloud::Deploy::V1::Rollout

Inherits:

Object

Object
Google::Cloud::Deploy::V1::Rollout

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/deploy/v1/cloud_deploy.rb

Overview

A Rollout resource in the Cloud Deploy API.

A Rollout contains information around a specific deployment to a Target.

Defined Under Namespace

Modules: ApprovalState, FailureCause, State Classes: AnnotationsEntry, LabelsEntry

Instance Attribute Summary collapse

#annotations ⇒ ::Google::Protobuf::Map{::String => ::String}
User annotations.
#approval_state ⇒ ::Google::Cloud::Deploy::V1::Rollout::ApprovalState readonly
Output only.
#approve_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#controller_rollout ⇒ ::String readonly
Output only.
#create_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#deploy_end_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#deploy_failure_cause ⇒ ::Google::Cloud::Deploy::V1::Rollout::FailureCause readonly
Output only.
#deploy_start_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#deploying_build ⇒ ::String readonly
Output only.
#description ⇒ ::String
Description of the Rollout for user purposes.
#enqueue_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#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.
#failure_reason ⇒ ::String readonly
Output only.
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Labels are attributes that can be set and used by both the user and by Cloud Deploy.
#metadata ⇒ ::Google::Cloud::Deploy::V1::Metadata readonly
Output only.
#name ⇒ ::String
Optional.
#phases ⇒ ::Array<::Google::Cloud::Deploy::V1::Phase> readonly
Output only.
#rollback_of_rollout ⇒ ::String readonly
Output only.
#rolled_back_by_rollouts ⇒ ::Array<::String> readonly
Output only.
#state ⇒ ::Google::Cloud::Deploy::V1::Rollout::State readonly
Output only.
#target_id ⇒ ::String
Required.
#uid ⇒ ::String readonly
Output only.

Instance Attribute Details

#annotations ⇒ `::Google::Protobuf::Map{::String => ::String}`

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

Returns:

(::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.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#approval_state ⇒ `::Google::Cloud::Deploy::V1::Rollout::ApprovalState` (readonly)

Returns Output only. Approval state of the Rollout.

Returns:

(::Google::Cloud::Deploy::V1::Rollout::ApprovalState) —
Output only. Approval state of the Rollout.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#approve_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

Returns Output only. Time at which the Rollout was approved.

Returns:

(::Google::Protobuf::Timestamp) —
Output only. Time at which the Rollout was approved.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#controller_rollout ⇒ `::String` (readonly)

Returns Output only. Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

Returns:

(::String) —
Output only. Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#create_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

Returns Output only. Time at which the Rollout was created.

Returns:

(::Google::Protobuf::Timestamp) —
Output only. Time at which the Rollout was created.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#deploy_end_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

Returns Output only. Time at which the Rollout finished deploying.

Returns:

(::Google::Protobuf::Timestamp) —
Output only. Time at which the Rollout finished deploying.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#deploy_failure_cause ⇒ `::Google::Cloud::Deploy::V1::Rollout::FailureCause` (readonly)

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

Returns:

(::Google::Cloud::Deploy::V1::Rollout::FailureCause) —
Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#deploy_start_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

Returns Output only. Time at which the Rollout started deploying.

Returns:

(::Google::Protobuf::Timestamp) —
Output only. Time at which the Rollout started deploying.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#deploying_build ⇒ `::String` (readonly)

Returns 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:

(::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}.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#description ⇒ `::String`

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

Returns:

(::String) —
Description of the Rollout for user purposes. Max length is 255 characters.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#enqueue_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

Returns Output only. Time at which the Rollout was enqueued.

Returns:

(::Google::Protobuf::Timestamp) —
Output only. Time at which the Rollout was enqueued.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#etag ⇒ `::String`

Returns 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:

(::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.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#failure_reason ⇒ `::String` (readonly)

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

Returns:

(::String) —
Output only. Additional information about the rollout failure, if available.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#labels ⇒ `::Google::Protobuf::Map{::String => ::String}`

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

Returns:

(::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.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#metadata ⇒ `::Google::Cloud::Deploy::V1::Metadata` (readonly)

Returns Output only. Metadata contains information about the rollout.

Returns:

(::Google::Cloud::Deploy::V1::Metadata) —
Output only. Metadata contains information about the rollout.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#name ⇒ `::String`

Returns Optional. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}. The rollout component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?.

Returns:

(::String) —
Optional. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}. The rollout component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#phases ⇒ `::Array<::Google::Cloud::Deploy::V1::Phase>` (readonly)

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

Returns:

(::Array<::Google::Cloud::Deploy::V1::Phase>) —
Output only. The phases that represent the workflows of this Rollout.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#rollback_of_rollout ⇒ `::String` (readonly)

Returns Output only. Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn't created as a rollback.

Returns:

(::String) —
Output only. Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn't created as a rollback.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#rolled_back_by_rollouts ⇒ `::Array<::String>` (readonly)

Returns Output only. Names of Rollouts that rolled back this Rollout.

Returns:

(::Array<::String>) —
Output only. Names of Rollouts that rolled back this Rollout.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#state ⇒ `::Google::Cloud::Deploy::V1::Rollout::State` (readonly)

Returns Output only. Current state of the Rollout.

Returns:

(::Google::Cloud::Deploy::V1::Rollout::State) —
Output only. Current state of the Rollout.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#target_id ⇒ `::String`

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

Returns:

(::String) —
Required. The ID of Target to which this Rollout is deploying.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

#uid ⇒ `::String` (readonly)

Returns Output only. Unique identifier of the Rollout.

Returns:

(::String) —
Output only. Unique identifier of the Rollout.

# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2542

class Rollout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Valid approval states of a `Rollout`.
  module ApprovalState
    # The `Rollout` has an unspecified approval state.
    APPROVAL_STATE_UNSPECIFIED = 0

    # The `Rollout` requires approval.
    NEEDS_APPROVAL = 1

    # The `Rollout` does not require approval.
    DOES_NOT_NEED_APPROVAL = 2

    # The `Rollout` has been approved.
    APPROVED = 3

    # The `Rollout` has been rejected.
    REJECTED = 4
  end

  # Valid states of a `Rollout`.
  module State
    # The `Rollout` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `Rollout` has completed successfully.
    SUCCEEDED = 1

    # The `Rollout` has failed.
    FAILED = 2

    # The `Rollout` is being deployed.
    IN_PROGRESS = 3

    # The `Rollout` needs approval.
    PENDING_APPROVAL = 4

    # An approver rejected the `Rollout`.
    APPROVAL_REJECTED = 5

    # The `Rollout` is waiting for an earlier Rollout(s) to complete on this
    # `Target`.
    PENDING = 6

    # The `Rollout` is waiting for the `Release` to be fully rendered.
    PENDING_RELEASE = 7

    # The `Rollout` is in the process of being cancelled.
    CANCELLING = 8

    # The `Rollout` has been cancelled.
    CANCELLED = 9

    # The `Rollout` is halted.
    HALTED = 10
  end

  # Well-known rollout failures.
  module FailureCause
    # No reason for failure is specified.
    FAILURE_CAUSE_UNSPECIFIED = 0

    # Cloud Build is not available, either because it is not enabled or because
    # Cloud Deploy has insufficient permissions. See [required
    # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
    CLOUD_BUILD_UNAVAILABLE = 1

    # The deploy operation did not complete successfully; check Cloud Build
    # logs.
    EXECUTION_FAILED = 2

    # Deployment did not complete within the alloted time.
    DEADLINE_EXCEEDED = 3

    # Release is in a failed state.
    RELEASE_FAILED = 4

    # Release is abandoned.
    RELEASE_ABANDONED = 5

    # No Skaffold verify configuration was found.
    VERIFICATION_CONFIG_NOT_FOUND = 6

    # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
    # for additional details.
    CLOUD_BUILD_REQUEST_FAILED = 7

    # A Rollout operation had a feature configured that is not supported.
    OPERATION_FEATURE_NOT_SUPPORTED = 8
  end
end

Class: Google::Cloud::Deploy::V1::Rollout

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#annotations ⇒ ::Google::Protobuf::Map{::String => ::String}

#approval_state ⇒ ::Google::Cloud::Deploy::V1::Rollout::ApprovalState (readonly)

#approve_time ⇒ ::Google::Protobuf::Timestamp (readonly)

#controller_rollout ⇒ ::String (readonly)

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

#deploy_end_time ⇒ ::Google::Protobuf::Timestamp (readonly)

#deploy_failure_cause ⇒ ::Google::Cloud::Deploy::V1::Rollout::FailureCause (readonly)

#deploy_start_time ⇒ ::Google::Protobuf::Timestamp (readonly)

#deploying_build ⇒ ::String (readonly)

#description ⇒ ::String

#enqueue_time ⇒ ::Google::Protobuf::Timestamp (readonly)

#etag ⇒ ::String

#failure_reason ⇒ ::String (readonly)

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

#metadata ⇒ ::Google::Cloud::Deploy::V1::Metadata (readonly)

#name ⇒ ::String

#phases ⇒ ::Array<::Google::Cloud::Deploy::V1::Phase> (readonly)

#rollback_of_rollout ⇒ ::String (readonly)

#rolled_back_by_rollouts ⇒ ::Array<::String> (readonly)

#state ⇒ ::Google::Cloud::Deploy::V1::Rollout::State (readonly)

#target_id ⇒ ::String

#uid ⇒ ::String (readonly)

#annotations ⇒ `::Google::Protobuf::Map{::String => ::String}`

#approval_state ⇒ `::Google::Cloud::Deploy::V1::Rollout::ApprovalState` (readonly)

#approve_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

#controller_rollout ⇒ `::String` (readonly)

#create_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

#deploy_end_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

#deploy_failure_cause ⇒ `::Google::Cloud::Deploy::V1::Rollout::FailureCause` (readonly)

#deploy_start_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

#deploying_build ⇒ `::String` (readonly)

#description ⇒ `::String`

#enqueue_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

#etag ⇒ `::String`

#failure_reason ⇒ `::String` (readonly)

#labels ⇒ `::Google::Protobuf::Map{::String => ::String}`

#metadata ⇒ `::Google::Cloud::Deploy::V1::Metadata` (readonly)

#name ⇒ `::String`

#phases ⇒ `::Array<::Google::Cloud::Deploy::V1::Phase>` (readonly)

#rollback_of_rollout ⇒ `::String` (readonly)

#rolled_back_by_rollouts ⇒ `::Array<::String>` (readonly)

#state ⇒ `::Google::Cloud::Deploy::V1::Rollout::State` (readonly)

#target_id ⇒ `::String`

#uid ⇒ `::String` (readonly)