Field

google.firestore.admin.v1. Field

Represents a Field.

Constructor

new Field(propertiesopt)

Constructs a new Field.

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

Properties to set

Implements:
  • IField

Classes

IndexConfig
TtlConfig

Members

indexConfig

Field indexConfig.

name

Field name.

ttlConfig

Field ttlConfig.

Methods

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

Converts this Field to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a Field 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

Field

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Field

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

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

Field

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object