Class SearchDataObjectsResponse (0.1.0)

public final class SearchDataObjectsResponse extends GeneratedMessageV3 implements SearchDataObjectsResponseOrBuilder

Response for a search request.

Protobuf type google.cloud.vectorsearch.v1beta.SearchDataObjectsResponse

Static Fields

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

RESULTS_FIELD_NUMBER

public static final int RESULTS_FIELD_NUMBER
Field Value
Type Description
int

SEARCH_RESPONSE_METADATA_FIELD_NUMBER

public static final int SEARCH_RESPONSE_METADATA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchDataObjectsResponse getDefaultInstance()
Returns
Type Description
SearchDataObjectsResponse

getDescriptor()

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

newBuilder()

public static SearchDataObjectsResponse.Builder newBuilder()
Returns
Type Description
SearchDataObjectsResponse.Builder

newBuilder(SearchDataObjectsResponse prototype)

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

parseDelimitedFrom(InputStream input)

public static SearchDataObjectsResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchDataObjectsResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static SearchDataObjectsResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchDataObjectsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static SearchDataObjectsResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchDataObjectsResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static SearchDataObjectsResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchDataObjectsResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static SearchDataObjectsResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchDataObjectsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<SearchDataObjectsResponse> parser()
Returns
Type Description
Parser<SearchDataObjectsResponse>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SearchDataObjectsResponse getDefaultInstanceForType()
Returns
Type Description
SearchDataObjectsResponse

getNextPageToken()

public String getNextPageToken()

Output only. A token to retrieve next page of results. Pass to [DataObjectSearchService.SearchDataObjectsRequest.page_token][] to obtain that page.

string next_page_token = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The nextPageToken.

getNextPageTokenBytes()

public ByteString getNextPageTokenBytes()

Output only. A token to retrieve next page of results. Pass to [DataObjectSearchService.SearchDataObjectsRequest.page_token][] to obtain that page.

string next_page_token = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for nextPageToken.

getParserForType()

public Parser<SearchDataObjectsResponse> getParserForType()
Returns
Type Description
Parser<SearchDataObjectsResponse>
Overrides

getResults(int index)

public SearchResult getResults(int index)

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
SearchResult

getResultsCount()

public int getResultsCount()

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getResultsList()

public List<SearchResult> getResultsList()

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<SearchResult>

getResultsOrBuilder(int index)

public SearchResultOrBuilder getResultsOrBuilder(int index)

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
SearchResultOrBuilder

getResultsOrBuilderList()

public List<? extends SearchResultOrBuilder> getResultsOrBuilderList()

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.vectorsearch.v1beta.SearchResultOrBuilder>

getSearchResponseMetadata()

public SearchResponseMetadata getSearchResponseMetadata()

Output only. Metadata about the search execution.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SearchResponseMetadata

The searchResponseMetadata.

getSearchResponseMetadataOrBuilder()

public SearchResponseMetadataOrBuilder getSearchResponseMetadataOrBuilder()

Output only. Metadata about the search execution.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SearchResponseMetadataOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasSearchResponseMetadata()

public boolean hasSearchResponseMetadata()

Output only. Metadata about the search execution.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the searchResponseMetadata field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public SearchDataObjectsResponse.Builder toBuilder()
Returns
Type Description
SearchDataObjectsResponse.Builder

writeTo(CodedOutputStream output)

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