Class AdvancedCompleteQueryResponse.QuerySuggestion (0.51.0)

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

Suggestions as search queries.

Protobuf type google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.QuerySuggestion

Inheritance

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

Static Fields

COMPLETABLE_FIELD_PATHS_FIELD_NUMBER

public static final int COMPLETABLE_FIELD_PATHS_FIELD_NUMBER
Field Value
Type Description
int

DATA_STORE_FIELD_NUMBER

public static final int DATA_STORE_FIELD_NUMBER
Field Value
Type Description
int

SUGGESTION_FIELD_NUMBER

public static final int SUGGESTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AdvancedCompleteQueryResponse.QuerySuggestion getDefaultInstance()
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AdvancedCompleteQueryResponse.QuerySuggestion.Builder newBuilder()
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

newBuilder(AdvancedCompleteQueryResponse.QuerySuggestion prototype)

public static AdvancedCompleteQueryResponse.QuerySuggestion.Builder newBuilder(AdvancedCompleteQueryResponse.QuerySuggestion prototype)
Parameter
Name Description
prototype AdvancedCompleteQueryResponse.QuerySuggestion
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

parseDelimitedFrom(InputStream input)

public static AdvancedCompleteQueryResponse.QuerySuggestion parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryResponse.QuerySuggestion parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AdvancedCompleteQueryResponse.QuerySuggestion parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryResponse.QuerySuggestion parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AdvancedCompleteQueryResponse.QuerySuggestion parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryResponse.QuerySuggestion parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AdvancedCompleteQueryResponse.QuerySuggestion parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryResponse.QuerySuggestion parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AdvancedCompleteQueryResponse.QuerySuggestion parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryResponse.QuerySuggestion parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AdvancedCompleteQueryResponse.QuerySuggestion parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryResponse.QuerySuggestion parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AdvancedCompleteQueryResponse.QuerySuggestion> parser()
Returns
Type Description
Parser<QuerySuggestion>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
ProtocolStringList

A list containing the completableFieldPaths.

getDataStore(int index)

public String getDataStore(int index)

The name of the dataStore that this suggestion belongs to.

repeated string data_store = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The dataStore at the given index.

getDataStoreBytes(int index)

public ByteString getDataStoreBytes(int index)

The name of the dataStore that this suggestion belongs to.

repeated string data_store = 3;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the dataStore at the given index.

getDataStoreCount()

public int getDataStoreCount()

The name of the dataStore that this suggestion belongs to.

repeated string data_store = 3;

Returns
Type Description
int

The count of dataStore.

getDataStoreList()

public ProtocolStringList getDataStoreList()

The name of the dataStore that this suggestion belongs to.

repeated string data_store = 3;

Returns
Type Description
ProtocolStringList

A list containing the dataStore.

getDefaultInstanceForType()

public AdvancedCompleteQueryResponse.QuerySuggestion getDefaultInstanceForType()
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion

getParserForType()

public Parser<AdvancedCompleteQueryResponse.QuerySuggestion> getParserForType()
Returns
Type Description
Parser<QuerySuggestion>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSuggestion()

public String getSuggestion()

The suggestion for the query.

string suggestion = 1;

Returns
Type Description
String

The suggestion.

getSuggestionBytes()

public ByteString getSuggestionBytes()

The suggestion for the query.

string suggestion = 1;

Returns
Type Description
ByteString

The bytes for suggestion.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder newBuilderForType()
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AdvancedCompleteQueryResponse.QuerySuggestion.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder toBuilder()
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException