Skip to main content

releases

Overview

Namereleases
TypeResource
Idgoogle.clouddeploy.releases

Fields

NameDatatypeDescription
namestringOptional. Name of the Release. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/a-z{0,62}.
descriptionstringDescription of the Release. Max length is 255 characters.
abandonedbooleanOutput only. Indicates whether this is an abandoned release.
annotationsobjectUser 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.
buildArtifactsarrayList of artifacts to pass through to Skaffold command.
conditionobjectReleaseCondition contains all conditions relevant to a Release.
createTimestringOutput only. Time at which the Release was created.
deliveryPipelineSnapshotobjectA DeliveryPipeline resource in the Cloud Deploy API. A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.
deployParametersobjectOptional. The deploy parameters to use for all targets in this release.
etagstringThis 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.
labelsobjectLabels 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.
renderEndTimestringOutput only. Time at which the render completed.
renderStartTimestringOutput only. Time at which the render began.
renderStatestringOutput only. Current state of the render operation.
skaffoldConfigPathstringFilepath of the Skaffold config inside of the config URI.
skaffoldConfigUristringCloud Storage URI of tar.gz archive containing Skaffold configuration.
skaffoldVersionstringThe 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.
targetArtifactsobjectOutput only. Map from target ID to the target artifacts created during the render operation.
targetRendersobjectOutput only. Map from target ID to details of the render operation for that target.
targetSnapshotsarrayOutput only. Snapshot of the targets taken at release creation time.
uidstringOutput only. Unique identifier of the Release.

Methods

NameAccessible byRequired ParamsDescription
getSELECTdeliveryPipelinesId, locationsId, projectsId, releasesIdGets details of a single Release.
listSELECTdeliveryPipelinesId, locationsId, projectsIdLists Releases in a given project and location.
createINSERTdeliveryPipelinesId, locationsId, projectsIdCreates a new Release in a given project and location.
_listEXECdeliveryPipelinesId, locationsId, projectsIdLists Releases in a given project and location.
abandonEXECdeliveryPipelinesId, locationsId, projectsId, releasesIdAbandons a Release in the Delivery Pipeline.