releases

Creates, updates, deletes, gets or lists a releases resource.

Overview

Name	`releases`
Type	Resource
Id	`google.clouddeploy.releases`

Fields

The following fields are returned by SELECT queries:

get
list

Successful response

Name	Datatype	Description
`name`	`string`	Identifier. 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])?`
`abandoned`	`boolean`	Output only. Indicates whether this is an abandoned release.
`annotations`	`object`	Optional. 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.
`buildArtifacts`	`array`	Optional. List of artifacts to pass through to Skaffold command.
`condition`	`object`	Output only. Information around the state of the Release. (id: ReleaseCondition)
`createTime`	`string (google-datetime)`	Output only. Time at which the `Release` was created.
`customTargetTypeSnapshots`	`array`	Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.
`deliveryPipelineSnapshot`	`object`	A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress. (id: DeliveryPipeline)
`deployParameters`	`object`	Optional. The deploy parameters to use for all targets in this release.
`description`	`string`	Optional. Description of the `Release`. Max length is 255 characters.
`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.
`labels`	`object`	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.
`renderEndTime`	`string (google-datetime)`	Output only. Time at which the render completed.
`renderStartTime`	`string (google-datetime)`	Output only. Time at which the render began.
`renderState`	`string`	Output only. Current state of the render operation.
`skaffoldConfigPath`	`string`	Optional. Filepath of the Skaffold config inside of the config URI.
`skaffoldConfigUri`	`string`	Optional. Cloud Storage URI of tar.gz archive containing Skaffold configuration.
`skaffoldVersion`	`string`	Optional. 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.
`targetArtifacts`	`object`	Output only. Map from target ID to the target artifacts created during the render operation.
`targetRenders`	`object`	Output only. Map from target ID to details of the render operation for that target.
`targetSnapshots`	`array`	Output only. Snapshot of the targets taken at release creation time.
`uid`	`string`	Output only. Unique identifier of the `Release`.

Successful response

Name	Datatype	Description
`name`	`string`	Identifier. 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])?`
`abandoned`	`boolean`	Output only. Indicates whether this is an abandoned release.
`annotations`	`object`	Optional. 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.
`buildArtifacts`	`array`	Optional. List of artifacts to pass through to Skaffold command.
`condition`	`object`	Output only. Information around the state of the Release. (id: ReleaseCondition)
`createTime`	`string (google-datetime)`	Output only. Time at which the `Release` was created.
`customTargetTypeSnapshots`	`array`	Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.
`deliveryPipelineSnapshot`	`object`	A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress. (id: DeliveryPipeline)
`deployParameters`	`object`	Optional. The deploy parameters to use for all targets in this release.
`description`	`string`	Optional. Description of the `Release`. Max length is 255 characters.
`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.
`labels`	`object`	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.
`renderEndTime`	`string (google-datetime)`	Output only. Time at which the render completed.
`renderStartTime`	`string (google-datetime)`	Output only. Time at which the render began.
`renderState`	`string`	Output only. Current state of the render operation.
`skaffoldConfigPath`	`string`	Optional. Filepath of the Skaffold config inside of the config URI.
`skaffoldConfigUri`	`string`	Optional. Cloud Storage URI of tar.gz archive containing Skaffold configuration.
`skaffoldVersion`	`string`	Optional. 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.
`targetArtifacts`	`object`	Output only. Map from target ID to the target artifacts created during the render operation.
`targetRenders`	`object`	Output only. Map from target ID to details of the render operation for that target.
`targetSnapshots`	`array`	Output only. Snapshot of the targets taken at release creation time.
`uid`	`string`	Output only. Unique identifier of the `Release`.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`projectsId`, `locationsId`, `deliveryPipelinesId`, `releasesId`		Gets details of a single Release.
`list`	`select`	`projectsId`, `locationsId`, `deliveryPipelinesId`	`pageSize`, `pageToken`, `filter`, `orderBy`	Lists Releases in a given project and location.
`create`	`insert`	`projectsId`, `locationsId`, `deliveryPipelinesId`	`releaseId`, `requestId`, `validateOnly`, `overrideDeployPolicy`	Creates a new Release in a given project and location.
`abandon`	`exec`	`projectsId`, `locationsId`, `deliveryPipelinesId`, `releasesId`		Abandons a Release in the Delivery Pipeline.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`deliveryPipelinesId`	`string`
`locationsId`	`string`
`projectsId`	`string`
`releasesId`	`string`
`filter`	`string`
`orderBy`	`string`
`overrideDeployPolicy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`releaseId`	`string`
`requestId`	`string`
`validateOnly`	`boolean`

`SELECT` examples

get
list

Gets details of a single Release.

SELECT
name,
abandoned,
annotations,
buildArtifacts,
condition,
createTime,
customTargetTypeSnapshots,
deliveryPipelineSnapshot,
deployParameters,
description,
etag,
labels,
renderEndTime,
renderStartTime,
renderState,
skaffoldConfigPath,
skaffoldConfigUri,
skaffoldVersion,
targetArtifacts,
targetRenders,
targetSnapshots,
uid
FROM google.clouddeploy.releases
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deliveryPipelinesId = '{{ deliveryPipelinesId }}' -- required
AND releasesId = '{{ releasesId }}' -- required;

Lists Releases in a given project and location.

SELECT
name,
abandoned,
annotations,
buildArtifacts,
condition,
createTime,
customTargetTypeSnapshots,
deliveryPipelineSnapshot,
deployParameters,
description,
etag,
labels,
renderEndTime,
renderStartTime,
renderState,
skaffoldConfigPath,
skaffoldConfigUri,
skaffoldVersion,
targetArtifacts,
targetRenders,
targetSnapshots,
uid
FROM google.clouddeploy.releases
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deliveryPipelinesId = '{{ deliveryPipelinesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

`INSERT` examples

create
Manifest

Creates a new Release in a given project and location.

INSERT INTO google.clouddeploy.releases (
data__name,
data__description,
data__annotations,
data__labels,
data__skaffoldConfigUri,
data__skaffoldConfigPath,
data__buildArtifacts,
data__etag,
data__skaffoldVersion,
data__deployParameters,
projectsId,
locationsId,
deliveryPipelinesId,
releaseId,
requestId,
validateOnly,
overrideDeployPolicy
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ annotations }}',
'{{ labels }}',
'{{ skaffoldConfigUri }}',
'{{ skaffoldConfigPath }}',
'{{ buildArtifacts }}',
'{{ etag }}',
'{{ skaffoldVersion }}',
'{{ deployParameters }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ deliveryPipelinesId }}',
'{{ releaseId }}',
'{{ requestId }}',
'{{ validateOnly }}',
'{{ overrideDeployPolicy }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: releases
  props:
    - name: projectsId
      value: string
      description: Required parameter for the releases resource.
    - name: locationsId
      value: string
      description: Required parameter for the releases resource.
    - name: deliveryPipelinesId
      value: string
      description: Required parameter for the releases resource.
    - name: name
      value: string
      description: >
        Identifier. 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])?`
        
    - name: description
      value: string
      description: >
        Optional. Description of the `Release`. Max length is 255 characters.
        
    - name: annotations
      value: object
      description: >
        Optional. 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.
        
    - name: labels
      value: object
      description: >
        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.
        
    - name: skaffoldConfigUri
      value: string
      description: >
        Optional. Cloud Storage URI of tar.gz archive containing Skaffold configuration.
        
    - name: skaffoldConfigPath
      value: string
      description: >
        Optional. Filepath of the Skaffold config inside of the config URI.
        
    - name: buildArtifacts
      value: array
      description: >
        Optional. List of artifacts to pass through to Skaffold command.
        
    - name: etag
      value: string
      description: >
        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.
        
    - name: skaffoldVersion
      value: string
      description: >
        Optional. 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.
        
    - name: deployParameters
      value: object
      description: >
        Optional. The deploy parameters to use for all targets in this release.
        
    - name: releaseId
      value: string
    - name: requestId
      value: string
    - name: validateOnly
      value: boolean
    - name: overrideDeployPolicy
      value: string

Lifecycle Methods

abandon

Abandons a Release in the Delivery Pipeline.

EXEC google.clouddeploy.releases.abandon 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@deliveryPipelinesId='{{ deliveryPipelinesId }}' --required, 
@releasesId='{{ releasesId }}' --required;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

Lifecycle Methods​