/*
 * Copyright 2020 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/contentwarehouse/v1/document_service.proto

package com.google.cloud.contentwarehouse.v1;

public interface SearchDocumentsResponseOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.contentwarehouse.v1.SearchDocumentsResponse)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * <pre>
   * The document entities that match the specified
   * [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
   * </pre>
   *
   * <code>
   * repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;
   * </code>
   */
  java.util.List<com.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument>
      getMatchingDocumentsList();
  /**
   *
   *
   * <pre>
   * The document entities that match the specified
   * [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
   * </pre>
   *
   * <code>
   * repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;
   * </code>
   */
  com.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument
      getMatchingDocuments(int index);
  /**
   *
   *
   * <pre>
   * The document entities that match the specified
   * [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
   * </pre>
   *
   * <code>
   * repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;
   * </code>
   */
  int getMatchingDocumentsCount();
  /**
   *
   *
   * <pre>
   * The document entities that match the specified
   * [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
   * </pre>
   *
   * <code>
   * repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;
   * </code>
   */
  java.util.List<
          ? extends
              com.google.cloud.contentwarehouse.v1.SearchDocumentsResponse
                  .MatchingDocumentOrBuilder>
      getMatchingDocumentsOrBuilderList();
  /**
   *
   *
   * <pre>
   * The document entities that match the specified
   * [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
   * </pre>
   *
   * <code>
   * repeated .google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument matching_documents = 1;
   * </code>
   */
  com.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocumentOrBuilder
      getMatchingDocumentsOrBuilder(int index);

  /**
   *
   *
   * <pre>
   * The token that specifies the starting position of the next page of results.
   * This field is empty if there are no more results.
   * </pre>
   *
   * <code>string next_page_token = 2;</code>
   *
   * @return The nextPageToken.
   */
  java.lang.String getNextPageToken();
  /**
   *
   *
   * <pre>
   * The token that specifies the starting position of the next page of results.
   * This field is empty if there are no more results.
   * </pre>
   *
   * <code>string next_page_token = 2;</code>
   *
   * @return The bytes for nextPageToken.
   */
  com.google.protobuf.ByteString getNextPageTokenBytes();

  /**
   *
   *
   * <pre>
   * The total number of matched documents which is available only if the client
   * set
   * [SearchDocumentsRequest.require_total_size][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.require_total_size]
   * to `true` or set
   * [SearchDocumentsRequest.total_result_size][google.cloud.contentwarehouse.v1.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 &amp;quot;of
   * many&amp;quot;, for example: &amp;quot;Displaying 10 of many&amp;quot;.
   * </pre>
   *
   * <code>int32 total_size = 3;</code>
   *
   * @return The totalSize.
   */
  int getTotalSize();

  /**
   *
   *
   * <pre>
   * Additional information for the API invocation, such as the request tracking
   * id.
   * </pre>
   *
   * <code>.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;</code>
   *
   * @return Whether the metadata field is set.
   */
  boolean hasMetadata();
  /**
   *
   *
   * <pre>
   * Additional information for the API invocation, such as the request tracking
   * id.
   * </pre>
   *
   * <code>.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;</code>
   *
   * @return The metadata.
   */
  com.google.cloud.contentwarehouse.v1.ResponseMetadata getMetadata();
  /**
   *
   *
   * <pre>
   * Additional information for the API invocation, such as the request tracking
   * id.
   * </pre>
   *
   * <code>.google.cloud.contentwarehouse.v1.ResponseMetadata metadata = 4;</code>
   */
  com.google.cloud.contentwarehouse.v1.ResponseMetadataOrBuilder getMetadataOrBuilder();

  /**
   *
   *
   * <pre>
   * The histogram results that match with the specified
   * [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
   * </pre>
   *
   * <code>
   * repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;
   * </code>
   */
  java.util.List<com.google.cloud.contentwarehouse.v1.HistogramQueryResult>
      getHistogramQueryResultsList();
  /**
   *
   *
   * <pre>
   * The histogram results that match with the specified
   * [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
   * </pre>
   *
   * <code>
   * repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;
   * </code>
   */
  com.google.cloud.contentwarehouse.v1.HistogramQueryResult getHistogramQueryResults(int index);
  /**
   *
   *
   * <pre>
   * The histogram results that match with the specified
   * [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
   * </pre>
   *
   * <code>
   * repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;
   * </code>
   */
  int getHistogramQueryResultsCount();
  /**
   *
   *
   * <pre>
   * The histogram results that match with the specified
   * [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
   * </pre>
   *
   * <code>
   * repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;
   * </code>
   */
  java.util.List<? extends com.google.cloud.contentwarehouse.v1.HistogramQueryResultOrBuilder>
      getHistogramQueryResultsOrBuilderList();
  /**
   *
   *
   * <pre>
   * The histogram results that match with the specified
   * [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
   * </pre>
   *
   * <code>
   * repeated .google.cloud.contentwarehouse.v1.HistogramQueryResult histogram_query_results = 6;
   * </code>
   */
  com.google.cloud.contentwarehouse.v1.HistogramQueryResultOrBuilder
      getHistogramQueryResultsOrBuilder(int index);
}