releases

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

Overview

Name	releases
Type	Resource
Id	google.saasservicemgmt.releases

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/releases/{release}"
annotations	object	Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
blueprint	object	Optional. Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. (id: Blueprint)
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
etag	string	Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
inputVariableDefaults	array	Optional. Mapping of input variables to default values. Maximum 100
inputVariables	array	Optional. Output only. List of input variables declared on the blueprint and can be present with their values on the unit spec
labels	object	Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
outputVariables	array	Optional. Output only. List of output variables declared on the blueprint and can be present with their values on the unit status
releaseRequirements	object	Optional. Set of requirements to be fulfilled on the Unit when using this Release. (id: ReleaseRequirements)
uid	string	Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
unitKind	string	Required. Immutable. Reference to the UnitKind this Release corresponds to (required and immutable once created).
updateTime	string (google-datetime)	Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/releases/{release}"
annotations	object	Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
blueprint	object	Optional. Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. (id: Blueprint)
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
etag	string	Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
inputVariableDefaults	array	Optional. Mapping of input variables to default values. Maximum 100
inputVariables	array	Optional. Output only. List of input variables declared on the blueprint and can be present with their values on the unit spec
labels	object	Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
outputVariables	array	Optional. Output only. List of output variables declared on the blueprint and can be present with their values on the unit status
releaseRequirements	object	Optional. Set of requirements to be fulfilled on the Unit when using this Release. (id: ReleaseRequirements)
uid	string	Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
unitKind	string	Required. Immutable. Reference to the UnitKind this Release corresponds to (required and immutable once created).
updateTime	string (google-datetime)	Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, releasesId		Retrieve a single release.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Retrieve a collection of releases.
create	insert	projectsId, locationsId	releaseId, validateOnly, requestId	Create a new release.
patch	update	projectsId, locationsId, releasesId	validateOnly, requestId, updateMask	Update a single release.
delete	delete	projectsId, locationsId, releasesId	etag, validateOnly, requestId	Delete a single release.

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
locationsId	string
projectsId	string
releasesId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
releaseId	string
requestId	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Retrieve a single release.

SELECT
name,
annotations,
blueprint,
createTime,
etag,
inputVariableDefaults,
inputVariables,
labels,
outputVariables,
releaseRequirements,
uid,
unitKind,
updateTime
FROM google.saasservicemgmt.releases
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND releasesId = '{{ releasesId }}' -- required;

list

Retrieve a collection of releases.

SELECT
name,
annotations,
blueprint,
createTime,
etag,
inputVariableDefaults,
inputVariables,
labels,
outputVariables,
releaseRequirements,
uid,
unitKind,
updateTime
FROM google.saasservicemgmt.releases
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Create a new release.

INSERT INTO google.saasservicemgmt.releases (
data__name,
data__unitKind,
data__blueprint,
data__releaseRequirements,
data__inputVariableDefaults,
data__labels,
data__annotations,
projectsId,
locationsId,
releaseId,
validateOnly,
requestId
)
SELECT 
'{{ name }}',
'{{ unitKind }}',
'{{ blueprint }}',
'{{ releaseRequirements }}',
'{{ inputVariableDefaults }}',
'{{ labels }}',
'{{ annotations }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ releaseId }}',
'{{ validateOnly }}',
'{{ requestId }}'
RETURNING
name,
annotations,
blueprint,
createTime,
etag,
inputVariableDefaults,
inputVariables,
labels,
outputVariables,
releaseRequirements,
uid,
unitKind,
updateTime
;

Manifest

# 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: name
      value: string
      description: >
        Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/releases/{release}"
        
    - name: unitKind
      value: string
      description: >
        Required. Immutable. Reference to the UnitKind this Release corresponds to (required and immutable once created).
        
    - name: blueprint
      value: object
      description: >
        Optional. Blueprints are OCI Images that contain all of the artifacts needed to provision a unit.
        
    - name: releaseRequirements
      value: object
      description: >
        Optional. Set of requirements to be fulfilled on the Unit when using this Release.
        
    - name: inputVariableDefaults
      value: array
      description: >
        Optional. Mapping of input variables to default values. Maximum 100
        
    - name: labels
      value: object
      description: >
        Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
        
    - name: annotations
      value: object
      description: >
        Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
        
    - name: releaseId
      value: string
    - name: validateOnly
      value: boolean
    - name: requestId
      value: string

UPDATE examples

patch

Update a single release.

UPDATE google.saasservicemgmt.releases
SET 
data__name = '{{ name }}',
data__unitKind = '{{ unitKind }}',
data__blueprint = '{{ blueprint }}',
data__releaseRequirements = '{{ releaseRequirements }}',
data__inputVariableDefaults = '{{ inputVariableDefaults }}',
data__labels = '{{ labels }}',
data__annotations = '{{ annotations }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND releasesId = '{{ releasesId }}' --required
AND validateOnly = {{ validateOnly}}
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
annotations,
blueprint,
createTime,
etag,
inputVariableDefaults,
inputVariables,
labels,
outputVariables,
releaseRequirements,
uid,
unitKind,
updateTime;

DELETE examples

delete

Delete a single release.

DELETE FROM google.saasservicemgmt.releases
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND releasesId = '{{ releasesId }}' --required
AND etag = '{{ etag }}'
AND validateOnly = '{{ validateOnly }}'
AND requestId = '{{ requestId }}';