Package com.google.cloud.contentwarehouse.v1

Class PropertyFilter

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  PropertyFilter.Builder
      Protobuf type google.cloud.contentwarehouse.v1.PropertyFilter

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int CONDITION_FIELD_NUMBER  
      static int DOCUMENT_SCHEMA_NAME_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Field Detail

      • DOCUMENT_SCHEMA_NAME_FIELD_NUMBER

        public static final int DOCUMENT_SCHEMA_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

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

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

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

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

      • isInitialized

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

      • writeTo

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

      • getSerializedSize

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

      • equals

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

      • hashCode

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static PropertyFilter getDefaultInstance()

      • parser

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

      • getParserForType

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

      • getDefaultInstanceForType

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