Constructor
new IndexField(propertiesopt)
Constructs a new IndexField.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.firestore.admin.v1.Index.IIndexField |
<optional> |
Properties to set |
- Implements:
-
- IIndexField
Members
arrayConfig
IndexField arrayConfig.
fieldPath
IndexField fieldPath.
order
IndexField order.
valueMode
IndexField valueMode.
ArrayConfig
ArrayConfig enum.
Properties:
| Name | Type | Description |
|---|---|---|
ARRAY_CONFIG_UNSPECIFIED |
string |
ARRAY_CONFIG_UNSPECIFIED value |
CONTAINS |
string |
CONTAINS value |
Order
Order enum.
Properties:
| Name | Type | Description |
|---|---|---|
ORDER_UNSPECIFIED |
string |
ORDER_UNSPECIFIED value |
ASCENDING |
string |
ASCENDING value |
DESCENDING |
string |
DESCENDING value |
Methods
toJSON() → {Object.<string, *>}
Converts this IndexField to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) fromObject(object) → {google.firestore.admin.v1.Index.IndexField}
Creates an IndexField 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.Index.IndexField |
IndexField |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for IndexField
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 IndexField message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.firestore.admin.v1.Index.IndexField |
IndexField |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |