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
toJSON() → {Object.<string, *>}
Converts this UpdateFieldRequest to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(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) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for UpdateFieldRequest
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 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 |