Share via


RestartReplicaRequest interface

Request to restart a replica.

Properties

forceRestart

If true, the restart operation will be forced. Use this option with care, as it may cause data loss.

partitionId

The ID of the partition.

replicaIds

The IDs of the replicas to be restarted.

restartKind

The kind of restart to perform.

timeout

The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

Property Details

forceRestart

If true, the restart operation will be forced. Use this option with care, as it may cause data loss.

forceRestart?: boolean

Property Value

boolean

partitionId

The ID of the partition.

partitionId: string

Property Value

string

replicaIds

The IDs of the replicas to be restarted.

replicaIds: number[]

Property Value

number[]

restartKind

The kind of restart to perform.

restartKind: string

Property Value

string

timeout

The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

timeout?: number

Property Value

number