Index

google.firestore.admin.v1. Index

Represents an Index.

Constructor

new Index(propertiesopt)

Constructs a new Index.

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

Properties to set

Implements:
  • IIndex

Classes

IndexField

Members

(static) QueryScope :string

QueryScope enum.

Properties:
Name Type Description
QUERY_SCOPE_UNSPECIFIED string

QUERY_SCOPE_UNSPECIFIED value

COLLECTION string

COLLECTION value

COLLECTION_GROUP string

COLLECTION_GROUP value

(static) State :string

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED string

STATE_UNSPECIFIED value

CREATING string

CREATING value

READY string

READY value

NEEDS_REPAIR string

NEEDS_REPAIR value

fields :Array.<google.firestore.admin.v1.Index.IIndexField>

Index fields.

name :string

Index name.

queryScope :google.firestore.admin.v1.Index.QueryScope

Index queryScope.

state :google.firestore.admin.v1.Index.State

Index state.

Methods

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

Creates an Index 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 Index message. Also converts values to other types if specified.

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

Index

options $protobuf.IConversionOptions <optional>

Conversion options

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

Converts this Index to JSON.