Constructor
new ScavengeDatabaseCompleted(propertiesopt)
Constructs a new ScavengeDatabaseCompleted.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
properties |
EventStore.Client.Messages.IScavengeDatabaseCompleted |
<optional> |
Properties to set |
- Implements:
- IScavengeDatabaseCompleted
- Source:
Members
(static) ScavengeResult :string
ScavengeResult enum.
Type:
- string
Properties:
Name | Type | Description |
---|---|---|
Success |
number | Success value |
InProgress |
number | InProgress value |
Failed |
number | Failed value |
- Source:
error :string
ScavengeDatabaseCompleted error.
Type:
- string
- Source:
result :EventStore.Client.Messages.ScavengeDatabaseCompleted.ScavengeResult
ScavengeDatabaseCompleted result.
Type:
- Source:
totalSpaceSaved :number|Long
ScavengeDatabaseCompleted totalSpaceSaved.
Type:
- number | Long
- Source:
totalTimeMs :number
ScavengeDatabaseCompleted totalTimeMs.
Type:
- number
- Source:
Methods
(static) create(propertiesopt) → {EventStore.Client.Messages.ScavengeDatabaseCompleted}
Creates a new ScavengeDatabaseCompleted instance using the specified properties.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
properties |
EventStore.Client.Messages.IScavengeDatabaseCompleted |
<optional> |
Properties to set |
- Source:
Returns:
ScavengeDatabaseCompleted instance
(static) decode(reader, lengthopt) → {EventStore.Client.Messages.ScavengeDatabaseCompleted}
Decodes a ScavengeDatabaseCompleted message from the specified reader or buffer.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reader |
$protobuf.Reader | Uint8Array | Reader or buffer to decode from | |
length |
number |
<optional> |
Message length if known beforehand |
- Source:
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
Returns:
ScavengeDatabaseCompleted
(static) decodeDelimited(reader) → {EventStore.Client.Messages.ScavengeDatabaseCompleted}
Decodes a ScavengeDatabaseCompleted message from the specified reader or buffer, length delimited.
Parameters:
Name | Type | Description |
---|---|---|
reader |
$protobuf.Reader | Uint8Array | Reader or buffer to decode from |
- Source:
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
Returns:
ScavengeDatabaseCompleted
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified ScavengeDatabaseCompleted message. Does not implicitly verify messages.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
EventStore.Client.Messages.IScavengeDatabaseCompleted | ScavengeDatabaseCompleted message or plain object to encode | |
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
- Source:
Returns:
Writer
- Type
- $protobuf.Writer
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified ScavengeDatabaseCompleted message, length delimited. Does not implicitly verify messages.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
EventStore.Client.Messages.IScavengeDatabaseCompleted | ScavengeDatabaseCompleted message or plain object to encode | |
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
- Source:
Returns:
Writer
- Type
- $protobuf.Writer
(static) fromObject(object) → {EventStore.Client.Messages.ScavengeDatabaseCompleted}
Creates a ScavengeDatabaseCompleted message from a plain object. Also converts values to their respective internal types.
Parameters:
Name | Type | Description |
---|---|---|
object |
Object.<string, *> | Plain object |
- Source:
Returns:
ScavengeDatabaseCompleted
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a ScavengeDatabaseCompleted message. Also converts values to other types if specified.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
EventStore.Client.Messages.ScavengeDatabaseCompleted | ScavengeDatabaseCompleted | |
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
- Source:
Returns:
Plain object
- Type
- Object.<string, *>
(static) verify(message) → {string|null}
Verifies a ScavengeDatabaseCompleted message.
Parameters:
Name | Type | Description |
---|---|---|
message |
Object.<string, *> | Plain object to verify |
- Source:
Returns:
`null` if valid, otherwise the reason why it is not
- Type
- string | null
toJSON() → {Object.<string, *>}
Converts this ScavengeDatabaseCompleted to JSON.
- Source:
Returns:
JSON object
- Type
- Object.<string, *>