Package com.google.cloud.contentwarehouse.v1

Class SearchDocumentsRequest

  • All Implemented Interfaces:
    SearchDocumentsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class SearchDocumentsRequest
extends com.google.protobuf.GeneratedMessageV3
implements SearchDocumentsRequestOrBuilder
     Request message for DocumentService.SearchDocuments.
    Protobuf type google.cloud.contentwarehouse.v1.SearchDocumentsRequest
    See Also:
    Serialized Form

    • Field Detail

      • REQUEST_METADATA_FIELD_NUMBER

        public static final int REQUEST_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCUMENT_QUERY_FIELD_NUMBER

        public static final int DOCUMENT_QUERY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PAGE_TOKEN_FIELD_NUMBER

        public static final int PAGE_TOKEN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HISTOGRAM_QUERIES_FIELD_NUMBER

        public static final int HISTOGRAM_QUERIES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUIRE_TOTAL_SIZE_FIELD_NUMBER

        public static final int REQUIRE_TOTAL_SIZE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOTAL_RESULT_SIZE_FIELD_NUMBER

        public static final int TOTAL_RESULT_SIZE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • QA_SIZE_LIMIT_FIELD_NUMBER

        public static final int QA_SIZE_LIMIT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getParent

        public 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) = { ... }
        Specified by:
        getParent in interface SearchDocumentsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         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) = { ... }
        Specified by:
        getParentBytes in interface SearchDocumentsRequestOrBuilder
        Returns:
        The bytes for parent.

      • hasRequestMetadata

        public 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;
        Specified by:
        hasRequestMetadata in interface SearchDocumentsRequestOrBuilder
        Returns:
        Whether the requestMetadata field is set.

      • getRequestMetadata

        public 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;
        Specified by:
        getRequestMetadata in interface SearchDocumentsRequestOrBuilder
        Returns:
        The requestMetadata.

      • hasDocumentQuery

        public boolean hasDocumentQuery()
         Query used to search against documents (keyword, filters, etc.).
        .google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;
        Specified by:
        hasDocumentQuery in interface SearchDocumentsRequestOrBuilder
        Returns:
        Whether the documentQuery field is set.

      • getOffset

        public int getOffset()
         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;
        Specified by:
        getOffset in interface SearchDocumentsRequestOrBuilder
        Returns:
        The offset.

      • getPageSize

        public int getPageSize()
         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;
        Specified by:
        getPageSize in interface SearchDocumentsRequestOrBuilder
        Returns:
        The pageSize.

      • getPageToken

        public 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;
        Specified by:
        getPageToken in interface SearchDocumentsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         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;
        Specified by:
        getPageTokenBytes in interface SearchDocumentsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • getOrderBy

        public 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;
        Specified by:
        getOrderBy in interface SearchDocumentsRequestOrBuilder
        Returns:
        The orderBy.

      • getOrderByBytes

        public com.google.protobuf.ByteString getOrderByBytes()
         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;
        Specified by:
        getOrderByBytes in interface SearchDocumentsRequestOrBuilder
        Returns:
        The bytes for orderBy.

      • getHistogramQueriesList

        public List<HistogramQuery> 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
 &lt;schema id&gt;.&lt;facet&gt;. 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: &lt;schema id&gt;.&lt;parent facet name&gt;.
 &lt;child facet name&gt;. 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;
        Specified by:
        getHistogramQueriesList in interface SearchDocumentsRequestOrBuilder

      • getHistogramQueriesOrBuilderList

        public List<? extends HistogramQueryOrBuilder> 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
 &lt;schema id&gt;.&lt;facet&gt;. 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: &lt;schema id&gt;.&lt;parent facet name&gt;.
 &lt;child facet name&gt;. 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;
        Specified by:
        getHistogramQueriesOrBuilderList in interface SearchDocumentsRequestOrBuilder

      • getHistogramQueriesCount

        public 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
 &lt;schema id&gt;.&lt;facet&gt;. 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: &lt;schema id&gt;.&lt;parent facet name&gt;.
 &lt;child facet name&gt;. 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;
        Specified by:
        getHistogramQueriesCount in interface SearchDocumentsRequestOrBuilder

      • getHistogramQueries

        public 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
 &lt;schema id&gt;.&lt;facet&gt;. 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: &lt;schema id&gt;.&lt;parent facet name&gt;.
 &lt;child facet name&gt;. 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;
        Specified by:
        getHistogramQueries in interface SearchDocumentsRequestOrBuilder

      • getHistogramQueriesOrBuilder

        public HistogramQueryOrBuilder getHistogramQueriesOrBuilder​(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
 &lt;schema id&gt;.&lt;facet&gt;. 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: &lt;schema id&gt;.&lt;parent facet name&gt;.
 &lt;child facet name&gt;. 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;
        Specified by:
        getHistogramQueriesOrBuilder in interface SearchDocumentsRequestOrBuilder

      • getRequireTotalSize

        public 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].

 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;
        Specified by:
        getRequireTotalSize in interface SearchDocumentsRequestOrBuilder
        Returns:
        The requireTotalSize.

      • getTotalResultSizeValue

        public 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;
        Specified by:
        getTotalResultSizeValue in interface SearchDocumentsRequestOrBuilder
        Returns:
        The enum numeric value on the wire for totalResultSize.

      • getTotalResultSize

        public SearchDocumentsRequest.TotalResultSize getTotalResultSize()
         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;
        Specified by:
        getTotalResultSize in interface SearchDocumentsRequestOrBuilder
        Returns:
        The totalResultSize.

      • getQaSizeLimit

        public int getQaSizeLimit()
         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;
        Specified by:
        getQaSizeLimit in interface SearchDocumentsRequestOrBuilder
        Returns:
        The qaSizeLimit.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static SearchDocumentsRequest parseFrom​(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchDocumentsRequest parseFrom​(ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchDocumentsRequest parseFrom​(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchDocumentsRequest parseFrom​(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchDocumentsRequest parseFrom​(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchDocumentsRequest parseFrom​(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public SearchDocumentsRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public SearchDocumentsRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected SearchDocumentsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<SearchDocumentsRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public SearchDocumentsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder