com.google.api.services.compute.model

Class RolloutPlan

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class RolloutPlan
extends com.google.api.client.json.GenericJson

RolloutPlan resource. A RolloutPlan is the customer-defined strategy to divide a large-scale change into smaller increments, referred to as "waves". Each wave targets a specific portion of the overall affected area and defines criteria that must be met before progressing to the subsequent wave.

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
RolloutPlan()

Method Summary

Modifier and Type	Method and Description
RolloutPlan	clone()
String	getCreationTimestamp() Output only.
String	getDescription() An optional description of this resource.
BigInteger	getId() Output only.
String	getKind() Output only.
String	getLocationScope() The location scope of the rollout plan.
String	getName() Name of the resource.
String	getSelfLink() Output only.
String	getSelfLinkWithId() Output only.
List<RolloutPlanWave>	getWaves() Required.
RolloutPlan	set(String fieldName, Object value)
RolloutPlan	setCreationTimestamp(String creationTimestamp) Output only.
RolloutPlan	setDescription(String description) An optional description of this resource.
RolloutPlan	setId(BigInteger id) Output only.
RolloutPlan	setKind(String kind) Output only.
RolloutPlan	setLocationScope(String locationScope) The location scope of the rollout plan.
RolloutPlan	setName(String name) Name of the resource.
RolloutPlan	setSelfLink(String selfLink) Output only.
RolloutPlan	setSelfLinkWithId(String selfLinkWithId) Output only.
RolloutPlan	setWaves(List<RolloutPlanWave> waves) Required.

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

RolloutPlan

public RolloutPlan()

Method Detail

getCreationTimestamp

public String getCreationTimestamp()

Output only. [Output Only] Creation timestamp inRFC3339 text format.

Returns:

value or null for none

setCreationTimestamp

public RolloutPlan setCreationTimestamp(String creationTimestamp)

Output only. [Output Only] Creation timestamp inRFC3339 text format.

Parameters:

creationTimestamp - creationTimestamp 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 RolloutPlan setDescription(String description)

An optional description of this resource. Provide this property when you create the resource.

Parameters:

description - description 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 RolloutPlan 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#rolloutPlan for rolloutPlans.

Returns:

value or null for none

setKind

public RolloutPlan setKind(String kind)

Output only. [Output Only] Type of the resource. Always compute#rolloutPlan for rolloutPlans.

Parameters:

kind - kind or null for none

getLocationScope

public String getLocationScope()

The location scope of the rollout plan. If not specified, the location scope is considered as ZONAL.

Returns:

value or null for none

setLocationScope

public RolloutPlan setLocationScope(String locationScope)

The location scope of the rollout plan. If not specified, the location scope is considered as ZONAL.

Parameters:

locationScope - locationScope 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 RolloutPlan 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

getSelfLink

public String getSelfLink()

Output only. [Output Only] Server-defined fully-qualified URL for this resource.

Returns:

value or null for none

setSelfLink

public RolloutPlan 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 RolloutPlan setSelfLinkWithId(String selfLinkWithId)

Output only. [Output Only] Server-defined URL for this resource's resource id.

Parameters:

selfLinkWithId - selfLinkWithId or null for none

getWaves

public List<RolloutPlanWave> getWaves()

Required. The waves included in this rollout plan.

Returns:

value or null for none

setWaves

public RolloutPlan setWaves(List<RolloutPlanWave> waves)

Required. The waves included in this rollout plan.

Parameters:

waves - waves or null for none

set

public RolloutPlan set(String fieldName,
                       Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public RolloutPlan clone()

Overrides:

clone in class com.google.api.client.json.GenericJson