Google Cloud Deploy V1 API - Class Google::Cloud::Deploy::V1::Release (v0.4.0)

Reference documentation and code samples for the Google Cloud Deploy V1 API class Google::Cloud::Deploy::V1::Release.

A Release resource in the Google Cloud Deploy API.

A Release defines a specific Skaffold configuration instance that can be deployed.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#abandoned

def abandoned() -> ::Boolean

Returns

(::Boolean) — Output only. Indicates whether this is an abandoned release.

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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.

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — 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.

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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.

#build_artifacts

def build_artifacts() -> ::Array<::Google::Cloud::Deploy::V1::BuildArtifact>

Returns

(::Array<::Google::Cloud::Deploy::V1::BuildArtifact>) — List of artifacts to pass through to Skaffold command.

#build_artifacts=

def build_artifacts=(value) -> ::Array<::Google::Cloud::Deploy::V1::BuildArtifact>

Parameter

value (::Array<::Google::Cloud::Deploy::V1::BuildArtifact>) — List of artifacts to pass through to Skaffold command.

Returns

(::Array<::Google::Cloud::Deploy::V1::BuildArtifact>) — List of artifacts to pass through to Skaffold command.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time at which the Release was created.

#delivery_pipeline_snapshot

def delivery_pipeline_snapshot() -> ::Google::Cloud::Deploy::V1::DeliveryPipeline

Returns

(::Google::Cloud::Deploy::V1::DeliveryPipeline) — Output only. Snapshot of the parent pipeline taken at release creation time.

#description

def description() -> ::String

Returns

(::String) — Description of the Release. Max length is 255 characters.

#description=

def description=(value) -> ::String

Parameter

value (::String) — Description of the Release. Max length is 255 characters.

Returns

(::String) — Description of the Release. Max length is 255 characters.

#etag

def etag() -> ::String

Returns

(::String) — 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.

#etag=

def etag=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — 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.

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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.

#name

def name() -> ::String

Returns

(::String) — Optional. Name of the Release. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/[a-z][a-z0-9-]{0,62}.

#name=

def name=(value) -> ::String

Parameter

value (::String) — Optional. Name of the Release. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/[a-z][a-z0-9-]{0,62}.

Returns

(::String) — Optional. Name of the Release. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/[a-z][a-z0-9-]{0,62}.

#render_end_time

def render_end_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time at which the render completed.

#render_start_time

def render_start_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time at which the render began.

#render_state

def render_state() -> ::Google::Cloud::Deploy::V1::Release::RenderState

Returns

(::Google::Cloud::Deploy::V1::Release::RenderState) — Output only. Current state of the render operation.

#skaffold_config_path

def skaffold_config_path() -> ::String

Returns

(::String) — Filepath of the Skaffold config inside of the config URI.

#skaffold_config_path=

def skaffold_config_path=(value) -> ::String

Parameter

value (::String) — Filepath of the Skaffold config inside of the config URI.

Returns

(::String) — Filepath of the Skaffold config inside of the config URI.

#skaffold_config_uri

def skaffold_config_uri() -> ::String

Returns

(::String) — Cloud Storage URI of tar.gz archive containing Skaffold configuration.

#skaffold_config_uri=

def skaffold_config_uri=(value) -> ::String

Parameter

value (::String) — Cloud Storage URI of tar.gz archive containing Skaffold configuration.

Returns

(::String) — Cloud Storage URI of tar.gz archive containing Skaffold configuration.

#skaffold_version

def skaffold_version() -> ::String

Returns

(::String) — 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.

#skaffold_version=

def skaffold_version=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#target_artifacts

def target_artifacts() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Deploy::V1::TargetArtifact}

Returns

(::Google::Protobuf::Map{::String => ::Google::Cloud::Deploy::V1::TargetArtifact}) — Output only. Map from target ID to the target artifacts created during the render operation.

#target_renders

def target_renders() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Deploy::V1::Release::TargetRender}

Returns

(::Google::Protobuf::Map{::String => ::Google::Cloud::Deploy::V1::Release::TargetRender}) — Output only. Map from target ID to details of the render operation for that target.

#target_snapshots

def target_snapshots() -> ::Array<::Google::Cloud::Deploy::V1::Target>

Returns

(::Array<::Google::Cloud::Deploy::V1::Target>) — Output only. Snapshot of the targets taken at release creation time.

#uid

def uid() -> ::String

Returns

(::String) — Output only. Unique identifier of the Release.