tenants

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

Overview

Name	tenants
Type	Resource
Id	google.saasservicemgmt.tenants

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}/tenants/{tenant}"
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
consumerResource	string	Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by SaaS Runtime for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API).
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.
labels	object	Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
saas	string	Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model.
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

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}/tenants/{tenant}"
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
consumerResource	string	Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by SaaS Runtime for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API).
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.
labels	object	Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
saas	string	Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model.
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, tenantsId		Retrieve a single tenant.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Retrieve a collection of tenants.
create	insert	projectsId, locationsId	tenantId, validateOnly, requestId	Create a new tenant.
patch	update	projectsId, locationsId, tenantsId	validateOnly, requestId, updateMask	Update a single tenant.
delete	delete	projectsId, locationsId, tenantsId	etag, validateOnly, requestId	Delete a single tenant.

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

SELECT examples

get

Retrieve a single tenant.

SELECT
name,
annotations,
consumerResource,
createTime,
etag,
labels,
saas,
uid,
updateTime
FROM google.saasservicemgmt.tenants
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND tenantsId = '{{ tenantsId }}' -- required;

list

Retrieve a collection of tenants.

SELECT
name,
annotations,
consumerResource,
createTime,
etag,
labels,
saas,
uid,
updateTime
FROM google.saasservicemgmt.tenants
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 tenant.

INSERT INTO google.saasservicemgmt.tenants (
data__name,
data__consumerResource,
data__saas,
data__labels,
data__annotations,
projectsId,
locationsId,
tenantId,
validateOnly,
requestId
)
SELECT 
'{{ name }}',
'{{ consumerResource }}',
'{{ saas }}',
'{{ labels }}',
'{{ annotations }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ tenantId }}',
'{{ validateOnly }}',
'{{ requestId }}'
RETURNING
name,
annotations,
consumerResource,
createTime,
etag,
labels,
saas,
uid,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: tenants
  props:
    - name: projectsId
      value: string
      description: Required parameter for the tenants resource.
    - name: locationsId
      value: string
      description: Required parameter for the tenants resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/tenants/{tenant}"
        
    - name: consumerResource
      value: string
      description: >
        Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by SaaS Runtime for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API).
        
    - name: saas
      value: string
      description: >
        Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model.
        
    - 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: tenantId
      value: string
    - name: validateOnly
      value: boolean
    - name: requestId
      value: string

UPDATE examples

patch

Update a single tenant.

UPDATE google.saasservicemgmt.tenants
SET 
data__name = '{{ name }}',
data__consumerResource = '{{ consumerResource }}',
data__saas = '{{ saas }}',
data__labels = '{{ labels }}',
data__annotations = '{{ annotations }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND tenantsId = '{{ tenantsId }}' --required
AND validateOnly = {{ validateOnly}}
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
annotations,
consumerResource,
createTime,
etag,
labels,
saas,
uid,
updateTime;

DELETE examples

delete

Delete a single tenant.

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