Constructor
new TtlConfig(propertiesopt)
Constructs a new TtlConfig.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
properties |
google.firestore.admin.v1.Field.ITtlConfig |
<optional> |
Properties to set |
- Implements:
-
- ITtlConfig
Members
state
TtlConfig state.
State
State enum.
Properties:
Name | Type | Description |
---|---|---|
STATE_UNSPECIFIED |
string |
STATE_UNSPECIFIED value |
CREATING |
string |
CREATING value |
ACTIVE |
string |
ACTIVE value |
NEEDS_REPAIR |
string |
NEEDS_REPAIR value |
Methods
toJSON() → {Object.<string, *>}
Converts this TtlConfig to JSON.
Returns:
Type | Description |
---|---|
Object.<string, *> |
JSON object |
(static) fromObject(object) → {google.firestore.admin.v1.Field.TtlConfig}
Creates a TtlConfig 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.TtlConfig |
TtlConfig |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for TtlConfig
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 TtlConfig message. Also converts values to other types if specified.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
google.firestore.admin.v1.Field.TtlConfig |
TtlConfig |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
Type | Description |
---|---|
Object.<string, *> |
Plain object |