UpdateFieldRequest

google.firestore.admin.v1. UpdateFieldRequest

Represents an UpdateFieldRequest.

Constructor

new UpdateFieldRequest(propertiesopt)

Constructs a new UpdateFieldRequest.

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

Properties to set

Implements:
  • IUpdateFieldRequest

Members

field

UpdateFieldRequest field.

updateMask

UpdateFieldRequest updateMask.

Methods

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

Creates an UpdateFieldRequest 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.UpdateFieldRequest

UpdateFieldRequest

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

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

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

UpdateFieldRequest

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Converts this UpdateFieldRequest to JSON.

Returns:
Type Description
Object.<string, *>

JSON object