Package com.google.cloud.contentwarehouse.v1

Class PropertyFilter.Builder

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

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

      • clear

        public PropertyFilter.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<PropertyFilter.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<PropertyFilter.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public PropertyFilter.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<PropertyFilter.Builder>

      • setField

        public PropertyFilter.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<PropertyFilter.Builder>

      • clearField

        public PropertyFilter.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<PropertyFilter.Builder>

      • clearOneof

        public PropertyFilter.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<PropertyFilter.Builder>

      • setRepeatedField

        public PropertyFilter.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<PropertyFilter.Builder>

      • addRepeatedField

        public PropertyFilter.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<PropertyFilter.Builder>

      • mergeFrom

        public PropertyFilter.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<PropertyFilter.Builder>

      • isInitialized

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

      • mergeFrom

        public PropertyFilter.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<PropertyFilter.Builder>
        Throws:
        IOException

      • getDocumentSchemaName

        public String getDocumentSchemaName()
         The Document schema name
 [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name].
 Format:
 projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
        string document_schema_name = 1 [(.google.api.resource_reference) = { ... }
        Specified by:
        getDocumentSchemaName in interface PropertyFilterOrBuilder
        Returns:
        The documentSchemaName.

      • getDocumentSchemaNameBytes

        public com.google.protobuf.ByteString getDocumentSchemaNameBytes()
         The Document schema name
 [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name].
 Format:
 projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
        string document_schema_name = 1 [(.google.api.resource_reference) = { ... }
        Specified by:
        getDocumentSchemaNameBytes in interface PropertyFilterOrBuilder
        Returns:
        The bytes for documentSchemaName.

      • setDocumentSchemaName

        public PropertyFilter.Builder setDocumentSchemaName​(String value)
         The Document schema name
 [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name].
 Format:
 projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
        string document_schema_name = 1 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The documentSchemaName to set.
        Returns:
        This builder for chaining.

      • clearDocumentSchemaName

        public PropertyFilter.Builder clearDocumentSchemaName()
         The Document schema name
 [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name].
 Format:
 projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
        string document_schema_name = 1 [(.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setDocumentSchemaNameBytes

        public PropertyFilter.Builder setDocumentSchemaNameBytes​(com.google.protobuf.ByteString value)
         The Document schema name
 [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name].
 Format:
 projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
        string document_schema_name = 1 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for documentSchemaName to set.
        Returns:
        This builder for chaining.

      • getCondition

        public String getCondition()
         The filter condition.
 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.

 `~~` is the LIKE operator. The right of the operator must be a string. The
 only supported property data type for LIKE is text_values. It provides
 semantic search functionality by parsing, stemming and doing synonyms
 expansion against the input query. It matches if the property contains
 semantic similar content to the query. It is not regex matching or wildcard
 matching. For example, "property.company ~~ \"google\"" will match records
 whose property `property.compnay` have values like "Google Inc.", "Google
 LLC" or "Google Company".

 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.

 Only properties that are marked filterable are allowed
 ([PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable]).
 Property names do not need to be prefixed by the document schema id (as is
 the case with histograms), however property names will need to be prefixed
 by its parent hierarchy, if any.  For example:
 top_property_name.sub_property_name.

 Sample Query:
 `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND
 driving_years > 10`


 CMEK compliant deployment only supports:

 * Operators: `=`, `<`, `<=`, `>`, and `>=`.
 * Boolean expressions: AND and OR.
        string condition = 2;
        Specified by:
        getCondition in interface PropertyFilterOrBuilder
        Returns:
        The condition.

      • getConditionBytes

        public com.google.protobuf.ByteString getConditionBytes()
         The filter condition.
 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.

 `~~` is the LIKE operator. The right of the operator must be a string. The
 only supported property data type for LIKE is text_values. It provides
 semantic search functionality by parsing, stemming and doing synonyms
 expansion against the input query. It matches if the property contains
 semantic similar content to the query. It is not regex matching or wildcard
 matching. For example, "property.company ~~ \"google\"" will match records
 whose property `property.compnay` have values like "Google Inc.", "Google
 LLC" or "Google Company".

 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.

 Only properties that are marked filterable are allowed
 ([PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable]).
 Property names do not need to be prefixed by the document schema id (as is
 the case with histograms), however property names will need to be prefixed
 by its parent hierarchy, if any.  For example:
 top_property_name.sub_property_name.

 Sample Query:
 `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND
 driving_years > 10`


 CMEK compliant deployment only supports:

 * Operators: `=`, `<`, `<=`, `>`, and `>=`.
 * Boolean expressions: AND and OR.
        string condition = 2;
        Specified by:
        getConditionBytes in interface PropertyFilterOrBuilder
        Returns:
        The bytes for condition.

      • setCondition

        public PropertyFilter.Builder setCondition​(String value)
         The filter condition.
 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.

 `~~` is the LIKE operator. The right of the operator must be a string. The
 only supported property data type for LIKE is text_values. It provides
 semantic search functionality by parsing, stemming and doing synonyms
 expansion against the input query. It matches if the property contains
 semantic similar content to the query. It is not regex matching or wildcard
 matching. For example, "property.company ~~ \"google\"" will match records
 whose property `property.compnay` have values like "Google Inc.", "Google
 LLC" or "Google Company".

 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.

 Only properties that are marked filterable are allowed
 ([PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable]).
 Property names do not need to be prefixed by the document schema id (as is
 the case with histograms), however property names will need to be prefixed
 by its parent hierarchy, if any.  For example:
 top_property_name.sub_property_name.

 Sample Query:
 `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND
 driving_years > 10`


 CMEK compliant deployment only supports:

 * Operators: `=`, `<`, `<=`, `>`, and `>=`.
 * Boolean expressions: AND and OR.
        string condition = 2;
        Parameters:
        value - The condition to set.
        Returns:
        This builder for chaining.

      • clearCondition

        public PropertyFilter.Builder clearCondition()
         The filter condition.
 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.

 `~~` is the LIKE operator. The right of the operator must be a string. The
 only supported property data type for LIKE is text_values. It provides
 semantic search functionality by parsing, stemming and doing synonyms
 expansion against the input query. It matches if the property contains
 semantic similar content to the query. It is not regex matching or wildcard
 matching. For example, "property.company ~~ \"google\"" will match records
 whose property `property.compnay` have values like "Google Inc.", "Google
 LLC" or "Google Company".

 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.

 Only properties that are marked filterable are allowed
 ([PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable]).
 Property names do not need to be prefixed by the document schema id (as is
 the case with histograms), however property names will need to be prefixed
 by its parent hierarchy, if any.  For example:
 top_property_name.sub_property_name.

 Sample Query:
 `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND
 driving_years > 10`


 CMEK compliant deployment only supports:

 * Operators: `=`, `<`, `<=`, `>`, and `>=`.
 * Boolean expressions: AND and OR.
        string condition = 2;
        Returns:
        This builder for chaining.

      • setConditionBytes

        public PropertyFilter.Builder setConditionBytes​(com.google.protobuf.ByteString value)
         The filter condition.
 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.

 `~~` is the LIKE operator. The right of the operator must be a string. The
 only supported property data type for LIKE is text_values. It provides
 semantic search functionality by parsing, stemming and doing synonyms
 expansion against the input query. It matches if the property contains
 semantic similar content to the query. It is not regex matching or wildcard
 matching. For example, "property.company ~~ \"google\"" will match records
 whose property `property.compnay` have values like "Google Inc.", "Google
 LLC" or "Google Company".

 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.

 Only properties that are marked filterable are allowed
 ([PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable]).
 Property names do not need to be prefixed by the document schema id (as is
 the case with histograms), however property names will need to be prefixed
 by its parent hierarchy, if any.  For example:
 top_property_name.sub_property_name.

 Sample Query:
 `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND
 driving_years > 10`


 CMEK compliant deployment only supports:

 * Operators: `=`, `<`, `<=`, `>`, and `>=`.
 * Boolean expressions: AND and OR.
        string condition = 2;
        Parameters:
        value - The bytes for condition to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final PropertyFilter.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<PropertyFilter.Builder>

      • mergeUnknownFields

        public final PropertyFilter.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<PropertyFilter.Builder>