Class PropertyFilter.Builder (0.51.0) 

public static final class PropertyFilter.Builder extends GeneratedMessageV3.Builder<PropertyFilter.Builder> implements PropertyFilterOrBuilder

Protobuf type google.cloud.contentwarehouse.v1.PropertyFilter

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PropertyFilter.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PropertyFilter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PropertyFilter.Builder
Overrides

build()

public PropertyFilter build()
Returns
Type Description
PropertyFilter

buildPartial()

public PropertyFilter buildPartial()
Returns
Type Description
PropertyFilter

clear()

public PropertyFilter.Builder clear()
Returns
Type Description
PropertyFilter.Builder
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
Type Description
PropertyFilter.Builder

This builder for chaining.

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
Type Description
PropertyFilter.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PropertyFilter.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PropertyFilter.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public PropertyFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PropertyFilter.Builder
Overrides

clone()

public PropertyFilter.Builder clone()
Returns
Type Description
PropertyFilter.Builder
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()
Returns
Type Description
PropertyFilter

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PropertyFilter other)

public PropertyFilter.Builder mergeFrom(PropertyFilter other)
Parameter
Name Description
other PropertyFilter
Returns
Type Description
PropertyFilter.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PropertyFilter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyFilter.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PropertyFilter.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PropertyFilter.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PropertyFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PropertyFilter.Builder
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
Type Description
PropertyFilter.Builder

This builder for chaining.

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
Type Description
PropertyFilter.Builder

This builder for chaining.

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
Type Description
PropertyFilter.Builder

This builder for chaining.

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
Type Description
PropertyFilter.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PropertyFilter.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PropertyFilter.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PropertyFilter.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PropertyFilter.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PropertyFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PropertyFilter.Builder
Overrides