public final class PropertyFilter extends GeneratedMessageV3 implements PropertyFilterOrBuilder
Protobuf type google.cloud.contentwarehouse.v1.PropertyFilter
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CONDITION_FIELD_NUMBER
public static final int CONDITION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DOCUMENT_SCHEMA_NAME_FIELD_NUMBER
public static final int DOCUMENT_SCHEMA_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static PropertyFilter getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PropertyFilter.Builder newBuilder()
newBuilder(PropertyFilter prototype)
public static PropertyFilter.Builder newBuilder(PropertyFilter prototype)
parseDelimitedFrom(InputStream input)
public static PropertyFilter parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PropertyFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PropertyFilter parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PropertyFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PropertyFilter parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PropertyFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static PropertyFilter parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PropertyFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static PropertyFilter parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PropertyFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PropertyFilter parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PropertyFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PropertyFilter> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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).
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 |
| 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 ~~ 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).
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 |
| Type |
Description |
ByteString |
The bytes for condition.
|
getDefaultInstanceForType()
public PropertyFilter getDefaultInstanceForType()
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) = { ... }
| Returns |
| 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) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for documentSchemaName.
|
getParserForType()
public Parser<PropertyFilter> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PropertyFilter.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PropertyFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public PropertyFilter.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
