com.google.cloud.discoveryengine.v1beta

Class AdvancedCompleteQueryResponse.QuerySuggestion.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>

com.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.QuerySuggestion.Builder

All Implemented Interfaces:

AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

AdvancedCompleteQueryResponse.QuerySuggestion

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

 Suggestions as search queries.
 

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

Method Summary

Modifier and Type	Method and Description
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.
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	addAllDataStore(Iterable<String> values) The name of the dataStore that this suggestion belongs to.
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.
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	addCompletableFieldPathsBytes(com.google.protobuf.ByteString value) The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	addDataStore(String value) The name of the dataStore that this suggestion belongs to.
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	addDataStoreBytes(com.google.protobuf.ByteString value) The name of the dataStore that this suggestion belongs to.
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AdvancedCompleteQueryResponse.QuerySuggestion	build()
AdvancedCompleteQueryResponse.QuerySuggestion	buildPartial()
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	clear()
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	clearCompletableFieldPaths() The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	clearDataStore() The name of the dataStore that this suggestion belongs to.
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	clearSuggestion() The suggestion for the query.
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	clone()
String	getCompletableFieldPaths(int index) The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.
com.google.protobuf.ByteString	getCompletableFieldPathsBytes(int index) The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.
int	getCompletableFieldPathsCount() The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.
com.google.protobuf.ProtocolStringList	getCompletableFieldPathsList() The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.
String	getDataStore(int index) The name of the dataStore that this suggestion belongs to.
com.google.protobuf.ByteString	getDataStoreBytes(int index) The name of the dataStore that this suggestion belongs to.
int	getDataStoreCount() The name of the dataStore that this suggestion belongs to.
com.google.protobuf.ProtocolStringList	getDataStoreList() The name of the dataStore that this suggestion belongs to.
AdvancedCompleteQueryResponse.QuerySuggestion	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getSuggestion() The suggestion for the query.
com.google.protobuf.ByteString	getSuggestionBytes() The suggestion for the query.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	mergeFrom(AdvancedCompleteQueryResponse.QuerySuggestion other)
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	mergeFrom(com.google.protobuf.Message other)
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
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.
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	setDataStore(int index, String value) The name of the dataStore that this suggestion belongs to.
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	setSuggestion(String value) The suggestion for the query.
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	setSuggestionBytes(com.google.protobuf.ByteString value) The suggestion for the query.
AdvancedCompleteQueryResponse.QuerySuggestion.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>

clear

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>

getDefaultInstanceForType

public AdvancedCompleteQueryResponse.QuerySuggestion getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public AdvancedCompleteQueryResponse.QuerySuggestion build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public AdvancedCompleteQueryResponse.QuerySuggestion buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>

setField

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                      Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>

clearField

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>

clearOneof

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>

setRepeatedField

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                              int index,
                                                                              Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>

addRepeatedField

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                              Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>

mergeFrom

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>

mergeFrom

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder mergeFrom(AdvancedCompleteQueryResponse.QuerySuggestion other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>

mergeFrom

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>

Throws:

IOException

getSuggestion

public String getSuggestion()

 The suggestion for the query.
 

string suggestion = 1;

Specified by:

getSuggestion in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder

Returns:

The suggestion.

getSuggestionBytes

public com.google.protobuf.ByteString getSuggestionBytes()

 The suggestion for the query.
 

string suggestion = 1;

Specified by:

getSuggestionBytes in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder

Returns:

The bytes for suggestion.

setSuggestion

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder setSuggestion(String value)

 The suggestion for the query.
 

string suggestion = 1;

Parameters:

value - The suggestion to set.

Returns:

This builder for chaining.

clearSuggestion

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder clearSuggestion()

 The suggestion for the query.
 

string suggestion = 1;

Returns:

This builder for chaining.

setSuggestionBytes

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder setSuggestionBytes(com.google.protobuf.ByteString value)

 The suggestion for the query.
 

string suggestion = 1;

Parameters:

value - The bytes for suggestion to set.

Returns:

This builder for chaining.

getCompletableFieldPathsList

public com.google.protobuf.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;

Specified by:

getCompletableFieldPathsList in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder

Returns:

A list containing the completableFieldPaths.

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;

Specified by:

getCompletableFieldPathsCount in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder

Returns:

The count of completableFieldPaths.

getCompletableFieldPaths

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;

Specified by:

getCompletableFieldPaths in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The completableFieldPaths at the given index.

getCompletableFieldPathsBytes

public com.google.protobuf.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;

Specified by:

getCompletableFieldPathsBytes in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the completableFieldPaths at the given index.

setCompletableFieldPaths

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:

index - The index to set the value at.

value - The completableFieldPaths to set.

Returns:

This builder for chaining.

addCompletableFieldPaths

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;

Parameters:

value - The completableFieldPaths to add.

Returns:

This builder for chaining.

addAllCompletableFieldPaths

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;

Parameters:

values - The completableFieldPaths to add.

Returns:

This builder for chaining.

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:

This builder for chaining.

addCompletableFieldPathsBytes

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder addCompletableFieldPathsBytes(com.google.protobuf.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;

Parameters:

value - The bytes of the completableFieldPaths to add.

Returns:

This builder for chaining.

getDataStoreList

public com.google.protobuf.ProtocolStringList getDataStoreList()

 The name of the dataStore that this suggestion belongs to.
 

repeated string data_store = 3;

Specified by:

getDataStoreList in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder

Returns:

A list containing the dataStore.

getDataStoreCount

public int getDataStoreCount()

 The name of the dataStore that this suggestion belongs to.
 

repeated string data_store = 3;

Specified by:

getDataStoreCount in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder

Returns:

The count of dataStore.

getDataStore

public String getDataStore(int index)

 The name of the dataStore that this suggestion belongs to.
 

repeated string data_store = 3;

Specified by:

getDataStore in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The dataStore at the given index.

getDataStoreBytes

public com.google.protobuf.ByteString getDataStoreBytes(int index)

 The name of the dataStore that this suggestion belongs to.
 

repeated string data_store = 3;

Specified by:

getDataStoreBytes in interface AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the dataStore at the given index.

setDataStore

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:

index - The index to set the value at.

value - The dataStore to set.

Returns:

This builder for chaining.

addDataStore

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder addDataStore(String value)

 The name of the dataStore that this suggestion belongs to.
 

repeated string data_store = 3;

Parameters:

value - The dataStore to add.

Returns:

This builder for chaining.

addAllDataStore

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

 The name of the dataStore that this suggestion belongs to.
 

repeated string data_store = 3;

Parameters:

values - The dataStore to add.

Returns:

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:

This builder for chaining.

addDataStoreBytes

public AdvancedCompleteQueryResponse.QuerySuggestion.Builder addDataStoreBytes(com.google.protobuf.ByteString value)

 The name of the dataStore that this suggestion belongs to.
 

repeated string data_store = 3;

Parameters:

value - The bytes of the dataStore to add.

Returns:

This builder for chaining.

setUnknownFields

public final AdvancedCompleteQueryResponse.QuerySuggestion.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>

mergeUnknownFields

public final AdvancedCompleteQueryResponse.QuerySuggestion.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AdvancedCompleteQueryResponse.QuerySuggestion.Builder>