public static final class PropertyFilter.Builder extends GeneratedMessageV3.Builder<PropertyFilter.Builder> implements PropertyFilterOrBuilder
Protobuf type google.cloud.contentwarehouse.v1.PropertyFilter
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PropertyFilter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public PropertyFilter build()
Returns
buildPartial()
public PropertyFilter buildPartial()
Returns
clear()
public PropertyFilter.Builder clear()
Returns
Overrides
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). 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
clearDocumentSchemaName()
public PropertyFilter.Builder clearDocumentSchemaName()
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
clearField(Descriptors.FieldDescriptor field)
public PropertyFilter.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public PropertyFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clone()
public PropertyFilter.Builder clone()
Returns
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
getDefaultInstanceForType()
public PropertyFilter getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(PropertyFilter other)
public PropertyFilter.Builder mergeFrom(PropertyFilter other)
Parameter
Returns
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PropertyFilter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public PropertyFilter.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PropertyFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setCondition(String value)
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). 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;
Parameter
Name | Description |
value | String
The condition to set.
|
Returns
setConditionBytes(ByteString value)
public PropertyFilter.Builder setConditionBytes(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). 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;
Parameter
Name | Description |
value | ByteString
The bytes for condition to set.
|
Returns
setDocumentSchemaName(String value)
public PropertyFilter.Builder setDocumentSchemaName(String value)
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) = { ... }
Parameter
Name | Description |
value | String
The documentSchemaName to set.
|
Returns
setDocumentSchemaNameBytes(ByteString value)
public PropertyFilter.Builder setDocumentSchemaNameBytes(ByteString value)
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) = { ... }
Parameter
Name | Description |
value | ByteString
The bytes for documentSchemaName to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public PropertyFilter.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PropertyFilter.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final PropertyFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides