Class RolloutPlan.Builder (1.105.0)

public static final class RolloutPlan.Builder extends GeneratedMessage.Builder<RolloutPlan.Builder> implements RolloutPlanOrBuilder

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.

Protobuf type google.cloud.compute.v1.RolloutPlan

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllWaves(Iterable<? extends RolloutPlanWave> values)

public RolloutPlan.Builder addAllWaves(Iterable<? extends RolloutPlanWave> values)

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.RolloutPlanWave>
Returns
Type Description
RolloutPlan.Builder

addWaves(RolloutPlanWave value)

public RolloutPlan.Builder addWaves(RolloutPlanWave value)

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Parameter
Name Description
value RolloutPlanWave
Returns
Type Description
RolloutPlan.Builder

addWaves(RolloutPlanWave.Builder builderForValue)

public RolloutPlan.Builder addWaves(RolloutPlanWave.Builder builderForValue)

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Parameter
Name Description
builderForValue RolloutPlanWave.Builder
Returns
Type Description
RolloutPlan.Builder

addWaves(int index, RolloutPlanWave value)

public RolloutPlan.Builder addWaves(int index, RolloutPlanWave value)

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Parameters
Name Description
index int
value RolloutPlanWave
Returns
Type Description
RolloutPlan.Builder

addWaves(int index, RolloutPlanWave.Builder builderForValue)

public RolloutPlan.Builder addWaves(int index, RolloutPlanWave.Builder builderForValue)

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Parameters
Name Description
index int
builderForValue RolloutPlanWave.Builder
Returns
Type Description
RolloutPlan.Builder

addWavesBuilder()

public RolloutPlanWave.Builder addWavesBuilder()

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Returns
Type Description
RolloutPlanWave.Builder

addWavesBuilder(int index)

public RolloutPlanWave.Builder addWavesBuilder(int index)

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Parameter
Name Description
index int
Returns
Type Description
RolloutPlanWave.Builder

build()

public RolloutPlan build()
Returns
Type Description
RolloutPlan

buildPartial()

public RolloutPlan buildPartial()
Returns
Type Description
RolloutPlan

clear()

public RolloutPlan.Builder clear()
Returns
Type Description
RolloutPlan.Builder
Overrides

clearCreationTimestamp()

public RolloutPlan.Builder clearCreationTimestamp()

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

optional string creation_timestamp = 30525366;

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

clearDescription()

public RolloutPlan.Builder clearDescription()

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

optional string description = 422937596;

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

clearId()

public RolloutPlan.Builder clearId()

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

clearKind()

public RolloutPlan.Builder clearKind()

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

optional string kind = 3292052;

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

clearLocationScope()

public RolloutPlan.Builder clearLocationScope()

The location scope of the rollout plan. If not specified, the location scope is considered as ZONAL. Check the LocationScope enum for the list of possible values.

optional string location_scope = 138667338;

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

clearName()

public RolloutPlan.Builder clearName()

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

optional string name = 3373707;

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

public RolloutPlan.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

clearSelfLinkWithId()

public RolloutPlan.Builder clearSelfLinkWithId()

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

optional string self_link_with_id = 44520962;

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

clearWaves()

public RolloutPlan.Builder clearWaves()

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Returns
Type Description
RolloutPlan.Builder

getCreationTimestamp()

public String getCreationTimestamp()

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

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

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

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public RolloutPlan getDefaultInstanceForType()
Returns
Type Description
RolloutPlan

getDescription()

public String getDescription()

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

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getId()

public long getId()

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getKind()

public String getKind()

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

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

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

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

getLocationScope()

public String getLocationScope()

The location scope of the rollout plan. If not specified, the location scope is considered as ZONAL. Check the LocationScope enum for the list of possible values.

optional string location_scope = 138667338;

Returns
Type Description
String

The locationScope.

getLocationScopeBytes()

public ByteString getLocationScopeBytes()

The location scope of the rollout plan. If not specified, the location scope is considered as ZONAL. Check the LocationScope enum for the list of possible values.

optional string location_scope = 138667338;

Returns
Type Description
ByteString

The bytes for locationScope.

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

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

public String getSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getSelfLinkWithId()

public String getSelfLinkWithId()

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

optional string self_link_with_id = 44520962;

Returns
Type Description
String

The selfLinkWithId.

getSelfLinkWithIdBytes()

public ByteString getSelfLinkWithIdBytes()

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

optional string self_link_with_id = 44520962;

Returns
Type Description
ByteString

The bytes for selfLinkWithId.

getWaves(int index)

public RolloutPlanWave getWaves(int index)

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Parameter
Name Description
index int
Returns
Type Description
RolloutPlanWave

getWavesBuilder(int index)

public RolloutPlanWave.Builder getWavesBuilder(int index)

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Parameter
Name Description
index int
Returns
Type Description
RolloutPlanWave.Builder

getWavesBuilderList()

public List<RolloutPlanWave.Builder> getWavesBuilderList()

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Returns
Type Description
List<Builder>

getWavesCount()

public int getWavesCount()

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Returns
Type Description
int

getWavesList()

public List<RolloutPlanWave> getWavesList()

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Returns
Type Description
List<RolloutPlanWave>

getWavesOrBuilder(int index)

public RolloutPlanWaveOrBuilder getWavesOrBuilder(int index)

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Parameter
Name Description
index int
Returns
Type Description
RolloutPlanWaveOrBuilder

getWavesOrBuilderList()

public List<? extends RolloutPlanWaveOrBuilder> getWavesOrBuilderList()

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.RolloutPlanWaveOrBuilder>

hasCreationTimestamp()

public boolean hasCreationTimestamp()

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

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

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

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasId()

public boolean hasId()

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

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

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasLocationScope()

public boolean hasLocationScope()

The location scope of the rollout plan. If not specified, the location scope is considered as ZONAL. Check the LocationScope enum for the list of possible values.

optional string location_scope = 138667338;

Returns
Type Description
boolean

Whether the locationScope field is set.

hasName()

public boolean hasName()

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

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

public boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasSelfLinkWithId()

public boolean hasSelfLinkWithId()

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

optional string self_link_with_id = 44520962;

Returns
Type Description
boolean

Whether the selfLinkWithId field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RolloutPlan other)

public RolloutPlan.Builder mergeFrom(RolloutPlan other)
Parameter
Name Description
other RolloutPlan
Returns
Type Description
RolloutPlan.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RolloutPlan.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RolloutPlan.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RolloutPlan.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RolloutPlan.Builder
Overrides

removeWaves(int index)

public RolloutPlan.Builder removeWaves(int index)

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Parameter
Name Description
index int
Returns
Type Description
RolloutPlan.Builder

setCreationTimestamp(String value)

public RolloutPlan.Builder setCreationTimestamp(String value)

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

optional string creation_timestamp = 30525366;

Parameter
Name Description
value String

The creationTimestamp to set.

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public RolloutPlan.Builder setCreationTimestampBytes(ByteString value)

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

optional string creation_timestamp = 30525366;

Parameter
Name Description
value ByteString

The bytes for creationTimestamp to set.

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

setDescription(String value)

public RolloutPlan.Builder setDescription(String value)

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

optional string description = 422937596;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public RolloutPlan.Builder setDescriptionBytes(ByteString value)

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

optional string description = 422937596;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

setId(long value)

public RolloutPlan.Builder setId(long value)

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Parameter
Name Description
value long

The id to set.

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

setKind(String value)

public RolloutPlan.Builder setKind(String value)

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

optional string kind = 3292052;

Parameter
Name Description
value String

The kind to set.

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

setKindBytes(ByteString value)

public RolloutPlan.Builder setKindBytes(ByteString value)

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

optional string kind = 3292052;

Parameter
Name Description
value ByteString

The bytes for kind to set.

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

setLocationScope(String value)

public RolloutPlan.Builder setLocationScope(String value)

The location scope of the rollout plan. If not specified, the location scope is considered as ZONAL. Check the LocationScope enum for the list of possible values.

optional string location_scope = 138667338;

Parameter
Name Description
value String

The locationScope to set.

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

setLocationScopeBytes(ByteString value)

public RolloutPlan.Builder setLocationScopeBytes(ByteString value)

The location scope of the rollout plan. If not specified, the location scope is considered as ZONAL. Check the LocationScope enum for the list of possible values.

optional string location_scope = 138667338;

Parameter
Name Description
value ByteString

The bytes for locationScope to set.

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

setName(String value)

public RolloutPlan.Builder setName(String value)

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

optional string name = 3373707;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

setNameBytes(ByteString value)

public RolloutPlan.Builder setNameBytes(ByteString value)

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

optional string name = 3373707;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

public RolloutPlan.Builder setSelfLink(String value)

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

optional string self_link = 456214797;

Parameter
Name Description
value String

The selfLink to set.

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public RolloutPlan.Builder setSelfLinkBytes(ByteString value)

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

optional string self_link = 456214797;

Parameter
Name Description
value ByteString

The bytes for selfLink to set.

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

setSelfLinkWithId(String value)

public RolloutPlan.Builder setSelfLinkWithId(String value)

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

optional string self_link_with_id = 44520962;

Parameter
Name Description
value String

The selfLinkWithId to set.

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

setSelfLinkWithIdBytes(ByteString value)

public RolloutPlan.Builder setSelfLinkWithIdBytes(ByteString value)

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

optional string self_link_with_id = 44520962;

Parameter
Name Description
value ByteString

The bytes for selfLinkWithId to set.

Returns
Type Description
RolloutPlan.Builder

This builder for chaining.

setWaves(int index, RolloutPlanWave value)

public RolloutPlan.Builder setWaves(int index, RolloutPlanWave value)

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Parameters
Name Description
index int
value RolloutPlanWave
Returns
Type Description
RolloutPlan.Builder

setWaves(int index, RolloutPlanWave.Builder builderForValue)

public RolloutPlan.Builder setWaves(int index, RolloutPlanWave.Builder builderForValue)

Required. The waves included in this rollout plan.

repeated .google.cloud.compute.v1.RolloutPlanWave waves = 112905370;

Parameters
Name Description
index int
builderForValue RolloutPlanWave.Builder
Returns
Type Description
RolloutPlan.Builder