Class CompleteQueryRequest.Builder (2.46.0)

public static final class CompleteQueryRequest.Builder extends GeneratedMessageV3.Builder<CompleteQueryRequest.Builder> implements CompleteQueryRequestOrBuilder

Auto-complete parameters.

Protobuf type google.cloud.talent.v4.CompleteQueryRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllLanguageCodes(Iterable<String> values)

public CompleteQueryRequest.Builder addAllLanguageCodes(Iterable<String> values)

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
values Iterable<String>

The languageCodes to add.

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

addLanguageCodes(String value)

public CompleteQueryRequest.Builder addLanguageCodes(String value)

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
value String

The languageCodes to add.

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

addLanguageCodesBytes(ByteString value)

public CompleteQueryRequest.Builder addLanguageCodesBytes(ByteString value)

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
value ByteString

The bytes of the languageCodes to add.

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CompleteQueryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CompleteQueryRequest.Builder
Overrides

build()

public CompleteQueryRequest build()
Returns
Type Description
CompleteQueryRequest

buildPartial()

public CompleteQueryRequest buildPartial()
Returns
Type Description
CompleteQueryRequest

clear()

public CompleteQueryRequest.Builder clear()
Returns
Type Description
CompleteQueryRequest.Builder
Overrides

clearCompany()

public CompleteQueryRequest.Builder clearCompany()

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

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

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CompleteQueryRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CompleteQueryRequest.Builder
Overrides

clearLanguageCodes()

public CompleteQueryRequest.Builder clearLanguageCodes()

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
CompleteQueryRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CompleteQueryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CompleteQueryRequest.Builder
Overrides

clearPageSize()

public CompleteQueryRequest.Builder clearPageSize()

Required. Completion result count.

The maximum allowed page size is 10.

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

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

clearQuery()

public CompleteQueryRequest.Builder clearQuery()

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
CompleteQueryRequest.Builder

This builder for chaining.

clearScope()

public CompleteQueryRequest.Builder clearScope()

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

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

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

clearTenant()

public CompleteQueryRequest.Builder clearTenant()

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

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

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

clearType()

public CompleteQueryRequest.Builder clearType()

The completion topic. The default is CompletionType.COMBINED.

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

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

clone()

public CompleteQueryRequest.Builder clone()
Returns
Type Description
CompleteQueryRequest.Builder
Overrides

getCompany()

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

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

Returns
Type Description
String

The company.

getCompanyBytes()

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

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

Returns
Type Description
ByteString

The bytes for company.

getDefaultInstanceForType()

public CompleteQueryRequest getDefaultInstanceForType()
Returns
Type Description
CompleteQueryRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLanguageCodes(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the languageCodes.

getPageSize()

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

getQuery()

public 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 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 CompleteQueryRequest.CompletionScope getScope()

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

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

Returns
Type Description
CompleteQueryRequest.CompletionScope

The scope.

getScopeValue()

public int getScopeValue()

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

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

Returns
Type Description
int

The enum numeric value on the wire for scope.

getTenant()

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

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

Returns
Type Description
String

The tenant.

getTenantBytes()

public ByteString getTenantBytes()

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

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

Returns
Type Description
ByteString

The bytes for tenant.

getType()

public CompleteQueryRequest.CompletionType getType()

The completion topic. The default is CompletionType.COMBINED.

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

Returns
Type Description
CompleteQueryRequest.CompletionType

The type.

getTypeValue()

public int getTypeValue()

The completion topic. The default is CompletionType.COMBINED.

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

Returns
Type Description
int

The enum numeric value on the wire for type.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CompleteQueryRequest other)

public CompleteQueryRequest.Builder mergeFrom(CompleteQueryRequest other)
Parameter
Name Description
other CompleteQueryRequest
Returns
Type Description
CompleteQueryRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CompleteQueryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompleteQueryRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CompleteQueryRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CompleteQueryRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CompleteQueryRequest.Builder
Overrides

setCompany(String value)

public CompleteQueryRequest.Builder setCompany(String value)

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

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

Parameter
Name Description
value String

The company to set.

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

setCompanyBytes(ByteString value)

public CompleteQueryRequest.Builder setCompanyBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for company to set.

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CompleteQueryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CompleteQueryRequest.Builder
Overrides

setLanguageCodes(int index, String value)

public CompleteQueryRequest.Builder setLanguageCodes(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.

value String

The languageCodes to set.

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

setPageSize(int value)

public CompleteQueryRequest.Builder setPageSize(int value)

Required. Completion result count.

The maximum allowed page size is 10.

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

setQuery(String value)

public CompleteQueryRequest.Builder setQuery(String value)

Required. The query used to generate suggestions.

The maximum number of allowed characters is 255.

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

Parameter
Name Description
value String

The query to set.

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

setQueryBytes(ByteString value)

public CompleteQueryRequest.Builder setQueryBytes(ByteString value)

Required. The query used to generate suggestions.

The maximum number of allowed characters is 255.

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

Parameter
Name Description
value ByteString

The bytes for query to set.

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CompleteQueryRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CompleteQueryRequest.Builder
Overrides

setScope(CompleteQueryRequest.CompletionScope value)

public CompleteQueryRequest.Builder setScope(CompleteQueryRequest.CompletionScope value)

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

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

Parameter
Name Description
value CompleteQueryRequest.CompletionScope

The scope to set.

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

setScopeValue(int value)

public CompleteQueryRequest.Builder setScopeValue(int value)

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for scope to set.

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

setTenant(String value)

public CompleteQueryRequest.Builder setTenant(String value)

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

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

Parameter
Name Description
value String

The tenant to set.

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

setTenantBytes(ByteString value)

public CompleteQueryRequest.Builder setTenantBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for tenant to set.

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

setType(CompleteQueryRequest.CompletionType value)

public CompleteQueryRequest.Builder setType(CompleteQueryRequest.CompletionType value)

The completion topic. The default is CompletionType.COMBINED.

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

Parameter
Name Description
value CompleteQueryRequest.CompletionType

The type to set.

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

setTypeValue(int value)

public CompleteQueryRequest.Builder setTypeValue(int value)

The completion topic. The default is CompletionType.COMBINED.

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

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.

Returns
Type Description
CompleteQueryRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CompleteQueryRequest.Builder
Overrides