com.google.cloud.talent.v4

Interface CompleteQueryRequestOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

CompleteQueryRequest, CompleteQueryRequest.Builder

public interface CompleteQueryRequestOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getCompany() If provided, restricts completion to specified company.
ByteString	getCompanyBytes() If provided, restricts completion to specified company.
String	getLanguageCodes(int index) The list of languages of the query.
ByteString	getLanguageCodesBytes(int index) The list of languages of the query.
int	getLanguageCodesCount() The list of languages of the query.
List<String>	getLanguageCodesList() The list of languages of the query.
int	getPageSize() Required.
String	getQuery() Required.
ByteString	getQueryBytes() Required.
CompleteQueryRequest.CompletionScope	getScope() The scope of the completion.
int	getScopeValue() The scope of the completion.
String	getTenant() Required.
ByteString	getTenantBytes() Required.
CompleteQueryRequest.CompletionType	getType() The completion topic.
int	getTypeValue() The completion topic.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getTenant

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:

The tenant.

getTenantBytes

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:

The bytes for tenant.

getQuery

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:

The query.

getQueryBytes

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:

The bytes for query.

getLanguageCodesList

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](https://tools.ietf.org/html/bcp47).
 The maximum number of allowed characters is 255.
 

repeated string language_codes = 3;

Returns:

A list containing the languageCodes.

getLanguageCodesCount

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](https://tools.ietf.org/html/bcp47).
 The maximum number of allowed characters is 255.
 

repeated string language_codes = 3;

Returns:

The count of languageCodes.

getLanguageCodes

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](https://tools.ietf.org/html/bcp47).
 The maximum number of allowed characters is 255.
 

repeated string language_codes = 3;

Parameters:

index - The index of the element to return.

Returns:

The languageCodes at the given index.

getLanguageCodesBytes

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](https://tools.ietf.org/html/bcp47).
 The maximum number of allowed characters is 255.
 

repeated string language_codes = 3;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the languageCodes at the given index.

getPageSize

int getPageSize()

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

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

Returns:

The pageSize.

getCompany

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:

The company.

getCompanyBytes

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:

The bytes for company.

getScopeValue

int getScopeValue()

 The scope of the completion. The defaults is [CompletionScope.PUBLIC][google.cloud.talent.v4.CompleteQueryRequest.CompletionScope.PUBLIC].
 

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

Returns:

The enum numeric value on the wire for scope.

getScope

CompleteQueryRequest.CompletionScope getScope()

 The scope of the completion. The defaults is [CompletionScope.PUBLIC][google.cloud.talent.v4.CompleteQueryRequest.CompletionScope.PUBLIC].
 

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

Returns:

The scope.

getTypeValue

int getTypeValue()

 The completion topic. The default is [CompletionType.COMBINED][google.cloud.talent.v4.CompleteQueryRequest.CompletionType.COMBINED].
 

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

Returns:

The enum numeric value on the wire for type.

getType

CompleteQueryRequest.CompletionType getType()

 The completion topic. The default is [CompletionType.COMBINED][google.cloud.talent.v4.CompleteQueryRequest.CompletionType.COMBINED].
 

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

Returns:

The type.