FabricClient.QueryClient.GetClusterLoadInformationAsync Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

GetClusterLoadInformationAsync()	Gets the cluster load information.
GetClusterLoadInformationAsync(TimeSpan, CancellationToken)	Gets the cluster load information.

GetClusterLoadInformationAsync()

Gets the cluster load information.

public System.Threading.Tasks.Task<System.Fabric.Query.ClusterLoadInformation> GetClusterLoadInformationAsync ();

member this.GetClusterLoadInformationAsync : unit -> System.Threading.Tasks.Task<System.Fabric.Query.ClusterLoadInformation>

Public Function GetClusterLoadInformationAsync () As Task(Of ClusterLoadInformation)

Returns

Task<ClusterLoadInformation>

A task that represents the asynchronous query operation.

See ClusterLoadInformation.

The returned task contains the load information of the cluster as ClusterLoadInformation.

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.

GetClusterLoadInformationAsync(TimeSpan, CancellationToken)

Gets the cluster load information.

public System.Threading.Tasks.Task<System.Fabric.Query.ClusterLoadInformation> GetClusterLoadInformationAsync (TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetClusterLoadInformationAsync : TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.ClusterLoadInformation>

Public Function GetClusterLoadInformationAsync (timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ClusterLoadInformation)

Parameters

timeout

TimeSpan

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

cancellationToken

CancellationToken

Propagates notification that operations should be canceled.

Returns

Task<ClusterLoadInformation>

A task that represents the asynchronous query operation.

The returned task contains the load information of the cluster as ClusterLoadInformation.

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.