Reference documentation and code samples for the Google Cloud Deploy V1 Client class Release.
A Release
resource in the Cloud Deploy API.
A Release
defines a specific Skaffold configuration instance
that can be deployed.
Generated from protobuf message google.cloud.deploy.v1.Release
Namespace
Google \ Cloud \ Deploy \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Optional. Name of the Release
. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}
. The release
component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?
↳ uid
string
Output only. Unique identifier of the Release
.
↳ description
string
Description of the Release
. Max length is 255 characters.
↳ annotations
array| Google\Protobuf\Internal\MapField
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.
↳ labels
array| Google\Protobuf\Internal\MapField
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.
↳ abandoned
bool
Output only. Indicates whether this is an abandoned release.
↳ create_time
↳ render_start_time
↳ render_end_time
↳ skaffold_config_uri
string
Cloud Storage URI of tar.gz archive containing Skaffold configuration.
↳ skaffold_config_path
string
Filepath of the Skaffold config inside of the config URI.
↳ build_artifacts
array< Google\Cloud\Deploy\V1\BuildArtifact
>
List of artifacts to pass through to Skaffold command.
↳ delivery_pipeline_snapshot
Google\Cloud\Deploy\V1\DeliveryPipeline
Output only. Snapshot of the parent pipeline taken at release creation time.
↳ target_snapshots
array< Google\Cloud\Deploy\V1\Target
>
Output only. Snapshot of the targets taken at release creation time.
↳ custom_target_type_snapshots
array< Google\Cloud\Deploy\V1\CustomTargetType
>
Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.
↳ render_state
int
Output only. Current state of the render operation.
↳ etag
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.
↳ skaffold_version
string
The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set of versions. If unset, the most recent supported Skaffold version will be used.
↳ target_artifacts
array| Google\Protobuf\Internal\MapField
Output only. Map from target ID to the target artifacts created during the render operation.
↳ target_renders
array| Google\Protobuf\Internal\MapField
Output only. Map from target ID to details of the render operation for that target.
↳ condition
Google\Cloud\Deploy\V1\Release\ReleaseCondition
Output only. Information around the state of the Release.
↳ deploy_parameters
array| Google\Protobuf\Internal\MapField
Optional. The deploy parameters to use for all targets in this release.
getName
Optional. Name of the Release
. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}
.
The release
component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?
string
setName
Optional. Name of the Release
. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}
.
The release
component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?
var
string
$this
getUid
Output only. Unique identifier of the Release
.
string
setUid
Output only. Unique identifier of the Release
.
var
string
$this
getDescription
Description of the Release
. Max length is 255 characters.
string
setDescription
Description of the Release
. Max length is 255 characters.
var
string
$this
getAnnotations
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.
setAnnotations
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.
$this
getLabels
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.
setLabels
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.
$this
getAbandoned
Output only. Indicates whether this is an abandoned release.
bool
setAbandoned
Output only. Indicates whether this is an abandoned release.
var
bool
$this
getCreateTime
Output only. Time at which the Release
was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time at which the Release
was created.
$this
getRenderStartTime
Output only. Time at which the render began.
hasRenderStartTime
clearRenderStartTime
setRenderStartTime
Output only. Time at which the render began.
$this
getRenderEndTime
Output only. Time at which the render completed.
hasRenderEndTime
clearRenderEndTime
setRenderEndTime
Output only. Time at which the render completed.
$this
getSkaffoldConfigUri
Cloud Storage URI of tar.gz archive containing Skaffold configuration.
string
setSkaffoldConfigUri
Cloud Storage URI of tar.gz archive containing Skaffold configuration.
var
string
$this
getSkaffoldConfigPath
Filepath of the Skaffold config inside of the config URI.
string
setSkaffoldConfigPath
Filepath of the Skaffold config inside of the config URI.
var
string
$this
getBuildArtifacts
List of artifacts to pass through to Skaffold command.
setBuildArtifacts
List of artifacts to pass through to Skaffold command.
$this
getDeliveryPipelineSnapshot
Output only. Snapshot of the parent pipeline taken at release creation time.
hasDeliveryPipelineSnapshot
clearDeliveryPipelineSnapshot
setDeliveryPipelineSnapshot
Output only. Snapshot of the parent pipeline taken at release creation time.
$this
getTargetSnapshots
Output only. Snapshot of the targets taken at release creation time.
setTargetSnapshots
Output only. Snapshot of the targets taken at release creation time.
$this
getCustomTargetTypeSnapshots
Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.
setCustomTargetTypeSnapshots
Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.
$this
getRenderState
Output only. Current state of the render operation.
int
setRenderState
Output only. Current state of the render operation.
var
int
$this
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
setEtag
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.
var
string
$this
getSkaffoldVersion
The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set of versions.
If unset, the most recent supported Skaffold version will be used.
string
setSkaffoldVersion
The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set of versions.
If unset, the most recent supported Skaffold version will be used.
var
string
$this
getTargetArtifacts
Output only. Map from target ID to the target artifacts created during the render operation.
setTargetArtifacts
Output only. Map from target ID to the target artifacts created during the render operation.
$this
getTargetRenders
Output only. Map from target ID to details of the render operation for that target.
setTargetRenders
Output only. Map from target ID to details of the render operation for that target.
$this
getCondition
Output only. Information around the state of the Release.
hasCondition
clearCondition
setCondition
Output only. Information around the state of the Release.
$this
getDeployParameters
Optional. The deploy parameters to use for all targets in this release.
setDeployParameters
Optional. The deploy parameters to use for all targets in this release.
$this
