Class CompleteQueryRequest

public final class CompleteQueryRequest extends GeneratedMessageV3 implements CompleteQueryRequestOrBuilder

Auto-complete parameters.

Protobuf type google.cloud.talent.v4.CompleteQueryRequest

Fields

COMPANY_FIELD_NUMBER

public static final int COMPANY_FIELD_NUMBER
Field Value
TypeDescription
int

LANGUAGE_CODES_FIELD_NUMBER

public static final int LANGUAGE_CODES_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
TypeDescription
int

TENANT_FIELD_NUMBER

public static final int TENANT_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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
TypeDescription
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
TypeDescription
ByteString

The bytes for company.

getDefaultInstance()

public static CompleteQueryRequest getDefaultInstance()
Returns
TypeDescription
CompleteQueryRequest

getDefaultInstanceForType()

public CompleteQueryRequest getDefaultInstanceForType()
Returns
TypeDescription
CompleteQueryRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The pageSize.

getParserForType()

public Parser<CompleteQueryRequest> getParserForType()
Returns
TypeDescription
Parser<CompleteQueryRequest>
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for scope.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for type.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static CompleteQueryRequest.Builder newBuilder()
Returns
TypeDescription
CompleteQueryRequest.Builder

newBuilder(CompleteQueryRequest prototype)

public static CompleteQueryRequest.Builder newBuilder(CompleteQueryRequest prototype)
Parameter
NameDescription
prototypeCompleteQueryRequest
Returns
TypeDescription
CompleteQueryRequest.Builder

newBuilderForType()

public CompleteQueryRequest.Builder newBuilderForType()
Returns
TypeDescription
CompleteQueryRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CompleteQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CompleteQueryRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static CompleteQueryRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CompleteQueryRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CompleteQueryRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CompleteQueryRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CompleteQueryRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CompleteQueryRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CompleteQueryRequest> parser()
Returns
TypeDescription
Parser<CompleteQueryRequest>

toBuilder()

public CompleteQueryRequest.Builder toBuilder()
Returns
TypeDescription
CompleteQueryRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException