tenants

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

Overview

Name	tenants
Type	Resource
Id	google.jobs.tenants

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
externalId	string	Required. Client side tenant identifier, used to uniquely identify the tenant. The maximum number of allowed characters is 255.

list

Successful response

Name	Datatype	Description
name	string	Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
externalId	string	Required. Client side tenant identifier, used to uniquely identify the tenant. The maximum number of allowed characters is 255.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, tenantsId		Retrieves specified tenant.
list	select	projectsId	pageToken, pageSize	Lists all tenants associated with the project.
create	insert	projectsId		Creates a new tenant entity.
patch	update	projectsId, tenantsId	updateMask	Updates specified tenant.
delete	delete	projectsId, tenantsId		Deletes specified tenant.
complete_query	exec	projectsId, tenantsId	query, languageCodes, pageSize, company, scope, type	Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.

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
projectsId	string
tenantsId	string
company	string
languageCodes	string
pageSize	integer (int32)
pageToken	string
query	string
scope	string
type	string
updateMask	string (google-fieldmask)

SELECT examples

get

Retrieves specified tenant.

SELECT
name,
externalId
FROM google.jobs.tenants
WHERE projectsId = '{{ projectsId }}' -- required
AND tenantsId = '{{ tenantsId }}' -- required;

list

Lists all tenants associated with the project.

SELECT
name,
externalId
FROM google.jobs.tenants
WHERE projectsId = '{{ projectsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

INSERT examples

create

Creates a new tenant entity.

INSERT INTO google.jobs.tenants (
data__name,
data__externalId,
projectsId
)
SELECT 
'{{ name }}',
'{{ externalId }}',
'{{ projectsId }}'
RETURNING
name,
externalId
;

Manifest

# Description fields are for documentation purposes
- name: tenants
  props:
    - name: projectsId
      value: string
      description: Required parameter for the tenants resource.
    - name: name
      value: string
      description: >
        Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
        
    - name: externalId
      value: string
      description: >
        Required. Client side tenant identifier, used to uniquely identify the tenant. The maximum number of allowed characters is 255.
        

UPDATE examples

patch

Updates specified tenant.

UPDATE google.jobs.tenants
SET 
data__name = '{{ name }}',
data__externalId = '{{ externalId }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND tenantsId = '{{ tenantsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
externalId;

DELETE examples

delete

Deletes specified tenant.

DELETE FROM google.jobs.tenants
WHERE projectsId = '{{ projectsId }}' --required
AND tenantsId = '{{ tenantsId }}' --required;

Lifecycle Methods

complete_query

Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.

EXEC google.jobs.tenants.complete_query 
@projectsId='{{ projectsId }}' --required, 
@tenantsId='{{ tenantsId }}' --required, 
@query='{{ query }}', 
@languageCodes='{{ languageCodes }}', 
@pageSize='{{ pageSize }}', 
@company='{{ company }}', 
@scope='{{ scope }}', 
@type='{{ type }}';