FieldFilter

google.firestore.v1beta1.StructuredQuery. FieldFilter

Represents a FieldFilter.

Constructor

new FieldFilter(propertiesopt)

Constructs a new FieldFilter.

Parameters:
Name Type Attributes Description
properties google.firestore.v1beta1.StructuredQuery.IFieldFilter <optional>

Properties to set

Implements:
  • IFieldFilter

Members

field

FieldFilter field.

op

FieldFilter op.

value

FieldFilter value.

Operator

Operator enum.

Properties:
Name Type Description
OPERATOR_UNSPECIFIED string

OPERATOR_UNSPECIFIED value

LESS_THAN string

LESS_THAN value

LESS_THAN_OR_EQUAL string

LESS_THAN_OR_EQUAL value

GREATER_THAN string

GREATER_THAN value

GREATER_THAN_OR_EQUAL string

GREATER_THAN_OR_EQUAL value

EQUAL string

EQUAL value

NOT_EQUAL string

NOT_EQUAL value

ARRAY_CONTAINS string

ARRAY_CONTAINS value

IN string

IN value

ARRAY_CONTAINS_ANY string

ARRAY_CONTAINS_ANY value

NOT_IN string

NOT_IN value

Methods

toJSON() → {Object.<string, *>}

Converts this FieldFilter to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) fromObject(object) → {google.firestore.v1beta1.StructuredQuery.FieldFilter}

Creates a FieldFilter message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.firestore.v1beta1.StructuredQuery.FieldFilter

FieldFilter

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for FieldFilter

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a FieldFilter message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.firestore.v1beta1.StructuredQuery.FieldFilter

FieldFilter

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object