public final class CompleteQueryResponse extends GeneratedMessageV3 implements CompleteQueryResponseOrBuilder
Response message for CompletionService.CompleteQuery method.
Protobuf type google.cloud.discoveryengine.v1.CompleteQueryResponse
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CompleteQueryResponseImplements
CompleteQueryResponseOrBuilderStatic Fields
QUERY_SUGGESTIONS_FIELD_NUMBER
public static final int QUERY_SUGGESTIONS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
TAIL_MATCH_TRIGGERED_FIELD_NUMBER
public static final int TAIL_MATCH_TRIGGERED_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static CompleteQueryResponse getDefaultInstance()
Returns | |
---|---|
Type | Description |
CompleteQueryResponse |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static CompleteQueryResponse.Builder newBuilder()
Returns | |
---|---|
Type | Description |
CompleteQueryResponse.Builder |
newBuilder(CompleteQueryResponse prototype)
public static CompleteQueryResponse.Builder newBuilder(CompleteQueryResponse prototype)
Parameter | |
---|---|
Name | Description |
prototype | CompleteQueryResponse |
Returns | |
---|---|
Type | Description |
CompleteQueryResponse.Builder |
parseDelimitedFrom(InputStream input)
public static CompleteQueryResponse parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
CompleteQueryResponse |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
CompleteQueryResponse |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static CompleteQueryResponse parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data | byte[] |
Returns | |
---|---|
Type | Description |
CompleteQueryResponse |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
CompleteQueryResponse |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static CompleteQueryResponse parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data | ByteString |
Returns | |
---|---|
Type | Description |
CompleteQueryResponse |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
CompleteQueryResponse |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static CompleteQueryResponse parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input | CodedInputStream |
Returns | |
---|---|
Type | Description |
CompleteQueryResponse |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
CompleteQueryResponse |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static CompleteQueryResponse parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
CompleteQueryResponse |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
CompleteQueryResponse |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static CompleteQueryResponse parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data | ByteBuffer |
Returns | |
---|---|
Type | Description |
CompleteQueryResponse |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
CompleteQueryResponse |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<CompleteQueryResponse> parser()
Returns | |
---|---|
Type | Description |
Parser<CompleteQueryResponse> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj | Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public CompleteQueryResponse getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
CompleteQueryResponse |
getParserForType()
public Parser<CompleteQueryResponse> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<CompleteQueryResponse> |
getQuerySuggestions(int index)
public CompleteQueryResponse.QuerySuggestion getQuerySuggestions(int index)
Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.
repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
CompleteQueryResponse.QuerySuggestion |
getQuerySuggestionsCount()
public int getQuerySuggestionsCount()
Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.
repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;
Returns | |
---|---|
Type | Description |
int |
getQuerySuggestionsList()
public List<CompleteQueryResponse.QuerySuggestion> getQuerySuggestionsList()
Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.
repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;
Returns | |
---|---|
Type | Description |
List<QuerySuggestion> |
getQuerySuggestionsOrBuilder(int index)
public CompleteQueryResponse.QuerySuggestionOrBuilder getQuerySuggestionsOrBuilder(int index)
Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.
repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
CompleteQueryResponse.QuerySuggestionOrBuilder |
getQuerySuggestionsOrBuilderList()
public List<? extends CompleteQueryResponse.QuerySuggestionOrBuilder> getQuerySuggestionsOrBuilderList()
Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.
repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestionOrBuilder> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getTailMatchTriggered()
public boolean getTailMatchTriggered()
True if the returned suggestions are all tail suggestions.
For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.
bool tail_match_triggered = 2;
Returns | |
---|---|
Type | Description |
boolean | The tailMatchTriggered. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public CompleteQueryResponse.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
CompleteQueryResponse.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CompleteQueryResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent | BuilderParent |
Returns | |
---|---|
Type | Description |
CompleteQueryResponse.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused | UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public CompleteQueryResponse.Builder toBuilder()
Returns | |
---|---|
Type | Description |
CompleteQueryResponse.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output | CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |