class ProjectsTenantsCompanies extends Resource (View source)

The "companies" collection of methods.

Typical usage is:

 $jobsService = new Google\Service\CloudTalentSolution(...);
 $companies = $jobsService->projects_tenants_companies;

Methods

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

Creates a new company entity. (companies.create)

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

Deletes specified company. Prerequisite: The company has no jobs associated with it. (companies.delete)

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

Retrieves specified company. (companies.get)

listProjectsTenantsCompanies(string $parent, array $optParams = [])

Lists all companies associated with the project.

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

Updates specified company. (companies.patch)

Details

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

Creates a new company entity. (companies.create)

Parameters

string $parent

Required. Resource name of the tenant under which the company is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".

Company $postBody
array $optParams

Optional parameters.

Return Value

Company

Exceptions

Exception

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

Deletes specified company. Prerequisite: The company has no jobs associated with it. (companies.delete)

Parameters

string $name

Required. The resource name of the company to be deleted. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz".

array $optParams

Optional parameters.

Return Value

JobsEmpty

Exceptions

Exception

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

Retrieves specified company. (companies.get)

Parameters

string $name

Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/api-test-project/tenants/foo/companies/bar".

array $optParams

Optional parameters.

Return Value

Company

Exceptions

Exception

ListCompaniesResponse listProjectsTenantsCompanies(string $parent, array $optParams = [])

Lists all companies associated with the project.

(companies.listProjectsTenantsCompanies)

Parameters

string $parent

Required. Resource name of the tenant under which the company is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".

array $optParams

Optional parameters.

Return Value

ListCompaniesResponse

Exceptions

Exception

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

Updates specified company. (companies.patch)

Parameters

string $name

Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz".

Company $postBody
array $optParams

Optional parameters.

Return Value

Company

Exceptions

Exception