FabricClient.QueryClient.GetReplicaListAsync Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

GetReplicaListAsync(Guid, String, TimeSpan, CancellationToken)	Gets the details for all replicas of a partition. If the replicas do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.
GetReplicaListAsync(Guid, Int64, ServiceReplicaStatusFilter, String, TimeSpan, CancellationToken)	Gets the details for all replicas of a partition that match the replica or instance filter and the status filter. If the replicas do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.
GetReplicaListAsync(Guid, Int64, ServiceReplicaStatusFilter, TimeSpan, CancellationToken)	Gets the details for all replicas of a partition that match the replica or instance filter and the status filter. If the replicas do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.
GetReplicaListAsync(Guid, String)	Gets the details for all replicas of a partition. If the replicas do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.
GetReplicaListAsync(Guid, Int64)	Gets the details for all replicas of a partition that match the replica or instance filter and the status filter. If the replicas do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.
GetReplicaListAsync(Guid)	Gets the details for all replicas of a partition. If the replicas do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.
GetReplicaListAsync(Guid, Int64, TimeSpan, CancellationToken)	Gets the details for all replicas of a partition that match the replica or instance filter. If the replicas do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

GetReplicaListAsync(Guid, String, TimeSpan, CancellationToken)

Gets the details for all replicas of a partition. If the replicas do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

public System.Threading.Tasks.Task<System.Fabric.Query.ServiceReplicaList> GetReplicaListAsync (Guid partitionId, string continuationToken, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetReplicaListAsync : Guid * string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.ServiceReplicaList>

Public Function GetReplicaListAsync (partitionId As Guid, continuationToken As String, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ServiceReplicaList)

Parameters

partitionId

Guid

The partition identifier of the partition to get replicas for.

continuationToken

String

The continuation token obtained from a previous query. This value can be passed along to this query to start where the last query left off. Not passing a continuation token means returned results start from the first page.

timeout

TimeSpan

Specifies the duration this operation has to complete before timing out.

cancellationToken

CancellationToken

Propagates notification that operation should be canceled.

Returns

Task<ServiceReplicaList>

A task that represents the asynchronous operation.

The returned task contains the replica information of the partition as ServiceReplicaList.

Exceptions

FabricObjectClosedException

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

TimeoutException

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

FabricException

See also https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

Remarks

Service Fabric is a distributed system where many components have a view of the same entity.

In an unstable or transient state, this view may not match GetDeployedReplicaListAsync(String, Uri) and GetDeployedReplicaDetailAsync(String, Guid, Int64)

GetReplicaListAsync(Guid, Int64, ServiceReplicaStatusFilter, String, TimeSpan, CancellationToken)

Gets the details for all replicas of a partition that match the replica or instance filter and the status filter. If the replicas do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

public System.Threading.Tasks.Task<System.Fabric.Query.ServiceReplicaList> GetReplicaListAsync (Guid partitionId, long replicaIdOrInstanceIdFilter, System.Fabric.Query.ServiceReplicaStatusFilter replicaStatusFilter, string continuationToken, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetReplicaListAsync : Guid * int64 * System.Fabric.Query.ServiceReplicaStatusFilter * string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.ServiceReplicaList>

Public Function GetReplicaListAsync (partitionId As Guid, replicaIdOrInstanceIdFilter As Long, replicaStatusFilter As ServiceReplicaStatusFilter, continuationToken As String, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ServiceReplicaList)

Parameters

partitionId

Guid

The partition identifier for the partition to get replicas for.

replicaIdOrInstanceIdFilter

Int64

The replica identifier or instance identifier to get replicas for.

replicaStatusFilter

ServiceReplicaStatusFilter

Filter results to include only those matching this replica status.

continuationToken

String

The continuation token obtained from a previous query. This value can be passed along to this query to start where the last query left off. Not passing a continuation token means returned results start from the first page.

timeout

TimeSpan

Specifies the duration this operation has to complete before timing out.

cancellationToken

CancellationToken

Propagates notification that operation should be canceled.

Returns

Task<ServiceReplicaList>

A task that represents the asynchronous query operation.

The returned task contains the replica information of the partition as ServiceReplicaList.

Exceptions

FabricObjectClosedException

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

TimeoutException

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

FabricException

See also https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

Remarks

Service Fabric is a distributed system where many components have a view of the same entity.

In an unstable or transient state, this view may not match GetDeployedReplicaListAsync(String, Uri) and GetDeployedReplicaDetailAsync(String, Guid, Int64)

GetReplicaListAsync(Guid, Int64, ServiceReplicaStatusFilter, TimeSpan, CancellationToken)

Gets the details for all replicas of a partition that match the replica or instance filter and the status filter. If the replicas do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

public System.Threading.Tasks.Task<System.Fabric.Query.ServiceReplicaList> GetReplicaListAsync (Guid partitionId, long replicaIdOrInstanceIdFilter, System.Fabric.Query.ServiceReplicaStatusFilter replicaStatusFilter, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetReplicaListAsync : Guid * int64 * System.Fabric.Query.ServiceReplicaStatusFilter * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.ServiceReplicaList>

Public Function GetReplicaListAsync (partitionId As Guid, replicaIdOrInstanceIdFilter As Long, replicaStatusFilter As ServiceReplicaStatusFilter, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ServiceReplicaList)

Parameters

partitionId

Guid

The partition identifier for the partition to get replicas for.

replicaIdOrInstanceIdFilter

Int64

The replica identifier or instance identifier to get replicas for.

replicaStatusFilter

ServiceReplicaStatusFilter

The replica status(es) to get replicas for.

timeout

TimeSpan

Specifies the duration this operation has to complete before timing out.

cancellationToken

CancellationToken

Propagates notification that operation should be canceled.

Returns

Task<ServiceReplicaList>

A task that represents the asynchronous query operation.

The returned task contains the replica information of the partition as ServiceReplicaList.

Exceptions

FabricObjectClosedException

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

TimeoutException

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

FabricException

See also https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

Remarks

Service Fabric is a distributed system where many components have a view of the same entity.

In an unstable or transient state, this view may not match GetDeployedReplicaListAsync(String, Uri) and GetDeployedReplicaDetailAsync(String, Guid, Int64)

GetReplicaListAsync(Guid, String)

Gets the details for all replicas of a partition. If the replicas do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

public System.Threading.Tasks.Task<System.Fabric.Query.ServiceReplicaList> GetReplicaListAsync (Guid partitionId, string continuationToken);

member this.GetReplicaListAsync : Guid * string -> System.Threading.Tasks.Task<System.Fabric.Query.ServiceReplicaList>

Public Function GetReplicaListAsync (partitionId As Guid, continuationToken As String) As Task(Of ServiceReplicaList)

Parameters

partitionId

Guid

The partition identifier for the partition to get replicas for.

continuationToken

String

The continuation token obtained from a previous query. This value can be passed along to this query to start where the last query left off. Not passing a continuation token means returned results start from the first page.

Returns

Task<ServiceReplicaList>

A task that represents the asynchronous operation.

The returned task contains the replica information of the partition as ServiceReplicaList.

Exceptions

FabricObjectClosedException

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

TimeoutException

This operation has a timeout of 60 seconds.

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

FabricException

See also https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

Remarks

Service Fabric is a distributed system where many components have a view of the same entity.

In an unstable or transient state, this view may not match GetDeployedReplicaListAsync(String, Uri) and GetDeployedReplicaDetailAsync(String, Guid, Int64)

GetReplicaListAsync(Guid, Int64)

Gets the details for all replicas of a partition that match the replica or instance filter and the status filter. If the replicas do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

public System.Threading.Tasks.Task<System.Fabric.Query.ServiceReplicaList> GetReplicaListAsync (Guid partitionId, long replicaIdOrInstanceIdFilter);

member this.GetReplicaListAsync : Guid * int64 -> System.Threading.Tasks.Task<System.Fabric.Query.ServiceReplicaList>

Public Function GetReplicaListAsync (partitionId As Guid, replicaIdOrInstanceIdFilter As Long) As Task(Of ServiceReplicaList)

Parameters

partitionId

Guid

The partition identifier for the partition to get replicas for.

replicaIdOrInstanceIdFilter

Int64

The replica identifier or instance identifier to get replicas for.

Returns

Task<ServiceReplicaList>

A task that represents the asynchronous query operation.

The returned task contains the replica information of the partition as ServiceReplicaList.

Exceptions

FabricObjectClosedException

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

TimeoutException

This operation has a timeout of 60 seconds.

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

FabricException

See also https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

Remarks

Service Fabric is a distributed system where many components have a view of the same entity.

In an unstable or transient state, this view may not match GetDeployedReplicaListAsync(String, Uri) and GetDeployedReplicaDetailAsync(String, Guid, Int64)

GetReplicaListAsync(Guid)

Gets the details for all replicas of a partition. If the replicas do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

public System.Threading.Tasks.Task<System.Fabric.Query.ServiceReplicaList> GetReplicaListAsync (Guid partitionId);

member this.GetReplicaListAsync : Guid -> System.Threading.Tasks.Task<System.Fabric.Query.ServiceReplicaList>

Public Function GetReplicaListAsync (partitionId As Guid) As Task(Of ServiceReplicaList)

Parameters

partitionId

Guid

The partition identifier for the partition to get replicas for.

Returns

Task<ServiceReplicaList>

A task that represents the asynchronous query operation.

The returned task contains the replica information of the partition as ServiceReplicaList.

Exceptions

FabricObjectClosedException

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

TimeoutException

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

FabricException

See also https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

Remarks

Service Fabric is a distributed system where many components have a view of the same entity.

In an unstable or transient state, this view may not match GetDeployedReplicaListAsync(String, Uri) and GetDeployedReplicaDetailAsync(String, Guid, Int64)

GetReplicaListAsync(Guid, Int64, TimeSpan, CancellationToken)

Gets the details for all replicas of a partition that match the replica or instance filter. If the replicas do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.

public System.Threading.Tasks.Task<System.Fabric.Query.ServiceReplicaList> GetReplicaListAsync (Guid partitionId, long replicaIdOrInstanceIdFilter, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetReplicaListAsync : Guid * int64 * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.ServiceReplicaList>

Public Function GetReplicaListAsync (partitionId As Guid, replicaIdOrInstanceIdFilter As Long, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ServiceReplicaList)

Parameters

partitionId

Guid

The partition identifier for the partition to get replicas for.

replicaIdOrInstanceIdFilter

Int64

The replica identifier or instance identifier to get replicas for.

timeout

TimeSpan

Specifies the duration this operation has to complete before timing out.

cancellationToken

CancellationToken

Propagates notification that operations should be canceled.

Returns

Task<ServiceReplicaList>

A task that represents the asynchronous query operation.

The returned task contains the replica information of the partition as ServiceReplicaList.

Exceptions

FabricObjectClosedException

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

TimeoutException

See https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

FabricException

See also https://docs.microsoft.com/azure/service-fabric/service-fabric-errors-and-exceptions for handling common FabricClient failures.

Remarks

Service Fabric is a distributed system where many components have a view of the same entity.

In an unstable or transient state, this view may not match GetDeployedReplicaListAsync(String, Uri) and GetDeployedReplicaDetailAsync(String, Guid, Int64)