Class RolloutPlan (1.105.0)

public final class RolloutPlan extends GeneratedMessage 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 Fields

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_SCOPE_FIELD_NUMBER

public static final int LOCATION_SCOPE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_WITH_ID_FIELD_NUMBER
Field Value
Type Description
int

WAVES_FIELD_NUMBER

public static final int WAVES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RolloutPlan getDefaultInstance()
Returns
Type Description
RolloutPlan

getDescriptor()

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

newBuilder()

public static RolloutPlan.Builder newBuilder()
Returns
Type Description
RolloutPlan.Builder

newBuilder(RolloutPlan prototype)

public static RolloutPlan.Builder newBuilder(RolloutPlan prototype)
Parameter
Name Description
prototype RolloutPlan
Returns
Type Description
RolloutPlan.Builder

parseDelimitedFrom(InputStream input)

public static RolloutPlan parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RolloutPlan
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RolloutPlan parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RolloutPlan
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RolloutPlan parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RolloutPlan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RolloutPlan parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RolloutPlan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RolloutPlan parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RolloutPlan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RolloutPlan parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RolloutPlan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RolloutPlan parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RolloutPlan
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RolloutPlan parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RolloutPlan
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RolloutPlan parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RolloutPlan
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RolloutPlan parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RolloutPlan
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RolloutPlan parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RolloutPlan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RolloutPlan parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RolloutPlan
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RolloutPlan> parser()
Returns
Type Description
Parser<RolloutPlan>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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.

getParserForType()

public Parser<RolloutPlan> getParserForType()
Returns
Type Description
Parser<RolloutPlan>
Overrides
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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RolloutPlan.Builder newBuilderForType()
Returns
Type Description
RolloutPlan.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected RolloutPlan.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RolloutPlan.Builder
Overrides

toBuilder()

public RolloutPlan.Builder toBuilder()
Returns
Type Description
RolloutPlan.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException