Rollout (Compute Engine API beta-rev20260410-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.Rollout

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Rollout
extends com.google.api.client.json.GenericJson
```
Rollout resource. 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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Rollout()

Constructors
Constructor and Description
`Rollout()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Rollout`	`clone()`
`String`	`getCancellationTime()` Output only.
`String`	`getCompletionTime()` Output only.
`String`	`getCreationTimestamp()` Output only.
`Long`	`getCurrentWaveNumber()` Output only.
`String`	`getDescription()` An optional description of this resource.
`String`	`getEtag()` Output only.
`BigInteger`	`getId()` Output only.
`String`	`getKind()` Output only.
`String`	`getName()` Name of the resource.
`RolloutRolloutEntity`	`getRolloutEntity()` Required.
`String`	`getRolloutPlan()` Required.
`String`	`getSelfLink()` Output only.
`String`	`getSelfLinkWithId()` Output only.
`String`	`getState()` Output only.
`List<RolloutWaveDetails>`	`getWaveDetails()` Output only.
`Rollout`	`set(String fieldName, Object value)`
`Rollout`	`setCancellationTime(String cancellationTime)` Output only.
`Rollout`	`setCompletionTime(String completionTime)` Output only.
`Rollout`	`setCreationTimestamp(String creationTimestamp)` Output only.
`Rollout`	`setCurrentWaveNumber(Long currentWaveNumber)` Output only.
`Rollout`	`setDescription(String description)` An optional description of this resource.
`Rollout`	`setEtag(String etag)` Output only.
`Rollout`	`setId(BigInteger id)` Output only.
`Rollout`	`setKind(String kind)` Output only.
`Rollout`	`setName(String name)` Name of the resource.
`Rollout`	`setRolloutEntity(RolloutRolloutEntity rolloutEntity)` Required.
`Rollout`	`setRolloutPlan(String rolloutPlan)` Required.
`Rollout`	`setSelfLink(String selfLink)` Output only.
`Rollout`	`setSelfLinkWithId(String selfLinkWithId)` Output only.
`Rollout`	`setState(String state)` Output only.
`Rollout`	`setWaveDetails(List<RolloutWaveDetails> waveDetails)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Rollout
```
public Rollout()
```
- Method Detail
  - getCancellationTime
```
public String getCancellationTime()
```
    Output only. The timestamp at which the Rollout was cancelled.
    
    Returns:
    
    value or null for none
  - setCancellationTime
```
public Rollout setCancellationTime(String cancellationTime)
```
    Output only. The timestamp at which the Rollout was cancelled.
    
    Parameters:
    
    cancellationTime - cancellationTime or null for none
  - getCompletionTime
```
public String getCompletionTime()
```
    Output only. The timestamp at which the Rollout was completed.
    
    Returns:
    
    value or null for none
  - setCompletionTime
```
public Rollout setCompletionTime(String completionTime)
```
    Output only. The timestamp at which the Rollout was completed.
    
    Parameters:
    
    completionTime - completionTime or null for none
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    Output only. [Output Only] Creation timestamp inRFC3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public Rollout setCreationTimestamp(String creationTimestamp)
```
    Output only. [Output Only] Creation timestamp inRFC3339 text format.
    
    Parameters:
    
    creationTimestamp - creationTimestamp or null for none
  - getCurrentWaveNumber
```
public Long getCurrentWaveNumber()
```
    Output only. The number of the currently running wave. Ex. 1
    
    Returns:
    
    value or null for none
  - setCurrentWaveNumber
```
public Rollout setCurrentWaveNumber(Long currentWaveNumber)
```
    Output only. The number of the currently running wave. Ex. 1
    
    Parameters:
    
    currentWaveNumber - currentWaveNumber or null for none
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Returns:
    
    value or null for none
  - setDescription
```
public Rollout setDescription(String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    
    description - description or null for none
  - getEtag
```
public String getEtag()
```
    Output only. etag of the Rollout Ex. abc1234
    
    Returns:
    
    value or null for none
  - setEtag
```
public Rollout setEtag(String etag)
```
    Output only. etag of the Rollout Ex. abc1234
    
    Parameters:
    
    etag - etag or null for none
  - getId
```
public BigInteger getId()
```
    Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Returns:
    
    value or null for none
  - setId
```
public Rollout setId(BigInteger id)
```
    Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Parameters:
    
    id - id or null for none
  - getKind
```
public String getKind()
```
    Output only. [Output Only] Type of the resource. Always compute#rollout for rollouts.
    
    Returns:
    
    value or null for none
  - setKind
```
public Rollout setKind(String kind)
```
    Output only. [Output Only] Type of the resource. Always compute#rollout for rollouts.
    
    Parameters:
    
    kind - kind or null for none
  - getName
```
public String getName()
```
    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:
    
    value or null for none
  - setName
```
public Rollout setName(String name)
```
    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.
    
    Parameters:
    
    name - name or null for none
  - getRolloutEntity
```
public RolloutRolloutEntity getRolloutEntity()
```
    Required. The resource being rolled out.
    
    Returns:
    
    value or null for none
  - setRolloutEntity
```
public Rollout setRolloutEntity(RolloutRolloutEntity rolloutEntity)
```
    Required. The resource being rolled out.
    
    Parameters:
    
    rolloutEntity - rolloutEntity or null for none
  - getRolloutPlan
```
public String getRolloutPlan()
```
    Required. Rollout Plan used to model the Rollout. Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1
    
    Returns:
    
    value or null for none
  - setRolloutPlan
```
public Rollout setRolloutPlan(String rolloutPlan)
```
    Required. Rollout Plan used to model the Rollout. Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1
    
    Parameters:
    
    rolloutPlan - rolloutPlan or null for none
  - getSelfLink
```
public String getSelfLink()
```
    Output only. [Output Only] Server-defined fully-qualified URL for this resource.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public Rollout setSelfLink(String selfLink)
```
    Output only. [Output Only] Server-defined fully-qualified URL for this resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getSelfLinkWithId
```
public String getSelfLinkWithId()
```
    Output only. [Output Only] Server-defined URL for this resource's resource id.
    
    Returns:
    
    value or null for none
  - setSelfLinkWithId
```
public Rollout setSelfLinkWithId(String selfLinkWithId)
```
    Output only. [Output Only] Server-defined URL for this resource's resource id.
    
    Parameters:
    
    selfLinkWithId - selfLinkWithId or null for none
  - getState
```
public String getState()
```
    Output only. The current state of the Rollout.
    
    Returns:
    
    value or null for none
  - setState
```
public Rollout setState(String state)
```
    Output only. The current state of the Rollout.
    
    Parameters:
    
    state - state or null for none
  - getWaveDetails
```
public List<RolloutWaveDetails> getWaveDetails()
```
    Output only. Details about each wave of the rollout.
    
    Returns:
    
    value or null for none
  - setWaveDetails
```
public Rollout setWaveDetails(List<RolloutWaveDetails> waveDetails)
```
    Output only. Details about each wave of the rollout.
    
    Parameters:
    
    waveDetails - waveDetails or null for none
  - set
```
public Rollout set(String fieldName,
                   Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Rollout clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Rollout

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Rollout

Method Detail

getCancellationTime

setCancellationTime

getCompletionTime

setCompletionTime

getCreationTimestamp

setCreationTimestamp

getCurrentWaveNumber

setCurrentWaveNumber

getDescription

setDescription

getEtag

setEtag

getId

setId

getKind

setKind

getName

setName

getRolloutEntity

setRolloutEntity

getRolloutPlan

setRolloutPlan

getSelfLink

setSelfLink

getSelfLinkWithId

setSelfLinkWithId

getState

setState

getWaveDetails

setWaveDetails

set

clone