saas

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

Overview

Name	saas
Type	Resource
Id	google.saasservicemgmt.saas

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/saas/{saas}"
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
conditions	array	Output only. A set of conditions which indicate the various conditions this resource can have.
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
error	object	Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states. (id: Status)
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.
labels	object	Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
locations	array	Optional. List of locations that the service is available in. Rollout refers to the list to generate a rollout plan.
state	string	Output only. State of the Saas. It is always in STATE_ACTIVE state if the application_template is empty. (STATE_TYPE_UNSPECIFIED, STATE_ACTIVE, STATE_RUNNING, STATE_FAILED)
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.

list

Name	Datatype	Description
name	string	Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/saas/{saas}"
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
conditions	array	Output only. A set of conditions which indicate the various conditions this resource can have.
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
error	object	Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states. (id: Status)
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.
labels	object	Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
locations	array	Optional. List of locations that the service is available in. Rollout refers to the list to generate a rollout plan.
state	string	Output only. State of the Saas. It is always in STATE_ACTIVE state if the application_template is empty. (STATE_TYPE_UNSPECIFIED, STATE_ACTIVE, STATE_RUNNING, STATE_FAILED)
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, saasId		Retrieve a single saas.
list	select	projectsId, locationsId	pageToken, filter, pageSize, orderBy	Retrieve a collection of saas.
create	insert	projectsId, locationsId	saasId, validateOnly, requestId	Create a new saas.
patch	update	projectsId, locationsId, saasId	validateOnly, requestId, updateMask	Update a single saas.
delete	delete	projectsId, locationsId, saasId	etag, validateOnly, requestId	Delete a single saas.

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

SELECT examples

get

Retrieve a single saas.

SELECT
name,
annotations,
conditions,
createTime,
error,
etag,
labels,
locations,
state,
uid,
updateTime
FROM google.saasservicemgmt.saas
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND saasId = '{{ saasId }}' -- required
;

list

Retrieve a collection of saas.

SELECT
name,
annotations,
conditions,
createTime,
error,
etag,
labels,
locations,
state,
uid,
updateTime
FROM google.saasservicemgmt.saas
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Create a new saas.

INSERT INTO google.saasservicemgmt.saas (
data__annotations,
data__locations,
data__labels,
data__name,
projectsId,
locationsId,
saasId,
validateOnly,
requestId
)
SELECT 
'{{ annotations }}',
'{{ locations }}',
'{{ labels }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ saasId }}',
'{{ validateOnly }}',
'{{ requestId }}'
RETURNING
name,
annotations,
conditions,
createTime,
error,
etag,
labels,
locations,
state,
uid,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: saas
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the saas resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the saas resource.
  - 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: locations
    description: |
      Optional. List of locations that the service is available in. Rollout refers to the list to generate a rollout plan.
    value:
      - name: "{{ name }}"
  - 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}/saas/{saas}"
  - name: saasId
    value: "{{ saasId }}"
  - name: validateOnly
    value: {{ validateOnly }}
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Update a single saas.

UPDATE google.saasservicemgmt.saas
SET 
data__annotations = '{{ annotations }}',
data__locations = '{{ locations }}',
data__labels = '{{ labels }}',
data__name = '{{ name }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND saasId = '{{ saasId }}' --required
AND validateOnly = {{ validateOnly}}
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
annotations,
conditions,
createTime,
error,
etag,
labels,
locations,
state,
uid,
updateTime;

DELETE examples

delete

Delete a single saas.

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