Class AdvancedCompleteQueryResponse.QuerySuggestion.Builder (0.50.0)

public static final class AdvancedCompleteQueryResponse.QuerySuggestion.Builder extends GeneratedMessageV3.Builder<AdvancedCompleteQueryResponse.QuerySuggestion.Builder> implements AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder

Suggestions as search queries.

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

Static Methods

getDescriptor()

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

Methods

addAllCompletableFieldPaths(Iterable<String> values)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder addAllCompletableFieldPaths(Iterable<String> values)

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
values Iterable<String>

The completableFieldPaths to add.

Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

addAllDataStore(Iterable<String> values)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder addAllDataStore(Iterable<String> values)

The name of the dataStore that this suggestion belongs to.

repeated string data_store = 3;

Parameter
Name Description
values Iterable<String>

The dataStore to add.

Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

addCompletableFieldPaths(String value)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder addCompletableFieldPaths(String value)

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
value String

The completableFieldPaths to add.

Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

addCompletableFieldPathsBytes(ByteString value)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder addCompletableFieldPathsBytes(ByteString value)

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
value ByteString

The bytes of the completableFieldPaths to add.

Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

addDataStore(String value)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder addDataStore(String value)

The name of the dataStore that this suggestion belongs to.

repeated string data_store = 3;

Parameter
Name Description
value String

The dataStore to add.

Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

addDataStoreBytes(ByteString value)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder addDataStoreBytes(ByteString value)

The name of the dataStore that this suggestion belongs to.

repeated string data_store = 3;

Parameter
Name Description
value ByteString

The bytes of the dataStore to add.

Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder
Overrides

build()

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

buildPartial()

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

clear()

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder clear()
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder
Overrides

clearCompletableFieldPaths()

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder clearCompletableFieldPaths()

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
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

clearDataStore()

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder clearDataStore()

The name of the dataStore that this suggestion belongs to.

repeated string data_store = 3;

Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder
Overrides

clearSuggestion()

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder clearSuggestion()

The suggestion for the query.

string suggestion = 1;

Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

clone()

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder clone()
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AdvancedCompleteQueryResponse.QuerySuggestion other)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder mergeFrom(AdvancedCompleteQueryResponse.QuerySuggestion other)
Parameter
Name Description
other AdvancedCompleteQueryResponse.QuerySuggestion
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AdvancedCompleteQueryResponse.QuerySuggestion.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder
Overrides

setCompletableFieldPaths(int index, String value)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder setCompletableFieldPaths(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.

value String

The completableFieldPaths to set.

Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

setDataStore(int index, String value)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder setDataStore(int index, String value)

The name of the dataStore that this suggestion belongs to.

repeated string data_store = 3;

Parameters
Name Description
index int

The index to set the value at.

value String

The dataStore to set.

Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder
Overrides

setSuggestion(String value)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder setSuggestion(String value)

The suggestion for the query.

string suggestion = 1;

Parameter
Name Description
value String

The suggestion to set.

Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

setSuggestionBytes(ByteString value)

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder setSuggestionBytes(ByteString value)

The suggestion for the query.

string suggestion = 1;

Parameter
Name Description
value ByteString

The bytes for suggestion to set.

Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AdvancedCompleteQueryResponse.QuerySuggestion.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion.Builder
Overrides