# App Lifecycle Manager V1BETA1 API - Class Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout (v0.7.0)

0.7.0 (latest) 0.6.0 0.5.2 0.4.0 0.3.0 0.2.1 0.1.0 Reference documentation and code samples for the App Lifecycle Manager V1BETA1 API class Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout.

Represents a single rollout execution and its results

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #annotations

    def annotations() -> ::Google::Protobuf::Map{::String => ::String}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::String}) --- Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

  More info: https://kubernetes.io/docs/user-guide/annotations

### #annotations=

    def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}

**Parameter**

- **value** (::Google::Protobuf::Map{::String =\> ::String}) --- Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.


  More info: https://kubernetes.io/docs/user-guide/annotations
**Returns**

- (::Google::Protobuf::Map{::String =\> ::String}) --- Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

  More info: https://kubernetes.io/docs/user-guide/annotations

### #control

    def control() -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutControl

**Returns**

- ([::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutControl](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-saas_platform-saas_service_mgmt-v1beta1/latest/Google-Cloud-SaasPlatform-SaasServiceMgmt-V1beta1-RolloutControl)) --- Optional. Requested change to the execution of this rollout. Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -\> SUCCEEDED or RUNNING -\> FAILED). Requests can only be made when the Rollout is in a non-terminal state.

### #control=

    def control=(value) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutControl

**Parameter**

- **value** ([::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutControl](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-saas_platform-saas_service_mgmt-v1beta1/latest/Google-Cloud-SaasPlatform-SaasServiceMgmt-V1beta1-RolloutControl)) --- Optional. Requested change to the execution of this rollout. Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -\> SUCCEEDED or RUNNING -\> FAILED). Requests can only be made when the Rollout is in a non-terminal state.
**Returns**

- ([::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutControl](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-saas_platform-saas_service_mgmt-v1beta1/latest/Google-Cloud-SaasPlatform-SaasServiceMgmt-V1beta1-RolloutControl)) --- Optional. Requested change to the execution of this rollout. Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -\> SUCCEEDED or RUNNING -\> FAILED). Requests can only be made when the Rollout is in a non-terminal state.

### #create_time

    def create_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-saas_platform-saas_service_mgmt-v1beta1/latest/Google-Protobuf-Timestamp)) --- Output only. The timestamp when the resource was created.

### #delete_time

    def delete_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-saas_platform-saas_service_mgmt-v1beta1/latest/Google-Protobuf-Timestamp)) --- Output only. The timestamp when the resource was marked for deletion (deletion is an asynchronous operation).

### #effective_unit_filter

    def effective_unit_filter() -> ::String

**Returns**

- (::String) --- Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here.

### #end_time

    def end_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-saas_platform-saas_service_mgmt-v1beta1/latest/Google-Protobuf-Timestamp)) --- Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final.

### #etag

    def etag() -> ::String

**Returns**

- (::String) --- Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.

### #labels

    def labels() -> ::Google::Protobuf::Map{::String => ::String}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::String}) --- Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

### #labels=

    def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

**Parameter**

- **value** (::Google::Protobuf::Map{::String =\> ::String}) --- Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
**Returns**

- (::Google::Protobuf::Map{::String =\> ::String}) --- Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

### #name

    def name() -> ::String

**Returns**

- (::String) --- Identifier. The resource name (full URI of the resource) following the standard naming scheme:

  "projects/{project}/locations/{location}/rollout/{rollout_id}"

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- Identifier. The resource name (full URI of the resource) following the standard naming scheme:


  "projects/{project}/locations/{location}/rollout/{rollout_id}"
**Returns**

- (::String) --- Identifier. The resource name (full URI of the resource) following the standard naming scheme:

  "projects/{project}/locations/{location}/rollout/{rollout_id}"

### #parent_rollout

    def parent_rollout() -> ::String

**Returns**

- (::String) --- Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme:

  "projects/{project}/locations/{location}/rollouts/{rollout_id}"

### #release

    def release() -> ::String

**Returns**

- (::String) --- Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified.

### #release=

    def release=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified.
**Returns**

- (::String) --- Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified.

### #rollout_kind

    def rollout_kind() -> ::String

**Returns**

- (::String) --- Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.

### #rollout_kind=

    def rollout_kind=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.
**Returns**

- (::String) --- Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.

### #rollout_orchestration_strategy

    def rollout_orchestration_strategy() -> ::String

**Returns**

- (::String) --- Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used.

  There are two supported values strategies which are used to control
  - "Google.Cloud.Simple.AllAtOnce"
  - "Google.Cloud.Simple.OneLocationAtATime"

  A rollout with one of these simple strategies will rollout across
  all locations defined in the targeted UnitKind's Saas Locations.

### #rollout_orchestration_strategy=

    def rollout_orchestration_strategy=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used.


  There are two supported values strategies which are used to control
  - "Google.Cloud.Simple.AllAtOnce"
  - "Google.Cloud.Simple.OneLocationAtATime"

  A rollout with one of these simple strategies will rollout across
  all locations defined in the targeted UnitKind's Saas Locations.
**Returns**

- (::String) --- Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used.

  There are two supported values strategies which are used to control
  - "Google.Cloud.Simple.AllAtOnce"
  - "Google.Cloud.Simple.OneLocationAtATime"

  A rollout with one of these simple strategies will rollout across
  all locations defined in the targeted UnitKind's Saas Locations.

### #root_rollout

    def root_rollout() -> ::String

**Returns**

- (::String) --- Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme:

  "projects/{project}/locations/{location}/rollouts/{rollout_id}"

### #start_time

    def start_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-saas_platform-saas_service_mgmt-v1beta1/latest/Google-Protobuf-Timestamp)) --- Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet.

### #state

    def state() -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout::RolloutState

**Returns**

- ([::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout::RolloutState](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-saas_platform-saas_service_mgmt-v1beta1/latest/Google-Cloud-SaasPlatform-SaasServiceMgmt-V1beta1-Rollout-RolloutState)) --- Output only. Current state of the rollout.

### #state_message

    def state_message() -> ::String

**Returns**

- (::String) --- Output only. Human readable message indicating details about the last state transition.

### #state_transition_time

    def state_transition_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-saas_platform-saas_service_mgmt-v1beta1/latest/Google-Protobuf-Timestamp)) --- Optional. Output only. The time when the rollout transitioned into its current state.

### #stats

    def stats() -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutStats

**Returns**

- ([::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutStats](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-saas_platform-saas_service_mgmt-v1beta1/latest/Google-Cloud-SaasPlatform-SaasServiceMgmt-V1beta1-RolloutStats)) --- Optional. Output only. Details about the progress of the rollout.

### #uid

    def uid() -> ::String

**Returns**

- (::String) --- Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.

### #unit_filter

    def unit_filter() -> ::String

**Returns**

- (::String) --- Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutKind will be used.

### #unit_filter=

    def unit_filter=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutKind will be used.
**Returns**

- (::String) --- Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutKind will be used.

### #update_time

    def update_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-saas_platform-saas_service_mgmt-v1beta1/latest/Google-Protobuf-Timestamp)) --- Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.