Package com.google.cloud.contentwarehouse.v1

Interface DocumentQueryOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    DocumentQuery, DocumentQuery.Builder
    public interface DocumentQueryOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getQuery

        String getQuery()
         The query string that matches against the full text of the document and
 the searchable properties.

 The query partially supports [Google AIP style
 syntax](https://google.aip.dev/160). Specifically, the query supports
 literals, logical operators, negation operators, comparison operators, and
 functions.

 Literals: A bare literal value (examples: "42", "Hugo") is a value to be
 matched against. It searches over the full text of the document and the
 searchable properties.

 Logical operators: "AND", "and", "OR", and "or" are binary logical
 operators (example: "engineer OR developer").

 Negation operators: "NOT" and "!" are negation operators (example: "NOT
 software").

 Comparison operators: support the binary comparison operators =, !=, <, >,
 <= and >= for string, numeric, enum, boolean. Also support like operator
 `~~` for string. It provides semantic search functionality by parsing,
 stemming and doing synonyms expansion against the input query.

 To specify a property in the query, the left hand side expression in the
 comparison must be the property ID including the parent. The right hand
 side must be literals. For example:
 "\"projects/123/locations/us\".property_a < 1" matches results whose
 "property_a" is less than 1 in project 123 and us location.
 The literals and comparison expression can be connected in a single query
 (example: "software engineer \"projects/123/locations/us\".salary > 100").

 Functions: supported functions are `LOWER([property_name])` to perform a
 case insensitive match and `EMPTY([property_name])` to filter on the
 existence of a key.

 Support nested expressions connected using parenthesis and logical
 operators. The default logical operators is `AND` if there is no operators
 between expressions.

 The query can be used with other filters e.g. `time_filters` and
 `folder_name_filter`. They are connected with `AND` operator under the
 hood.

 The maximum number of allowed characters is 255.
        string query = 1;
        Returns:
        The query.

      • getQueryBytes

        com.google.protobuf.ByteString getQueryBytes()
         The query string that matches against the full text of the document and
 the searchable properties.

 The query partially supports [Google AIP style
 syntax](https://google.aip.dev/160). Specifically, the query supports
 literals, logical operators, negation operators, comparison operators, and
 functions.

 Literals: A bare literal value (examples: "42", "Hugo") is a value to be
 matched against. It searches over the full text of the document and the
 searchable properties.

 Logical operators: "AND", "and", "OR", and "or" are binary logical
 operators (example: "engineer OR developer").

 Negation operators: "NOT" and "!" are negation operators (example: "NOT
 software").

 Comparison operators: support the binary comparison operators =, !=, <, >,
 <= and >= for string, numeric, enum, boolean. Also support like operator
 `~~` for string. It provides semantic search functionality by parsing,
 stemming and doing synonyms expansion against the input query.

 To specify a property in the query, the left hand side expression in the
 comparison must be the property ID including the parent. The right hand
 side must be literals. For example:
 "\"projects/123/locations/us\".property_a < 1" matches results whose
 "property_a" is less than 1 in project 123 and us location.
 The literals and comparison expression can be connected in a single query
 (example: "software engineer \"projects/123/locations/us\".salary > 100").

 Functions: supported functions are `LOWER([property_name])` to perform a
 case insensitive match and `EMPTY([property_name])` to filter on the
 existence of a key.

 Support nested expressions connected using parenthesis and logical
 operators. The default logical operators is `AND` if there is no operators
 between expressions.

 The query can be used with other filters e.g. `time_filters` and
 `folder_name_filter`. They are connected with `AND` operator under the
 hood.

 The maximum number of allowed characters is 255.
        string query = 1;
        Returns:
        The bytes for query.

      • getIsNlQuery

        boolean getIsNlQuery()
         Experimental, do not use.
 If the query is a natural language question. False by default. If true,
 then the question-answering feature will be used instead of search, and
 `result_count` in
 [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest]
 must be set. In addition, all other input fields related to search
 (pagination, histograms, etc.) will be ignored.
        bool is_nl_query = 12;
        Returns:
        The isNlQuery.

      • getCustomPropertyFilter

        @Deprecated
String getCustomPropertyFilter()
        Deprecated.
        google.cloud.contentwarehouse.v1.DocumentQuery.custom_property_filter is deprecated. See google/cloud/contentwarehouse/v1/filters.proto;l=104
         This filter specifies a structured syntax to match against the
 [PropertyDefinition].[is_filterable][] marked as `true`. The syntax for
 this expression is a subset of SQL syntax.

 Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left
 of the operator is a property name and the right of the operator is a
 number or a quoted string. You must escape backslash (\\) and quote (\")
 characters. Supported functions are `LOWER([property_name])` to perform a
 case insensitive match and `EMPTY([property_name])` to filter on the
 existence of a key.

 Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting
 (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100
 comparisons or functions are allowed in the expression. The expression must
 be < 6000 bytes in length.

 Sample Query:
 `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND
 driving_years > 10`
        string custom_property_filter = 4 [deprecated = true];
        Returns:
        The customPropertyFilter.

      • getCustomPropertyFilterBytes

        @Deprecated
com.google.protobuf.ByteString getCustomPropertyFilterBytes()
        Deprecated.
        google.cloud.contentwarehouse.v1.DocumentQuery.custom_property_filter is deprecated. See google/cloud/contentwarehouse/v1/filters.proto;l=104
         This filter specifies a structured syntax to match against the
 [PropertyDefinition].[is_filterable][] marked as `true`. The syntax for
 this expression is a subset of SQL syntax.

 Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left
 of the operator is a property name and the right of the operator is a
 number or a quoted string. You must escape backslash (\\) and quote (\")
 characters. Supported functions are `LOWER([property_name])` to perform a
 case insensitive match and `EMPTY([property_name])` to filter on the
 existence of a key.

 Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting
 (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100
 comparisons or functions are allowed in the expression. The expression must
 be < 6000 bytes in length.

 Sample Query:
 `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND
 driving_years > 10`
        string custom_property_filter = 4 [deprecated = true];
        Returns:
        The bytes for customPropertyFilter.

      • getTimeFiltersList

        List<TimeFilter> getTimeFiltersList()
         Documents created/updated within a range specified by this filter are
 searched against.
        repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;

      • getTimeFilters

        TimeFilter getTimeFilters​(int index)
         Documents created/updated within a range specified by this filter are
 searched against.
        repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;

      • getTimeFiltersCount

        int getTimeFiltersCount()
         Documents created/updated within a range specified by this filter are
 searched against.
        repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;

      • getTimeFiltersOrBuilderList

        List<? extends TimeFilterOrBuilder> getTimeFiltersOrBuilderList()
         Documents created/updated within a range specified by this filter are
 searched against.
        repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;

      • getTimeFiltersOrBuilder

        TimeFilterOrBuilder getTimeFiltersOrBuilder​(int index)
         Documents created/updated within a range specified by this filter are
 searched against.
        repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;

      • getDocumentSchemaNamesList

        List<String> getDocumentSchemaNamesList()
         This filter specifies the exact document schema
 [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name]
 of the documents to search against.

 If a value isn't specified, documents within the search results are
 associated with any schema. If multiple values are specified, documents
 within the search results may be associated with any of the specified
 schemas.

 At most 20 document schema names are allowed.
        repeated string document_schema_names = 6;
        Returns:
        A list containing the documentSchemaNames.

      • getDocumentSchemaNamesCount

        int getDocumentSchemaNamesCount()
         This filter specifies the exact document schema
 [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name]
 of the documents to search against.

 If a value isn't specified, documents within the search results are
 associated with any schema. If multiple values are specified, documents
 within the search results may be associated with any of the specified
 schemas.

 At most 20 document schema names are allowed.
        repeated string document_schema_names = 6;
        Returns:
        The count of documentSchemaNames.

      • getDocumentSchemaNames

        String getDocumentSchemaNames​(int index)
         This filter specifies the exact document schema
 [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name]
 of the documents to search against.

 If a value isn't specified, documents within the search results are
 associated with any schema. If multiple values are specified, documents
 within the search results may be associated with any of the specified
 schemas.

 At most 20 document schema names are allowed.
        repeated string document_schema_names = 6;
        Parameters:
        index - The index of the element to return.
        Returns:
        The documentSchemaNames at the given index.

      • getDocumentSchemaNamesBytes

        com.google.protobuf.ByteString getDocumentSchemaNamesBytes​(int index)
         This filter specifies the exact document schema
 [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name]
 of the documents to search against.

 If a value isn't specified, documents within the search results are
 associated with any schema. If multiple values are specified, documents
 within the search results may be associated with any of the specified
 schemas.

 At most 20 document schema names are allowed.
        repeated string document_schema_names = 6;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the documentSchemaNames at the given index.

      • getPropertyFilterList

        List<PropertyFilter> getPropertyFilterList()
         This filter specifies a structured syntax to match against the
 [PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable]
 marked as `true`. The relationship between the PropertyFilters is OR.
        repeated .google.cloud.contentwarehouse.v1.PropertyFilter property_filter = 7;

      • getPropertyFilter

        PropertyFilter getPropertyFilter​(int index)
         This filter specifies a structured syntax to match against the
 [PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable]
 marked as `true`. The relationship between the PropertyFilters is OR.
        repeated .google.cloud.contentwarehouse.v1.PropertyFilter property_filter = 7;

      • getPropertyFilterCount

        int getPropertyFilterCount()
         This filter specifies a structured syntax to match against the
 [PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable]
 marked as `true`. The relationship between the PropertyFilters is OR.
        repeated .google.cloud.contentwarehouse.v1.PropertyFilter property_filter = 7;

      • getPropertyFilterOrBuilderList

        List<? extends PropertyFilterOrBuilder> getPropertyFilterOrBuilderList()
         This filter specifies a structured syntax to match against the
 [PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable]
 marked as `true`. The relationship between the PropertyFilters is OR.
        repeated .google.cloud.contentwarehouse.v1.PropertyFilter property_filter = 7;

      • getPropertyFilterOrBuilder

        PropertyFilterOrBuilder getPropertyFilterOrBuilder​(int index)
         This filter specifies a structured syntax to match against the
 [PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable]
 marked as `true`. The relationship between the PropertyFilters is OR.
        repeated .google.cloud.contentwarehouse.v1.PropertyFilter property_filter = 7;

      • hasFileTypeFilter

        boolean hasFileTypeFilter()
         This filter specifies the types of files to return: ALL, FOLDER, or FILE.
 If FOLDER or FILE is specified, then only either folders or files will be
 returned, respectively. If ALL is specified, both folders and files will be
 returned.

 If no value is specified, ALL files will be returned.
        .google.cloud.contentwarehouse.v1.FileTypeFilter file_type_filter = 8;
        Returns:
        Whether the fileTypeFilter field is set.

      • getFileTypeFilter

        FileTypeFilter getFileTypeFilter()
         This filter specifies the types of files to return: ALL, FOLDER, or FILE.
 If FOLDER or FILE is specified, then only either folders or files will be
 returned, respectively. If ALL is specified, both folders and files will be
 returned.

 If no value is specified, ALL files will be returned.
        .google.cloud.contentwarehouse.v1.FileTypeFilter file_type_filter = 8;
        Returns:
        The fileTypeFilter.

      • getFileTypeFilterOrBuilder

        FileTypeFilterOrBuilder getFileTypeFilterOrBuilder()
         This filter specifies the types of files to return: ALL, FOLDER, or FILE.
 If FOLDER or FILE is specified, then only either folders or files will be
 returned, respectively. If ALL is specified, both folders and files will be
 returned.

 If no value is specified, ALL files will be returned.
        .google.cloud.contentwarehouse.v1.FileTypeFilter file_type_filter = 8;

      • getFolderNameFilter

        String getFolderNameFilter()
         Search all the documents under this specified folder.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        string folder_name_filter = 9;
        Returns:
        The folderNameFilter.

      • getFolderNameFilterBytes

        com.google.protobuf.ByteString getFolderNameFilterBytes()
         Search all the documents under this specified folder.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        string folder_name_filter = 9;
        Returns:
        The bytes for folderNameFilter.

      • getDocumentNameFilterList

        List<String> getDocumentNameFilterList()
         Search the documents in the list.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string document_name_filter = 14;
        Returns:
        A list containing the documentNameFilter.

      • getDocumentNameFilterCount

        int getDocumentNameFilterCount()
         Search the documents in the list.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string document_name_filter = 14;
        Returns:
        The count of documentNameFilter.

      • getDocumentNameFilter

        String getDocumentNameFilter​(int index)
         Search the documents in the list.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string document_name_filter = 14;
        Parameters:
        index - The index of the element to return.
        Returns:
        The documentNameFilter at the given index.

      • getDocumentNameFilterBytes

        com.google.protobuf.ByteString getDocumentNameFilterBytes​(int index)
         Search the documents in the list.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string document_name_filter = 14;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the documentNameFilter at the given index.

      • getQueryContextList

        List<String> getQueryContextList()
         For custom synonyms.
 Customers provide the synonyms based on context. One customer can provide
 multiple set of synonyms based on different context. The search query will
 be expanded based on the custom synonyms of the query context set.
 By default, no custom synonyms wll be applied if no query context is
 provided.
 It is not supported for CMEK compliant deployment.
        repeated string query_context = 10;
        Returns:
        A list containing the queryContext.

      • getQueryContextCount

        int getQueryContextCount()
         For custom synonyms.
 Customers provide the synonyms based on context. One customer can provide
 multiple set of synonyms based on different context. The search query will
 be expanded based on the custom synonyms of the query context set.
 By default, no custom synonyms wll be applied if no query context is
 provided.
 It is not supported for CMEK compliant deployment.
        repeated string query_context = 10;
        Returns:
        The count of queryContext.

      • getQueryContext

        String getQueryContext​(int index)
         For custom synonyms.
 Customers provide the synonyms based on context. One customer can provide
 multiple set of synonyms based on different context. The search query will
 be expanded based on the custom synonyms of the query context set.
 By default, no custom synonyms wll be applied if no query context is
 provided.
 It is not supported for CMEK compliant deployment.
        repeated string query_context = 10;
        Parameters:
        index - The index of the element to return.
        Returns:
        The queryContext at the given index.

      • getQueryContextBytes

        com.google.protobuf.ByteString getQueryContextBytes​(int index)
         For custom synonyms.
 Customers provide the synonyms based on context. One customer can provide
 multiple set of synonyms based on different context. The search query will
 be expanded based on the custom synonyms of the query context set.
 By default, no custom synonyms wll be applied if no query context is
 provided.
 It is not supported for CMEK compliant deployment.
        repeated string query_context = 10;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the queryContext at the given index.

      • getDocumentCreatorFilterList

        List<String> getDocumentCreatorFilterList()
         The exact creator(s) of the documents to search against.

 If a value isn't specified, documents within the search results are
 associated with any creator. If multiple values are specified, documents
 within the search results may be associated with any of the specified
 creators.
        repeated string document_creator_filter = 11;
        Returns:
        A list containing the documentCreatorFilter.

      • getDocumentCreatorFilterCount

        int getDocumentCreatorFilterCount()
         The exact creator(s) of the documents to search against.

 If a value isn't specified, documents within the search results are
 associated with any creator. If multiple values are specified, documents
 within the search results may be associated with any of the specified
 creators.
        repeated string document_creator_filter = 11;
        Returns:
        The count of documentCreatorFilter.

      • getDocumentCreatorFilter

        String getDocumentCreatorFilter​(int index)
         The exact creator(s) of the documents to search against.

 If a value isn't specified, documents within the search results are
 associated with any creator. If multiple values are specified, documents
 within the search results may be associated with any of the specified
 creators.
        repeated string document_creator_filter = 11;
        Parameters:
        index - The index of the element to return.
        Returns:
        The documentCreatorFilter at the given index.

      • getDocumentCreatorFilterBytes

        com.google.protobuf.ByteString getDocumentCreatorFilterBytes​(int index)
         The exact creator(s) of the documents to search against.

 If a value isn't specified, documents within the search results are
 associated with any creator. If multiple values are specified, documents
 within the search results may be associated with any of the specified
 creators.
        repeated string document_creator_filter = 11;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the documentCreatorFilter at the given index.

      • hasCustomWeightsMetadata

        boolean hasCustomWeightsMetadata()
         To support the custom weighting across document schemas, customers need to
 provide the properties to be used to boost the ranking in the search
 request. For a search query with CustomWeightsMetadata specified, only the
 RetrievalImportance for the properties in the CustomWeightsMetadata will
 be honored.
        .google.cloud.contentwarehouse.v1.CustomWeightsMetadata custom_weights_metadata = 13;
        Returns:
        Whether the customWeightsMetadata field is set.

      • getCustomWeightsMetadata

        CustomWeightsMetadata getCustomWeightsMetadata()
         To support the custom weighting across document schemas, customers need to
 provide the properties to be used to boost the ranking in the search
 request. For a search query with CustomWeightsMetadata specified, only the
 RetrievalImportance for the properties in the CustomWeightsMetadata will
 be honored.
        .google.cloud.contentwarehouse.v1.CustomWeightsMetadata custom_weights_metadata = 13;
        Returns:
        The customWeightsMetadata.

      • getCustomWeightsMetadataOrBuilder

        CustomWeightsMetadataOrBuilder getCustomWeightsMetadataOrBuilder()
         To support the custom weighting across document schemas, customers need to
 provide the properties to be used to boost the ranking in the search
 request. For a search query with CustomWeightsMetadata specified, only the
 RetrievalImportance for the properties in the CustomWeightsMetadata will
 be honored.
        .google.cloud.contentwarehouse.v1.CustomWeightsMetadata custom_weights_metadata = 13;