Constructor
new Index(propertiesopt)
Constructs a new Index.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.firestore.admin.v1.IIndex |
<optional> |
Properties to set |
- Implements:
-
- IIndex
Classes
Members
QueryScope
QueryScope enum.
Properties:
| Name | Type | Description |
|---|---|---|
QUERY_SCOPE_UNSPECIFIED |
string |
QUERY_SCOPE_UNSPECIFIED value |
COLLECTION |
string |
COLLECTION value |
COLLECTION_GROUP |
string |
COLLECTION_GROUP value |
State
State enum.
Properties:
| Name | Type | Description |
|---|---|---|
STATE_UNSPECIFIED |
string |
STATE_UNSPECIFIED value |
CREATING |
string |
CREATING value |
READY |
string |
READY value |
NEEDS_REPAIR |
string |
NEEDS_REPAIR value |
fields
Index fields.
name
Index name.
queryScope
Index queryScope.
state
Index state.
Methods
(static) fromObject(object) → {google.firestore.admin.v1.Index}
Creates an Index 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 |
Index |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from an Index message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.firestore.admin.v1.Index |
Index |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
toJSON() → {Object.<string, *>}
Converts this Index to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |