Rollout (proto-google-cloud-deploy-v1 1.31.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.deploy.v1.Rollout

All Implemented Interfaces:

RolloutOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class Rollout
extends com.google.protobuf.GeneratedMessageV3
implements RolloutOrBuilder
```
```
 A `Rollout` resource in the Cloud Deploy API.

 A `Rollout` contains information around a specific deployment to a `Target`.
 
```
Protobuf type google.cloud.deploy.v1.Rollout
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Rollout.ApprovalState` Valid approval states of a `Rollout`.
`static class`	`Rollout.Builder` A `Rollout` resource in the Cloud Deploy API.
`static class`	`Rollout.FailureCause` Well-known rollout failures.
`static class`	`Rollout.State` Valid states of a `Rollout`.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ANNOTATIONS_FIELD_NUMBER`
`static int`	`APPROVAL_STATE_FIELD_NUMBER`
`static int`	`APPROVE_TIME_FIELD_NUMBER`
`static int`	`CONTROLLER_ROLLOUT_FIELD_NUMBER`
`static int`	`CREATE_TIME_FIELD_NUMBER`
`static int`	`DEPLOY_END_TIME_FIELD_NUMBER`
`static int`	`DEPLOY_FAILURE_CAUSE_FIELD_NUMBER`
`static int`	`DEPLOY_START_TIME_FIELD_NUMBER`
`static int`	`DEPLOYING_BUILD_FIELD_NUMBER`
`static int`	`DESCRIPTION_FIELD_NUMBER`
`static int`	`ENQUEUE_TIME_FIELD_NUMBER`
`static int`	`ETAG_FIELD_NUMBER`
`static int`	`FAILURE_REASON_FIELD_NUMBER`
`static int`	`LABELS_FIELD_NUMBER`
`static int`	`METADATA_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`PHASES_FIELD_NUMBER`
`static int`	`ROLLBACK_OF_ROLLOUT_FIELD_NUMBER`
`static int`	`ROLLED_BACK_BY_ROLLOUTS_FIELD_NUMBER`
`static int`	`STATE_FIELD_NUMBER`
`static int`	`TARGET_ID_FIELD_NUMBER`
`static int`	`UID_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsAnnotations(String key)` User annotations.
`boolean`	`containsLabels(String key)` Labels are attributes that can be set and used by both the user and by Cloud Deploy.
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAnnotations()` Deprecated.
`int`	`getAnnotationsCount()` User annotations.
`Map<String,String>`	`getAnnotationsMap()` User annotations.
`String`	`getAnnotationsOrDefault(String key, String defaultValue)` User annotations.
`String`	`getAnnotationsOrThrow(String key)` User annotations.
`Rollout.ApprovalState`	`getApprovalState()` Output only.
`int`	`getApprovalStateValue()` Output only.
`com.google.protobuf.Timestamp`	`getApproveTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getApproveTimeOrBuilder()` Output only.
`String`	`getControllerRollout()` Output only.
`com.google.protobuf.ByteString`	`getControllerRolloutBytes()` Output only.
`com.google.protobuf.Timestamp`	`getCreateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getCreateTimeOrBuilder()` Output only.
`static Rollout`	`getDefaultInstance()`
`Rollout`	`getDefaultInstanceForType()`
`com.google.protobuf.Timestamp`	`getDeployEndTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getDeployEndTimeOrBuilder()` Output only.
`Rollout.FailureCause`	`getDeployFailureCause()` Output only.
`int`	`getDeployFailureCauseValue()` Output only.
`String`	`getDeployingBuild()` Output only.
`com.google.protobuf.ByteString`	`getDeployingBuildBytes()` Output only.
`com.google.protobuf.Timestamp`	`getDeployStartTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getDeployStartTimeOrBuilder()` Output only.
`String`	`getDescription()` Description of the `Rollout` for user purposes.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` Description of the `Rollout` for user purposes.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Timestamp`	`getEnqueueTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getEnqueueTimeOrBuilder()` Output only.
`String`	`getEtag()` This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
`com.google.protobuf.ByteString`	`getEtagBytes()` This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
`String`	`getFailureReason()` Output only.
`com.google.protobuf.ByteString`	`getFailureReasonBytes()` Output only.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` Labels are attributes that can be set and used by both the user and by Cloud Deploy.
`Map<String,String>`	`getLabelsMap()` Labels are attributes that can be set and used by both the user and by Cloud Deploy.
`String`	`getLabelsOrDefault(String key, String defaultValue)` Labels are attributes that can be set and used by both the user and by Cloud Deploy.
`String`	`getLabelsOrThrow(String key)` Labels are attributes that can be set and used by both the user and by Cloud Deploy.
`Metadata`	`getMetadata()` Output only.
`MetadataOrBuilder`	`getMetadataOrBuilder()` Output only.
`String`	`getName()` Optional.
`com.google.protobuf.ByteString`	`getNameBytes()` Optional.
`com.google.protobuf.Parser<Rollout>`	`getParserForType()`
`Phase`	`getPhases(int index)` Output only.
`int`	`getPhasesCount()` Output only.
`List<Phase>`	`getPhasesList()` Output only.
`PhaseOrBuilder`	`getPhasesOrBuilder(int index)` Output only.
`List<? extends PhaseOrBuilder>`	`getPhasesOrBuilderList()` Output only.
`String`	`getRollbackOfRollout()` Output only.
`com.google.protobuf.ByteString`	`getRollbackOfRolloutBytes()` Output only.
`String`	`getRolledBackByRollouts(int index)` Output only.
`com.google.protobuf.ByteString`	`getRolledBackByRolloutsBytes(int index)` Output only.
`int`	`getRolledBackByRolloutsCount()` Output only.
`com.google.protobuf.ProtocolStringList`	`getRolledBackByRolloutsList()` Output only.
`int`	`getSerializedSize()`
`Rollout.State`	`getState()` Output only.
`int`	`getStateValue()` Output only.
`String`	`getTargetId()` Required.
`com.google.protobuf.ByteString`	`getTargetIdBytes()` Required.
`String`	`getUid()` Output only.
`com.google.protobuf.ByteString`	`getUidBytes()` Output only.
`boolean`	`hasApproveTime()` Output only.
`boolean`	`hasCreateTime()` Output only.
`boolean`	`hasDeployEndTime()` Output only.
`boolean`	`hasDeployStartTime()` Output only.
`boolean`	`hasEnqueueTime()` Output only.
`int`	`hashCode()`
`boolean`	`hasMetadata()` Output only.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static Rollout.Builder`	`newBuilder()`
`static Rollout.Builder`	`newBuilder(Rollout prototype)`
`Rollout.Builder`	`newBuilderForType()`
`protected Rollout.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Rollout`	`parseDelimitedFrom(InputStream input)`
`static Rollout`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Rollout`	`parseFrom(byte[] data)`
`static Rollout`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Rollout`	`parseFrom(ByteBuffer data)`
`static Rollout`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Rollout`	`parseFrom(com.google.protobuf.ByteString data)`
`static Rollout`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Rollout`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Rollout`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Rollout`	`parseFrom(InputStream input)`
`static Rollout`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Rollout>`	`parser()`
`Rollout.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UID_FIELD_NUMBER
```
public static final int UID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DESCRIPTION_FIELD_NUMBER
```
public static final int DESCRIPTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ANNOTATIONS_FIELD_NUMBER
```
public static final int ANNOTATIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELS_FIELD_NUMBER
```
public static final int LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CREATE_TIME_FIELD_NUMBER
```
public static final int CREATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- APPROVE_TIME_FIELD_NUMBER
```
public static final int APPROVE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ENQUEUE_TIME_FIELD_NUMBER
```
public static final int ENQUEUE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DEPLOY_START_TIME_FIELD_NUMBER
```
public static final int DEPLOY_START_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DEPLOY_END_TIME_FIELD_NUMBER
```
public static final int DEPLOY_END_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TARGET_ID_FIELD_NUMBER
```
public static final int TARGET_ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- APPROVAL_STATE_FIELD_NUMBER
```
public static final int APPROVAL_STATE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STATE_FIELD_NUMBER
```
public static final int STATE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FAILURE_REASON_FIELD_NUMBER
```
public static final int FAILURE_REASON_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DEPLOYING_BUILD_FIELD_NUMBER
```
public static final int DEPLOYING_BUILD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ETAG_FIELD_NUMBER
```
public static final int ETAG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DEPLOY_FAILURE_CAUSE_FIELD_NUMBER
```
public static final int DEPLOY_FAILURE_CAUSE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PHASES_FIELD_NUMBER
```
public static final int PHASES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- METADATA_FIELD_NUMBER
```
public static final int METADATA_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CONTROLLER_ROLLOUT_FIELD_NUMBER
```
public static final int CONTROLLER_ROLLOUT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ROLLBACK_OF_ROLLOUT_FIELD_NUMBER
```
public static final int ROLLBACK_OF_ROLLOUT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ROLLED_BACK_BY_ROLLOUTS_FIELD_NUMBER
```
public static final int ROLLED_BACK_BY_ROLLOUTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 Optional. Name of the `Rollout`. Format is
 `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/[a-z][a-z0-9\-]{0,62}`.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getName in interface RolloutOrBuilder
Returns:: The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Optional. Name of the `Rollout`. Format is
 `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/[a-z][a-z0-9\-]{0,62}`.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getNameBytes in interface RolloutOrBuilder
Returns:: The bytes for name.

getUid
```
public String getUid()
```
```
 Output only. Unique identifier of the `Rollout`.
 
```
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getUid in interface RolloutOrBuilder

Returns:

The uid.

getUidBytes
```
public com.google.protobuf.ByteString getUidBytes()
```
```
 Output only. Unique identifier of the `Rollout`.
 
```
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getUidBytes in interface RolloutOrBuilder

Returns:

The bytes for uid.

getDescription

public String getDescription()

 Description of the `Rollout` for user purposes. Max length is 255
 characters.

string description = 3;

Specified by:: getDescription in interface RolloutOrBuilder
Returns:: The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 Description of the `Rollout` for user purposes. Max length is 255
 characters.

string description = 3;

Specified by:: getDescriptionBytes in interface RolloutOrBuilder
Returns:: The bytes for description.

getAnnotationsCount

public int getAnnotationsCount()

Description copied from interface: RolloutOrBuilder

 User annotations. These attributes can only be set and used by the
 user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations
 for more details such as format and size limitations.

map<string, string> annotations = 4;

Specified by:: getAnnotationsCount in interface RolloutOrBuilder

containsAnnotations

public boolean containsAnnotations(String key)

 User annotations. These attributes can only be set and used by the
 user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations
 for more details such as format and size limitations.

map<string, string> annotations = 4;

Specified by:: containsAnnotations in interface RolloutOrBuilder

getAnnotations
```
@Deprecated
public Map<String,String> getAnnotations()
```
Deprecated.

Use getAnnotationsMap() instead.

Specified by:

getAnnotations in interface RolloutOrBuilder

getAnnotationsMap

public Map<String,String> getAnnotationsMap()

 User annotations. These attributes can only be set and used by the
 user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations
 for more details such as format and size limitations.

map<string, string> annotations = 4;

Specified by:: getAnnotationsMap in interface RolloutOrBuilder

getAnnotationsOrDefault

public String getAnnotationsOrDefault(String key,
                                      String defaultValue)

 User annotations. These attributes can only be set and used by the
 user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations
 for more details such as format and size limitations.

map<string, string> annotations = 4;

Specified by:: getAnnotationsOrDefault in interface RolloutOrBuilder

getAnnotationsOrThrow

public String getAnnotationsOrThrow(String key)

 User annotations. These attributes can only be set and used by the
 user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations
 for more details such as format and size limitations.

map<string, string> annotations = 4;

Specified by:: getAnnotationsOrThrow in interface RolloutOrBuilder