/// <summary>
/// <para>Retrieves the upgrade progress of the specified compose deployment.</para>
/// </summary>
/// <param name="client"><see cref="System.Fabric.FabricClient"/> object.</param>
/// <param name="deploymentName">
/// <para>The name of the deployment.</para>
/// </param>
/// <param name="timeout">
/// <para>The maximum amount of time the system will allow this operation to continue before returning <see cref="System.TimeoutException" />.</para>
/// </param>
/// <param name="cancellationToken">
/// <para>The <see cref="System.Threading.CancellationToken" /> that the operation is observing. It can be used to propagate notification that the operation should be canceled.</para>
/// </param>
/// <returns>
/// <para>A <see cref="System.Threading.Tasks.Task" /> whose result is the upgrade progress of the specified compose deployment.</para>
/// </returns>
/// <exception cref="System.Fabric.FabricObjectClosedException">
/// <para>The <see cref="System.Fabric.FabricClient" /> object is in a closed state. Dispose of the <see cref="System.Fabric.FabricClient" /> object you are using and instantiate a new <see cref="System.Fabric.FabricClient" /> object.</para>
/// </exception>
/// <exception cref="System.Fabric.FabricElementNotFoundException">
/// <para>
/// <see cref="System.Fabric.FabricErrorCode.ComposeDeploymentNotFound" />: The compose deployment does not exist.
/// </para>
/// </exception>
/// <exception cref="System.TimeoutException">
/// <para>The request timed out but may have already been accepted for processing by the system.</para>
/// </exception>
/// <exception cref="System.OperationCanceledException">
/// <para>The request was canceled before the timeout expired but may have already been accepted for processing by the system.</para>
/// </exception>
internal static Task <ComposeDeploymentUpgradeProgress> GetComposeDeploymentUpgradeProgressAsync(
this FabricClient.ComposeDeploymentClient client,
string deploymentName,
TimeSpan timeout,
CancellationToken cancellationToken)
{
return(client.GetComposeDeploymentUpgradeProgressAsync(deploymentName, timeout, cancellationToken));
}
/// <summary>
/// <para>Retrieves the upgrade progress of the specified compose deployment.</para>
/// </summary>
/// <param name="client"><see cref="System.Fabric.FabricClient"/> object.</param>
/// <param name="deploymentName">
/// <para>The name of the deployment.</para>
/// </param>
/// <returns>
/// <para>A <see cref="System.Threading.Tasks.Task" /> whose result is the upgrade progress of the specified compose deployment.</para>
/// </returns>
/// <exception cref="System.Fabric.FabricObjectClosedException">
/// <para>The <see cref="System.Fabric.FabricClient" /> object is in a closed state. Dispose of the <see cref="System.Fabric.FabricClient" /> object you are using and instantiate a new <see cref="System.Fabric.FabricClient" /> object.</para>
/// </exception>
/// <exception cref="System.Fabric.FabricElementNotFoundException">
/// <para>
/// <see cref="System.Fabric.FabricErrorCode.ComposeDeploymentNotFound" />: The compose deployment does not exist.
/// </para>
/// </exception>
/// <exception cref="System.TimeoutException">
/// <para>The request timed out but may have already been accepted for processing by the system.</para>
/// </exception>
/// <exception cref="System.OperationCanceledException">
/// <para>The request was canceled before the timeout expired but may have already been accepted for processing by the system.</para>
/// </exception>
public static Task <ComposeDeploymentUpgradeProgress> GetComposeDeploymentUpgradeProgressAsync(
this FabricClient.ComposeDeploymentClient client,
string deploymentName)
{
return(client.GetComposeDeploymentUpgradeProgressAsync(deploymentName, FabricClient.DefaultTimeout, CancellationToken.None));
}
