FabricClient.TestManagementClient.InvokeDataLossAsync Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

InvokeDataLossAsync(PartitionSelector, DataLossMode, TimeSpan, CancellationToken)	Obsolete. This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition.
InvokeDataLossAsync(PartitionSelector, DataLossMode, TimeSpan)	Obsolete. This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition.
InvokeDataLossAsync(PartitionSelector, DataLossMode, CancellationToken)	Obsolete. This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition.
InvokeDataLossAsync(PartitionSelector, DataLossMode)	Obsolete. This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition.

InvokeDataLossAsync(PartitionSelector, DataLossMode, TimeSpan, CancellationToken)

Caution

This api is deprecated, use StartPartitionDataLossAsync instead. StartPartitionDataLossAsync requires the FaultAnalysisService

This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition.

[System.Obsolete("This api is deprecated, use StartPartitionDataLossAsync instead.  StartPartitionDataLossAsync requires the FaultAnalysisService")]
public System.Threading.Tasks.Task<System.Fabric.Result.InvokeDataLossResult> InvokeDataLossAsync (System.Fabric.PartitionSelector partitionSelector, System.Fabric.DataLossMode dataLossMode, TimeSpan operationTimeout, System.Threading.CancellationToken cancellationToken);

[<System.Obsolete("This api is deprecated, use StartPartitionDataLossAsync instead.  StartPartitionDataLossAsync requires the FaultAnalysisService")>]
member this.InvokeDataLossAsync : System.Fabric.PartitionSelector * System.Fabric.DataLossMode * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Result.InvokeDataLossResult>

Public Function InvokeDataLossAsync (partitionSelector As PartitionSelector, dataLossMode As DataLossMode, operationTimeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of InvokeDataLossResult)

Parameters

partitionSelector

PartitionSelector

The PartitionSelector to specify which partition data loss needs to be induced for.

dataLossMode

DataLossMode

Specifies the DataLossMode i.e. the options for inducing data loss.

operationTimeout

TimeSpan

The overall timeout for the operation

cancellationToken

CancellationToken

This token can be signalled to abort this operation before it finishes

Returns

Task<InvokeDataLossResult>

InvokeDataLossResult which gives information about the Partition that was selected for data loss.

Attributes

ObsoleteAttribute

Exceptions

TimeoutException

Action took more than its allocated time.

ArgumentNullException

Any of the required arguments are null.

InvalidOperationException

If the API is called for a partition belonging to a stateless service.

FabricException

These are the fabric failures FabricErrorCode.PartitionNotFound - if the specified partition selected does not exist.

Remarks

Actual data loss will depend on the specified DataLossMode PartialDataLoss - PartialDataLoss - Only a quorum of replicas are removed and OnDataLoss is triggered for the partition but actual data loss depends on presence of in-flight replication. FullDataLoss - All replicas are removed hence all data is lost and OnDataLoss is triggered.

This API should only be called with a stateful service as the target.

Calling this API with a system service as the target is not advised.

Important note: this API should not be aborted while running. Aborting this API while it is running may leave state behind. If this API is aborted while running, CleanTestStateAsync() should be invoked to remove state that may have been left behind.

InvokeDataLossAsync(PartitionSelector, DataLossMode, TimeSpan)

Caution

This api is deprecated, use StartPartitionDataLossAsync instead. StartPartitionDataLossAsync requires the FaultAnalysisService

This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition.

[System.Obsolete("This api is deprecated, use StartPartitionDataLossAsync instead.  StartPartitionDataLossAsync requires the FaultAnalysisService")]
public System.Threading.Tasks.Task<System.Fabric.Result.InvokeDataLossResult> InvokeDataLossAsync (System.Fabric.PartitionSelector partitionSelector, System.Fabric.DataLossMode dataLossMode, TimeSpan operationTimeout);

[<System.Obsolete("This api is deprecated, use StartPartitionDataLossAsync instead.  StartPartitionDataLossAsync requires the FaultAnalysisService")>]
member this.InvokeDataLossAsync : System.Fabric.PartitionSelector * System.Fabric.DataLossMode * TimeSpan -> System.Threading.Tasks.Task<System.Fabric.Result.InvokeDataLossResult>

Public Function InvokeDataLossAsync (partitionSelector As PartitionSelector, dataLossMode As DataLossMode, operationTimeout As TimeSpan) As Task(Of InvokeDataLossResult)

Parameters

partitionSelector

PartitionSelector

The PartitionSelector to specify which partition data loss needs to be induced for.

dataLossMode

DataLossMode

Specifies the DataLossMode i.e. the options for inducing data loss.

operationTimeout

TimeSpan

The overall timeout for the operation

Returns

Task<InvokeDataLossResult>

InvokeDataLossResult which gives information about the Partition that was selected for data loss.

Attributes

ObsoleteAttribute

Exceptions

TimeoutException

Action took more than its allocated time.

ArgumentNullException

Any of the required arguments are null.

InvalidOperationException

If the API is called for a partition belonging to a stateless service.

FabricException

These are the fabric failures FabricErrorCode.PartitionNotFound - if the specified partition selected does not exist.

Remarks

Actual data loss will depend on the specified DataLossMode PartialDataLoss - PartialDataLoss - Only a quorum of replicas are removed and OnDataLoss is triggered for the partition but actual data loss depends on presence of in-flight replication. FullDataLoss - All replicas are removed hence all data is lost and OnDataLoss is triggered.

This API should only be called with a stateful service as the target.

Calling this API with a system service as the target is not advised.

Important note: this API should not be aborted while running. Aborting this API while it is running may leave state behind. If this API is aborted while running, CleanTestStateAsync() should be invoked to remove state that may have been left behind.

InvokeDataLossAsync(PartitionSelector, DataLossMode, CancellationToken)

Caution

This api is deprecated, use StartPartitionDataLossAsync instead. StartPartitionDataLossAsync requires the FaultAnalysisService

This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition.

[System.Obsolete("This api is deprecated, use StartPartitionDataLossAsync instead.  StartPartitionDataLossAsync requires the FaultAnalysisService")]
public System.Threading.Tasks.Task<System.Fabric.Result.InvokeDataLossResult> InvokeDataLossAsync (System.Fabric.PartitionSelector partitionSelector, System.Fabric.DataLossMode dataLossMode, System.Threading.CancellationToken cancellationToken);

[<System.Obsolete("This api is deprecated, use StartPartitionDataLossAsync instead.  StartPartitionDataLossAsync requires the FaultAnalysisService")>]
member this.InvokeDataLossAsync : System.Fabric.PartitionSelector * System.Fabric.DataLossMode * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Result.InvokeDataLossResult>

Public Function InvokeDataLossAsync (partitionSelector As PartitionSelector, dataLossMode As DataLossMode, cancellationToken As CancellationToken) As Task(Of InvokeDataLossResult)

Parameters

partitionSelector

PartitionSelector

The PartitionSelector to specify which partition data loss needs to be induced for.

dataLossMode

DataLossMode

Specifies the DataLossMode i.e. the options for inducing data loss.

cancellationToken

CancellationToken

This token can be signalled to abort this operation before it finishes

Returns

Task<InvokeDataLossResult>

InvokeDataLossResult which gives information about the Partition that was selected for data loss.

Attributes

ObsoleteAttribute

Exceptions

TimeoutException

Action took more than its allocated time.

ArgumentNullException

Any of the required arguments are null.

InvalidOperationException

If the API is called for a partition belonging to a stateless service.

FabricException

These are the fabric failures FabricErrorCode.PartitionNotFound - if the specified partition selected does not exist.

Remarks

Actual data loss will depend on the specified DataLossMode PartialDataLoss - PartialDataLoss - Only a quorum of replicas are removed and OnDataLoss is triggered for the partition but actual data loss depends on presence of in-flight replication. FullDataLoss - All replicas are removed hence all data is lost and OnDataLoss is triggered.

This API should only be called with a stateful service as the target.

Calling this API with a system service as the target is not advised.

Important note: this API should not be aborted while running. Aborting this API while it is running may leave state behind. If this API is aborted while running, CleanTestStateAsync() should be invoked to remove state that may have been left behind.

InvokeDataLossAsync(PartitionSelector, DataLossMode)

Caution

This api is deprecated, use StartPartitionDataLossAsync instead. StartPartitionDataLossAsync requires the FaultAnalysisService

This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition.

[System.Obsolete("This api is deprecated, use StartPartitionDataLossAsync instead.  StartPartitionDataLossAsync requires the FaultAnalysisService")]
public System.Threading.Tasks.Task<System.Fabric.Result.InvokeDataLossResult> InvokeDataLossAsync (System.Fabric.PartitionSelector partitionSelector, System.Fabric.DataLossMode dataLossMode);

[<System.Obsolete("This api is deprecated, use StartPartitionDataLossAsync instead.  StartPartitionDataLossAsync requires the FaultAnalysisService")>]
member this.InvokeDataLossAsync : System.Fabric.PartitionSelector * System.Fabric.DataLossMode -> System.Threading.Tasks.Task<System.Fabric.Result.InvokeDataLossResult>

Public Function InvokeDataLossAsync (partitionSelector As PartitionSelector, dataLossMode As DataLossMode) As Task(Of InvokeDataLossResult)

Parameters

partitionSelector

PartitionSelector

The PartitionSelector to specify which partition data loss needs to be induced for

dataLossMode

DataLossMode

Specifies the DataLossMode i.e. the options for inducing data loss.

Returns

Task<InvokeDataLossResult>

InvokeDataLossResult which gives information about the Partition that was selected for data loss.

Attributes

ObsoleteAttribute

Exceptions

TimeoutException

Action took more than its allocated time.

ArgumentNullException

Any of the required arguments are null.

InvalidOperationException

If the API is called for a partition belonging to a stateless service.

FabricException

These are the fabric failures FabricErrorCode.PartitionNotFound - if the specified partition selected does not exist.

Remarks

Actual data loss will depend on the specified DataLossMode PartialDataLoss - PartialDataLoss - Only a quorum of replicas are removed and OnDataLoss is triggered for the partition but actual data loss depends on presence of in-flight replication. FullDataLoss - All replicas are removed hence all data is lost and OnDataLoss is triggered.

This API should only be called with a stateful service as the target.

Calling this API with a system service as the target is not advised.

Important note: this API should not be aborted while running. Aborting this API while it is running may leave state behind. If this API is aborted while running, CleanTestStateAsync() should be invoked to remove state that may have been left behind.