Class: ScavengeDatabaseResponse

EventStore.Client.Messages.ScavengeDatabaseResponse(propertiesopt)

Represents a ScavengeDatabaseResponse.

Constructor

new ScavengeDatabaseResponse(propertiesopt)

Constructs a new ScavengeDatabaseResponse.
Parameters:
Name Type Attributes Description
properties EventStore.Client.Messages.IScavengeDatabaseResponse <optional>
 Properties to set
Implements:
  • IScavengeDatabaseResponse
Source:

Members

result :EventStore.Client.Messages.ScavengeDatabaseResponse.ScavengeResult

ScavengeDatabaseResponse result.
Type:
Source:

scavengeId :string

ScavengeDatabaseResponse scavengeId.
Type:
  • string
Source:

(static) ScavengeResult :number

ScavengeResult enum.
Type:
  • number
Properties:
Name Type Description
Started number Started value
InProgress number InProgress value
Unauthorized number Unauthorized value
Source:

Methods

toJSON() → {Object.<string, *>}

Converts this ScavengeDatabaseResponse to JSON.
Source:
Returns:
JSON object
Type
Object.<string, *>

(static) create(propertiesopt) → {EventStore.Client.Messages.ScavengeDatabaseResponse}

Creates a new ScavengeDatabaseResponse instance using the specified properties.
Parameters:
Name Type Attributes Description
properties EventStore.Client.Messages.IScavengeDatabaseResponse <optional>
 Properties to set
Source:
Returns:
ScavengeDatabaseResponse instance
Type
EventStore.Client.Messages.ScavengeDatabaseResponse

(static) decode(reader, lengthopt) → {EventStore.Client.Messages.ScavengeDatabaseResponse}

Decodes a ScavengeDatabaseResponse 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:
ScavengeDatabaseResponse
Type
EventStore.Client.Messages.ScavengeDatabaseResponse

(static) decodeDelimited(reader) → {EventStore.Client.Messages.ScavengeDatabaseResponse}

Decodes a ScavengeDatabaseResponse 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:
ScavengeDatabaseResponse
Type
EventStore.Client.Messages.ScavengeDatabaseResponse

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified ScavengeDatabaseResponse message. Does not implicitly verify messages.
Parameters:
Name Type Attributes Description
message EventStore.Client.Messages.IScavengeDatabaseResponse ScavengeDatabaseResponse 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 ScavengeDatabaseResponse message, length delimited. Does not implicitly verify messages.
Parameters:
Name Type Attributes Description
message EventStore.Client.Messages.IScavengeDatabaseResponse ScavengeDatabaseResponse 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.ScavengeDatabaseResponse}

Creates a ScavengeDatabaseResponse message from a plain object. Also converts values to their respective internal types.
Parameters:
Name Type Description
object Object.<string, *> Plain object
Source:
Returns:
ScavengeDatabaseResponse
Type
EventStore.Client.Messages.ScavengeDatabaseResponse

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for ScavengeDatabaseResponse
Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>
 your custom typeUrlPrefix(default "type.googleapis.com")
Source:
Returns:
The default type url
Type
string

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a ScavengeDatabaseResponse message. Also converts values to other types if specified.
Parameters:
Name Type Attributes Description
message EventStore.Client.Messages.ScavengeDatabaseResponse ScavengeDatabaseResponse
options $protobuf.IConversionOptions <optional>
 Conversion options
Source:
Returns:
Plain object
Type
Object.<string, *>

(static) verify(message) → {string|null}

Verifies a ScavengeDatabaseResponse 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