Google Cloud Talent Solution V4 Client - Class CompanyServiceClient (1.1.1)

Reference documentation and code samples for the Google Cloud Talent Solution V4 Client class CompanyServiceClient.

Service Description: A service that handles company management, including CRUD and enumeration.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$companyServiceClient = new CompanyServiceClient();
try {
    $formattedParent = $companyServiceClient->tenantName('[PROJECT]', '[TENANT]');
    $company = new Company();
    $response = $companyServiceClient->createCompany($formattedParent, $company);
} finally {
    $companyServiceClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This service has a new (beta) implementation. See Google\Cloud\Talent\V4\Client\CompanyServiceClient to use the new surface.

Namespace

Google \ Cloud \ Talent \ V4

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createCompany

Creates a new company entity.

Parameters
Name	Description
`parent`	`string` 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`	`Google\Cloud\Talent\V4\Company` Required. The company to be created.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Talent\V4\Company`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Talent\V4\Company;
use Google\Cloud\Talent\V4\CompanyServiceClient;

/**
 * @param string $formattedParent    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". Please see
 *                                   {@see CompanyServiceClient::tenantName()} for help formatting this field.
 * @param string $companyDisplayName The display name of the company, for example, "Google LLC".
 * @param string $companyExternalId  Client side company identifier, used to uniquely identify the
 *                                   company.
 *
 *                                   The maximum number of allowed characters is 255.
 */
function create_company_sample(
    string $formattedParent,
    string $companyDisplayName,
    string $companyExternalId
): void {
    // Create a client.
    $companyServiceClient = new CompanyServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $company = (new Company())
        ->setDisplayName($companyDisplayName)
        ->setExternalId($companyExternalId);

    // Call the API and handle any network failures.
    try {
        /** @var Company $response */
        $response = $companyServiceClient->createCompany($formattedParent, $company);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = CompanyServiceClient::tenantName('[PROJECT]', '[TENANT]');
    $companyDisplayName = '[DISPLAY_NAME]';
    $companyExternalId = '[EXTERNAL_ID]';

    create_company_sample($formattedParent, $companyDisplayName, $companyExternalId);
}

deleteCompany

Deletes specified company.

Prerequisite: The company has no jobs associated with it.

Parameters
Name	Description
`name`	`string` 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".
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Talent\V4\CompanyServiceClient;

/**
 * @param string $formattedName 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". Please see
 *                              {@see CompanyServiceClient::companyName()} for help formatting this field.
 */
function delete_company_sample(string $formattedName): void
{
    // Create a client.
    $companyServiceClient = new CompanyServiceClient();

    // Call the API and handle any network failures.
    try {
        $companyServiceClient->deleteCompany($formattedName);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = CompanyServiceClient::companyName('[PROJECT]', '[TENANT]', '[COMPANY]');

    delete_company_sample($formattedName);
}

getCompany

Retrieves specified company.

Parameters
Name	Description
`name`	`string` 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".
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Talent\V4\Company`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Talent\V4\Company;
use Google\Cloud\Talent\V4\CompanyServiceClient;

/**
 * @param string $formattedName 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". Please see
 *                              {@see CompanyServiceClient::companyName()} for help formatting this field.
 */
function get_company_sample(string $formattedName): void
{
    // Create a client.
    $companyServiceClient = new CompanyServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var Company $response */
        $response = $companyServiceClient->getCompany($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = CompanyServiceClient::companyName('[PROJECT]', '[TENANT]', '[COMPANY]');

    get_company_sample($formattedName);
}

listCompanies

Lists all companies associated with the project.

Parameters
Name	Description
`parent`	`string` 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".
`optionalArgs`	`array` Optional.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ requireOpenJobs`	`bool` Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Talent\V4\Company;
use Google\Cloud\Talent\V4\CompanyServiceClient;

/**
 * @param string $formattedParent 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". Please see
 *                                {@see CompanyServiceClient::tenantName()} for help formatting this field.
 */
function list_companies_sample(string $formattedParent): void
{
    // Create a client.
    $companyServiceClient = new CompanyServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $companyServiceClient->listCompanies($formattedParent);

        /** @var Company $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = CompanyServiceClient::tenantName('[PROJECT]', '[TENANT]');

    list_companies_sample($formattedParent);
}

updateCompany

Updates specified company.

Parameters
Name	Description
`company`	`Google\Cloud\Talent\V4\Company` Required. The company resource to replace the current resource in the system.
`optionalArgs`	`array` Optional.
`↳ updateMask`	`FieldMask` Strongly recommended for the best service experience. If update_mask is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to be updated. Only top level fields of Company are supported.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Talent\V4\Company`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Talent\V4\Company;
use Google\Cloud\Talent\V4\CompanyServiceClient;

/**
 * @param string $companyDisplayName The display name of the company, for example, "Google LLC".
 * @param string $companyExternalId  Client side company identifier, used to uniquely identify the
 *                                   company.
 *
 *                                   The maximum number of allowed characters is 255.
 */
function update_company_sample(string $companyDisplayName, string $companyExternalId): void
{
    // Create a client.
    $companyServiceClient = new CompanyServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $company = (new Company())
        ->setDisplayName($companyDisplayName)
        ->setExternalId($companyExternalId);

    // Call the API and handle any network failures.
    try {
        /** @var Company $response */
        $response = $companyServiceClient->updateCompany($company);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $companyDisplayName = '[DISPLAY_NAME]';
    $companyExternalId = '[EXTERNAL_ID]';

    update_company_sample($companyDisplayName, $companyExternalId);
}

static::companyName

Formats a string containing the fully-qualified path to represent a company resource.

Parameters
Name	Description
`project`	`string`
`tenant`	`string`
`company`	`string`

Returns
Type	Description
`string`	The formatted company resource.

static::tenantName

Formats a string containing the fully-qualified path to represent a tenant resource.

Parameters
Name	Description
`project`	`string`
`tenant`	`string`

Returns
Type	Description
`string`	The formatted tenant resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

company: projects/{project}/tenants/{tenant}/companies/{company}
tenant: projects/{project}/tenants/{tenant}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.

Constants

SERVICE_NAME

Value: 'google.cloud.talent.v4.CompanyService'

The name of the service.

SERVICE_ADDRESS

Value: 'jobs.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.