public final class Release extends GeneratedMessageV3 implements ReleaseOrBuilder
A Release
resource in the Google Cloud Deploy API.
A Release
defines a specific Skaffold configuration instance
that can be deployed.
Protobuf type google.cloud.deploy.v1.Release
Static Fields
ABANDONED_FIELD_NUMBER
public static final int ABANDONED_FIELD_NUMBER
Field Value
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
BUILD_ARTIFACTS_FIELD_NUMBER
public static final int BUILD_ARTIFACTS_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DELIVERY_PIPELINE_SNAPSHOT_FIELD_NUMBER
public static final int DELIVERY_PIPELINE_SNAPSHOT_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
RENDER_END_TIME_FIELD_NUMBER
public static final int RENDER_END_TIME_FIELD_NUMBER
Field Value
RENDER_START_TIME_FIELD_NUMBER
public static final int RENDER_START_TIME_FIELD_NUMBER
Field Value
RENDER_STATE_FIELD_NUMBER
public static final int RENDER_STATE_FIELD_NUMBER
Field Value
SKAFFOLD_CONFIG_PATH_FIELD_NUMBER
public static final int SKAFFOLD_CONFIG_PATH_FIELD_NUMBER
Field Value
SKAFFOLD_CONFIG_URI_FIELD_NUMBER
public static final int SKAFFOLD_CONFIG_URI_FIELD_NUMBER
Field Value
SKAFFOLD_VERSION_FIELD_NUMBER
public static final int SKAFFOLD_VERSION_FIELD_NUMBER
Field Value
TARGET_ARTIFACTS_FIELD_NUMBER
public static final int TARGET_ARTIFACTS_FIELD_NUMBER
Field Value
TARGET_RENDERS_FIELD_NUMBER
public static final int TARGET_RENDERS_FIELD_NUMBER
Field Value
TARGET_SNAPSHOTS_FIELD_NUMBER
public static final int TARGET_SNAPSHOTS_FIELD_NUMBER
Field Value
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Release getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Release.Builder newBuilder()
Returns
newBuilder(Release prototype)
public static Release.Builder newBuilder(Release prototype)
Parameter
Returns
public static Release parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Release parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Release parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Release parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Release parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Release parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Release parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Release parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Release parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Release parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Release parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Release parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Release> parser()
Returns
Methods
containsAnnotations(String key)
public boolean containsAnnotations(String key)
User annotations. These attributes can only be set and used by the
user, and not by Google Cloud Deploy. See
https://google.aip.dev/128#annotations for more details such as format and
size limitations.
map<string, string> annotations = 4;
Parameter
Returns
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
Returns
containsTargetArtifacts(String key)
public 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
Returns
containsTargetRenders(String key)
public 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
Returns
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAbandoned()
public 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 Map<String,String> getAnnotations()
Returns
getAnnotationsCount()
public int getAnnotationsCount()
User annotations. These attributes can only be set and used by the
user, and not by Google Cloud Deploy. See
https://google.aip.dev/128#annotations for more details such as format and
size limitations.
map<string, string> annotations = 4;
Returns
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
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
Returns
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
Returns
getBuildArtifacts(int index)
public BuildArtifact getBuildArtifacts(int index)
List of artifacts to pass through to Skaffold command.
repeated .google.cloud.deploy.v1.BuildArtifact build_artifacts = 10;
Parameter
Returns
getBuildArtifactsCount()
public int getBuildArtifactsCount()
List of artifacts to pass through to Skaffold command.
repeated .google.cloud.deploy.v1.BuildArtifact build_artifacts = 10;
Returns
getBuildArtifactsList()
public List<BuildArtifact> getBuildArtifactsList()
List of artifacts to pass through to Skaffold command.
repeated .google.cloud.deploy.v1.BuildArtifact build_artifacts = 10;
Returns
getBuildArtifactsOrBuilder(int index)
public BuildArtifactOrBuilder getBuildArtifactsOrBuilder(int index)
List of artifacts to pass through to Skaffold command.
repeated .google.cloud.deploy.v1.BuildArtifact build_artifacts = 10;
Parameter
Returns
getBuildArtifactsOrBuilderList()
public 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 Timestamp getCreateTime()
Output only. Time at which the Release
was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time at which the Release
was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getDefaultInstanceForType()
public Release getDefaultInstanceForType()
Returns
getDeliveryPipelineSnapshot()
public 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
getDeliveryPipelineSnapshotOrBuilder()
public 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
getDescription()
public String getDescription()
Description of the Release
. Max length is 255 characters.
string description = 3;
Returns
Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Description of the Release
. Max length is 255 characters.
string description = 3;
Returns
Type | Description |
ByteString | The bytes for description.
|
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
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
Labels are attributes that can be set and used by both the
user and by Google Cloud Deploy. Labels must meet the following
constraints:
- Keys and values can contain only lowercase letters, numeric characters,
underscores, and dashes.
- All characters must use UTF-8 encoding, and international characters are
allowed.
- Keys must start with a lowercase letter or international character.
- Each resource is limited to a maximum of 64 labels.
Both keys and values are additionally constrained to be <= 128 bytes.
map<string, string> labels = 5;
Returns
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
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
Returns
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
Returns
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 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
getParserForType()
public Parser<Release> getParserForType()
Returns
Overrides
getRenderEndTime()
public Timestamp getRenderEndTime()
Output only. Time at which the render completed.
.google.protobuf.Timestamp render_end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getRenderEndTimeOrBuilder()
public TimestampOrBuilder getRenderEndTimeOrBuilder()
Output only. Time at which the render completed.
.google.protobuf.Timestamp render_end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getRenderStartTime()
public Timestamp getRenderStartTime()
Output only. Time at which the render began.
.google.protobuf.Timestamp render_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getRenderStartTimeOrBuilder()
public TimestampOrBuilder getRenderStartTimeOrBuilder()
Output only. Time at which the render began.
.google.protobuf.Timestamp render_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getRenderState()
public 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
getRenderStateValue()
public 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.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSkaffoldConfigPath()
public 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 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 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 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 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 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 Map<String,TargetArtifact> getTargetArtifacts()
Returns
getTargetArtifactsCount()
public 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
getTargetArtifactsMap()
public 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
getTargetArtifactsOrDefault(String key, TargetArtifact defaultValue)
public 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
Returns
getTargetArtifactsOrThrow(String key)
public 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
Returns
getTargetRenders()
public Map<String,Release.TargetRender> getTargetRenders()
Returns
getTargetRendersCount()
public 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
getTargetRendersMap()
public 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
getTargetRendersOrDefault(String key, Release.TargetRender defaultValue)
public 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
Returns
getTargetRendersOrThrow(String key)
public 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
Returns
getTargetSnapshots(int index)
public 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
Returns
getTargetSnapshotsCount()
public 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
getTargetSnapshotsList()
public 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
getTargetSnapshotsOrBuilder(int index)
public 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
Returns
getTargetSnapshotsOrBuilderList()
public 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()
Output only. Unique identifier of the Release
.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getUidBytes()
public ByteString getUidBytes()
Output only. Unique identifier of the Release
.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasCreateTime()
public 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 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 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 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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Release.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Release.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Release.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions