public final class PropertyFilter extends GeneratedMessageV3 implements PropertyFilterOrBuilder
Protobuf type google.cloud.contentwarehouse.v1.PropertyFilter
Static Fields
CONDITION_FIELD_NUMBER
public static final int CONDITION_FIELD_NUMBER
Field Value
DOCUMENT_SCHEMA_NAME_FIELD_NUMBER
public static final int DOCUMENT_SCHEMA_NAME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static PropertyFilter getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static PropertyFilter.Builder newBuilder()
Returns
newBuilder(PropertyFilter prototype)
public static PropertyFilter.Builder newBuilder(PropertyFilter prototype)
Parameter
Returns
parseDelimitedFrom(InputStream input)
public static PropertyFilter parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PropertyFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static PropertyFilter parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PropertyFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static PropertyFilter parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PropertyFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static PropertyFilter parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PropertyFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static PropertyFilter parseFrom(InputStream input)
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PropertyFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static PropertyFilter parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PropertyFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<PropertyFilter> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getCondition()
public String getCondition()
The filter condition.
The syntax for this expression is a subset of SQL syntax.
Supported operators are: =, !=, <, <=, >, >=, and 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). 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;
| Type | Description |
| String | The condition.
|
getConditionBytes()
public ByteString getConditionBytes()
The filter condition.
The syntax for this expression is a subset of SQL syntax.
Supported operators are: =, !=, <, <=, >, >=, and 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). 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;
getDefaultInstanceForType()
public PropertyFilter getDefaultInstanceForType()
Returns
getDocumentSchemaName()
public String getDocumentSchemaName()
The Document schema name Document.document_schema_name.
Format:
projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
string document_schema_name = 1 [(.google.api.resource_reference) = { ... }
| Type | Description |
| String | The documentSchemaName.
|
getDocumentSchemaNameBytes()
public ByteString getDocumentSchemaNameBytes()
The Document schema name Document.document_schema_name.
Format:
projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
string document_schema_name = 1 [(.google.api.resource_reference) = { ... }
| Type | Description |
| ByteString | The bytes for documentSchemaName.
|
getParserForType()
public Parser<PropertyFilter> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public PropertyFilter.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PropertyFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public PropertyFilter.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
