FabricClient.QueryClient.GetNodeListAsync Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

GetNodeListAsync(String, NodeStatusFilter, String, 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. For the latest features, use GetNodePagedListAsync(NodeQueryDescription, TimeSpan, CancellationToken).
GetNodeListAsync(String, TimeSpan, CancellationToken)	Gets the details for all nodes in the cluster or for the specified node. For the latest features, use GetNodePagedListAsync(NodeQueryDescription, TimeSpan, CancellationToken).
GetNodeListAsync(String, String, 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. For the latest features, use GetNodePagedListAsync(NodeQueryDescription, TimeSpan, CancellationToken).
GetNodeListAsync(String)	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. For the latest features, use GetNodePagedListAsync(NodeQueryDescription).
GetNodeListAsync()	Gets the details for all nodes in the cluster. 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. For the latest features, use GetNodePagedListAsync().
GetNodeListAsync(String, String)	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. For the latest features, use GetNodePagedListAsync(NodeQueryDescription).

GetNodeListAsync(String, NodeStatusFilter, String, 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. For the latest features, use GetNodePagedListAsync(NodeQueryDescription, TimeSpan, CancellationToken).

public System.Threading.Tasks.Task<System.Fabric.Query.NodeList> GetNodeListAsync (string nodeNameFilter, System.Fabric.Query.NodeStatusFilter nodeStatusFilter, string continuationToken, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetNodeListAsync : string * System.Fabric.Query.NodeStatusFilter * string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.NodeList>

Public Function GetNodeListAsync (nodeNameFilter As String, nodeStatusFilter As NodeStatusFilter, continuationToken As String, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of NodeList)

Parameters

nodeNameFilter

String

The name of the node to get details for. The node name is a case-sensitive exact match. Gets all nodes if the given node name is null. If the node name does not match any node on the cluster, an empty list is returned.

nodeStatusFilter

NodeStatusFilter

The node status(es) of the nodes to get details 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<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.

GetNodeListAsync(String, TimeSpan, CancellationToken)

Gets the details for all nodes in the cluster or for the specified node. For the latest features, use GetNodePagedListAsync(NodeQueryDescription, TimeSpan, CancellationToken).

public System.Threading.Tasks.Task<System.Fabric.Query.NodeList> GetNodeListAsync (string nodeNameFilter, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetNodeListAsync : string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.NodeList>

Public Function GetNodeListAsync (nodeNameFilter As String, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of NodeList)

Parameters

nodeNameFilter

String

The name of the node to get details for. The node name is a case-sensitive exact match. Gets all nodes if the given node name is null. If the node name does not match any node on the cluster, an empty list is returned.

timeout

TimeSpan

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

cancellationToken

CancellationToken

Propagates notification that operations should be canceled.

Returns

Task<NodeList>

A task that represents the asynchronous query 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.

GetNodeListAsync(String, String, 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. For the latest features, use GetNodePagedListAsync(NodeQueryDescription, TimeSpan, CancellationToken).

public System.Threading.Tasks.Task<System.Fabric.Query.NodeList> GetNodeListAsync (string nodeNameFilter, string continuationToken, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetNodeListAsync : string * string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.NodeList>

Public Function GetNodeListAsync (nodeNameFilter As String, continuationToken As String, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of NodeList)

Parameters

nodeNameFilter

String

The name of the node to get details for. The node name is a case-sensitive exact match. Gets all nodes if the given node name is null. If the node name does not match any node on the cluster, an empty list is returned.

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<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.

GetNodeListAsync(String)

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. For the latest features, use GetNodePagedListAsync(NodeQueryDescription).

public System.Threading.Tasks.Task<System.Fabric.Query.NodeList> GetNodeListAsync (string nodeNameFilter);

member this.GetNodeListAsync : string -> System.Threading.Tasks.Task<System.Fabric.Query.NodeList>

Public Function GetNodeListAsync (nodeNameFilter As String) As Task(Of NodeList)

Parameters

nodeNameFilter

String

The name of the node to get details for. The node name is a case-sensitive exact match. Gets all nodes in the cluster if the given node name is null. If the node name does not match any node on the cluster, an empty list is returned.

Returns

Task<NodeList>

A task that represents the asynchronous query 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

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.

GetNodeListAsync()

Gets the details for all nodes in the cluster. 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. For the latest features, use GetNodePagedListAsync().

public System.Threading.Tasks.Task<System.Fabric.Query.NodeList> GetNodeListAsync ();

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

Public Function GetNodeListAsync () As Task(Of NodeList)

Returns

Task<NodeList>

A task that represents the asynchronous query 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.

GetNodeListAsync(String, String)

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. For the latest features, use GetNodePagedListAsync(NodeQueryDescription).

public System.Threading.Tasks.Task<System.Fabric.Query.NodeList> GetNodeListAsync (string nodeNameFilter, string continuationToken);

member this.GetNodeListAsync : string * string -> System.Threading.Tasks.Task<System.Fabric.Query.NodeList>

Public Function GetNodeListAsync (nodeNameFilter As String, continuationToken As String) As Task(Of NodeList)

Parameters

nodeNameFilter

String

The name of the node to get details for. The node name is a case-sensitive exact match. Gets all nodes if the given node name is null. If the node name does not match any node on the cluster, an empty list is returned.

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<NodeList>

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.