1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudTalentSolution
  7. \
  8. Resource
  9. \
  10. ProjectsTenants

ProjectsTenants

class ProjectsTenants extends Resource (View source)

The "tenants" collection of methods.

Typical usage is:

 $jobsService = new Google\Service\CloudTalentSolution(...);
 $tenants = $jobsService->projects_tenants;

Methods

CompleteQueryResponse
completeQuery(string $tenant, array $optParams = [])

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

Tenant
create(string $parent, Tenant $postBody, array $optParams = [])

Creates a new tenant entity. (tenants.create)

JobsEmpty
delete(string $name, array $optParams = [])

Deletes specified tenant. (tenants.delete)

Tenant
get(string $name, array $optParams = [])

Retrieves specified tenant. (tenants.get)

ListTenantsResponse
listProjectsTenants(string $parent, array $optParams = [])

Lists all tenants associated with the project. (tenants.listProjectsTenants)

Tenant
patch(string $name, Tenant $postBody, array $optParams = [])

Updates specified tenant. (tenants.patch)

Details

at line 63
CompleteQueryResponse completeQuery(string $tenant, array $optParams = [])

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

Parameters

string $tenant

Required. Resource name of tenant the completion is performed within. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
array $optParams

Optional parameters.

Return Value

CompleteQueryResponse

Exceptions

Exception

at line 80
Tenant create(string $parent, Tenant $postBody, array $optParams = [])

Creates a new tenant entity. (tenants.create)

Parameters

string $parent

Required. Resource name of the project under which the tenant is created. The format is "projects/{project_id}", for example, "projects/foo".
Tenant $postBody
array $optParams

Optional parameters.

Return Value

Tenant

Exceptions

Exception

at line 96
JobsEmpty delete(string $name, array $optParams = [])

Deletes specified tenant. (tenants.delete)

Parameters

string $name

Required. The resource name of the tenant to be deleted. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
array $optParams

Optional parameters.

Return Value

JobsEmpty

Exceptions

Exception

at line 112
Tenant get(string $name, array $optParams = [])

Retrieves specified tenant. (tenants.get)

Parameters

string $name

Required. The resource name of the tenant to be retrieved. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
array $optParams

Optional parameters.

Return Value

Tenant

Exceptions

Exception

at line 133
ListTenantsResponse listProjectsTenants(string $parent, array $optParams = [])

Lists all tenants associated with the project. (tenants.listProjectsTenants)

Parameters

string $parent

Required. Resource name of the project under which the tenant is created. The format is "projects/{project_id}", for example, "projects/foo".
array $optParams

Optional parameters.

Return Value

ListTenantsResponse

Exceptions

Exception

at line 157
Tenant patch(string $name, Tenant $postBody, array $optParams = [])

Updates specified tenant. (tenants.patch)

Parameters

string $name

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".
Tenant $postBody
array $optParams

Optional parameters.

Return Value

Tenant

Exceptions

Exception