Class SearchResponse.OneBoxResult (0.49.0)

public static final class SearchResponse.OneBoxResult extends GeneratedMessageV3 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.v1alpha.SearchResponse.OneBoxResult

Static Fields

ONE_BOX_TYPE_FIELD_NUMBER

public static final int ONE_BOX_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SEARCH_RESULTS_FIELD_NUMBER

public static final int SEARCH_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchResponse.OneBoxResult getDefaultInstance()
Returns
Type Description
SearchResponse.OneBoxResult

getDescriptor()

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

newBuilder()

public static SearchResponse.OneBoxResult.Builder newBuilder()
Returns
Type Description
SearchResponse.OneBoxResult.Builder

newBuilder(SearchResponse.OneBoxResult prototype)

public static SearchResponse.OneBoxResult.Builder newBuilder(SearchResponse.OneBoxResult prototype)
Parameter
Name Description
prototype SearchResponse.OneBoxResult
Returns
Type Description
SearchResponse.OneBoxResult.Builder

parseDelimitedFrom(InputStream input)

public static SearchResponse.OneBoxResult parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchResponse.OneBoxResult
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static SearchResponse.OneBoxResult parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchResponse.OneBoxResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static SearchResponse.OneBoxResult parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchResponse.OneBoxResult
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static SearchResponse.OneBoxResult parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchResponse.OneBoxResult
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static SearchResponse.OneBoxResult parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchResponse.OneBoxResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<SearchResponse.OneBoxResult> parser()
Returns
Type Description
Parser<OneBoxResult>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchResponse.OneBoxResult getDefaultInstanceForType()
Returns
Type Description
SearchResponse.OneBoxResult

getOneBoxType()

public SearchResponse.OneBoxResult.OneBoxType getOneBoxType()

The type of One Box result.

.google.cloud.discoveryengine.v1alpha.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.v1alpha.SearchResponse.OneBoxResult.OneBoxType one_box_type = 1;

Returns
Type Description
int

The enum numeric value on the wire for oneBoxType.

getParserForType()

public Parser<SearchResponse.OneBoxResult> getParserForType()
Returns
Type Description
Parser<OneBoxResult>
Overrides

getSearchResults(int index)

public SearchResponse.SearchResult getSearchResults(int index)

The search results for this One Box.

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

Parameter
Name Description
index int
Returns
Type Description
SearchResponse.SearchResult

getSearchResultsCount()

public int getSearchResultsCount()

The search results for this One Box.

repeated .google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.SearchResponse.SearchResult search_results = 2;

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 SearchResponse.OneBoxResult.Builder newBuilderForType()
Returns
Type Description
SearchResponse.OneBoxResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchResponse.OneBoxResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchResponse.OneBoxResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public SearchResponse.OneBoxResult.Builder toBuilder()
Returns
Type Description
SearchResponse.OneBoxResult.Builder

writeTo(CodedOutputStream output)

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