public interface SearchDocumentsResponseOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getHistogramQueryResults(int index)
public abstract 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;
| Name | Description |
| index | int |
| Type | Description |
| HistogramQueryResult |
getHistogramQueryResultsCount()
public abstract int getHistogramQueryResultsCount()The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.
repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;
| Type | Description |
| int |
getHistogramQueryResultsList()
public abstract List<HistogramQueryResult> getHistogramQueryResultsList()The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.
repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;
| Type | Description |
| List<HistogramQueryResult> |
getHistogramQueryResultsOrBuilder(int index)
public abstract 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;
| Name | Description |
| index | int |
| Type | Description |
| HistogramQueryResultOrBuilder |
getHistogramQueryResultsOrBuilderList()
public abstract 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;
| Type | Description |
| List<? extends com.google.cloud.contentwarehouse.v1.HistogramQueryResultOrBuilder> |
getMatchingDocuments(int index)
public abstract SearchDocumentsResponse.MatchingDocument getMatchingDocuments(int index)The document entities that match the specified SearchDocumentsRequest.
repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;
| Name | Description |
| index | int |
| Type | Description |
| SearchDocumentsResponse.MatchingDocument |
getMatchingDocumentsCount()
public abstract int getMatchingDocumentsCount()The document entities that match the specified SearchDocumentsRequest.
repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;
| Type | Description |
| int |
getMatchingDocumentsList()
public abstract List<SearchDocumentsResponse.MatchingDocument> getMatchingDocumentsList()The document entities that match the specified SearchDocumentsRequest.
repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;
| Type | Description |
| List<MatchingDocument> |
getMatchingDocumentsOrBuilder(int index)
public abstract SearchDocumentsResponse.MatchingDocumentOrBuilder getMatchingDocumentsOrBuilder(int index)The document entities that match the specified SearchDocumentsRequest.
repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;
| Name | Description |
| index | int |
| Type | Description |
| SearchDocumentsResponse.MatchingDocumentOrBuilder |
getMatchingDocumentsOrBuilderList()
public abstract List<? extends SearchDocumentsResponse.MatchingDocumentOrBuilder> getMatchingDocumentsOrBuilderList()The document entities that match the specified SearchDocumentsRequest.
repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;
| Type | Description |
| List<? extends com.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocumentOrBuilder> |
getMetadata()
public abstract ResponseMetadata getMetadata()Additional information for the API invocation, such as the request tracking id.
.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;
| Type | Description |
| ResponseMetadata | The metadata. |
getMetadataOrBuilder()
public abstract ResponseMetadataOrBuilder getMetadataOrBuilder()Additional information for the API invocation, such as the request tracking id.
.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;
| Type | Description |
| ResponseMetadataOrBuilder |
getNextPageToken()
public abstract 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;
| Type | Description |
| String | The nextPageToken. |
getNextPageTokenBytes()
public abstract 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;
| Type | Description |
| ByteString | The bytes for nextPageToken. |
getTotalSize()
public abstract int getTotalSize() The total number of matched documents which is available only if the client
set SearchDocumentsRequest.require_total_size to true. Otherwise, the
value will be -1. total_size will max at "100,000". If this
is returned, then it can be assumed that the count is equal to or greater
than 100,000. Typically a UI would handle this condition by displaying
"of many", for example: "Displaying 10 of many".
int32 total_size = 3;
| Type | Description |
| int | The totalSize. |
hasMetadata()
public abstract boolean hasMetadata()Additional information for the API invocation, such as the request tracking id.
.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;
| Type | Description |
| boolean | Whether the metadata field is set. |