Package com.google.cloud.contentwarehouse.v1

Class DocumentQuery

  • All Implemented Interfaces:
    DocumentQueryOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class DocumentQuery
extends com.google.protobuf.GeneratedMessageV3
implements DocumentQueryOrBuilder
    Protobuf type google.cloud.contentwarehouse.v1.DocumentQuery
    See Also:
    Serialized Form

    • Field Detail

      • IS_NL_QUERY_FIELD_NUMBER

        public static final int IS_NL_QUERY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CUSTOM_PROPERTY_FILTER_FIELD_NUMBER

        public static final int CUSTOM_PROPERTY_FILTER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TIME_FILTERS_FIELD_NUMBER

        public static final int TIME_FILTERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCUMENT_SCHEMA_NAMES_FIELD_NUMBER

        public static final int DOCUMENT_SCHEMA_NAMES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROPERTY_FILTER_FIELD_NUMBER

        public static final int PROPERTY_FILTER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FILE_TYPE_FILTER_FIELD_NUMBER

        public static final int FILE_TYPE_FILTER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FOLDER_NAME_FILTER_FIELD_NUMBER

        public static final int FOLDER_NAME_FILTER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCUMENT_NAME_FILTER_FIELD_NUMBER

        public static final int DOCUMENT_NAME_FILTER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • QUERY_CONTEXT_FIELD_NUMBER

        public static final int QUERY_CONTEXT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCUMENT_CREATOR_FILTER_FIELD_NUMBER

        public static final int DOCUMENT_CREATOR_FILTER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CUSTOM_WEIGHTS_METADATA_FIELD_NUMBER

        public static final int CUSTOM_WEIGHTS_METADATA_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

      • getQuery

        public 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;
        Specified by:
        getQuery in interface DocumentQueryOrBuilder
        Returns:
        The query.

      • getQueryBytes

        public 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;
        Specified by:
        getQueryBytes in interface DocumentQueryOrBuilder
        Returns:
        The bytes for query.

      • getIsNlQuery

        public 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;
        Specified by:
        getIsNlQuery in interface DocumentQueryOrBuilder
        Returns:
        The isNlQuery.

      • getCustomPropertyFilter

        @Deprecated
public 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];
        Specified by:
        getCustomPropertyFilter in interface DocumentQueryOrBuilder
        Returns:
        The customPropertyFilter.

      • getCustomPropertyFilterBytes

        @Deprecated
public 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];
        Specified by:
        getCustomPropertyFilterBytes in interface DocumentQueryOrBuilder
        Returns:
        The bytes for customPropertyFilter.

      • getTimeFiltersList

        public 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;
        Specified by:
        getTimeFiltersList in interface DocumentQueryOrBuilder

      • getTimeFiltersCount

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

      • getTimeFilters

        public 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;
        Specified by:
        getTimeFilters in interface DocumentQueryOrBuilder

      • getTimeFiltersOrBuilder

        public 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;
        Specified by:
        getTimeFiltersOrBuilder in interface DocumentQueryOrBuilder

      • getDocumentSchemaNamesList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getDocumentSchemaNamesList in interface DocumentQueryOrBuilder
        Returns:
        A list containing the documentSchemaNames.

      • getDocumentSchemaNamesCount

        public 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;
        Specified by:
        getDocumentSchemaNamesCount in interface DocumentQueryOrBuilder
        Returns:
        The count of documentSchemaNames.

      • getDocumentSchemaNames

        public 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;
        Specified by:
        getDocumentSchemaNames in interface DocumentQueryOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The documentSchemaNames at the given index.

      • getDocumentSchemaNamesBytes

        public 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;
        Specified by:
        getDocumentSchemaNamesBytes in interface DocumentQueryOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the documentSchemaNames at the given index.

      • getPropertyFilterList

        public 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;
        Specified by:
        getPropertyFilterList in interface DocumentQueryOrBuilder

      • getPropertyFilterOrBuilderList

        public 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;
        Specified by:
        getPropertyFilterOrBuilderList in interface DocumentQueryOrBuilder

      • getPropertyFilterCount

        public 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;
        Specified by:
        getPropertyFilterCount in interface DocumentQueryOrBuilder

      • getPropertyFilter

        public 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;
        Specified by:
        getPropertyFilter in interface DocumentQueryOrBuilder

      • getPropertyFilterOrBuilder

        public 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;
        Specified by:
        getPropertyFilterOrBuilder in interface DocumentQueryOrBuilder

      • hasFileTypeFilter

        public 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;
        Specified by:
        hasFileTypeFilter in interface DocumentQueryOrBuilder
        Returns:
        Whether the fileTypeFilter field is set.

      • getFileTypeFilter

        public 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;
        Specified by:
        getFileTypeFilter in interface DocumentQueryOrBuilder
        Returns:
        The fileTypeFilter.

      • getFileTypeFilterOrBuilder

        public 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;
        Specified by:
        getFileTypeFilterOrBuilder in interface DocumentQueryOrBuilder

      • getFolderNameFilter

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

      • getFolderNameFilterBytes

        public 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;
        Specified by:
        getFolderNameFilterBytes in interface DocumentQueryOrBuilder
        Returns:
        The bytes for folderNameFilter.

      • getDocumentNameFilterList

        public com.google.protobuf.ProtocolStringList getDocumentNameFilterList()
         Search the documents in the list.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string document_name_filter = 14;
        Specified by:
        getDocumentNameFilterList in interface DocumentQueryOrBuilder
        Returns:
        A list containing the documentNameFilter.

      • getDocumentNameFilterCount

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

      • getDocumentNameFilter

        public 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;
        Specified by:
        getDocumentNameFilter in interface DocumentQueryOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The documentNameFilter at the given index.

      • getDocumentNameFilterBytes

        public 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;
        Specified by:
        getDocumentNameFilterBytes in interface DocumentQueryOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the documentNameFilter at the given index.

      • getQueryContextList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getQueryContextList in interface DocumentQueryOrBuilder
        Returns:
        A list containing the queryContext.

      • getQueryContextCount

        public 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;
        Specified by:
        getQueryContextCount in interface DocumentQueryOrBuilder
        Returns:
        The count of queryContext.

      • getQueryContext

        public 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;
        Specified by:
        getQueryContext in interface DocumentQueryOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The queryContext at the given index.

      • getQueryContextBytes

        public 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;
        Specified by:
        getQueryContextBytes in interface DocumentQueryOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the queryContext at the given index.

      • getDocumentCreatorFilterList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getDocumentCreatorFilterList in interface DocumentQueryOrBuilder
        Returns:
        A list containing the documentCreatorFilter.

      • getDocumentCreatorFilterCount

        public 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;
        Specified by:
        getDocumentCreatorFilterCount in interface DocumentQueryOrBuilder
        Returns:
        The count of documentCreatorFilter.

      • getDocumentCreatorFilter

        public 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;
        Specified by:
        getDocumentCreatorFilter in interface DocumentQueryOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The documentCreatorFilter at the given index.

      • getDocumentCreatorFilterBytes

        public 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;
        Specified by:
        getDocumentCreatorFilterBytes in interface DocumentQueryOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the documentCreatorFilter at the given index.

      • hasCustomWeightsMetadata

        public 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;
        Specified by:
        hasCustomWeightsMetadata in interface DocumentQueryOrBuilder
        Returns:
        Whether the customWeightsMetadata field is set.

      • getCustomWeightsMetadata

        public 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;
        Specified by:
        getCustomWeightsMetadata in interface DocumentQueryOrBuilder
        Returns:
        The customWeightsMetadata.

      • getCustomWeightsMetadataOrBuilder

        public 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;
        Specified by:
        getCustomWeightsMetadataOrBuilder in interface DocumentQueryOrBuilder

      • 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 DocumentQuery parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static DocumentQuery parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static DocumentQuery getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<DocumentQuery> parser()

      • getParserForType

        public com.google.protobuf.Parser<DocumentQuery> 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 DocumentQuery getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder