FabricClient.QueryClient.GetDeployedServicePackagePagedListAsync Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

GetDeployedServicePackagePagedListAsync(PagedDeployedServicePackageQueryDescription)	Gets the deployed service packages for the given node and application.
GetDeployedServicePackagePagedListAsync(PagedDeployedServicePackageQueryDescription, TimeSpan, CancellationToken)	Gets the deployed service packages for the given node and application.

GetDeployedServicePackagePagedListAsync(PagedDeployedServicePackageQueryDescription)

Gets the deployed service packages for the given node and application.

public System.Threading.Tasks.Task<System.Fabric.Query.DeployedServicePackagePagedList> GetDeployedServicePackagePagedListAsync (System.Fabric.Description.PagedDeployedServicePackageQueryDescription queryDescription);

member this.GetDeployedServicePackagePagedListAsync : System.Fabric.Description.PagedDeployedServicePackageQueryDescription -> System.Threading.Tasks.Task<System.Fabric.Query.DeployedServicePackagePagedList>

Public Function GetDeployedServicePackagePagedListAsync (queryDescription As PagedDeployedServicePackageQueryDescription) As Task(Of DeployedServicePackagePagedList)

Parameters

queryDescription

PagedDeployedServicePackageQueryDescription

A PagedDeployedServicePackageQueryDescription object describing which deployed service packages to return.

Returns

Task<DeployedServicePackagePagedList>

A task that represents the asynchronous query operation.

The returned task contains the list of deployed service packages as DeployedServicePackagePagedList.

This query returns empty rather than an error if no results are found matching the filters provided.

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.

FabricElementNotFoundException

ApplicationNotFound: The application does not exist.

FabricException

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

FabricInvalidAddressException

For this query, this exception usually means that the given node name does not match any node in the cluster.

Remarks

This is a paged query, meaning that if not all of the service packages 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 example, if there are 10000 service packages but a page only fits the first 3000 service packages, 3000 is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. A null continuation token is returned if there are no subsequent pages.

GetDeployedServicePackagePagedListAsync(PagedDeployedServicePackageQueryDescription, TimeSpan, CancellationToken)

Gets the deployed service packages for the given node and application.

public System.Threading.Tasks.Task<System.Fabric.Query.DeployedServicePackagePagedList> GetDeployedServicePackagePagedListAsync (System.Fabric.Description.PagedDeployedServicePackageQueryDescription queryDescription, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetDeployedServicePackagePagedListAsync : System.Fabric.Description.PagedDeployedServicePackageQueryDescription * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Query.DeployedServicePackagePagedList>

Public Function GetDeployedServicePackagePagedListAsync (queryDescription As PagedDeployedServicePackageQueryDescription, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of DeployedServicePackagePagedList)

Parameters

queryDescription

PagedDeployedServicePackageQueryDescription

A PagedDeployedServicePackageQueryDescription object describing which deployed service packages to return.

timeout

TimeSpan

cancellationToken

CancellationToken

Returns

Task<DeployedServicePackagePagedList>

A task that represents the asynchronous query operation.

The returned task contains the list of deployed service packages as DeployedServicePackagePagedList.

This query returns empty rather than an error if no results are found matching the filters provided.

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.

FabricElementNotFoundException

ApplicationNotFound: The application does not exist.

FabricException

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

FabricInvalidAddressException

For this query, this exception usually means that the given node name does not match any node in the cluster.

Remarks

This is a paged query, meaning that if not all of the service packages 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 example, if there are 10000 service packages but a page only fits the first 3000 service packages, 3000 is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. A null continuation token is returned if there are no subsequent pages.