public final class CompleteQueryRequest extends GeneratedMessageV3 implements CompleteQueryRequestOrBuilder
Request message for
CompletionService.CompleteQuery
method.
Protobuf type google.cloud.discoveryengine.v1alpha.CompleteQueryRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DATA_STORE_FIELD_NUMBER
public static final int DATA_STORE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INCLUDE_TAIL_SUGGESTIONS_FIELD_NUMBER
public static final int INCLUDE_TAIL_SUGGESTIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
QUERY_MODEL_FIELD_NUMBER
public static final int QUERY_MODEL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
USER_PSEUDO_ID_FIELD_NUMBER
public static final int USER_PSEUDO_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static CompleteQueryRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CompleteQueryRequest.Builder newBuilder()
newBuilder(CompleteQueryRequest prototype)
public static CompleteQueryRequest.Builder newBuilder(CompleteQueryRequest prototype)
public static CompleteQueryRequest parseDelimitedFrom(InputStream input)
public static CompleteQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CompleteQueryRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CompleteQueryRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryRequest parseFrom(CodedInputStream input)
public static CompleteQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryRequest parseFrom(InputStream input)
public static CompleteQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CompleteQueryRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CompleteQueryRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDataStore()
public String getDataStore()
Required. The parent data store resource name for which the completion is
performed, such as
projects/*/locations/global/collections/default_collection/dataStores/default_data_store.
string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
String | The dataStore.
|
getDataStoreBytes()
public ByteString getDataStoreBytes()
Required. The parent data store resource name for which the completion is
performed, such as
projects/*/locations/global/collections/default_collection/dataStores/default_data_store.
string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for dataStore.
|
getDefaultInstanceForType()
public CompleteQueryRequest getDefaultInstanceForType()
getIncludeTailSuggestions()
public boolean getIncludeTailSuggestions()
Indicates if tail suggestions should be returned if there are no
suggestions that match the full query. Even if set to true, if there are
suggestions that match the full query, those are returned and no
tail suggestions are returned.
bool include_tail_suggestions = 5;
| Returns |
|---|
| Type | Description |
boolean | The includeTailSuggestions.
|
getParserForType()
public Parser<CompleteQueryRequest> getParserForType()
Overrides
getQuery()
Required. The typeahead input used to fetch suggestions. Maximum length is
128 characters.
string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The query.
|
getQueryBytes()
public ByteString getQueryBytes()
Required. The typeahead input used to fetch suggestions. Maximum length is
128 characters.
string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for query.
|
getQueryModel()
public String getQueryModel()
Selects data model of query suggestions for serving. Currently supported
values:
string query_model = 3;
| Returns |
|---|
| Type | Description |
String | The queryModel.
|
getQueryModelBytes()
public ByteString getQueryModelBytes()
Selects data model of query suggestions for serving. Currently supported
values:
string query_model = 3;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for queryModel.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUserPseudoId()
public String getUserPseudoId()
A unique identifier for tracking visitors. For example, this could be
implemented with an HTTP cookie, which should be able to uniquely identify
a visitor on a single device. This unique identifier should not change if
the visitor logs in or out of the website.
This field should NOT have a fixed value such as unknown_visitor.
This should be the same identifier as
UserEvent.user_pseudo_id
and
SearchRequest.user_pseudo_id.
The field must be a UTF-8 encoded string with a length limit of 128
characters. Otherwise, an INVALID_ARGUMENT error is returned.
string user_pseudo_id = 4;
| Returns |
|---|
| Type | Description |
String | The userPseudoId.
|
getUserPseudoIdBytes()
public ByteString getUserPseudoIdBytes()
A unique identifier for tracking visitors. For example, this could be
implemented with an HTTP cookie, which should be able to uniquely identify
a visitor on a single device. This unique identifier should not change if
the visitor logs in or out of the website.
This field should NOT have a fixed value such as unknown_visitor.
This should be the same identifier as
UserEvent.user_pseudo_id
and
SearchRequest.user_pseudo_id.
The field must be a UTF-8 encoded string with a length limit of 128
characters. Otherwise, an INVALID_ARGUMENT error is returned.
string user_pseudo_id = 4;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for userPseudoId.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CompleteQueryRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CompleteQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public CompleteQueryRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
