Class CompleteQueryResponse.QuerySuggestion (0.31.0)

public static final class CompleteQueryResponse.QuerySuggestion extends GeneratedMessageV3 implements CompleteQueryResponse.QuerySuggestionOrBuilder

Suggestions as search queries.

Protobuf type google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CompleteQueryResponse.QuerySuggestion

Static Fields

COMPLETABLE_FIELD_PATHS_FIELD_NUMBER

public static final int COMPLETABLE_FIELD_PATHS_FIELD_NUMBER
Field Value
TypeDescription
int

SUGGESTION_FIELD_NUMBER

public static final int SUGGESTION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CompleteQueryResponse.QuerySuggestion getDefaultInstance()
Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion

getDescriptor()

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

newBuilder()

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

newBuilder(CompleteQueryResponse.QuerySuggestion prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCompletableFieldPaths(int index)

public String getCompletableFieldPaths(int index)

The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.

This field is only populated for the document-completable model.

repeated string completable_field_paths = 2;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The completableFieldPaths at the given index.

getCompletableFieldPathsBytes(int index)

public ByteString getCompletableFieldPathsBytes(int index)

The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.

This field is only populated for the document-completable model.

repeated string completable_field_paths = 2;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the completableFieldPaths at the given index.

getCompletableFieldPathsCount()

public int getCompletableFieldPathsCount()

The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.

This field is only populated for the document-completable model.

repeated string completable_field_paths = 2;

Returns
TypeDescription
int

The count of completableFieldPaths.

getCompletableFieldPathsList()

public ProtocolStringList getCompletableFieldPathsList()

The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.

This field is only populated for the document-completable model.

repeated string completable_field_paths = 2;

Returns
TypeDescription
ProtocolStringList

A list containing the completableFieldPaths.

getDefaultInstanceForType()

public CompleteQueryResponse.QuerySuggestion getDefaultInstanceForType()
Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSuggestion()

public String getSuggestion()

The suggestion for the query.

string suggestion = 1;

Returns
TypeDescription
String

The suggestion.

getSuggestionBytes()

public ByteString getSuggestionBytes()

The suggestion for the query.

string suggestion = 1;

Returns
TypeDescription
ByteString

The bytes for suggestion.

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.QuerySuggestion.Builder newBuilderForType()
Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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