FabricClient.ClusterManagementClient.GetClusterManifestAsync Method
Definition
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
| GetClusterManifestAsync() |
Gets the XML contents of the current running cluster manifest. |
| GetClusterManifestAsync(TimeSpan, CancellationToken) |
Gets the XML contents of the current running cluster manifest. |
| GetClusterManifestAsync(ClusterManifestQueryDescription, TimeSpan, CancellationToken) |
Gets the XML contents of a cluster manifest as specified by |
GetClusterManifestAsync()
Gets the XML contents of the current running cluster manifest.
public System.Threading.Tasks.Task<string> GetClusterManifestAsync ();member this.GetClusterManifestAsync : unit -> System.Threading.Tasks.Task<string>Public Function GetClusterManifestAsync () As Task(Of String)Returns
The cluster manifest contents.
Exceptions
The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.
Failure of an operation due to a transient environmental or runtime circumstance clients should catch, wait a short time, and retry. In case of repeated timeout errors, client should back-off retry with an increasing wait.
Failure of an operation due to a transient environmental or runtime circumstance clients should catch, wait a short time, and retry. In case of repeated timeout errors, client should back-off retry with an increasing wait.
Applies to
GetClusterManifestAsync(TimeSpan, CancellationToken)
Gets the XML contents of the current running cluster manifest.
public System.Threading.Tasks.Task<string> GetClusterManifestAsync (TimeSpan timeout, System.Threading.CancellationToken cancellationToken);member this.GetClusterManifestAsync : TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>Public Function GetClusterManifestAsync (timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of String)Parameters
- timeout
- TimeSpan
The timespan that defines the maximum amount of time Service Fabric will allow this operation to continue before returning a TimeoutException.
- cancellationToken
- CancellationToken
The cancellation token that the operation is observing. It can be used to send a notification that the operation should be canceled. Note that cancellation is advisory and that the operation may still be completed even if it is canceled.
Returns
The cluster manifest contents.
Exceptions
The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.
Failure of an operation due to a transient environmental or runtime circumstance clients should catch, wait a short time, and retry. In case of repeated timeout errors, client should back-off retry with an increasing wait.
Failure of an operation due to a transient environmental or runtime circumstance clients should catch, wait a short time, and retry. In case of repeated timeout errors, client should back-off retry with an increasing wait.
Applies to
GetClusterManifestAsync(ClusterManifestQueryDescription, TimeSpan, CancellationToken)
Gets the XML contents of a cluster manifest as specified by queryDescription.
public System.Threading.Tasks.Task<string> GetClusterManifestAsync (System.Fabric.Description.ClusterManifestQueryDescription queryDescription, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);member this.GetClusterManifestAsync : System.Fabric.Description.ClusterManifestQueryDescription * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>Public Function GetClusterManifestAsync (queryDescription As ClusterManifestQueryDescription, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of String)Parameters
- queryDescription
- ClusterManifestQueryDescription
Specifies additional parameters to determine which cluster manifest to retrieve.
- timeout
- TimeSpan
The timespan that defines the maximum amount of time Service Fabric will allow this operation to continue before returning a TimeoutException.
- cancellationToken
- CancellationToken
The cancellation token that the operation is observing. It can be used to send a notification that the operation should be canceled. Note that cancellation is advisory and that the operation may still be completed even if it is canceled.
Returns
The cluster manifest contents.
Exceptions
The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.
Failure of an operation due to a transient environmental or runtime circumstance clients should catch, wait a short time, and retry. In case of repeated timeout errors, client should back-off retry with an increasing wait.
Failure of an operation due to a transient environmental or runtime circumstance clients should catch, wait a short time, and retry. In case of repeated timeout errors, client should back-off retry with an increasing wait.
