Send feedback
Class SearchDocumentsResponse (0.18.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.18.0keyboard_arrow_down
public final class SearchDocumentsResponse extends GeneratedMessageV3 implements SearchDocumentsResponseOrBuilder
Response message for DocumentService.SearchDocuments.
Protobuf type google.cloud.contentwarehouse.v1.SearchDocumentsResponse
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
HISTOGRAM_QUERY_RESULTS_FIELD_NUMBER
public static final int HISTOGRAM_QUERY_RESULTS_FIELD_NUMBER
Field Value
Type Description
int
MATCHING_DOCUMENTS_FIELD_NUMBER
public static final int MATCHING_DOCUMENTS_FIELD_NUMBER
Field Value
Type Description
int
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int
NEXT_PAGE_TOKEN_FIELD_NUMBER
public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int
TOTAL_SIZE_FIELD_NUMBER
public static final int TOTAL_SIZE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static SearchDocumentsResponse getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static SearchDocumentsResponse . Builder newBuilder ()
newBuilder(SearchDocumentsResponse prototype)
public static SearchDocumentsResponse . Builder newBuilder ( SearchDocumentsResponse prototype )
parseDelimitedFrom(InputStream input)
public static SearchDocumentsResponse parseDelimitedFrom ( InputStream input )
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsResponse parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static SearchDocumentsResponse parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsResponse parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static SearchDocumentsResponse parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsResponse parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
parseFrom(CodedInputStream input)
public static SearchDocumentsResponse parseFrom ( CodedInputStream input )
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsResponse parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(InputStream input)
public static SearchDocumentsResponse parseFrom ( InputStream input )
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsResponse parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static SearchDocumentsResponse parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsResponse parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<SearchDocumentsResponse> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public SearchDocumentsResponse getDefaultInstanceForType ()
getHistogramQueryResults(int index)
public HistogramQueryResult getHistogramQueryResults ( int index )
The histogram results that match with the specified
SearchDocumentsRequest.histogram_queries .
repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;
Parameter
Name Description
indexint
getHistogramQueryResultsCount()
public int getHistogramQueryResultsCount ()
The histogram results that match with the specified
SearchDocumentsRequest.histogram_queries .
repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;
Returns
Type Description
int
getHistogramQueryResultsList()
public List<HistogramQueryResult> getHistogramQueryResultsList ()
The histogram results that match with the specified
SearchDocumentsRequest.histogram_queries .
repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;
getHistogramQueryResultsOrBuilder(int index)
public HistogramQueryResultOrBuilder getHistogramQueryResultsOrBuilder ( int index )
The histogram results that match with the specified
SearchDocumentsRequest.histogram_queries .
repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;
Parameter
Name Description
indexint
getHistogramQueryResultsOrBuilderList()
public List <? extends HistogramQueryResultOrBuilder > getHistogramQueryResultsOrBuilderList ()
The histogram results that match with the specified
SearchDocumentsRequest.histogram_queries .
repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;
Returns
Type Description
List <? extends com.google.cloud.contentwarehouse.v1.HistogramQueryResultOrBuilder >
getMatchingDocuments(int index)
public SearchDocumentsResponse . MatchingDocument getMatchingDocuments ( int index )
The document entities that match the specified
SearchDocumentsRequest .
repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;
Parameter
Name Description
indexint
getMatchingDocumentsCount()
public int getMatchingDocumentsCount ()
The document entities that match the specified
SearchDocumentsRequest .
repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;
Returns
Type Description
int
getMatchingDocumentsList()
public List<SearchDocumentsResponse . MatchingDocument > getMatchingDocumentsList ()
The document entities that match the specified
SearchDocumentsRequest .
repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;
getMatchingDocumentsOrBuilder(int index)
public SearchDocumentsResponse . MatchingDocumentOrBuilder getMatchingDocumentsOrBuilder ( int index )
The document entities that match the specified
SearchDocumentsRequest .
repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;
Parameter
Name Description
indexint
getMatchingDocumentsOrBuilderList()
public List <? extends SearchDocumentsResponse . MatchingDocumentOrBuilder > getMatchingDocumentsOrBuilderList ()
The document entities that match the specified
SearchDocumentsRequest .
repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;
Returns
Type Description
List <? extends com.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocumentOrBuilder >
getMetadata()
public ResponseMetadata getMetadata ()
Additional information for the API invocation, such as the request tracking
id.
.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;
getMetadataOrBuilder()
public ResponseMetadataOrBuilder getMetadataOrBuilder ()
Additional information for the API invocation, such as the request tracking
id.
.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;
getNextPageToken()
public String getNextPageToken ()
The token that specifies the starting position of the next page of results.
This field is empty if there are no more results.
string next_page_token = 2;
Returns
Type Description
String The nextPageToken.
getNextPageTokenBytes()
public ByteString getNextPageTokenBytes ()
The token that specifies the starting position of the next page of results.
This field is empty if there are no more results.
string next_page_token = 2;
Returns
Type Description
ByteString The bytes for nextPageToken.
getParserForType()
public Parser<SearchDocumentsResponse> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getTotalSize()
public int getTotalSize ()
The total number of matched documents which is available only if the client
set
SearchDocumentsRequest.require_total_size
to true or set
SearchDocumentsRequest.total_result_size
to ESTIMATED_SIZE or ACTUAL_SIZE. Otherwise, the value will be -1.
Typically a UI would handle this condition by displaying "of
many", for example: "Displaying 10 of many".
int32 total_size = 3;
Returns
Type Description
int The totalSize.
hasMetadata()
public boolean hasMetadata ()
Additional information for the API invocation, such as the request tracking
id.
.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;
Returns
Type Description
boolean Whether the metadata field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public SearchDocumentsResponse . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchDocumentsResponse . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public SearchDocumentsResponse . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-04 UTC."],[],[]]
