Google Cloud Talent Solution V4beta1 Client - Class CompleteQueryRequest (1.1.1)

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

Auto-complete parameters.

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

Namespace

Google \ Cloud \ Talent \ V4beta1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

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

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

↳ type int

The completion topic. The default is CompletionType.COMBINED.

getParent

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

Returns
TypeDescription
string

setParent

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getQuery

Required. The query used to generate suggestions.

The maximum number of allowed characters is 255.

Returns
TypeDescription
string

setQuery

Required. The query used to generate suggestions.

The maximum number of allowed characters is 255.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string[]
Returns
TypeDescription
$this

getPageSize

Required. Completion result count.

The maximum allowed page size is 10.

Returns
TypeDescription
int

setPageSize

Required. Completion result count.

The maximum allowed page size is 10.

Parameter
NameDescription
var int
Returns
TypeDescription
$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". If tenant id is unspecified, the default tenant is used, for example, "projects/foo".

Returns
TypeDescription
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". If tenant id is unspecified, the default tenant is used, for example, "projects/foo".

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getScope

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

Returns
TypeDescription
int

setScope

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getType

The completion topic. The default is CompletionType.COMBINED.

Returns
TypeDescription
int

setType

The completion topic. The default is CompletionType.COMBINED.

Parameter
NameDescription
var int
Returns
TypeDescription
$this