Class Rollout.Builder (1.1.3)

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

Implements

RolloutOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Rollout.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Rollout.Builder
Overrides

build()

public Rollout build()
Returns
TypeDescription
Rollout

buildPartial()

public Rollout buildPartial()
Returns
TypeDescription
Rollout

clear()

public Rollout.Builder clear()
Returns
TypeDescription
Rollout.Builder
Overrides

clearAnnotations()

public Rollout.Builder clearAnnotations()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
Rollout.Builder

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
TypeDescription
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
TypeDescription
Rollout.Builder

clearDeployFailureCause()

public Rollout.Builder clearDeployFailureCause()

Output only. The reason this deploy failed. This will always be unspecified while the deploy in progress.

.google.cloud.deploy.v1.Rollout.FailureCause deploy_failure_cause = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
Rollout.Builder

This builder for chaining.

clearFailureReason()

public Rollout.Builder clearFailureReason()

Output only. Reason the build failed. Empty if the build succeeded.

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

Returns
TypeDescription
Rollout.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Rollout.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Rollout.Builder
Overrides

clearLabels()

public Rollout.Builder clearLabels()
Returns
TypeDescription
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
TypeDescription
Rollout.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Rollout.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Rollout.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
Rollout.Builder

This builder for chaining.

clone()

public Rollout.Builder clone()
Returns
TypeDescription
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 Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

map<string, string> annotations = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getAnnotations()

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
TypeDescription
Map<String,String>

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;

Returns
TypeDescription
int

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;

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

map<string, string> annotations = 4;

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

map<string, string> annotations = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Rollout getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDeployFailureCause()

public Rollout.FailureCause getDeployFailureCause()

Output only. The reason this deploy failed. This will always be unspecified while the deploy in progress.

.google.cloud.deploy.v1.Rollout.FailureCause deploy_failure_cause = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Rollout.FailureCause

The deployFailureCause.

getDeployFailureCauseValue()

public int getDeployFailureCauseValue()

Output only. The reason this deploy failed. This will always be unspecified while the deploy in progress.

.google.cloud.deploy.v1.Rollout.FailureCause deploy_failure_cause = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 3;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for etag.

getFailureReason()

public String getFailureReason()

Output only. Reason the build failed. Empty if the build succeeded.

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

Returns
TypeDescription
String

The failureReason.

getFailureReasonBytes()

public ByteString getFailureReasonBytes()

Output only. Reason the build failed. Empty if the build succeeded.

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

Returns
TypeDescription
ByteString

The bytes for failureReason.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

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;

Returns
TypeDescription
int

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;

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

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMutableAnnotations()

public Map<String,String> getMutableAnnotations()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. Unique identifier of the Rollout.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the enqueueTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
Rollout.Builder

mergeFrom(Rollout other)

public Rollout.Builder mergeFrom(Rollout other)
Parameter
NameDescription
otherRollout
Returns
TypeDescription
Rollout.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Rollout.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rollout.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Rollout.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Rollout.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Rollout.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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 Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

map<string, string> annotations = 4;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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 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;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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 Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

map<string, string> annotations = 4;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
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 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;

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

map<string, string> annotations = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
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 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;

Parameter
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
valueRollout.ApprovalState

The approvalState to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for approvalState to set.

Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
Rollout.Builder

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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
Rollout.Builder

setDeployFailureCause(Rollout.FailureCause value)

public Rollout.Builder setDeployFailureCause(Rollout.FailureCause value)

Output only. The reason this deploy failed. This will always be unspecified while the deploy in progress.

.google.cloud.deploy.v1.Rollout.FailureCause deploy_failure_cause = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueRollout.FailureCause

The deployFailureCause to set.

Returns
TypeDescription
Rollout.Builder

This builder for chaining.

setDeployFailureCauseValue(int value)

public Rollout.Builder setDeployFailureCauseValue(int value)

Output only. The reason this deploy failed. This will always be unspecified while the deploy in progress.

.google.cloud.deploy.v1.Rollout.FailureCause deploy_failure_cause = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueint

The enum numeric value on the wire for deployFailureCause to set.

Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valueString

The deployingBuild to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for deployingBuild to set.

Returns
TypeDescription
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
NameDescription
valueString

The description to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valueString

The etag to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for etag to set.

Returns
TypeDescription
Rollout.Builder

This builder for chaining.

setFailureReason(String value)

public Rollout.Builder setFailureReason(String value)

Output only. Reason the build failed. Empty if the build succeeded.

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

Parameter
NameDescription
valueString

The failureReason to set.

Returns
TypeDescription
Rollout.Builder

This builder for chaining.

setFailureReasonBytes(ByteString value)

public Rollout.Builder setFailureReasonBytes(ByteString value)

Output only. Reason the build failed. Empty if the build succeeded.

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

Parameter
NameDescription
valueByteString

The bytes for failureReason to set.

Returns
TypeDescription
Rollout.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Rollout.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Rollout.Builder
Overrides

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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Rollout.Builder

This builder for chaining.

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

public Rollout.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Rollout.Builder
Overrides

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
NameDescription
valueRollout.State

The state to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
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
NameDescription
valueString

The targetId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for targetId to set.

Returns
TypeDescription
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
NameDescription
valueString

The uid to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for uid to set.

Returns
TypeDescription
Rollout.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Rollout.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Rollout.Builder
Overrides