Google Cloud Talent Solution V4 Client - Class CompleteQueryRequest (2.0.0-RC1)

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

Auto-complete parameters.

Generated from protobuf message google.cloud.talent.v4.CompleteQueryRequest

Namespace

Google \ Cloud \ Talent \ V4

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ tenant string

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".

↳ query string

Required. The query used to generate suggestions. The maximum number of allowed characters is 255.

↳ language_codes array

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.

↳ page_size int

Required. Completion result count. The maximum allowed page size is 10.

↳ 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".

↳ scope int

The scope of the completion. The defaults is CompletionScope.PUBLIC.

↳ type int

The completion topic. The default is CompletionType.COMBINED.

getTenant

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".

Returns
Type Description
string

setTenant

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".

Parameter
Name Description
var string
Returns
Type Description
$this

getQuery

Required. The query used to generate suggestions.

The maximum number of allowed characters is 255.

Returns
Type Description
string

setQuery

Required. The query used to generate suggestions.

The maximum number of allowed characters is 255.

Parameter
Name Description
var string
Returns
Type Description
$this

getLanguageCodes

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setLanguageCodes

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getPageSize

Required. Completion result count.

The maximum allowed page size is 10.

Returns
Type Description
int

setPageSize

Required. Completion result count.

The maximum allowed page size is 10.

Parameter
Name Description
var int
Returns
Type Description
$this

getCompany

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".

Returns
Type Description
string

setCompany

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".

Parameter
Name Description
var string
Returns
Type Description
$this

getScope

The scope of the completion. The defaults is CompletionScope.PUBLIC.

Returns
Type Description
int

setScope

The scope of the completion. The defaults is CompletionScope.PUBLIC.

Parameter
Name Description
var int
Returns
Type Description
$this

getType

The completion topic. The default is CompletionType.COMBINED.

Returns
Type Description
int

setType

The completion topic. The default is CompletionType.COMBINED.

Parameter
Name Description
var int
Returns
Type Description
$this