ILoadBalancerService.SetErrorPageAsync Method

ILoadBalancerServiceSetErrorPageAsync Method

This API is preliminary and subject to change.

Sets the HTML content of the custom error page which is shown to an end user who is attempting to access a load balancer node that is offline or unavailable.

Namespace: net.openstack.Providers.Rackspace
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c

Syntax

C++

Copy

Task SetErrorPageAsync(
	LoadBalancerId loadBalancerId,
	string content,
	AsyncCompletionOption completionOption,
	CancellationToken cancellationToken,
	IProgress<LoadBalancer> progress
)

Function SetErrorPageAsync ( 
	loadBalancerId As LoadBalancerId,
	content As String,
	completionOption As AsyncCompletionOption,
	cancellationToken As CancellationToken,
	progress As IProgress(Of LoadBalancer)
) As Task

Task^ SetErrorPageAsync(
	LoadBalancerId^ loadBalancerId, 
	String^ content, 
	AsyncCompletionOption completionOption, 
	CancellationToken cancellationToken, 
	IProgress<LoadBalancer^>^ progress
)

abstract SetErrorPageAsync : 
        loadBalancerId : LoadBalancerId * 
        content : string * 
        completionOption : AsyncCompletionOption * 
        cancellationToken : CancellationToken * 
        progress : IProgress<LoadBalancer> -> Task

Parameters

loadBalancerId: Type: net.openstack.Providers.Rackspace.Objects.LoadBalancersLoadBalancerId
The load balancer ID. This is obtained from LoadBalancer.Id.
content: Type: SystemString
The HTML content of the error page which is shown to an end user who is attempting to access a load balancer node that is offline or unavailable.
completionOption: Type: net.openstack.CoreAsyncCompletionOption
Specifies when the Task representing the asynchronous server operation should be considered complete.
cancellationToken: Type: System.ThreadingCancellationToken
The CancellationToken that the task will observe.
progress: Type: SystemIProgressLoadBalancer
An optional callback object to receive progress notifications, if completionOption is RequestCompleted. If this is , no progress notifications are sent.

Return Value

Type: Task
A Task object representing the asynchronous operation. If completionOption is RequestCompleted, the task will not be considered complete until the load balancer transitions out of the PendingUpdate state.

Exceptions

Exception	Condition
ArgumentNullException	If loadBalancerId is . -or- If content is .
ArgumentException	If content is empty. -or- If completionOption is not a valid AsyncCompletionOption.
WebException	If the REST request does not return successfully.

Exception

Condition

ArgumentNullException

If loadBalancerId is .

-or-

If content is .

ArgumentException

If content is empty.

-or-

If completionOption is not a valid AsyncCompletionOption.

WebException

If the REST request does not return successfully.