Google Cloud Talent Solution V4beta1 Client - Class CompletionClient (1.3.5)

Reference documentation and code samples for the Google Cloud Talent Solution V4beta1 Client class CompletionClient.

Service Description: A service handles auto completion.

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:

$completionClient = new CompletionClient();
try {
    $formattedParent = $completionClient->projectName('[PROJECT]');
    $query = 'query';
    $pageSize = 0;
    $response = $completionClient->completeQuery($formattedParent, $query, $pageSize);
} finally {
    $completionClient->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.

Namespace

Google \ Cloud \ Talent \ V4beta1

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.

completeQuery

Completes the specified prefix with keyword suggestions.

Intended for use by a job search auto-complete search box.

Parameters
Name Description
parent string

Required. Resource name of tenant the completion is performed within.

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenant/bar".

If tenant id is unspecified, the default tenant is used, for example, "projects/foo".

query string

Required. The query used to generate suggestions.

The maximum number of allowed characters is 255.

pageSize int

Required. Completion result count.

The maximum allowed page size is 10.

optionalArgs array

Optional.

↳ languageCodes string[]

The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages. The maximum number of allowed characters is 255.

↳ company string

If provided, restricts completion to specified company. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz". If tenant id is unspecified, the default tenant is used, for example, "projects/foo".

↳ scope int

The scope of the completion. The defaults is CompletionScope.PUBLIC. For allowed values, use constants defined on Google\Cloud\Talent\V4beta1\CompleteQueryRequest\CompletionScope

↳ type int

The completion topic. The default is CompletionType.COMBINED. For allowed values, use constants defined on Google\Cloud\Talent\V4beta1\CompleteQueryRequest\CompletionType

↳ 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\V4beta1\CompleteQueryResponse
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Talent\V4beta1\CompleteQueryResponse;
use Google\Cloud\Talent\V4beta1\CompletionClient;

/**
 * @param string $formattedParent Resource name of tenant the completion is performed within.
 *
 *                                The format is "projects/{project_id}/tenants/{tenant_id}", for example,
 *                                "projects/foo/tenant/bar".
 *
 *                                If tenant id is unspecified, the default tenant is used, for
 *                                example, "projects/foo". Please see
 *                                {@see CompletionClient::projectName()} for help formatting this field.
 * @param string $query           The query used to generate suggestions.
 *
 *                                The maximum number of allowed characters is 255.
 * @param int    $pageSize        Completion result count.
 *
 *                                The maximum allowed page size is 10.
 */
function complete_query_sample(string $formattedParent, string $query, int $pageSize): void
{
    // Create a client.
    $completionClient = new CompletionClient();

    // Call the API and handle any network failures.
    try {
        /** @var CompleteQueryResponse $response */
        $response = $completionClient->completeQuery($formattedParent, $query, $pageSize);
        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 = CompletionClient::projectName('[PROJECT]');
    $query = '[QUERY]';
    $pageSize = 0;

    complete_query_sample($formattedParent, $query, $pageSize);
}

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::projectName

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

Parameter
Name Description
project string
Returns
Type Description
string The formatted project resource.

static::projectCompanyName

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

Parameters
Name Description
project string
company string
Returns
Type Description
string The formatted project_company resource.

static::projectTenantCompanyName

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

Parameters
Name Description
project string
tenant string
company string
Returns
Type Description
string The formatted project_tenant_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}
  • project: projects/{project}
  • projectCompany: projects/{project}/companies/{company}
  • projectTenantCompany: 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.v4beta1.Completion'

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.