Interface CompleteQueryRequestOrBuilder (2.45.0)

public interface CompleteQueryRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCompany()

public abstract String 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".

string company = 5 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The company.

getCompanyBytes()

public abstract ByteString getCompanyBytes()

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

string company = 5 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for company.

getLanguageCodes(int index)

public abstract String getLanguageCodes(int index)

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.

repeated string language_codes = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The languageCodes at the given index.

getLanguageCodesBytes(int index)

public abstract ByteString getLanguageCodesBytes(int index)

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.

repeated string language_codes = 3;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the languageCodes at the given index.

getLanguageCodesCount()

public abstract int getLanguageCodesCount()

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.

repeated string language_codes = 3;

Returns
Type Description
int

The count of languageCodes.

getLanguageCodesList()

public abstract List<String> getLanguageCodesList()

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.

repeated string language_codes = 3;

Returns
Type Description
List<String>

A list containing the languageCodes.

getPageSize()

public abstract int getPageSize()

Required. Completion result count.

The maximum allowed page size is 10.

int32 page_size = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The pageSize.

getParent()

public abstract String 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".

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getQuery()

public abstract String getQuery()

Required. The query used to generate suggestions.

The maximum number of allowed characters is 255.

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The query.

getQueryBytes()

public abstract ByteString getQueryBytes()

Required. The query used to generate suggestions.

The maximum number of allowed characters is 255.

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for query.

getScope()

public abstract CompleteQueryRequest.CompletionScope getScope()

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

.google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionScope scope = 6;

Returns
Type Description
CompleteQueryRequest.CompletionScope

The scope.

getScopeValue()

public abstract int getScopeValue()

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

.google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionScope scope = 6;

Returns
Type Description
int

The enum numeric value on the wire for scope.

getType()

public abstract CompleteQueryRequest.CompletionType getType()

The completion topic. The default is CompletionType.COMBINED.

.google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType type = 7;

Returns
Type Description
CompleteQueryRequest.CompletionType

The type.

getTypeValue()

public abstract int getTypeValue()

The completion topic. The default is CompletionType.COMBINED.

.google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType type = 7;

Returns
Type Description
int

The enum numeric value on the wire for type.