IndexField

google.firestore.admin.v1.Index. IndexField

Represents an IndexField.

Constructor

new IndexField(propertiesopt)

Constructs a new IndexField.

Parameters:
Name Type Attributes Description
properties google.firestore.admin.v1.Index.IIndexField <optional>

Properties to set

Implements:
  • IIndexField

Members

(static) ArrayConfig :string

ArrayConfig enum.

Properties:
Name Type Description
ARRAY_CONFIG_UNSPECIFIED string

ARRAY_CONFIG_UNSPECIFIED value

CONTAINS string

CONTAINS value

(static) Order :string

Order enum.

Properties:
Name Type Description
ORDER_UNSPECIFIED string

ORDER_UNSPECIFIED value

ASCENDING string

ASCENDING value

DESCENDING string

DESCENDING value

arrayConfig :google.firestore.admin.v1.Index.IndexField.ArrayConfig

IndexField arrayConfig.

fieldPath :string

IndexField fieldPath.

order :google.firestore.admin.v1.Index.IndexField.Order

IndexField order.

valueMode :"order"|"arrayConfig"|undefined

IndexField valueMode.

Methods

(static) fromObject(object) → {google.firestore.admin.v1.Index.IndexField}

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

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

Plain object

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

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

Parameters:
Name Type Attributes Description
message google.firestore.admin.v1.Index.IndexField

IndexField

options $protobuf.IConversionOptions <optional>

Conversion options

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

Converts this IndexField to JSON.