Class Rollout.Builder (1.40.0) 

public static final class Rollout.Builder extends GeneratedMessageV3.Builder<Rollout.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Rollout.Builder

Implements

RolloutOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllPhases(Iterable<? extends Phase> values)

public Rollout.Builder addAllPhases(Iterable<? extends Phase> values)

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];

Parameter
Name Description
values Iterable<? extends com.google.cloud.deploy.v1.Phase>
Returns
Type Description
Rollout.Builder

addAllRolledBackByRollouts(Iterable<String> values)

public Rollout.Builder addAllRolledBackByRollouts(Iterable<String> values)

Output only. Names of Rollouts that rolled back this Rollout.

repeated string rolled_back_by_rollouts = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<String>

The rolledBackByRollouts to add.
Returns
Type Description
Rollout.Builder

This builder for chaining.

addPhases(Phase value)

public Rollout.Builder addPhases(Phase value)

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];

Parameter
Name Description
value Phase
Returns
Type Description
Rollout.Builder

addPhases(Phase.Builder builderForValue)

public Rollout.Builder addPhases(Phase.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Phase.Builder
Returns
Type Description
Rollout.Builder

addPhases(int index, Phase value)

public Rollout.Builder addPhases(int index, Phase value)

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];

Parameters
Name Description
index int
value Phase
Returns
Type Description
Rollout.Builder

addPhases(int index, Phase.Builder builderForValue)

public Rollout.Builder addPhases(int index, Phase.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Phase.Builder
Returns
Type Description
Rollout.Builder

addPhasesBuilder()

public Phase.Builder addPhasesBuilder()

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];

Returns
Type Description
Phase.Builder

addPhasesBuilder(int index)

public Phase.Builder addPhasesBuilder(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];

Parameter
Name Description
index int
Returns
Type Description
Phase.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Rollout.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Rollout.Builder
Overrides

addRolledBackByRollouts(String value)

public Rollout.Builder addRolledBackByRollouts(String value)

Output only. Names of Rollouts that rolled back this Rollout.

repeated string rolled_back_by_rollouts = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The rolledBackByRollouts to add.
Returns
Type Description
Rollout.Builder

This builder for chaining.

addRolledBackByRolloutsBytes(ByteString value)

public Rollout.Builder addRolledBackByRolloutsBytes(ByteString value)

Output only. Names of Rollouts that rolled back this Rollout.

repeated string rolled_back_by_rollouts = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes of the rolledBackByRollouts to add.
Returns
Type Description
Rollout.Builder

This builder for chaining.

build()

public Rollout build()
Returns
Type Description
Rollout

buildPartial()

public Rollout buildPartial()
Returns
Type Description
Rollout

clear()

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

clearAnnotations()

public Rollout.Builder clearAnnotations()
Returns
Type Description
Rollout.Builder

clearApprovalState()

public Rollout.Builder clearApprovalState()

Output only. Approval state of the Rollout.

.google.cloud.deploy.v1.Rollout.ApprovalState approval_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Rollout.Builder

This builder for chaining.

clearApproveTime()

public Rollout.Builder clearApproveTime()

Output only. Time at which the Rollout was approved.

.google.protobuf.Timestamp approve_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Rollout.Builder

clearControllerRollout()

public Rollout.Builder clearControllerRollout()

Output only. Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.

string controller_rollout = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Rollout.Builder

This builder for chaining.

clearCreateTime()

public Rollout.Builder clearCreateTime()

Output only. Time at which the Rollout was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Rollout.Builder

clearDeployEndTime()

public Rollout.Builder clearDeployEndTime()

Output only. Time at which the Rollout finished deploying.

.google.protobuf.Timestamp deploy_end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Rollout.Builder

clearDeployFailureCause()

public Rollout.Builder clearDeployFailureCause()

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];

Returns
Type Description
Rollout.Builder

This builder for chaining.

clearDeployStartTime()

public Rollout.Builder clearDeployStartTime()

Output only. Time at which the Rollout started deploying.

.google.protobuf.Timestamp deploy_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Rollout.Builder

clearDeployingBuild()

public Rollout.Builder clearDeployingBuild()

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) = { ... }

Returns
Type Description
Rollout.Builder

This builder for chaining.

clearDescription()

public Rollout.Builder clearDescription()

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

string description = 3;

Returns
Type Description
Rollout.Builder

This builder for chaining.

clearEnqueueTime()

public Rollout.Builder clearEnqueueTime()

Output only. Time at which the Rollout was enqueued.

.google.protobuf.Timestamp enqueue_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Rollout.Builder

clearEtag()

public Rollout.Builder clearEtag()

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;

Returns
Type Description
Rollout.Builder

This builder for chaining.

clearFailureReason()

public Rollout.Builder clearFailureReason()

Output only. Additional information about the rollout failure, if available.

string failure_reason = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Rollout.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Rollout.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Rollout.Builder
Overrides

clearLabels()

public Rollout.Builder clearLabels()
Returns
Type Description
Rollout.Builder

clearMetadata()

public Rollout.Builder clearMetadata()

Output only. Metadata contains information about the rollout.

.google.cloud.deploy.v1.Metadata metadata = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Rollout.Builder

clearName()

public Rollout.Builder clearName()

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];

Returns
Type Description
Rollout.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Rollout.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Rollout.Builder
Overrides

clearPhases()

public Rollout.Builder clearPhases()

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];

Returns
Type Description
Rollout.Builder

clearRollbackOfRollout()

public Rollout.Builder clearRollbackOfRollout()

Output only. Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn't created as a rollback.

string rollback_of_rollout = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Rollout.Builder

This builder for chaining.

clearRolledBackByRollouts()

public Rollout.Builder clearRolledBackByRollouts()

Output only. Names of Rollouts that rolled back this Rollout.

repeated string rolled_back_by_rollouts = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Rollout.Builder

This builder for chaining.

clearState()

public Rollout.Builder clearState()

Output only. Current state of the Rollout.

.google.cloud.deploy.v1.Rollout.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Rollout.Builder

This builder for chaining.

clearTargetId()

public Rollout.Builder clearTargetId()

Required. The ID of Target to which this Rollout is deploying.

string target_id = 18 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Rollout.Builder

This builder for chaining.

clearUid()

public Rollout.Builder clearUid()

Output only. Unique identifier of the Rollout.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Rollout.Builder

This builder for chaining.

clone()

public Rollout.Builder clone()
Returns
Type Description
Rollout.Builder
Overrides

containsAnnotations(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

public boolean containsLabels(String key)

Labels are attributes that can be set and used by both the user and by 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;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnnotations() (deprecated)

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

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;

Returns
Type Description
int

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;

Returns
Type Description
Map<String,String>

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 Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

map<string, string> annotations = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
String

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];

Returns
Type Description
Rollout.ApprovalState

The approvalState.

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];

Returns
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];

Returns
Type Description
Timestamp

The approveTime.

getApproveTimeBuilder()

public Timestamp.Builder getApproveTimeBuilder()

Output only. Time at which the Rollout was approved.

.google.protobuf.Timestamp approve_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

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];

Returns
Type Description
TimestampOrBuilder

getControllerRollout()

public String getControllerRollout()

Output only. Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.

string controller_rollout = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The controllerRollout.

getControllerRolloutBytes()

public ByteString getControllerRolloutBytes()

Output only. Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.

string controller_rollout = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for controllerRollout.

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];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Time at which the Rollout was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

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];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Rollout getDefaultInstanceForType()
Returns
Type Description
Rollout

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];

Returns
Type Description
Timestamp

The deployEndTime.

getDeployEndTimeBuilder()

public Timestamp.Builder getDeployEndTimeBuilder()

Output only. Time at which the Rollout finished deploying.

.google.protobuf.Timestamp deploy_end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

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];

Returns
Type Description
TimestampOrBuilder

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];

Returns
Type Description
Rollout.FailureCause

The deployFailureCause.

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];

Returns
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];

Returns
Type Description
Timestamp

The deployStartTime.

getDeployStartTimeBuilder()

public Timestamp.Builder getDeployStartTimeBuilder()

Output only. Time at which the Rollout started deploying.

.google.protobuf.Timestamp deploy_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

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];

Returns
Type Description
TimestampOrBuilder

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) = { ... }

Returns
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) = { ... }

Returns
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;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

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];

Returns
Type Description
Timestamp

The enqueueTime.

getEnqueueTimeBuilder()

public Timestamp.Builder getEnqueueTimeBuilder()

Output only. Time at which the Rollout was enqueued.

.google.protobuf.Timestamp enqueue_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

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];

Returns
Type Description
TimestampOrBuilder

getEtag()

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

string etag = 16;

Returns
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;

Returns
Type Description
ByteString

The bytes for etag.

getFailureReason()

public String getFailureReason()

Output only. Additional information about the rollout failure, if available.

string failure_reason = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
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];

Returns
Type Description
ByteString

The bytes for failureReason.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels are attributes that can be set and used by both the user and by 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;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels are attributes that can be set and used by both the user and by 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;

Returns
Type Description
Map<String,String>

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 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;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels are attributes that can be set and used by both the user and by 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;

Parameter
Name Description
key String
Returns
Type Description
String

getMetadata()

public Metadata getMetadata()

Output only. Metadata contains information about the rollout.

.google.cloud.deploy.v1.Metadata metadata = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Metadata

The metadata.

getMetadataBuilder()

public Metadata.Builder getMetadataBuilder()

Output only. Metadata contains information about the rollout.

.google.cloud.deploy.v1.Metadata metadata = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Metadata.Builder

getMetadataOrBuilder()

public MetadataOrBuilder getMetadataOrBuilder()

Output only. Metadata contains information about the rollout.

.google.cloud.deploy.v1.Metadata metadata = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MetadataOrBuilder

getMutableAnnotations() (deprecated)

public Map<String,String> getMutableAnnotations()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String 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];

Returns
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];

Returns
Type Description
ByteString

The bytes for name.

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];

Parameter
Name Description
index int
Returns
Type Description
Phase

getPhasesBuilder(int index)

public Phase.Builder getPhasesBuilder(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];

Parameter
Name Description
index int
Returns
Type Description
Phase.Builder

getPhasesBuilderList()

public List<Phase.Builder> getPhasesBuilderList()

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];

Returns
Type Description
List<Builder>

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];

Returns
Type Description
int

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];

Returns
Type Description
List<Phase>

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];

Parameter
Name Description
index int
Returns
Type Description
PhaseOrBuilder

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];

Returns
Type Description
List<? extends com.google.cloud.deploy.v1.PhaseOrBuilder>

getRollbackOfRollout()

public String getRollbackOfRollout()

Output only. Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn't created as a rollback.

string rollback_of_rollout = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The rollbackOfRollout.

getRollbackOfRolloutBytes()

public ByteString getRollbackOfRolloutBytes()

Output only. Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn't created as a rollback.

string rollback_of_rollout = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for rollbackOfRollout.

getRolledBackByRollouts(int index)

public String getRolledBackByRollouts(int index)

Output only. Names of Rollouts that rolled back this Rollout.

repeated string rolled_back_by_rollouts = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The rolledBackByRollouts at the given index.

getRolledBackByRolloutsBytes(int index)

public ByteString getRolledBackByRolloutsBytes(int index)

Output only. Names of Rollouts that rolled back this Rollout.

repeated string rolled_back_by_rollouts = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the rolledBackByRollouts at the given index.

getRolledBackByRolloutsCount()

public int getRolledBackByRolloutsCount()

Output only. Names of Rollouts that rolled back this Rollout.

repeated string rolled_back_by_rollouts = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of rolledBackByRollouts.

getRolledBackByRolloutsList()

public ProtocolStringList getRolledBackByRolloutsList()

Output only. Names of Rollouts that rolled back this Rollout.

repeated string rolled_back_by_rollouts = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the rolledBackByRollouts.

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];

Returns
Type Description
Rollout.State

The state.

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];

Returns
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];

Returns
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];

Returns
Type Description
ByteString

The bytes for targetId.

getUid()

public String getUid()

Output only. Unique identifier of the Rollout.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. Unique identifier of the Rollout.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

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];

Returns
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];

Returns
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];

Returns
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];

Returns
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];

Returns
Type Description
boolean

Whether the enqueueTime field is set.

hasMetadata()

public boolean hasMetadata()

Output only. Metadata contains information about the rollout.

.google.cloud.deploy.v1.Metadata metadata = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the metadata field is set.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeApproveTime(Timestamp value)

public Rollout.Builder mergeApproveTime(Timestamp value)

Output only. Time at which the Rollout was approved.

.google.protobuf.Timestamp approve_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Rollout.Builder

mergeCreateTime(Timestamp value)

public Rollout.Builder mergeCreateTime(Timestamp value)

Output only. Time at which the Rollout was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Rollout.Builder

mergeDeployEndTime(Timestamp value)

public Rollout.Builder mergeDeployEndTime(Timestamp value)

Output only. Time at which the Rollout finished deploying.

.google.protobuf.Timestamp deploy_end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Rollout.Builder

mergeDeployStartTime(Timestamp value)

public Rollout.Builder mergeDeployStartTime(Timestamp value)

Output only. Time at which the Rollout started deploying.

.google.protobuf.Timestamp deploy_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Rollout.Builder

mergeEnqueueTime(Timestamp value)

public Rollout.Builder mergeEnqueueTime(Timestamp value)

Output only. Time at which the Rollout was enqueued.

.google.protobuf.Timestamp enqueue_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Rollout.Builder

mergeFrom(Rollout other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeMetadata(Metadata value)

public Rollout.Builder mergeMetadata(Metadata value)

Output only. Metadata contains information about the rollout.

.google.cloud.deploy.v1.Metadata metadata = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Metadata
Returns
Type Description
Rollout.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Rollout.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Rollout.Builder
Overrides

putAllAnnotations(Map<String,String> values)

public Rollout.Builder putAllAnnotations(Map<String,String> values)

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;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Rollout.Builder

putAllLabels(Map<String,String> values)

public Rollout.Builder putAllLabels(Map<String,String> values)

Labels are attributes that can be set and used by both the user and by 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;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Rollout.Builder

putAnnotations(String key, String value)

public Rollout.Builder putAnnotations(String key, String value)

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;

Parameters
Name Description
key String
value String
Returns
Type Description
Rollout.Builder

putLabels(String key, String value)

public Rollout.Builder putLabels(String key, String value)

Labels are attributes that can be set and used by both the user and by 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;

Parameters
Name Description
key String
value String
Returns
Type Description
Rollout.Builder

removeAnnotations(String key)

public Rollout.Builder removeAnnotations(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;

Parameter
Name Description
key String
Returns
Type Description
Rollout.Builder

removeLabels(String key)

public Rollout.Builder removeLabels(String key)

Labels are attributes that can be set and used by both the user and by 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;

Parameter
Name Description
key String
Returns
Type Description
Rollout.Builder

removePhases(int index)

public Rollout.Builder removePhases(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];

Parameter
Name Description
index int
Returns
Type Description
Rollout.Builder

setApprovalState(Rollout.ApprovalState value)

public Rollout.Builder setApprovalState(Rollout.ApprovalState value)

Output only. Approval state of the Rollout.

.google.cloud.deploy.v1.Rollout.ApprovalState approval_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Rollout.ApprovalState

The approvalState to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setApprovalStateValue(int value)

public Rollout.Builder setApprovalStateValue(int value)

Output only. Approval state of the Rollout.

.google.cloud.deploy.v1.Rollout.ApprovalState approval_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for approvalState to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setApproveTime(Timestamp value)

public Rollout.Builder setApproveTime(Timestamp value)

Output only. Time at which the Rollout was approved.

.google.protobuf.Timestamp approve_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Rollout.Builder

setApproveTime(Timestamp.Builder builderForValue)

public Rollout.Builder setApproveTime(Timestamp.Builder builderForValue)

Output only. Time at which the Rollout was approved.

.google.protobuf.Timestamp approve_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Rollout.Builder

setControllerRollout(String value)

public Rollout.Builder setControllerRollout(String value)

Output only. Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.

string controller_rollout = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The controllerRollout to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setControllerRolloutBytes(ByteString value)

public Rollout.Builder setControllerRolloutBytes(ByteString value)

Output only. Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/a-z{0,62}.

string controller_rollout = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for controllerRollout to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Rollout.Builder setCreateTime(Timestamp value)

Output only. Time at which the Rollout was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Rollout.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Rollout.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time at which the Rollout was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Rollout.Builder

setDeployEndTime(Timestamp value)

public Rollout.Builder setDeployEndTime(Timestamp value)

Output only. Time at which the Rollout finished deploying.

.google.protobuf.Timestamp deploy_end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Rollout.Builder

setDeployEndTime(Timestamp.Builder builderForValue)

public Rollout.Builder setDeployEndTime(Timestamp.Builder builderForValue)

Output only. Time at which the Rollout finished deploying.

.google.protobuf.Timestamp deploy_end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Rollout.Builder

setDeployFailureCause(Rollout.FailureCause value)

public Rollout.Builder setDeployFailureCause(Rollout.FailureCause value)

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];

Parameter
Name Description
value Rollout.FailureCause

The deployFailureCause to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setDeployFailureCauseValue(int value)

public Rollout.Builder setDeployFailureCauseValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for deployFailureCause to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setDeployStartTime(Timestamp value)

public Rollout.Builder setDeployStartTime(Timestamp value)

Output only. Time at which the Rollout started deploying.

.google.protobuf.Timestamp deploy_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Rollout.Builder

setDeployStartTime(Timestamp.Builder builderForValue)

public Rollout.Builder setDeployStartTime(Timestamp.Builder builderForValue)

Output only. Time at which the Rollout started deploying.

.google.protobuf.Timestamp deploy_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Rollout.Builder

setDeployingBuild(String value)

public Rollout.Builder setDeployingBuild(String value)

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) = { ... }

Parameter
Name Description
value String

The deployingBuild to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setDeployingBuildBytes(ByteString value)

public Rollout.Builder setDeployingBuildBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for deployingBuild to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setDescription(String value)

public Rollout.Builder setDescription(String value)

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

string description = 3;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Rollout.Builder setDescriptionBytes(ByteString value)

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

string description = 3;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setEnqueueTime(Timestamp value)

public Rollout.Builder setEnqueueTime(Timestamp value)

Output only. Time at which the Rollout was enqueued.

.google.protobuf.Timestamp enqueue_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Rollout.Builder

setEnqueueTime(Timestamp.Builder builderForValue)

public Rollout.Builder setEnqueueTime(Timestamp.Builder builderForValue)

Output only. Time at which the Rollout was enqueued.

.google.protobuf.Timestamp enqueue_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Rollout.Builder

setEtag(String value)

public Rollout.Builder setEtag(String value)

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;

Parameter
Name Description
value String

The etag to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Rollout.Builder setEtagBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for etag to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setFailureReason(String value)

public Rollout.Builder setFailureReason(String value)

Output only. Additional information about the rollout failure, if available.

string failure_reason = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The failureReason to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setFailureReasonBytes(ByteString value)

public Rollout.Builder setFailureReasonBytes(ByteString value)

Output only. Additional information about the rollout failure, if available.

string failure_reason = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for failureReason to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Rollout.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Rollout.Builder
Overrides

setMetadata(Metadata value)

public Rollout.Builder setMetadata(Metadata value)

Output only. Metadata contains information about the rollout.

.google.cloud.deploy.v1.Metadata metadata = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Metadata
Returns
Type Description
Rollout.Builder

setMetadata(Metadata.Builder builderForValue)

public Rollout.Builder setMetadata(Metadata.Builder builderForValue)

Output only. Metadata contains information about the rollout.

.google.cloud.deploy.v1.Metadata metadata = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Metadata.Builder
Returns
Type Description
Rollout.Builder

setName(String value)

public Rollout.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Rollout.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setPhases(int index, Phase value)

public Rollout.Builder setPhases(int index, Phase value)

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];

Parameters
Name Description
index int
value Phase
Returns
Type Description
Rollout.Builder

setPhases(int index, Phase.Builder builderForValue)

public Rollout.Builder setPhases(int index, Phase.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Phase.Builder
Returns
Type Description
Rollout.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Rollout.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Rollout.Builder
Overrides

setRollbackOfRollout(String value)

public Rollout.Builder setRollbackOfRollout(String value)

Output only. Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn't created as a rollback.

string rollback_of_rollout = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The rollbackOfRollout to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setRollbackOfRolloutBytes(ByteString value)

public Rollout.Builder setRollbackOfRolloutBytes(ByteString value)

Output only. Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn't created as a rollback.

string rollback_of_rollout = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for rollbackOfRollout to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setRolledBackByRollouts(int index, String value)

public Rollout.Builder setRolledBackByRollouts(int index, String value)

Output only. Names of Rollouts that rolled back this Rollout.

repeated string rolled_back_by_rollouts = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int

The index to set the value at.
value String

The rolledBackByRollouts to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setState(Rollout.State value)

public Rollout.Builder setState(Rollout.State value)

Output only. Current state of the Rollout.

.google.cloud.deploy.v1.Rollout.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Rollout.State

The state to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setStateValue(int value)

public Rollout.Builder setStateValue(int value)

Output only. Current state of the Rollout.

.google.cloud.deploy.v1.Rollout.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setTargetId(String value)

public Rollout.Builder setTargetId(String value)

Required. The ID of Target to which this Rollout is deploying.

string target_id = 18 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The targetId to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setTargetIdBytes(ByteString value)

public Rollout.Builder setTargetIdBytes(ByteString value)

Required. The ID of Target to which this Rollout is deploying.

string target_id = 18 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for targetId to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setUid(String value)

public Rollout.Builder setUid(String value)

Output only. Unique identifier of the Rollout.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The uid to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setUidBytes(ByteString value)

public Rollout.Builder setUidBytes(ByteString value)

Output only. Unique identifier of the Rollout.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for uid to set.
Returns
Type Description
Rollout.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Rollout.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Rollout.Builder
Overrides