# Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::Rollout (v3.7.0)

3.7.0 (latest) 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.22.0 2.21.1 2.20.0 2.19.1 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.2 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.10.0 1.9.0 1.8.0 1.7.1 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.5.0 Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::Rollout.

Rollout resource.


<br />

A Rollout is a specific instance of a RolloutPlan. It represents a single
execution of a strategy to roll out a specific resource. It also provides
APIs to interact with the rollout.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #cancellation_time

    def cancellation_time() -> ::String

**Returns**

- (::String) --- Output only. The timestamp at which the Rollout was cancelled.

### #cancellation_time=

    def cancellation_time=(value) -> ::String

**Parameter**

- **value** (::String) --- Output only. The timestamp at which the Rollout was cancelled.
**Returns**

- (::String) --- Output only. The timestamp at which the Rollout was cancelled.

### #completion_time

    def completion_time() -> ::String

**Returns**

- (::String) --- Output only. The timestamp at which the Rollout was completed.

### #completion_time=

    def completion_time=(value) -> ::String

**Parameter**

- **value** (::String) --- Output only. The timestamp at which the Rollout was completed.
**Returns**

- (::String) --- Output only. The timestamp at which the Rollout was completed.

### #creation_timestamp

    def creation_timestamp() -> ::String

**Returns**

- (::String) --- Output only. \[Output Only\] Creation timestamp inRFC3339 text format.

### #creation_timestamp=

    def creation_timestamp=(value) -> ::String

**Parameter**

- **value** (::String) --- Output only. \[Output Only\] Creation timestamp inRFC3339 text format.
**Returns**

- (::String) --- Output only. \[Output Only\] Creation timestamp inRFC3339 text format.

### #current_wave_number

    def current_wave_number() -> ::Integer

**Returns**

- (::Integer) --- Output only. The number of the currently running wave. Ex. 1

### #current_wave_number=

    def current_wave_number=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Output only. The number of the currently running wave. Ex. 1
**Returns**

- (::Integer) --- Output only. The number of the currently running wave. Ex. 1

### #description

    def description() -> ::String

**Returns**

- (::String) --- An optional description of this resource. Provide this property when you create the resource.

### #description=

    def description=(value) -> ::String

**Parameter**

- **value** (::String) --- An optional description of this resource. Provide this property when you create the resource.
**Returns**

- (::String) --- An optional description of this resource. Provide this property when you create the resource.

### #etag

    def etag() -> ::String

**Returns**

- (::String) --- Output only. etag of the Rollout Ex. abc1234

### #etag=

    def etag=(value) -> ::String

**Parameter**

- **value** (::String) --- Output only. etag of the Rollout Ex. abc1234
**Returns**

- (::String) --- Output only. etag of the Rollout Ex. abc1234

### #id

    def id() -> ::Integer

**Returns**

- (::Integer) --- Output only. \[Output Only\] The unique identifier for the resource. This identifier is defined by the server.

### #id=

    def id=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Output only. \[Output Only\] The unique identifier for the resource. This identifier is defined by the server.
**Returns**

- (::Integer) --- Output only. \[Output Only\] The unique identifier for the resource. This identifier is defined by the server.

### #kind

    def kind() -> ::String

**Returns**

- (::String) --- Output only. \[Output Only\] Type of the resource. Always compute#rollout for rollouts.

### #kind=

    def kind=(value) -> ::String

**Parameter**

- **value** (::String) --- Output only. \[Output Only\] Type of the resource. Always compute#rollout for rollouts.
**Returns**

- (::String) --- Output only. \[Output Only\] Type of the resource. Always compute#rollout for rollouts.

### #name

    def name() -> ::String

**Returns**

- (::String) --- Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
**Returns**

- (::String) --- Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

### #rollout_entity

    def rollout_entity() -> ::Google::Cloud::Compute::V1::RolloutRolloutEntity

**Returns**

- ([::Google::Cloud::Compute::V1::RolloutRolloutEntity](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-RolloutRolloutEntity)) --- Required. The resource being rolled out.

### #rollout_entity=

    def rollout_entity=(value) -> ::Google::Cloud::Compute::V1::RolloutRolloutEntity

**Parameter**

- **value** ([::Google::Cloud::Compute::V1::RolloutRolloutEntity](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-RolloutRolloutEntity)) --- Required. The resource being rolled out.
**Returns**

- ([::Google::Cloud::Compute::V1::RolloutRolloutEntity](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-RolloutRolloutEntity)) --- Required. The resource being rolled out.

### #rollout_plan

    def rollout_plan() -> ::String

**Returns**

- (::String) --- Required. Rollout Plan used to model the Rollout. Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1

### #rollout_plan=

    def rollout_plan=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. Rollout Plan used to model the Rollout. Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1
**Returns**

- (::String) --- Required. Rollout Plan used to model the Rollout. Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1

### #self_link

    def self_link() -> ::String

**Returns**

- (::String) --- Output only. \[Output Only\] Server-defined fully-qualified URL for this resource.

### #self_link=

    def self_link=(value) -> ::String

**Parameter**

- **value** (::String) --- Output only. \[Output Only\] Server-defined fully-qualified URL for this resource.
**Returns**

- (::String) --- Output only. \[Output Only\] Server-defined fully-qualified URL for this resource.

### #self_link_with_id

    def self_link_with_id() -> ::String

**Returns**

- (::String) --- Output only. \[Output Only\] Server-defined URL for this resource's resource id.

### #self_link_with_id=

    def self_link_with_id=(value) -> ::String

**Parameter**

- **value** (::String) --- Output only. \[Output Only\] Server-defined URL for this resource's resource id.
**Returns**

- (::String) --- Output only. \[Output Only\] Server-defined URL for this resource's resource id.

### #state

    def state() -> ::String

**Returns**

- (::String) --- Output only. The current state of the Rollout. Check the State enum for the list of possible values.

### #state=

    def state=(value) -> ::String

**Parameter**

- **value** (::String) --- Output only. The current state of the Rollout. Check the State enum for the list of possible values.
**Returns**

- (::String) --- Output only. The current state of the Rollout. Check the State enum for the list of possible values.

### #wave_details

    def wave_details() -> ::Array<::Google::Cloud::Compute::V1::RolloutWaveDetails>

**Returns**

- (::Array\<[::Google::Cloud::Compute::V1::RolloutWaveDetails](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-RolloutWaveDetails)\>) --- Output only. Details about each wave of the rollout.

### #wave_details=

    def wave_details=(value) -> ::Array<::Google::Cloud::Compute::V1::RolloutWaveDetails>

**Parameter**

- **value** (::Array\<[::Google::Cloud::Compute::V1::RolloutWaveDetails](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-RolloutWaveDetails)\>) --- Output only. Details about each wave of the rollout.
**Returns**

- (::Array\<[::Google::Cloud::Compute::V1::RolloutWaveDetails](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-RolloutWaveDetails)\>) --- Output only. Details about each wave of the rollout.