IndexConfig

google.firestore.admin.v1.Field. IndexConfig

Represents an IndexConfig.

Constructor

new IndexConfig(propertiesopt)

Constructs a new IndexConfig.

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

Properties to set

Implements:
  • IIndexConfig

Members

ancestorField

IndexConfig ancestorField.

indexes

IndexConfig indexes.

reverting

IndexConfig reverting.

usesAncestorConfig

IndexConfig usesAncestorConfig.

Methods

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

Converts this IndexConfig to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates an IndexConfig 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.admin.v1.Field.IndexConfig

IndexConfig

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for IndexConfig

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

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

IndexConfig

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object