Package com.google.cloud.contentwarehouse.v1

Class DocumentQuery.Builder

  • All Implemented Interfaces:
    DocumentQueryOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    DocumentQuery
    public static final class DocumentQuery.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<DocumentQuery.Builder>
implements DocumentQueryOrBuilder
    Protobuf type google.cloud.contentwarehouse.v1.DocumentQuery

    • Method Detail

      • 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.Builder<DocumentQuery.Builder>

      • clear

        public DocumentQuery.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentQuery.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentQuery.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public DocumentQuery.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentQuery.Builder>

      • setField

        public DocumentQuery.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentQuery.Builder>

      • clearField

        public DocumentQuery.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentQuery.Builder>

      • clearOneof

        public DocumentQuery.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentQuery.Builder>

      • setRepeatedField

        public DocumentQuery.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              int index,
                                              Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentQuery.Builder>

      • addRepeatedField

        public DocumentQuery.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentQuery.Builder>

      • mergeFrom

        public DocumentQuery.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DocumentQuery.Builder>

      • isInitialized

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

      • mergeFrom

        public DocumentQuery.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DocumentQuery.Builder>
        Throws:
        IOException

      • 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.

      • setQuery

        public DocumentQuery.Builder setQuery​(String value)
         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;
        Parameters:
        value - The query to set.
        Returns:
        This builder for chaining.

      • clearQuery

        public DocumentQuery.Builder clearQuery()
         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:
        This builder for chaining.

      • setQueryBytes

        public DocumentQuery.Builder setQueryBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for query to set.
        Returns:
        This builder for chaining.

      • 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.

      • setIsNlQuery

        public DocumentQuery.Builder setIsNlQuery​(boolean value)
         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;
        Parameters:
        value - The isNlQuery to set.
        Returns:
        This builder for chaining.

      • clearIsNlQuery

        public DocumentQuery.Builder clearIsNlQuery()
         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:
        This builder for chaining.

      • 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.

      • setCustomPropertyFilter

        @Deprecated
public DocumentQuery.Builder setCustomPropertyFilter​(String value)
        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];
        Parameters:
        value - The customPropertyFilter to set.
        Returns:
        This builder for chaining.

      • clearCustomPropertyFilter

        @Deprecated
public DocumentQuery.Builder clearCustomPropertyFilter()
        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:
        This builder for chaining.

      • setCustomPropertyFilterBytes

        @Deprecated
public DocumentQuery.Builder setCustomPropertyFilterBytes​(com.google.protobuf.ByteString value)
        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];
        Parameters:
        value - The bytes for customPropertyFilter to set.
        Returns:
        This builder for chaining.

      • 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

      • setTimeFilters

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

      • setTimeFilters

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

      • addTimeFilters

        public DocumentQuery.Builder addTimeFilters​(TimeFilter value)
         Documents created/updated within a range specified by this filter are
 searched against.
        repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;

      • addTimeFilters

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

      • addTimeFilters

        public DocumentQuery.Builder addTimeFilters​(TimeFilter.Builder builderForValue)
         Documents created/updated within a range specified by this filter are
 searched against.
        repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;

      • addTimeFilters

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

      • addAllTimeFilters

        public DocumentQuery.Builder addAllTimeFilters​(Iterable<? extends TimeFilter> values)
         Documents created/updated within a range specified by this filter are
 searched against.
        repeated .google.cloud.contentwarehouse.v1.TimeFilter time_filters = 5;

      • clearTimeFilters

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

      • removeTimeFilters

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

      • getTimeFiltersBuilder

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

      • 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

      • addTimeFiltersBuilder

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

      • addTimeFiltersBuilder

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

      • getTimeFiltersBuilderList

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

      • 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.

      • setDocumentSchemaNames

        public DocumentQuery.Builder setDocumentSchemaNames​(int index,
                                                    String value)
         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 to set the value at.
        value - The documentSchemaNames to set.
        Returns:
        This builder for chaining.

      • addDocumentSchemaNames

        public DocumentQuery.Builder addDocumentSchemaNames​(String value)
         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:
        value - The documentSchemaNames to add.
        Returns:
        This builder for chaining.

      • addAllDocumentSchemaNames

        public DocumentQuery.Builder addAllDocumentSchemaNames​(Iterable<String> values)
         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:
        values - The documentSchemaNames to add.
        Returns:
        This builder for chaining.

      • clearDocumentSchemaNames

        public DocumentQuery.Builder clearDocumentSchemaNames()
         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:
        This builder for chaining.

      • addDocumentSchemaNamesBytes

        public DocumentQuery.Builder addDocumentSchemaNamesBytes​(com.google.protobuf.ByteString value)
         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:
        value - The bytes of the documentSchemaNames to add.
        Returns:
        This builder for chaining.

      • 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

      • 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

      • setPropertyFilter

        public DocumentQuery.Builder setPropertyFilter​(int index,
                                               PropertyFilter value)
         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;

      • setPropertyFilter

        public DocumentQuery.Builder setPropertyFilter​(int index,
                                               PropertyFilter.Builder builderForValue)
         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;

      • addPropertyFilter

        public DocumentQuery.Builder addPropertyFilter​(PropertyFilter value)
         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;

      • addPropertyFilter

        public DocumentQuery.Builder addPropertyFilter​(int index,
                                               PropertyFilter value)
         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;

      • addPropertyFilter

        public DocumentQuery.Builder addPropertyFilter​(PropertyFilter.Builder builderForValue)
         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;

      • addPropertyFilter

        public DocumentQuery.Builder addPropertyFilter​(int index,
                                               PropertyFilter.Builder builderForValue)
         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;

      • addAllPropertyFilter

        public DocumentQuery.Builder addAllPropertyFilter​(Iterable<? extends PropertyFilter> values)
         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;

      • clearPropertyFilter

        public DocumentQuery.Builder clearPropertyFilter()
         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;

      • removePropertyFilter

        public DocumentQuery.Builder removePropertyFilter​(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;

      • getPropertyFilterBuilder

        public PropertyFilter.Builder getPropertyFilterBuilder​(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;

      • 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

      • 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

      • addPropertyFilterBuilder

        public PropertyFilter.Builder addPropertyFilterBuilder()
         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;

      • addPropertyFilterBuilder

        public PropertyFilter.Builder addPropertyFilterBuilder​(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;

      • getPropertyFilterBuilderList

        public List<PropertyFilter.Builder> getPropertyFilterBuilderList()
         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

        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.

      • setFileTypeFilter

        public DocumentQuery.Builder setFileTypeFilter​(FileTypeFilter value)
         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;

      • setFileTypeFilter

        public DocumentQuery.Builder setFileTypeFilter​(FileTypeFilter.Builder builderForValue)
         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;

      • mergeFileTypeFilter

        public DocumentQuery.Builder mergeFileTypeFilter​(FileTypeFilter value)
         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;

      • clearFileTypeFilter

        public DocumentQuery.Builder clearFileTypeFilter()
         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;

      • getFileTypeFilterBuilder

        public FileTypeFilter.Builder getFileTypeFilterBuilder()
         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;

      • 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.

      • setFolderNameFilter

        public DocumentQuery.Builder setFolderNameFilter​(String value)
         Search all the documents under this specified folder.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        string folder_name_filter = 9;
        Parameters:
        value - The folderNameFilter to set.
        Returns:
        This builder for chaining.

      • clearFolderNameFilter

        public DocumentQuery.Builder clearFolderNameFilter()
         Search all the documents under this specified folder.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        string folder_name_filter = 9;
        Returns:
        This builder for chaining.

      • setFolderNameFilterBytes

        public DocumentQuery.Builder setFolderNameFilterBytes​(com.google.protobuf.ByteString value)
         Search all the documents under this specified folder.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        string folder_name_filter = 9;
        Parameters:
        value - The bytes for folderNameFilter to set.
        Returns:
        This builder for chaining.

      • 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.

      • setDocumentNameFilter

        public DocumentQuery.Builder setDocumentNameFilter​(int index,
                                                   String value)
         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 to set the value at.
        value - The documentNameFilter to set.
        Returns:
        This builder for chaining.

      • addDocumentNameFilter

        public DocumentQuery.Builder addDocumentNameFilter​(String value)
         Search the documents in the list.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string document_name_filter = 14;
        Parameters:
        value - The documentNameFilter to add.
        Returns:
        This builder for chaining.

      • addAllDocumentNameFilter

        public DocumentQuery.Builder addAllDocumentNameFilter​(Iterable<String> values)
         Search the documents in the list.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string document_name_filter = 14;
        Parameters:
        values - The documentNameFilter to add.
        Returns:
        This builder for chaining.

      • clearDocumentNameFilter

        public DocumentQuery.Builder clearDocumentNameFilter()
         Search the documents in the list.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string document_name_filter = 14;
        Returns:
        This builder for chaining.

      • addDocumentNameFilterBytes

        public DocumentQuery.Builder addDocumentNameFilterBytes​(com.google.protobuf.ByteString value)
         Search the documents in the list.
 Format:
 projects/{project_number}/locations/{location}/documents/{document_id}.
        repeated string document_name_filter = 14;
        Parameters:
        value - The bytes of the documentNameFilter to add.
        Returns:
        This builder for chaining.

      • 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.

      • setQueryContext

        public DocumentQuery.Builder setQueryContext​(int index,
                                             String value)
         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 to set the value at.
        value - The queryContext to set.
        Returns:
        This builder for chaining.

      • addQueryContext

        public DocumentQuery.Builder addQueryContext​(String value)
         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:
        value - The queryContext to add.
        Returns:
        This builder for chaining.

      • addAllQueryContext

        public DocumentQuery.Builder addAllQueryContext​(Iterable<String> values)
         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:
        values - The queryContext to add.
        Returns:
        This builder for chaining.

      • clearQueryContext

        public DocumentQuery.Builder clearQueryContext()
         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:
        This builder for chaining.

      • addQueryContextBytes

        public DocumentQuery.Builder addQueryContextBytes​(com.google.protobuf.ByteString value)
         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:
        value - The bytes of the queryContext to add.
        Returns:
        This builder for chaining.

      • 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.

      • setDocumentCreatorFilter

        public DocumentQuery.Builder setDocumentCreatorFilter​(int index,
                                                      String value)
         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 to set the value at.
        value - The documentCreatorFilter to set.
        Returns:
        This builder for chaining.

      • addDocumentCreatorFilter

        public DocumentQuery.Builder addDocumentCreatorFilter​(String value)
         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:
        value - The documentCreatorFilter to add.
        Returns:
        This builder for chaining.

      • addAllDocumentCreatorFilter

        public DocumentQuery.Builder addAllDocumentCreatorFilter​(Iterable<String> values)
         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:
        values - The documentCreatorFilter to add.
        Returns:
        This builder for chaining.

      • clearDocumentCreatorFilter

        public DocumentQuery.Builder clearDocumentCreatorFilter()
         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:
        This builder for chaining.

      • addDocumentCreatorFilterBytes

        public DocumentQuery.Builder addDocumentCreatorFilterBytes​(com.google.protobuf.ByteString value)
         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:
        value - The bytes of the documentCreatorFilter to add.
        Returns:
        This builder for chaining.

      • 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.

      • setCustomWeightsMetadata

        public DocumentQuery.Builder setCustomWeightsMetadata​(CustomWeightsMetadata value)
         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;

      • setCustomWeightsMetadata

        public DocumentQuery.Builder setCustomWeightsMetadata​(CustomWeightsMetadata.Builder builderForValue)
         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;

      • mergeCustomWeightsMetadata

        public DocumentQuery.Builder mergeCustomWeightsMetadata​(CustomWeightsMetadata value)
         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;

      • clearCustomWeightsMetadata

        public DocumentQuery.Builder clearCustomWeightsMetadata()
         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;

      • getCustomWeightsMetadataBuilder

        public CustomWeightsMetadata.Builder getCustomWeightsMetadataBuilder()
         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;

      • 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

      • setUnknownFields

        public final DocumentQuery.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentQuery.Builder>

      • mergeUnknownFields

        public final DocumentQuery.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DocumentQuery.Builder>