Interface ReleaseOrBuilder (1.6.0)

Version 1.6.0

• 1.52.0 (latest)
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.8
• 1.0.2

public interface ReleaseOrBuilder 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 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

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

Name	Description
key	String

Returns

Type	Description
boolean

containsTargetArtifacts(String key)

public abstract boolean containsTargetArtifacts(String key)

Output only. Map from target ID to the target artifacts created during the render operation.

map<string, .google.cloud.deploy.v1.TargetArtifact> target_artifacts = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

containsTargetRenders(String key)

public abstract boolean containsTargetRenders(String key)

Output only. Map from target ID to details of the render operation for that target.

map<string, .google.cloud.deploy.v1.Release.TargetRender> target_renders = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

getAbandoned()

public abstract boolean getAbandoned()

Output only. Indicates whether this is an abandoned release.

bool abandoned = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	The abandoned.

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

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

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

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

Name	Description
key	String

Returns

Type	Description
String

getBuildArtifacts(int index)

public abstract BuildArtifact getBuildArtifacts(int index)

List of artifacts to pass through to Skaffold command.

repeated .google.cloud.deploy.v1.BuildArtifact build_artifacts = 10;

Parameter

Name	Description
index	int

Returns

Type	Description
BuildArtifact

getBuildArtifactsCount()

public abstract int getBuildArtifactsCount()

List of artifacts to pass through to Skaffold command.

repeated .google.cloud.deploy.v1.BuildArtifact build_artifacts = 10;

Returns

Type	Description
int

getBuildArtifactsList()

public abstract List<BuildArtifact> getBuildArtifactsList()

List of artifacts to pass through to Skaffold command.

repeated .google.cloud.deploy.v1.BuildArtifact build_artifacts = 10;

Returns

Type	Description
List<BuildArtifact>

getBuildArtifactsOrBuilder(int index)

public abstract BuildArtifactOrBuilder getBuildArtifactsOrBuilder(int index)

List of artifacts to pass through to Skaffold command.

repeated .google.cloud.deploy.v1.BuildArtifact build_artifacts = 10;

Parameter

Name	Description
index	int

Returns

Type	Description
BuildArtifactOrBuilder

getBuildArtifactsOrBuilderList()

public abstract List<? extends BuildArtifactOrBuilder> getBuildArtifactsOrBuilderList()

List of artifacts to pass through to Skaffold command.

repeated .google.cloud.deploy.v1.BuildArtifact build_artifacts = 10;

Returns

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

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Time at which the Release was created.

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

Returns

Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time at which the Release was created.

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

Returns

Type	Description
TimestampOrBuilder

getDeliveryPipelineSnapshot()

public abstract DeliveryPipeline getDeliveryPipelineSnapshot()

Output only. Snapshot of the parent pipeline taken at release creation time.

.google.cloud.deploy.v1.DeliveryPipeline delivery_pipeline_snapshot = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
DeliveryPipeline	The deliveryPipelineSnapshot.

getDeliveryPipelineSnapshotOrBuilder()

public abstract DeliveryPipelineOrBuilder getDeliveryPipelineSnapshotOrBuilder()

Output only. Snapshot of the parent pipeline taken at release creation time.

.google.cloud.deploy.v1.DeliveryPipeline delivery_pipeline_snapshot = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
DeliveryPipelineOrBuilder

getDescription()

public abstract String getDescription()

Description of the Release. Max length is 255 characters.

string description = 3;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Description of the Release. Max length is 255 characters.

string description = 3;

Returns

Type	Description
ByteString	The bytes for description.

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.

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

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

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

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

Name	Description
key	String

Returns

Type	Description
String

getName()

public abstract String getName()

Optional. Name of the Release. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/a-z{0,62}.

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

Returns

Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Optional. Name of the Release. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/a-z{0,62}.

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

Returns

Type	Description
ByteString	The bytes for name.

getRenderEndTime()

public abstract Timestamp getRenderEndTime()

Output only. Time at which the render completed.

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

Returns

Type	Description
Timestamp	The renderEndTime.

getRenderEndTimeOrBuilder()

public abstract TimestampOrBuilder getRenderEndTimeOrBuilder()

Output only. Time at which the render completed.

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

Returns

Type	Description
TimestampOrBuilder

getRenderStartTime()

public abstract Timestamp getRenderStartTime()

Output only. Time at which the render began.

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

Returns

Type	Description
Timestamp	The renderStartTime.

getRenderStartTimeOrBuilder()

public abstract TimestampOrBuilder getRenderStartTimeOrBuilder()

Output only. Time at which the render began.

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

Returns

Type	Description
TimestampOrBuilder

getRenderState()

public abstract Release.RenderState getRenderState()

Output only. Current state of the render operation.

.google.cloud.deploy.v1.Release.RenderState render_state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Release.RenderState	The renderState.

getRenderStateValue()

public abstract int getRenderStateValue()

Output only. Current state of the render operation.

.google.cloud.deploy.v1.Release.RenderState render_state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
int	The enum numeric value on the wire for renderState.

getSkaffoldConfigPath()

public abstract String getSkaffoldConfigPath()

Filepath of the Skaffold config inside of the config URI.

string skaffold_config_path = 9;

Returns

Type	Description
String	The skaffoldConfigPath.

getSkaffoldConfigPathBytes()

public abstract ByteString getSkaffoldConfigPathBytes()

Filepath of the Skaffold config inside of the config URI.

string skaffold_config_path = 9;

Returns

Type	Description
ByteString	The bytes for skaffoldConfigPath.

getSkaffoldConfigUri()

public abstract String getSkaffoldConfigUri()

Cloud Storage URI of tar.gz archive containing Skaffold configuration.

string skaffold_config_uri = 17;

Returns

Type	Description
String	The skaffoldConfigUri.

getSkaffoldConfigUriBytes()

public abstract ByteString getSkaffoldConfigUriBytes()

Cloud Storage URI of tar.gz archive containing Skaffold configuration.

string skaffold_config_uri = 17;

Returns

Type	Description
ByteString	The bytes for skaffoldConfigUri.

getSkaffoldVersion()

public abstract String getSkaffoldVersion()

The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Google Cloud Deploy supports a specific set of versions. If unset, the most recent supported Skaffold version will be used.

string skaffold_version = 19;

Returns

Type	Description
String	The skaffoldVersion.

getSkaffoldVersionBytes()

public abstract ByteString getSkaffoldVersionBytes()

The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Google Cloud Deploy supports a specific set of versions. If unset, the most recent supported Skaffold version will be used.

string skaffold_version = 19;

Returns

Type	Description
ByteString	The bytes for skaffoldVersion.

getTargetArtifacts()

public abstract Map<String,TargetArtifact> getTargetArtifacts()

Use #getTargetArtifactsMap() instead.

Returns

Type	Description
Map<String,TargetArtifact>

getTargetArtifactsCount()

public abstract int getTargetArtifactsCount()

Output only. Map from target ID to the target artifacts created during the render operation.

map<string, .google.cloud.deploy.v1.TargetArtifact> target_artifacts = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
int

getTargetArtifactsMap()

public abstract Map<String,TargetArtifact> getTargetArtifactsMap()

Output only. Map from target ID to the target artifacts created during the render operation.

map<string, .google.cloud.deploy.v1.TargetArtifact> target_artifacts = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Map<String,TargetArtifact>

getTargetArtifactsOrDefault(String key, TargetArtifact defaultValue)

public abstract TargetArtifact getTargetArtifactsOrDefault(String key, TargetArtifact defaultValue)

Output only. Map from target ID to the target artifacts created during the render operation.

map<string, .google.cloud.deploy.v1.TargetArtifact> target_artifacts = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters

Name	Description
key	String
defaultValue	TargetArtifact

Returns

Type	Description
TargetArtifact

getTargetArtifactsOrThrow(String key)

public abstract TargetArtifact getTargetArtifactsOrThrow(String key)

Output only. Map from target ID to the target artifacts created during the render operation.

map<string, .google.cloud.deploy.v1.TargetArtifact> target_artifacts = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
key	String

Returns

Type	Description
TargetArtifact

getTargetRenders()

public abstract Map<String,Release.TargetRender> getTargetRenders()

Use #getTargetRendersMap() instead.

Returns

Type	Description
Map<String,TargetRender>

getTargetRendersCount()

public abstract int getTargetRendersCount()

Output only. Map from target ID to details of the render operation for that target.

map<string, .google.cloud.deploy.v1.Release.TargetRender> target_renders = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
int

getTargetRendersMap()

public abstract Map<String,Release.TargetRender> getTargetRendersMap()

Output only. Map from target ID to details of the render operation for that target.

map<string, .google.cloud.deploy.v1.Release.TargetRender> target_renders = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Map<String,TargetRender>

getTargetRendersOrDefault(String key, Release.TargetRender defaultValue)

public abstract Release.TargetRender getTargetRendersOrDefault(String key, Release.TargetRender defaultValue)

Output only. Map from target ID to details of the render operation for that target.

map<string, .google.cloud.deploy.v1.Release.TargetRender> target_renders = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters

Name	Description
key	String
defaultValue	Release.TargetRender

Returns

Type	Description
Release.TargetRender

getTargetRendersOrThrow(String key)

public abstract Release.TargetRender getTargetRendersOrThrow(String key)

Output only. Map from target ID to details of the render operation for that target.

map<string, .google.cloud.deploy.v1.Release.TargetRender> target_renders = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
key	String

Returns

Type	Description
Release.TargetRender

getTargetSnapshots(int index)

public abstract Target getTargetSnapshots(int index)

Output only. Snapshot of the targets taken at release creation time.

repeated .google.cloud.deploy.v1.Target target_snapshots = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
index	int

Returns

Type	Description
Target

getTargetSnapshotsCount()

public abstract int getTargetSnapshotsCount()

Output only. Snapshot of the targets taken at release creation time.

repeated .google.cloud.deploy.v1.Target target_snapshots = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
int

getTargetSnapshotsList()

public abstract List<Target> getTargetSnapshotsList()

Output only. Snapshot of the targets taken at release creation time.

repeated .google.cloud.deploy.v1.Target target_snapshots = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
List<Target>

getTargetSnapshotsOrBuilder(int index)

public abstract TargetOrBuilder getTargetSnapshotsOrBuilder(int index)

Output only. Snapshot of the targets taken at release creation time.

repeated .google.cloud.deploy.v1.Target target_snapshots = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
index	int

Returns

Type	Description
TargetOrBuilder

getTargetSnapshotsOrBuilderList()

public abstract List<? extends TargetOrBuilder> getTargetSnapshotsOrBuilderList()

Output only. Snapshot of the targets taken at release creation time.

repeated .google.cloud.deploy.v1.Target target_snapshots = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

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

getUid()

public abstract String getUid()

Output only. Unique identifier of the Release.

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

Returns

Type	Description
String	The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. Unique identifier of the Release.

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

Returns

Type	Description
ByteString	The bytes for uid.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Time at which the Release was created.

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

Returns

Type	Description
boolean	Whether the createTime field is set.

hasDeliveryPipelineSnapshot()

public abstract boolean hasDeliveryPipelineSnapshot()

Output only. Snapshot of the parent pipeline taken at release creation time.

.google.cloud.deploy.v1.DeliveryPipeline delivery_pipeline_snapshot = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the deliveryPipelineSnapshot field is set.

hasRenderEndTime()

public abstract boolean hasRenderEndTime()

Output only. Time at which the render completed.

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

Returns

Type	Description
boolean	Whether the renderEndTime field is set.

hasRenderStartTime()

public abstract boolean hasRenderStartTime()

Output only. Time at which the render began.

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

Returns

Type	Description
boolean	Whether the renderStartTime field is set.