unit_kinds

Creates, updates, deletes, gets or lists an unit_kinds resource.

Overview

Name	`unit_kinds`
Type	Resource
Id	`google.saasservicemgmt.unit_kinds`

Fields

The following fields are returned by SELECT queries:

get
list

Name	Datatype	Description
`name`	`string`	Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/unitKinds/{unitKind}"
`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
`boundaryType`	`string`	Optional. Output only. BoundaryType describes the type of boundary the Unit Kind represents. (BOUNDARY_TYPE_UNSPECIFIED, BOUNDARY_TYPE_TENANT_PROJECT, BOUNDARY_TYPE_MANAGED_PROJECT)
`createTime`	`string (google-datetime)`	Output only. The timestamp when the resource was created.
`defaultFlagRevisions`	`array`	Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation.
`defaultRelease`	`string`	Optional. A reference to the Release object to use as default for creating new units of this UnitKind (optional). If not specified, a new unit must explicitly reference which release to use for its creation.
`dependencies`	`array`	Optional. Immutable. List of other unit kinds that this release will depend on. Dependencies will be automatically provisioned if not found. Maximum 10.
`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.
`inputVariableMappings`	`array`	Optional. List of inputVariables for this release that will either be retrieved from a dependency's outputVariables, or will be passed on to a dependency's inputVariables. Maximum 100.
`labels`	`object`	Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
`outputVariableMappings`	`array`	Optional. List of outputVariables for this unit kind will be passed to this unit's outputVariables. Maximum 100.
`saas`	`string`	Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set.
`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.
`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.

Name	Datatype	Description
`name`	`string`	Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/unitKinds/{unitKind}"
`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
`boundaryType`	`string`	Optional. Output only. BoundaryType describes the type of boundary the Unit Kind represents. (BOUNDARY_TYPE_UNSPECIFIED, BOUNDARY_TYPE_TENANT_PROJECT, BOUNDARY_TYPE_MANAGED_PROJECT)
`createTime`	`string (google-datetime)`	Output only. The timestamp when the resource was created.
`defaultFlagRevisions`	`array`	Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation.
`defaultRelease`	`string`	Optional. A reference to the Release object to use as default for creating new units of this UnitKind (optional). If not specified, a new unit must explicitly reference which release to use for its creation.
`dependencies`	`array`	Optional. Immutable. List of other unit kinds that this release will depend on. Dependencies will be automatically provisioned if not found. Maximum 10.
`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.
`inputVariableMappings`	`array`	Optional. List of inputVariables for this release that will either be retrieved from a dependency's outputVariables, or will be passed on to a dependency's inputVariables. Maximum 100.
`labels`	`object`	Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
`outputVariableMappings`	`array`	Optional. List of outputVariables for this unit kind will be passed to this unit's outputVariables. Maximum 100.
`saas`	`string`	Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set.
`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.
`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`, `unitKindsId`		Retrieve a single unit kind.
`list`	`select`	`projectsId`, `locationsId`	`pageSize`, `orderBy`, `filter`, `pageToken`	Retrieve a collection of unit kinds.
`create`	`insert`	`projectsId`, `locationsId`	`unitKindId`, `validateOnly`, `requestId`	Create a new unit kind.
`patch`	`update`	`projectsId`, `locationsId`, `unitKindsId`	`updateMask`, `validateOnly`, `requestId`	Update a single unit kind.
`delete`	`delete`	`projectsId`, `locationsId`, `unitKindsId`	`etag`, `validateOnly`, `requestId`	Delete a single unit kind.

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`
`unitKindsId`	`string`
`etag`	`string`
`filter`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`requestId`	`string`
`unitKindId`	`string`
`updateMask`	`string (google-fieldmask)`
`validateOnly`	`boolean`

`SELECT` examples

get
list

Retrieve a single unit kind.

SELECT
name,
annotations,
boundaryType,
createTime,
defaultFlagRevisions,
defaultRelease,
dependencies,
etag,
inputVariableMappings,
labels,
outputVariableMappings,
saas,
uid,
updateTime
FROM google.saasservicemgmt.unit_kinds
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND unitKindsId = '{{ unitKindsId }}' -- required
;

Retrieve a collection of unit kinds.

SELECT
name,
annotations,
boundaryType,
createTime,
defaultFlagRevisions,
defaultRelease,
dependencies,
etag,
inputVariableMappings,
labels,
outputVariableMappings,
saas,
uid,
updateTime
FROM google.saasservicemgmt.unit_kinds
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND pageToken = '{{ pageToken }}'
;

`INSERT` examples

create
Manifest

Create a new unit kind.

INSERT INTO google.saasservicemgmt.unit_kinds (
data__defaultRelease,
data__defaultFlagRevisions,
data__labels,
data__name,
data__dependencies,
data__saas,
data__outputVariableMappings,
data__annotations,
data__inputVariableMappings,
projectsId,
locationsId,
unitKindId,
validateOnly,
requestId
)
SELECT 
'{{ defaultRelease }}',
'{{ defaultFlagRevisions }}',
'{{ labels }}',
'{{ name }}',
'{{ dependencies }}',
'{{ saas }}',
'{{ outputVariableMappings }}',
'{{ annotations }}',
'{{ inputVariableMappings }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ unitKindId }}',
'{{ validateOnly }}',
'{{ requestId }}'
RETURNING
name,
annotations,
boundaryType,
createTime,
defaultFlagRevisions,
defaultRelease,
dependencies,
etag,
inputVariableMappings,
labels,
outputVariableMappings,
saas,
uid,
updateTime
;

# Description fields are for documentation purposes
- name: unit_kinds
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the unit_kinds resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the unit_kinds resource.
  - name: defaultRelease
    value: "{{ defaultRelease }}"
    description: |
      Optional. A reference to the Release object to use as default for creating new units of this UnitKind (optional). If not specified, a new unit must explicitly reference which release to use for its creation.
  - name: defaultFlagRevisions
    value:
      - "{{ defaultFlagRevisions }}"
    description: |
      Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/unitKinds/{unitKind}"
  - name: dependencies
    description: |
      Optional. Immutable. List of other unit kinds that this release will depend on. Dependencies will be automatically provisioned if not found. Maximum 10.
    value:
      - unitKind: "{{ unitKind }}"
        alias: "{{ alias }}"
  - name: saas
    value: "{{ saas }}"
    description: |
      Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set.
  - name: outputVariableMappings
    description: |
      Optional. List of outputVariables for this unit kind will be passed to this unit's outputVariables. Maximum 100.
    value:
      - from:
          dependency: "{{ dependency }}"
          outputVariable: "{{ outputVariable }}"
        variable: "{{ variable }}"
        to:
          inputVariable: "{{ inputVariable }}"
          dependency: "{{ dependency }}"
          ignoreForLookup: {{ ignoreForLookup }}
  - name: annotations
    value: "{{ annotations }}"
    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: inputVariableMappings
    description: |
      Optional. List of inputVariables for this release that will either be retrieved from a dependency's outputVariables, or will be passed on to a dependency's inputVariables. Maximum 100.
    value:
      - from:
          dependency: "{{ dependency }}"
          outputVariable: "{{ outputVariable }}"
        variable: "{{ variable }}"
        to:
          inputVariable: "{{ inputVariable }}"
          dependency: "{{ dependency }}"
          ignoreForLookup: {{ ignoreForLookup }}
  - name: unitKindId
    value: "{{ unitKindId }}"
  - name: validateOnly
    value: {{ validateOnly }}
  - name: requestId
    value: "{{ requestId }}"

`UPDATE` examples

patch

Update a single unit kind.

UPDATE google.saasservicemgmt.unit_kinds
SET 
data__defaultRelease = '{{ defaultRelease }}',
data__defaultFlagRevisions = '{{ defaultFlagRevisions }}',
data__labels = '{{ labels }}',
data__name = '{{ name }}',
data__dependencies = '{{ dependencies }}',
data__saas = '{{ saas }}',
data__outputVariableMappings = '{{ outputVariableMappings }}',
data__annotations = '{{ annotations }}',
data__inputVariableMappings = '{{ inputVariableMappings }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND unitKindsId = '{{ unitKindsId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
AND requestId = '{{ requestId}}'
RETURNING
name,
annotations,
boundaryType,
createTime,
defaultFlagRevisions,
defaultRelease,
dependencies,
etag,
inputVariableMappings,
labels,
outputVariableMappings,
saas,
uid,
updateTime;

`DELETE` examples

delete

Delete a single unit kind.

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​