/*
* 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_request.proto
package com.google.cloud.contentwarehouse.v1;
public interface SearchDocumentsRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.contentwarehouse.v1.SearchDocumentsRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. The parent, which owns this collection of documents.
* Format: projects/{project_number}/locations/{location}.
*
*
*
* string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
*
*
* @return The parent.
*/
java.lang.String getParent();
/**
*
*
*
* Required. The parent, which owns this collection of documents.
* Format: projects/{project_number}/locations/{location}.
*
*
*
* string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
*
*
* @return The bytes for parent.
*/
com.google.protobuf.ByteString getParentBytes();
/**
*
*
*
* The meta information collected about the end user, used to enforce access
* control and improve the search quality of the service.
*
*
* .google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;
*
* @return Whether the requestMetadata field is set.
*/
boolean hasRequestMetadata();
/**
*
*
*
* The meta information collected about the end user, used to enforce access
* control and improve the search quality of the service.
*
*
* .google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;
*
* @return The requestMetadata.
*/
com.google.cloud.contentwarehouse.v1.RequestMetadata getRequestMetadata();
/**
*
*
*
* The meta information collected about the end user, used to enforce access
* control and improve the search quality of the service.
*
*
* .google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;
*/
com.google.cloud.contentwarehouse.v1.RequestMetadataOrBuilder getRequestMetadataOrBuilder();
/**
*
*
*
* Query used to search against documents (keyword, filters, etc.).
*
*
* .google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;
*
* @return Whether the documentQuery field is set.
*/
boolean hasDocumentQuery();
/**
*
*
*
* Query used to search against documents (keyword, filters, etc.).
*
*
* .google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;
*
* @return The documentQuery.
*/
com.google.cloud.contentwarehouse.v1.DocumentQuery getDocumentQuery();
/**
*
*
*
* Query used to search against documents (keyword, filters, etc.).
*
*
* .google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;
*/
com.google.cloud.contentwarehouse.v1.DocumentQueryOrBuilder getDocumentQueryOrBuilder();
/**
*
*
*
* An integer that specifies the current offset (that is, starting result
* location, amongst the documents deemed by the API as relevant) in search
* results. This field is only considered if
* [page_token][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.page_token]
* is unset.
* The maximum allowed value is 5000. Otherwise an error is thrown.
* For example, 0 means to return results starting from the first matching
* document, and 10 means to return from the 11th document. This can be used
* for pagination, (for example, pageSize = 10 and offset = 10 means to return
* from the second page).
*
*
* int32 offset = 5;
*
* @return The offset.
*/
int getOffset();
/**
*
*
*
* A limit on the number of documents returned in the search results.
* Increasing this value above the default value of 10 can increase search
* response time. The value can be between 1 and 100.
*
*
* int32 page_size = 6;
*
* @return The pageSize.
*/
int getPageSize();
/**
*
*
*
* The token specifying the current offset within search results.
* See
* [SearchDocumentsResponse.next_page_token][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token]
* for an explanation of how to obtain the next set of query results.
*
*
* string page_token = 7;
*
* @return The pageToken.
*/
java.lang.String getPageToken();
/**
*
*
*
* The token specifying the current offset within search results.
* See
* [SearchDocumentsResponse.next_page_token][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token]
* for an explanation of how to obtain the next set of query results.
*
*
* string page_token = 7;
*
* @return The bytes for pageToken.
*/
com.google.protobuf.ByteString getPageTokenBytes();
/**
*
*
*
* The criteria determining how search results are sorted. For non-empty
* query, default is `"relevance desc"`. For empty query, default is
* `"upload_date desc"`.
* Supported options are:
* * `"relevance desc"`: By relevance descending, as determined by the API
* algorithms.
* * `"upload_date desc"`: By upload date descending.
* * `"upload_date"`: By upload date ascending.
* * `"update_date desc"`: By last updated date descending.
* * `"update_date"`: By last updated date ascending.
* * `"retrieval_importance desc"`: By retrieval importance of properties
* descending. This feature is still under development, please do not use
* unless otherwise instructed to do so.
*
*
* string order_by = 8;
*
* @return The orderBy.
*/
java.lang.String getOrderBy();
/**
*
*
*
* The criteria determining how search results are sorted. For non-empty
* query, default is `"relevance desc"`. For empty query, default is
* `"upload_date desc"`.
* Supported options are:
* * `"relevance desc"`: By relevance descending, as determined by the API
* algorithms.
* * `"upload_date desc"`: By upload date descending.
* * `"upload_date"`: By upload date ascending.
* * `"update_date desc"`: By last updated date descending.
* * `"update_date"`: By last updated date ascending.
* * `"retrieval_importance desc"`: By retrieval importance of properties
* descending. This feature is still under development, please do not use
* unless otherwise instructed to do so.
*
*
* string order_by = 8;
*
* @return The bytes for orderBy.
*/
com.google.protobuf.ByteString getOrderByBytes();
/**
*
*
*
* An expression specifying a histogram request against matching
* documents. Expression syntax is an aggregation function call with
* histogram facets and other options.
* The following aggregation functions are supported:
* * `count(string_histogram_facet)`: Count the number of matching entities
* for each distinct attribute value.
* Data types:
* * Histogram facet (aka filterable properties): Facet names with format
* <schema id>.<facet>. Facets will have the
* format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child
* facet, then the parent hierarchy needs to be specified separated by
* dots in the prefix after the schema id. Thus, the format for a multi-
* level facet is: <schema id>.<parent facet name>.
* <child facet name>. Example:
* schema123.root_parent_facet.middle_facet.child_facet
* * DocumentSchemaId: (with no schema id prefix) to get
* histograms for each document type (returns the schema id path, e.g.
* projects/12345/locations/us-west/documentSchemas/abc123).
* Example expression:
* * Document type counts:
* count('DocumentSchemaId')
* * For schema id, abc123, get the counts for MORTGAGE_TYPE:
* count('abc123.MORTGAGE_TYPE')
*
*
* repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;
*/
java.util.List getHistogramQueriesList();
/**
*
*
*
* An expression specifying a histogram request against matching
* documents. Expression syntax is an aggregation function call with
* histogram facets and other options.
* The following aggregation functions are supported:
* * `count(string_histogram_facet)`: Count the number of matching entities
* for each distinct attribute value.
* Data types:
* * Histogram facet (aka filterable properties): Facet names with format
* <schema id>.<facet>. Facets will have the
* format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child
* facet, then the parent hierarchy needs to be specified separated by
* dots in the prefix after the schema id. Thus, the format for a multi-
* level facet is: <schema id>.<parent facet name>.
* <child facet name>. Example:
* schema123.root_parent_facet.middle_facet.child_facet
* * DocumentSchemaId: (with no schema id prefix) to get
* histograms for each document type (returns the schema id path, e.g.
* projects/12345/locations/us-west/documentSchemas/abc123).
* Example expression:
* * Document type counts:
* count('DocumentSchemaId')
* * For schema id, abc123, get the counts for MORTGAGE_TYPE:
* count('abc123.MORTGAGE_TYPE')
*
*
* repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;
*/
com.google.cloud.contentwarehouse.v1.HistogramQuery getHistogramQueries(int index);
/**
*
*
*
* An expression specifying a histogram request against matching
* documents. Expression syntax is an aggregation function call with
* histogram facets and other options.
* The following aggregation functions are supported:
* * `count(string_histogram_facet)`: Count the number of matching entities
* for each distinct attribute value.
* Data types:
* * Histogram facet (aka filterable properties): Facet names with format
* <schema id>.<facet>. Facets will have the
* format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child
* facet, then the parent hierarchy needs to be specified separated by
* dots in the prefix after the schema id. Thus, the format for a multi-
* level facet is: <schema id>.<parent facet name>.
* <child facet name>. Example:
* schema123.root_parent_facet.middle_facet.child_facet
* * DocumentSchemaId: (with no schema id prefix) to get
* histograms for each document type (returns the schema id path, e.g.
* projects/12345/locations/us-west/documentSchemas/abc123).
* Example expression:
* * Document type counts:
* count('DocumentSchemaId')
* * For schema id, abc123, get the counts for MORTGAGE_TYPE:
* count('abc123.MORTGAGE_TYPE')
*
*
* repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;
*/
int getHistogramQueriesCount();
/**
*
*
*
* An expression specifying a histogram request against matching
* documents. Expression syntax is an aggregation function call with
* histogram facets and other options.
* The following aggregation functions are supported:
* * `count(string_histogram_facet)`: Count the number of matching entities
* for each distinct attribute value.
* Data types:
* * Histogram facet (aka filterable properties): Facet names with format
* <schema id>.<facet>. Facets will have the
* format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child
* facet, then the parent hierarchy needs to be specified separated by
* dots in the prefix after the schema id. Thus, the format for a multi-
* level facet is: <schema id>.<parent facet name>.
* <child facet name>. Example:
* schema123.root_parent_facet.middle_facet.child_facet
* * DocumentSchemaId: (with no schema id prefix) to get
* histograms for each document type (returns the schema id path, e.g.
* projects/12345/locations/us-west/documentSchemas/abc123).
* Example expression:
* * Document type counts:
* count('DocumentSchemaId')
* * For schema id, abc123, get the counts for MORTGAGE_TYPE:
* count('abc123.MORTGAGE_TYPE')
*
*
* repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;
*/
java.util.List
getHistogramQueriesOrBuilderList();
/**
*
*
*
* An expression specifying a histogram request against matching
* documents. Expression syntax is an aggregation function call with
* histogram facets and other options.
* The following aggregation functions are supported:
* * `count(string_histogram_facet)`: Count the number of matching entities
* for each distinct attribute value.
* Data types:
* * Histogram facet (aka filterable properties): Facet names with format
* <schema id>.<facet>. Facets will have the
* format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child
* facet, then the parent hierarchy needs to be specified separated by
* dots in the prefix after the schema id. Thus, the format for a multi-
* level facet is: <schema id>.<parent facet name>.
* <child facet name>. Example:
* schema123.root_parent_facet.middle_facet.child_facet
* * DocumentSchemaId: (with no schema id prefix) to get
* histograms for each document type (returns the schema id path, e.g.
* projects/12345/locations/us-west/documentSchemas/abc123).
* Example expression:
* * Document type counts:
* count('DocumentSchemaId')
* * For schema id, abc123, get the counts for MORTGAGE_TYPE:
* count('abc123.MORTGAGE_TYPE')
*
*
* repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;
*/
com.google.cloud.contentwarehouse.v1.HistogramQueryOrBuilder getHistogramQueriesOrBuilder(
int index);
/**
*
*
*
* Controls if the search document request requires the return of a total size
* of matched documents. See
* [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size].
* Enabling this flag may adversely impact performance. Hint: If this is
* used with pagination, set this flag on the initial query but set this
* to false on subsequent page calls (keep the total count locally).
* Defaults to false.
*
*
* bool require_total_size = 10;
*
* @return The requireTotalSize.
*/
boolean getRequireTotalSize();
/**
*
*
*
* Controls if the search document request requires the return of a total size
* of matched documents. See
* [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size].
*
*
*
* .google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12;
*
*
* @return The enum numeric value on the wire for totalResultSize.
*/
int getTotalResultSizeValue();
/**
*
*
*
* Controls if the search document request requires the return of a total size
* of matched documents. See
* [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size].
*
*
*
* .google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12;
*
*
* @return The totalResultSize.
*/
com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize getTotalResultSize();
/**
*
*
*
* Experimental, do not use.
* The limit on the number of documents returned for the question-answering
* feature. To enable the question-answering feature, set
* [DocumentQuery].[is_nl_query][] to true.
*
*
* int32 qa_size_limit = 11;
*
* @return The qaSizeLimit.
*/
int getQaSizeLimit();
}