Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::StructuredQuery::Filter (v1.3.0)

Version latest

• 1.3.0 (latest)
• 1.2.0
• 1.1.1
• 1.0.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.8

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::StructuredQuery::Filter.

A filter.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#composite_filter

def composite_filter() -> ::Google::Cloud::Firestore::V1::StructuredQuery::CompositeFilter

Returns

• (::Google::Cloud::Firestore::V1::StructuredQuery::CompositeFilter) — A composite filter.

  Note: The following fields are mutually exclusive: composite_filter, field_filter, unary_filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

#composite_filter=

def composite_filter=(value) -> ::Google::Cloud::Firestore::V1::StructuredQuery::CompositeFilter

Parameter

• value (::Google::Cloud::Firestore::V1::StructuredQuery::CompositeFilter) — A composite filter.

  Note: The following fields are mutually exclusive: composite_filter, field_filter, unary_filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Firestore::V1::StructuredQuery::CompositeFilter) — A composite filter.

  Note: The following fields are mutually exclusive: composite_filter, field_filter, unary_filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

#field_filter

def field_filter() -> ::Google::Cloud::Firestore::V1::StructuredQuery::FieldFilter

Returns

• (::Google::Cloud::Firestore::V1::StructuredQuery::FieldFilter) — A filter on a document field.

  Note: The following fields are mutually exclusive: field_filter, composite_filter, unary_filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

#field_filter=

def field_filter=(value) -> ::Google::Cloud::Firestore::V1::StructuredQuery::FieldFilter

Parameter

• value (::Google::Cloud::Firestore::V1::StructuredQuery::FieldFilter) — A filter on a document field.

  Note: The following fields are mutually exclusive: field_filter, composite_filter, unary_filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Firestore::V1::StructuredQuery::FieldFilter) — A filter on a document field.

  Note: The following fields are mutually exclusive: field_filter, composite_filter, unary_filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

#unary_filter

def unary_filter() -> ::Google::Cloud::Firestore::V1::StructuredQuery::UnaryFilter

Returns

• (::Google::Cloud::Firestore::V1::StructuredQuery::UnaryFilter) — A filter that takes exactly one argument.

  Note: The following fields are mutually exclusive: unary_filter, composite_filter, field_filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

#unary_filter=

def unary_filter=(value) -> ::Google::Cloud::Firestore::V1::StructuredQuery::UnaryFilter

Parameter

• value (::Google::Cloud::Firestore::V1::StructuredQuery::UnaryFilter) — A filter that takes exactly one argument.

  Note: The following fields are mutually exclusive: unary_filter, composite_filter, field_filter. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Firestore::V1::StructuredQuery::UnaryFilter) — A filter that takes exactly one argument.

  Note: The following fields are mutually exclusive: unary_filter, composite_filter, field_filter. If a field in that set is populated, all other fields in the set will automatically be cleared.