Class CompleteQueryResponse (0.31.0)

public final class CompleteQueryResponse extends GeneratedMessageV3 implements CompleteQueryResponseOrBuilder

Response message for CompletionService.CompleteQuery method.

Protobuf type google.cloud.discoveryengine.v1beta.CompleteQueryResponse

Static Fields

QUERY_SUGGESTIONS_FIELD_NUMBER

public static final int QUERY_SUGGESTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

TAIL_MATCH_TRIGGERED_FIELD_NUMBER

public static final int TAIL_MATCH_TRIGGERED_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CompleteQueryResponse getDefaultInstance()
Returns
TypeDescription
CompleteQueryResponse

getDescriptor()

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

newBuilder()

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

newBuilder(CompleteQueryResponse prototype)

public static CompleteQueryResponse.Builder newBuilder(CompleteQueryResponse prototype)
Parameter
NameDescription
prototypeCompleteQueryResponse
Returns
TypeDescription
CompleteQueryResponse.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CompleteQueryResponse getDefaultInstanceForType()
Returns
TypeDescription
CompleteQueryResponse

getParserForType()

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

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.v1beta.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Returns
TypeDescription
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.v1beta.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Returns
TypeDescription
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.v1beta.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Returns
TypeDescription
List<? extends com.google.cloud.discoveryengine.v1beta.CompleteQueryResponse.QuerySuggestionOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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

The tailMatchTriggered.

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

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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