Class SearchResponse.OneBoxResult.Builder (0.47.0)

public static final class SearchResponse.OneBoxResult.Builder extends GeneratedMessageV3.Builder<SearchResponse.OneBoxResult.Builder> implements SearchResponse.OneBoxResultOrBuilder

OneBoxResult is a holder for all results of specific type that we want to display in UI differently.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.OneBoxResult

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchResponse.OneBoxResult.Builder

Implements

SearchResponse.OneBoxResultOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllSearchResults(Iterable<? extends SearchResponse.SearchResult> values)

public SearchResponse.OneBoxResult.Builder addAllSearchResults(Iterable<? extends SearchResponse.SearchResult> values)

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult>`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.OneBoxResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addSearchResults(SearchResponse.SearchResult value)

public SearchResponse.OneBoxResult.Builder addSearchResults(SearchResponse.SearchResult value)

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Parameter
Name	Description
`value`	`SearchResponse.SearchResult`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

addSearchResults(SearchResponse.SearchResult.Builder builderForValue)

public SearchResponse.OneBoxResult.Builder addSearchResults(SearchResponse.SearchResult.Builder builderForValue)

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Parameter
Name	Description
`builderForValue`	`SearchResponse.SearchResult.Builder`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

addSearchResults(int index, SearchResponse.SearchResult value)

public SearchResponse.OneBoxResult.Builder addSearchResults(int index, SearchResponse.SearchResult value)

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Parameters
Name	Description
`index`	`int`
`value`	`SearchResponse.SearchResult`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

addSearchResults(int index, SearchResponse.SearchResult.Builder builderForValue)

public SearchResponse.OneBoxResult.Builder addSearchResults(int index, SearchResponse.SearchResult.Builder builderForValue)

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`SearchResponse.SearchResult.Builder`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

addSearchResultsBuilder()

public SearchResponse.SearchResult.Builder addSearchResultsBuilder()

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Returns
Type	Description
`SearchResponse.SearchResult.Builder`

addSearchResultsBuilder(int index)

public SearchResponse.SearchResult.Builder addSearchResultsBuilder(int index)

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchResponse.SearchResult.Builder`

build()

public SearchResponse.OneBoxResult build()

Returns
Type	Description
`SearchResponse.OneBoxResult`

buildPartial()

public SearchResponse.OneBoxResult buildPartial()

Returns
Type	Description
`SearchResponse.OneBoxResult`

clear()

public SearchResponse.OneBoxResult.Builder clear()

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public SearchResponse.OneBoxResult.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneBoxType()

public SearchResponse.OneBoxResult.Builder clearOneBoxType()

The type of One Box result.

.google.cloud.discoveryengine.v1beta.SearchResponse.OneBoxResult.OneBoxType one_box_type = 1;

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchResponse.OneBoxResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSearchResults()

public SearchResponse.OneBoxResult.Builder clearSearchResults()

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

clone()

public SearchResponse.OneBoxResult.Builder clone()

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SearchResponse.OneBoxResult getDefaultInstanceForType()

Returns
Type	Description
`SearchResponse.OneBoxResult`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getOneBoxType()

public SearchResponse.OneBoxResult.OneBoxType getOneBoxType()

The type of One Box result.

.google.cloud.discoveryengine.v1beta.SearchResponse.OneBoxResult.OneBoxType one_box_type = 1;

Returns
Type	Description
`SearchResponse.OneBoxResult.OneBoxType`	The oneBoxType.

getOneBoxTypeValue()

public int getOneBoxTypeValue()

The type of One Box result.

.google.cloud.discoveryengine.v1beta.SearchResponse.OneBoxResult.OneBoxType one_box_type = 1;

Returns
Type	Description
`int`	The enum numeric value on the wire for oneBoxType.

getSearchResults(int index)

public SearchResponse.SearchResult getSearchResults(int index)

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchResponse.SearchResult`

getSearchResultsBuilder(int index)

public SearchResponse.SearchResult.Builder getSearchResultsBuilder(int index)

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchResponse.SearchResult.Builder`

getSearchResultsBuilderList()

public List<SearchResponse.SearchResult.Builder> getSearchResultsBuilderList()

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Returns
Type	Description
`List<Builder>`

getSearchResultsCount()

public int getSearchResultsCount()

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Returns
Type	Description
`int`

getSearchResultsList()

public List<SearchResponse.SearchResult> getSearchResultsList()

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Returns
Type	Description
`List<SearchResult>`

getSearchResultsOrBuilder(int index)

public SearchResponse.SearchResultOrBuilder getSearchResultsOrBuilder(int index)

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchResponse.SearchResultOrBuilder`

getSearchResultsOrBuilderList()

public List<? extends SearchResponse.SearchResultOrBuilder> getSearchResultsOrBuilderList()

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Returns
Type	Description
`List<? extends com.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResultOrBuilder>`

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(SearchResponse.OneBoxResult other)

public SearchResponse.OneBoxResult.Builder mergeFrom(SearchResponse.OneBoxResult other)

Parameter
Name	Description
`other`	`SearchResponse.OneBoxResult`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchResponse.OneBoxResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public SearchResponse.OneBoxResult.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.OneBoxResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeSearchResults(int index)

public SearchResponse.OneBoxResult.Builder removeSearchResults(int index)

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.OneBoxResult.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setOneBoxType(SearchResponse.OneBoxResult.OneBoxType value)

public SearchResponse.OneBoxResult.Builder setOneBoxType(SearchResponse.OneBoxResult.OneBoxType value)

The type of One Box result.

.google.cloud.discoveryengine.v1beta.SearchResponse.OneBoxResult.OneBoxType one_box_type = 1;

Parameter
Name	Description
`value`	`SearchResponse.OneBoxResult.OneBoxType` The oneBoxType to set.

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`	This builder for chaining.

setOneBoxTypeValue(int value)

public SearchResponse.OneBoxResult.Builder setOneBoxTypeValue(int value)

The type of One Box result.

.google.cloud.discoveryengine.v1beta.SearchResponse.OneBoxResult.OneBoxType one_box_type = 1;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for oneBoxType to set.

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`	This builder for chaining.

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

public SearchResponse.OneBoxResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSearchResults(int index, SearchResponse.SearchResult value)

public SearchResponse.OneBoxResult.Builder setSearchResults(int index, SearchResponse.SearchResult value)

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Parameters
Name	Description
`index`	`int`
`value`	`SearchResponse.SearchResult`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

setSearchResults(int index, SearchResponse.SearchResult.Builder builderForValue)

public SearchResponse.OneBoxResult.Builder setSearchResults(int index, SearchResponse.SearchResult.Builder builderForValue)

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult search_results = 2;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`SearchResponse.SearchResult.Builder`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.OneBoxResult.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchResponse.OneBoxResult.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)