public final class AdvancedCompleteQueryRequest extends GeneratedMessageV3 implements AdvancedCompleteQueryRequestOrBuilder
Request message for
CompletionService.AdvancedCompleteQuery
method.
.
Protobuf type google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest
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
BOOST_SPEC_FIELD_NUMBER
public static final int BOOST_SPEC_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
COMPLETION_CONFIG_FIELD_NUMBER
public static final int COMPLETION_CONFIG_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 |
|
SUGGESTION_TYPES_FIELD_NUMBER
public static final int SUGGESTION_TYPES_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
USER_INFO_FIELD_NUMBER
public static final int USER_INFO_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 AdvancedCompleteQueryRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AdvancedCompleteQueryRequest.Builder newBuilder()
newBuilder(AdvancedCompleteQueryRequest prototype)
public static AdvancedCompleteQueryRequest.Builder newBuilder(AdvancedCompleteQueryRequest prototype)
public static AdvancedCompleteQueryRequest parseDelimitedFrom(InputStream input)
public static AdvancedCompleteQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AdvancedCompleteQueryRequest parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AdvancedCompleteQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AdvancedCompleteQueryRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AdvancedCompleteQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AdvancedCompleteQueryRequest parseFrom(CodedInputStream input)
public static AdvancedCompleteQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AdvancedCompleteQueryRequest parseFrom(InputStream input)
public static AdvancedCompleteQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AdvancedCompleteQueryRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AdvancedCompleteQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AdvancedCompleteQueryRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getBoostSpec()
public AdvancedCompleteQueryRequest.BoostSpec getBoostSpec()
Optional. Specification to boost suggestions matching the condition.
.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];
getBoostSpecOrBuilder()
public AdvancedCompleteQueryRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()
Optional. Specification to boost suggestions matching the condition.
.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];
getCompletionConfig()
public String getCompletionConfig()
Required. The completion_config of the parent dataStore or engine resource
name for which the completion is performed, such as
projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig
projects/*/locations/global/collections/default_collection/engines/*/completionConfig
.
string completion_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns |
Type |
Description |
String |
The completionConfig.
|
getCompletionConfigBytes()
public ByteString getCompletionConfigBytes()
Required. The completion_config of the parent dataStore or engine resource
name for which the completion is performed, such as
projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig
projects/*/locations/global/collections/default_collection/engines/*/completionConfig
.
string completion_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns |
Type |
Description |
ByteString |
The bytes for completionConfig.
|
getDefaultInstanceForType()
public AdvancedCompleteQueryRequest 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<AdvancedCompleteQueryRequest> getParserForType()
Overrides
getQuery()
Required. The typeahead input used to fetch suggestions. Maximum length is
128 characters.
The query can not be empty for most of the suggestion types. If it is
empty, an INVALID_ARGUMENT
error is returned. The exception is when the
suggestion_types contains only the type RECENT_SEARCH
, the query can
be an empty string. The is called "zero prefix" feature, which returns
user's recently searched queries given the empty query.
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.
The query can not be empty for most of the suggestion types. If it is
empty, an INVALID_ARGUMENT
error is returned. The exception is when the
suggestion_types contains only the type RECENT_SEARCH
, the query can
be an empty string. The is called "zero prefix" feature, which returns
user's recently searched queries given the empty query.
string query = 2 [(.google.api.field_behavior) = REQUIRED];
Returns |
Type |
Description |
ByteString |
The bytes for query.
|
getQueryModel()
public String getQueryModel()
Specifies the autocomplete data model. This overrides any model specified
in the Configuration > Autocomplete section of the Cloud console. Currently
supported values:
string query_model = 3;
Returns |
Type |
Description |
String |
The queryModel.
|
getQueryModelBytes()
public ByteString getQueryModelBytes()
Specifies the autocomplete data model. This overrides any model specified
in the Configuration > Autocomplete section of the Cloud console. Currently
supported values:
string query_model = 3;
Returns |
Type |
Description |
ByteString |
The bytes for queryModel.
|
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
getSuggestionTypes(int index)
public AdvancedCompleteQueryRequest.SuggestionType getSuggestionTypes(int index)
Optional. Suggestion types to return. If empty or unspecified, query
suggestions are returned. Only one suggestion type is supported at the
moment.
repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];
Parameter |
Name |
Description |
index |
int
The index of the element to return.
|
getSuggestionTypesCount()
public int getSuggestionTypesCount()
Optional. Suggestion types to return. If empty or unspecified, query
suggestions are returned. Only one suggestion type is supported at the
moment.
repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
int |
The count of suggestionTypes.
|
getSuggestionTypesList()
public List<AdvancedCompleteQueryRequest.SuggestionType> getSuggestionTypesList()
Optional. Suggestion types to return. If empty or unspecified, query
suggestions are returned. Only one suggestion type is supported at the
moment.
repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];
getSuggestionTypesValue(int index)
public int getSuggestionTypesValue(int index)
Optional. Suggestion types to return. If empty or unspecified, query
suggestions are returned. Only one suggestion type is supported at the
moment.
repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];
Parameter |
Name |
Description |
index |
int
The index of the value to return.
|
Returns |
Type |
Description |
int |
The enum numeric value on the wire of suggestionTypes at the given index.
|
getSuggestionTypesValueList()
public List<Integer> getSuggestionTypesValueList()
Optional. Suggestion types to return. If empty or unspecified, query
suggestions are returned. Only one suggestion type is supported at the
moment.
repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
List<Integer> |
A list containing the enum numeric values on the wire for suggestionTypes.
|
getUserInfo()
public UserInfo getUserInfo()
Optional. Information about the end user.
This should be the same identifier information as
UserEvent.user_info
and
SearchRequest.user_info.
.google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
UserInfo |
The userInfo.
|
getUserInfoOrBuilder()
public UserInfoOrBuilder getUserInfoOrBuilder()
Optional. Information about the end user.
This should be the same identifier information as
UserEvent.user_info
and
SearchRequest.user_info.
.google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];
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
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
string user_pseudo_id = 4;
Returns |
Type |
Description |
ByteString |
The bytes for userPseudoId.
|
hasBoostSpec()
public boolean hasBoostSpec()
Optional. Specification to boost suggestions matching the condition.
.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
boolean |
Whether the boostSpec field is set.
|
hasUserInfo()
public boolean hasUserInfo()
Optional. Information about the end user.
This should be the same identifier information as
UserEvent.user_info
and
SearchRequest.user_info.
.google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
boolean |
Whether the userInfo field is set.
|
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AdvancedCompleteQueryRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AdvancedCompleteQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public AdvancedCompleteQueryRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides