FabricClient.QueryClient.GetNodePagedListAsync Method

Reference

Definition

Namespace:: System.Fabric

Assembly:: System.Fabric.dll

Package:: Microsoft.ServiceFabric v9.1.1833

Package:: Microsoft.ServiceFabric v8.2.1748

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

GetNodePagedListAsync()	Gets the details for all nodes in the cluster or for the specified node. If the nodes 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.
GetNodePagedListAsync(NodeQueryDescription)	Gets the details for all nodes in the cluster or for the specified node. If the nodes 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.
GetNodePagedListAsync(NodeQueryDescription, TimeSpan, CancellationToken)	Gets the details for all nodes in the cluster or for the specified node. If the nodes 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.

GetNodePagedListAsync()

Gets the details for all nodes in the cluster or for the specified node. If the nodes 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.NodeList> GetNodePagedListAsync ();

member this.GetNodePagedListAsync : unit -> System.Threading.Tasks.Task<System.Fabric.Query.NodeList>

Public Function GetNodePagedListAsync () As Task(Of NodeList)

Returns

Task<NodeList>

A task that represents the asynchronous operation.

The returned task contains the list of nodes as NodeList.

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.

Applies to

GetNodePagedListAsync(NodeQueryDescription)

public System.Threading.Tasks.Task<System.Fabric.Query.NodeList> GetNodePagedListAsync (System.Fabric.Description.NodeQueryDescription queryDescription);

member this.GetNodePagedListAsync : System.Fabric.Description.NodeQueryDescription -> System.Threading.Tasks.Task<System.Fabric.Query.NodeList>

Public Function GetNodePagedListAsync (queryDescription As NodeQueryDescription) As Task(Of NodeList)

Parameters

queryDescription: NodeQueryDescription

A NodeQueryDescription object describing which application nodes to return.

Returns

Task<NodeList>

A task that represents the asynchronous operation.

The returned task contains the list of nodes as NodeList.

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.

Applies to

GetNodePagedListAsync(NodeQueryDescription, TimeSpan, CancellationToken)

public System.Threading.Tasks.Task<System.Fabric.Query.NodeList> GetNodePagedListAsync (System.Fabric.Description.NodeQueryDescription queryDescription, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetNodePagedListAsync : System.Fabric.Description.NodeQueryDescription * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.NodeList>

Public Function GetNodePagedListAsync (queryDescription As NodeQueryDescription, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of NodeList)