public final class Rollout extends GeneratedMessage implements RolloutOrBuilderRollout 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.
Protobuf type google.cloud.compute.v1.Rollout
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > RolloutImplements
RolloutOrBuilderStatic Fields
CANCELLATION_TIME_FIELD_NUMBER
public static final int CANCELLATION_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
COMPLETION_TIME_FIELD_NUMBER
public static final int COMPLETION_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CURRENT_WAVE_NUMBER_FIELD_NUMBER
public static final int CURRENT_WAVE_NUMBER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_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 |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PAUSE_TIME_FIELD_NUMBER
public static final int PAUSE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RESUME_TIME_FIELD_NUMBER
public static final int RESUME_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ROLLOUT_ENTITY_FIELD_NUMBER
public static final int ROLLOUT_ENTITY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ROLLOUT_PLAN_FIELD_NUMBER
public static final int ROLLOUT_PLAN_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SELF_LINK_WITH_ID_FIELD_NUMBER
public static final int SELF_LINK_WITH_ID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
WAVE_DETAILS_FIELD_NUMBER
public static final int WAVE_DETAILS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static Rollout getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Rollout |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Rollout.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
newBuilder(Rollout prototype)
public static Rollout.Builder newBuilder(Rollout prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Rollout |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
parseDelimitedFrom(InputStream input)
public static Rollout parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Rollout |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Rollout parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Rollout |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Rollout parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Rollout |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Rollout parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Rollout |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Rollout parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Rollout |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Rollout parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Rollout |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Rollout parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Rollout |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Rollout parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Rollout |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Rollout parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Rollout |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Rollout parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Rollout |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Rollout parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Rollout |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Rollout parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Rollout |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Rollout> parser()| Returns | |
|---|---|
| Type | Description |
Parser<Rollout> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getCancellationTime()
public String getCancellationTime()Output only. The timestamp at which the Rollout was cancelled.
optional string cancellation_time = 323792009;
| Returns | |
|---|---|
| Type | Description |
String |
The cancellationTime. |
getCancellationTimeBytes()
public ByteString getCancellationTimeBytes()Output only. The timestamp at which the Rollout was cancelled.
optional string cancellation_time = 323792009;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for cancellationTime. |
getCompletionTime()
public String getCompletionTime()Output only. The timestamp at which the Rollout was completed.
optional string completion_time = 122892624;
| Returns | |
|---|---|
| Type | Description |
String |
The completionTime. |
getCompletionTimeBytes()
public ByteString getCompletionTimeBytes()Output only. The timestamp at which the Rollout was completed.
optional string completion_time = 122892624;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for completionTime. |
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. |
getCurrentWaveNumber()
public long getCurrentWaveNumber()Output only. The number of the currently running wave. Ex. 1
optional int64 current_wave_number = 178280841;
| Returns | |
|---|---|
| Type | Description |
long |
The currentWaveNumber. |
getDefaultInstanceForType()
public Rollout getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Rollout |
|
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. |
getEtag()
public String getEtag()Output only. etag of the Rollout Ex. abc1234
optional string etag = 3123477;
| Returns | |
|---|---|
| Type | Description |
String |
The etag. |
getEtagBytes()
public ByteString getEtagBytes()Output only. etag of the Rollout Ex. abc1234
optional string etag = 3123477;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for etag. |
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#rollout for rollouts.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
String |
The kind. |
getKindBytes()
public ByteString getKindBytes()Output only. [Output Only] Type of the resource. Always compute#rollout for rollouts.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for kind. |
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<Rollout> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Rollout> |
|
getPauseTime()
public String getPauseTime()Output only. The timestamp at which the Rollout was paused.
optional string pause_time = 489697142;
| Returns | |
|---|---|
| Type | Description |
String |
The pauseTime. |
getPauseTimeBytes()
public ByteString getPauseTimeBytes()Output only. The timestamp at which the Rollout was paused.
optional string pause_time = 489697142;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pauseTime. |
getResumeTime()
public String getResumeTime()Output only. The timestamp at which the Rollout was resumed.
optional string resume_time = 457856927;
| Returns | |
|---|---|
| Type | Description |
String |
The resumeTime. |
getResumeTimeBytes()
public ByteString getResumeTimeBytes()Output only. The timestamp at which the Rollout was resumed.
optional string resume_time = 457856927;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for resumeTime. |
getRolloutEntity()
public RolloutRolloutEntity getRolloutEntity()Required. The resource being rolled out.
optional .google.cloud.compute.v1.RolloutRolloutEntity rollout_entity = 70633009;
| Returns | |
|---|---|
| Type | Description |
RolloutRolloutEntity |
The rolloutEntity. |
getRolloutEntityOrBuilder()
public RolloutRolloutEntityOrBuilder getRolloutEntityOrBuilder()Required. The resource being rolled out.
optional .google.cloud.compute.v1.RolloutRolloutEntity rollout_entity = 70633009;
| Returns | |
|---|---|
| Type | Description |
RolloutRolloutEntityOrBuilder |
|
getRolloutPlan()
public String getRolloutPlan()Required. Rollout Plan used to model the Rollout. Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1
optional string rollout_plan = 459057399;
| Returns | |
|---|---|
| Type | Description |
String |
The rolloutPlan. |
getRolloutPlanBytes()
public ByteString getRolloutPlanBytes()Required. Rollout Plan used to model the Rollout. Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1
optional string rollout_plan = 459057399;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for rolloutPlan. |
getSelfLink()
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 |
|
getState()
public String getState()Output only. The current state of the Rollout. Check the State enum for the list of possible values.
optional string state = 109757585;
| Returns | |
|---|---|
| Type | Description |
String |
The state. |
getStateBytes()
public ByteString getStateBytes()Output only. The current state of the Rollout. Check the State enum for the list of possible values.
optional string state = 109757585;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for state. |
getWaveDetails(int index)
public RolloutWaveDetails getWaveDetails(int index)Output only. Details about each wave of the rollout.
repeated .google.cloud.compute.v1.RolloutWaveDetails wave_details = 8266492;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
RolloutWaveDetails |
|
getWaveDetailsCount()
public int getWaveDetailsCount()Output only. Details about each wave of the rollout.
repeated .google.cloud.compute.v1.RolloutWaveDetails wave_details = 8266492;
| Returns | |
|---|---|
| Type | Description |
int |
|
getWaveDetailsList()
public List<RolloutWaveDetails> getWaveDetailsList()Output only. Details about each wave of the rollout.
repeated .google.cloud.compute.v1.RolloutWaveDetails wave_details = 8266492;
| Returns | |
|---|---|
| Type | Description |
List<RolloutWaveDetails> |
|
getWaveDetailsOrBuilder(int index)
public RolloutWaveDetailsOrBuilder getWaveDetailsOrBuilder(int index)Output only. Details about each wave of the rollout.
repeated .google.cloud.compute.v1.RolloutWaveDetails wave_details = 8266492;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
RolloutWaveDetailsOrBuilder |
|
getWaveDetailsOrBuilderList()
public List<? extends RolloutWaveDetailsOrBuilder> getWaveDetailsOrBuilderList()Output only. Details about each wave of the rollout.
repeated .google.cloud.compute.v1.RolloutWaveDetails wave_details = 8266492;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.compute.v1.RolloutWaveDetailsOrBuilder> |
|
hasCancellationTime()
public boolean hasCancellationTime()Output only. The timestamp at which the Rollout was cancelled.
optional string cancellation_time = 323792009;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the cancellationTime field is set. |
hasCompletionTime()
public boolean hasCompletionTime()Output only. The timestamp at which the Rollout was completed.
optional string completion_time = 122892624;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the completionTime field is set. |
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. |
hasCurrentWaveNumber()
public boolean hasCurrentWaveNumber()Output only. The number of the currently running wave. Ex. 1
optional int64 current_wave_number = 178280841;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the currentWaveNumber 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. |
hasEtag()
public boolean hasEtag()Output only. etag of the Rollout Ex. abc1234
optional string etag = 3123477;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the etag 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#rollout for rollouts.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the kind 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. |
hasPauseTime()
public boolean hasPauseTime()Output only. The timestamp at which the Rollout was paused.
optional string pause_time = 489697142;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the pauseTime field is set. |
hasResumeTime()
public boolean hasResumeTime()Output only. The timestamp at which the Rollout was resumed.
optional string resume_time = 457856927;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the resumeTime field is set. |
hasRolloutEntity()
public boolean hasRolloutEntity()Required. The resource being rolled out.
optional .google.cloud.compute.v1.RolloutRolloutEntity rollout_entity = 70633009;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the rolloutEntity field is set. |
hasRolloutPlan()
public boolean hasRolloutPlan()Required. Rollout Plan used to model the Rollout. Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1
optional string rollout_plan = 459057399;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the rolloutPlan field is set. |
hasSelfLink()
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. |
hasState()
public boolean hasState()Output only. The current state of the Rollout. Check the State enum for the list of possible values.
optional string state = 109757585;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the state field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Rollout.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Rollout.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
toBuilder()
public Rollout.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|