public final class Rollout extends GeneratedMessageV3 implements RolloutOrBuilder
A Rollout resource in the Google Cloud Deploy API.
A Rollout contains information around a specific deployment to a Target.
Protobuf type google.cloud.deploy.v1.Rollout
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
APPROVAL_STATE_FIELD_NUMBER
public static final int APPROVAL_STATE_FIELD_NUMBER
Field Value
APPROVE_TIME_FIELD_NUMBER
public static final int APPROVE_TIME_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DEPLOYING_BUILD_FIELD_NUMBER
public static final int DEPLOYING_BUILD_FIELD_NUMBER
Field Value
DEPLOY_END_TIME_FIELD_NUMBER
public static final int DEPLOY_END_TIME_FIELD_NUMBER
Field Value
DEPLOY_FAILURE_CAUSE_FIELD_NUMBER
public static final int DEPLOY_FAILURE_CAUSE_FIELD_NUMBER
Field Value
DEPLOY_START_TIME_FIELD_NUMBER
public static final int DEPLOY_START_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
ENQUEUE_TIME_FIELD_NUMBER
public static final int ENQUEUE_TIME_FIELD_NUMBER
Field Value
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
Field Value
FAILURE_REASON_FIELD_NUMBER
public static final int FAILURE_REASON_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
public static final int METADATA_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PHASES_FIELD_NUMBER
public static final int PHASES_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
TARGET_ID_FIELD_NUMBER
public static final int TARGET_ID_FIELD_NUMBER
Field Value
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Rollout getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Rollout.Builder newBuilder()
Returns
newBuilder(Rollout prototype)
public static Rollout.Builder newBuilder(Rollout prototype)
Parameter
Returns
public static Rollout parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Rollout parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Rollout parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Rollout parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Rollout parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Rollout parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Rollout parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Rollout parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Rollout parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Rollout parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Rollout parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Rollout parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Rollout> parser()
Returns
Methods
containsAnnotations(String key)
public boolean containsAnnotations(String key)
User annotations. These attributes can only be set and used by the
user, and not by Google Cloud Deploy. See
https://google.aip.dev/128#annotations for more details such as format and
size limitations.
map<string, string> annotations = 4;
containsLabels(String key)
public boolean containsLabels(String key)
Labels are attributes that can be set and used by both the
user and by Google Cloud Deploy. Labels must meet the following
constraints:
- Keys and values can contain only lowercase letters, numeric characters,
underscores, and dashes.
- All characters must use UTF-8 encoding, and international characters are
allowed.
- Keys must start with a lowercase letter or international character.
- Each resource is limited to a maximum of 64 labels.
Both keys and values are additionally constrained to be <= 128 bytes.
map<string, string> labels = 5;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAnnotations()
public Map<String,String> getAnnotations()
Returns
getAnnotationsCount()
public int getAnnotationsCount()
User annotations. These attributes can only be set and used by the
user, and not by Google Cloud Deploy. See
https://google.aip.dev/128#annotations for more details such as format and
size limitations.
map<string, string> annotations = 4;
getAnnotationsMap()
public Map<String,String> getAnnotationsMap()
User annotations. These attributes can only be set and used by the
user, and not by Google Cloud Deploy. See
https://google.aip.dev/128#annotations for more details such as format and
size limitations.
map<string, string> annotations = 4;
getAnnotationsOrDefault(String key, String defaultValue)
public String getAnnotationsOrDefault(String key, String defaultValue)
User annotations. These attributes can only be set and used by the
user, and not by Google Cloud Deploy. See
https://google.aip.dev/128#annotations for more details such as format and
size limitations.
map<string, string> annotations = 4;
getAnnotationsOrThrow(String key)
public String getAnnotationsOrThrow(String key)
User annotations. These attributes can only be set and used by the
user, and not by Google Cloud Deploy. See
https://google.aip.dev/128#annotations for more details such as format and
size limitations.
map<string, string> annotations = 4;
getApprovalState()
public Rollout.ApprovalState getApprovalState()
Output only. Approval state of the Rollout.
.google.cloud.deploy.v1.Rollout.ApprovalState approval_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getApprovalStateValue()
public int getApprovalStateValue()
Output only. Approval state of the Rollout.
.google.cloud.deploy.v1.Rollout.ApprovalState approval_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The enum numeric value on the wire for approvalState.
|
getApproveTime()
public Timestamp getApproveTime()
Output only. Time at which the Rollout was approved.
.google.protobuf.Timestamp approve_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getApproveTimeOrBuilder()
public TimestampOrBuilder getApproveTimeOrBuilder()
Output only. Time at which the Rollout was approved.
.google.protobuf.Timestamp approve_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime()
public Timestamp getCreateTime()
Output only. Time at which the Rollout was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time at which the Rollout was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Rollout getDefaultInstanceForType()
Returns
getDeployEndTime()
public Timestamp getDeployEndTime()
Output only. Time at which the Rollout finished deploying.
.google.protobuf.Timestamp deploy_end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDeployEndTimeOrBuilder()
public TimestampOrBuilder getDeployEndTimeOrBuilder()
Output only. Time at which the Rollout finished deploying.
.google.protobuf.Timestamp deploy_end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDeployFailureCause()
public Rollout.FailureCause getDeployFailureCause()
Output only. The reason this rollout failed. This will always be unspecified while the
rollout is in progress.
.google.cloud.deploy.v1.Rollout.FailureCause deploy_failure_cause = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDeployFailureCauseValue()
public int getDeployFailureCauseValue()
Output only. The reason this rollout failed. This will always be unspecified while the
rollout is in progress.
.google.cloud.deploy.v1.Rollout.FailureCause deploy_failure_cause = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The enum numeric value on the wire for deployFailureCause.
|
getDeployStartTime()
public Timestamp getDeployStartTime()
Output only. Time at which the Rollout started deploying.
.google.protobuf.Timestamp deploy_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDeployStartTimeOrBuilder()
public TimestampOrBuilder getDeployStartTimeOrBuilder()
Output only. Time at which the Rollout started deploying.
.google.protobuf.Timestamp deploy_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDeployingBuild()
public String getDeployingBuild()
Output only. The resource name of the Cloud Build Build object that is used to deploy
the Rollout. Format is
projects/{project}/locations/{location}/builds/{build}.
string deploying_build = 17 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Type | Description |
| String | The deployingBuild.
|
getDeployingBuildBytes()
public ByteString getDeployingBuildBytes()
Output only. The resource name of the Cloud Build Build object that is used to deploy
the Rollout. Format is
projects/{project}/locations/{location}/builds/{build}.
string deploying_build = 17 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Type | Description |
| ByteString | The bytes for deployingBuild.
|
getDescription()
public String getDescription()
Description of the Rollout for user purposes. Max length is 255
characters.
string description = 3;
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Description of the Rollout for user purposes. Max length is 255
characters.
string description = 3;
| Type | Description |
| ByteString | The bytes for description.
|
getEnqueueTime()
public Timestamp getEnqueueTime()
Output only. Time at which the Rollout was enqueued.
.google.protobuf.Timestamp enqueue_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getEnqueueTimeOrBuilder()
public TimestampOrBuilder getEnqueueTimeOrBuilder()
Output only. Time at which the Rollout was enqueued.
.google.protobuf.Timestamp enqueue_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
string etag = 16;
| Type | Description |
| String | The etag.
|
getEtagBytes()
public 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 etag = 16;
getFailureReason()
public String getFailureReason()
Output only. Additional information about the rollout failure, if available.
string failure_reason = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The failureReason.
|
getFailureReasonBytes()
public ByteString getFailureReasonBytes()
Output only. Additional information about the rollout failure, if available.
string failure_reason = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| ByteString | The bytes for failureReason.
|
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
Labels are attributes that can be set and used by both the
user and by Google Cloud Deploy. Labels must meet the following
constraints:
- Keys and values can contain only lowercase letters, numeric characters,
underscores, and dashes.
- All characters must use UTF-8 encoding, and international characters are
allowed.
- Keys must start with a lowercase letter or international character.
- Each resource is limited to a maximum of 64 labels.
Both keys and values are additionally constrained to be <= 128 bytes.
map<string, string> labels = 5;
getLabelsMap()
public Map<String,String> getLabelsMap()
Labels are attributes that can be set and used by both the
user and by Google Cloud Deploy. Labels must meet the following
constraints:
- Keys and values can contain only lowercase letters, numeric characters,
underscores, and dashes.
- All characters must use UTF-8 encoding, and international characters are
allowed.
- Keys must start with a lowercase letter or international character.
- Each resource is limited to a maximum of 64 labels.
Both keys and values are additionally constrained to be <= 128 bytes.
map<string, string> labels = 5;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Labels are attributes that can be set and used by both the
user and by Google Cloud Deploy. Labels must meet the following
constraints:
- Keys and values can contain only lowercase letters, numeric characters,
underscores, and dashes.
- All characters must use UTF-8 encoding, and international characters are
allowed.
- Keys must start with a lowercase letter or international character.
- Each resource is limited to a maximum of 64 labels.
Both keys and values are additionally constrained to be <= 128 bytes.
map<string, string> labels = 5;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Labels are attributes that can be set and used by both the
user and by Google Cloud Deploy. Labels must meet the following
constraints:
- Keys and values can contain only lowercase letters, numeric characters,
underscores, and dashes.
- All characters must use UTF-8 encoding, and international characters are
allowed.
- Keys must start with a lowercase letter or international character.
- Each resource is limited to a maximum of 64 labels.
Both keys and values are additionally constrained to be <= 128 bytes.
map<string, string> labels = 5;
public Metadata getMetadata()
Output only. Metadata contains information about the rollout.
.google.cloud.deploy.v1.Metadata metadata = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
public MetadataOrBuilder getMetadataOrBuilder()
Output only. Metadata contains information about the rollout.
.google.cloud.deploy.v1.Metadata metadata = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
getName()
Optional. Name of the Rollout. Format is projects/{project}/
locations/{location}/deliveryPipelines/{deliveryPipeline}/
releases/{release}/rollouts/a-z{0,62}.
string name = 1 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Optional. Name of the Rollout. Format is projects/{project}/
locations/{location}/deliveryPipelines/{deliveryPipeline}/
releases/{release}/rollouts/a-z{0,62}.
string name = 1 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<Rollout> getParserForType()
Returns
Overrides
getPhases(int index)
public Phase getPhases(int index)
Output only. The phases that represent the workflows of this Rollout.
repeated .google.cloud.deploy.v1.Phase phases = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
getPhasesCount()
public int getPhasesCount()
Output only. The phases that represent the workflows of this Rollout.
repeated .google.cloud.deploy.v1.Phase phases = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
getPhasesList()
public List<Phase> getPhasesList()
Output only. The phases that represent the workflows of this Rollout.
repeated .google.cloud.deploy.v1.Phase phases = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
getPhasesOrBuilder(int index)
public PhaseOrBuilder getPhasesOrBuilder(int index)
Output only. The phases that represent the workflows of this Rollout.
repeated .google.cloud.deploy.v1.Phase phases = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
getPhasesOrBuilderList()
public List<? extends PhaseOrBuilder> getPhasesOrBuilderList()
Output only. The phases that represent the workflows of this Rollout.
repeated .google.cloud.deploy.v1.Phase phases = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| List<? extends com.google.cloud.deploy.v1.PhaseOrBuilder> | |
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getState()
public Rollout.State getState()
Output only. Current state of the Rollout.
.google.cloud.deploy.v1.Rollout.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public int getStateValue()
Output only. Current state of the Rollout.
.google.cloud.deploy.v1.Rollout.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The enum numeric value on the wire for state.
|
getTargetId()
public String getTargetId()
Required. The ID of Target to which this Rollout is deploying.
string target_id = 18 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The targetId.
|
getTargetIdBytes()
public ByteString getTargetIdBytes()
Required. The ID of Target to which this Rollout is deploying.
string target_id = 18 [(.google.api.field_behavior) = REQUIRED];
getUid()
Output only. Unique identifier of the Rollout.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUidBytes()
public ByteString getUidBytes()
Output only. Unique identifier of the Rollout.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasApproveTime()
public boolean hasApproveTime()
Output only. Time at which the Rollout was approved.
.google.protobuf.Timestamp approve_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the approveTime field is set.
|
hasCreateTime()
public boolean hasCreateTime()
Output only. Time at which the Rollout was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
hasDeployEndTime()
public boolean hasDeployEndTime()
Output only. Time at which the Rollout finished deploying.
.google.protobuf.Timestamp deploy_end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the deployEndTime field is set.
|
hasDeployStartTime()
public boolean hasDeployStartTime()
Output only. Time at which the Rollout started deploying.
.google.protobuf.Timestamp deploy_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the deployStartTime field is set.
|
hasEnqueueTime()
public boolean hasEnqueueTime()
Output only. Time at which the Rollout was enqueued.
.google.protobuf.Timestamp enqueue_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the enqueueTime field is set.
|
public boolean hasMetadata()
Output only. Metadata contains information about the rollout.
.google.cloud.deploy.v1.Metadata metadata = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the metadata field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Rollout.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Rollout.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Rollout.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
