Interface RolloutOrBuilder (0.16.0)

public interface RolloutOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract 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 abstract 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()

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type	Description
`Map<String,String>`

getAnnotationsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract Rollout.ApprovalState getApprovalState()

Output only. Approval state of the Rollout.

.google.events.cloud.deploy.v1.Rollout.ApprovalState approval_state = 12;

Returns
Type	Description
`Rollout.ApprovalState`	The approvalState.

getApprovalStateValue()

public abstract int getApprovalStateValue()

Output only. Approval state of the Rollout.

.google.events.cloud.deploy.v1.Rollout.ApprovalState approval_state = 12;

Returns
Type	Description
`int`	The enum numeric value on the wire for approvalState.

getApproveTime()

public abstract Timestamp getApproveTime()

Output only. Time at which the Rollout was approved.

.google.protobuf.Timestamp approve_time = 7;

Returns
Type	Description
`Timestamp`	The approveTime.

getApproveTimeOrBuilder()

public abstract TimestampOrBuilder getApproveTimeOrBuilder()

Output only. Time at which the Rollout was approved.

.google.protobuf.Timestamp approve_time = 7;

Returns
Type	Description
`TimestampOrBuilder`

getControllerRollout()

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

Returns
Type	Description
`String`	The controllerRollout.

getControllerRolloutBytes()

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

Returns
Type	Description
`ByteString`	The bytes for controllerRollout.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Time at which the Rollout was created.

.google.protobuf.Timestamp create_time = 6;

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time at which the Rollout was created.

.google.protobuf.Timestamp create_time = 6;

Returns
Type	Description
`TimestampOrBuilder`

getDeployEndTime()

public abstract Timestamp getDeployEndTime()

Output only. Time at which the Rollout finished deploying.

.google.protobuf.Timestamp deploy_end_time = 10;

Returns
Type	Description
`Timestamp`	The deployEndTime.

getDeployEndTimeOrBuilder()

public abstract TimestampOrBuilder getDeployEndTimeOrBuilder()

Output only. Time at which the Rollout finished deploying.

.google.protobuf.Timestamp deploy_end_time = 10;

Returns
Type	Description
`TimestampOrBuilder`

getDeployFailureCause()

public abstract Rollout.FailureCause getDeployFailureCause()

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

.google.events.cloud.deploy.v1.Rollout.FailureCause deploy_failure_cause = 19;

Returns
Type	Description
`Rollout.FailureCause`	The deployFailureCause.

getDeployFailureCauseValue()

public abstract int getDeployFailureCauseValue()

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

.google.events.cloud.deploy.v1.Rollout.FailureCause deploy_failure_cause = 19;

Returns
Type	Description
`int`	The enum numeric value on the wire for deployFailureCause.

getDeployStartTime()

public abstract Timestamp getDeployStartTime()

Output only. Time at which the Rollout started deploying.

.google.protobuf.Timestamp deploy_start_time = 9;

Returns
Type	Description
`Timestamp`	The deployStartTime.

getDeployStartTimeOrBuilder()

public abstract TimestampOrBuilder getDeployStartTimeOrBuilder()

Output only. Time at which the Rollout started deploying.

.google.protobuf.Timestamp deploy_start_time = 9;

Returns
Type	Description
`TimestampOrBuilder`

getDeployingBuild()

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

Returns
Type	Description
`String`	The deployingBuild.

getDeployingBuildBytes()

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

Returns
Type	Description
`ByteString`	The bytes for deployingBuild.

getDescription()

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

getEnqueueTime()

public abstract Timestamp getEnqueueTime()

Output only. Time at which the Rollout was enqueued.

.google.protobuf.Timestamp enqueue_time = 8;

Returns
Type	Description
`Timestamp`	The enqueueTime.

getEnqueueTimeOrBuilder()

public abstract TimestampOrBuilder getEnqueueTimeOrBuilder()

Output only. Time at which the Rollout was enqueued.

.google.protobuf.Timestamp enqueue_time = 8;

Returns
Type	Description
`TimestampOrBuilder`

getEtag()

public abstract 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 abstract 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 abstract String getFailureReason()

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

string failure_reason = 14;

Returns
Type	Description
`String`	The failureReason.

getFailureReasonBytes()

public abstract ByteString getFailureReasonBytes()

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

string failure_reason = 14;

Returns
Type	Description
`ByteString`	The bytes for failureReason.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract Metadata getMetadata()

Output only. Metadata contains information about the rollout.

.google.events.cloud.deploy.v1.Metadata metadata = 24;

Returns
Type	Description
`Metadata`	The metadata.

getMetadataOrBuilder()

public abstract MetadataOrBuilder getMetadataOrBuilder()

Output only. Metadata contains information about the rollout.

.google.events.cloud.deploy.v1.Metadata metadata = 24;

Returns
Type	Description
`MetadataOrBuilder`

getName()

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

Returns
Type	Description
`String`	The name.

getNameBytes()

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

Returns
Type	Description
`ByteString`	The bytes for name.