CloudLoadBalancerProvider.AddNodeAsync Method

This API is preliminary and subject to change.

Add a node to a load balancer.

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

Syntax

C++

Copy

public Task<Node> AddNodeAsync(
	LoadBalancerId loadBalancerId,
	NodeConfiguration nodeConfiguration,
	AsyncCompletionOption completionOption,
	CancellationToken cancellationToken,
	IProgress<LoadBalancer> progress
)

Public Function AddNodeAsync ( 
	loadBalancerId As LoadBalancerId,
	nodeConfiguration As NodeConfiguration,
	completionOption As AsyncCompletionOption,
	cancellationToken As CancellationToken,
	progress As IProgress(Of LoadBalancer)
) As Task(Of Node)

public:
virtual Task<Node^>^ AddNodeAsync(
	LoadBalancerId^ loadBalancerId, 
	NodeConfiguration^ nodeConfiguration, 
	AsyncCompletionOption completionOption, 
	CancellationToken cancellationToken, 
	IProgress<LoadBalancer^>^ progress
) sealed

abstract AddNodeAsync : 
        loadBalancerId : LoadBalancerId * 
        nodeConfiguration : NodeConfiguration * 
        completionOption : AsyncCompletionOption * 
        cancellationToken : CancellationToken * 
        progress : IProgress<LoadBalancer> -> Task<Node> 
override AddNodeAsync : 
        loadBalancerId : LoadBalancerId * 
        nodeConfiguration : NodeConfiguration * 
        completionOption : AsyncCompletionOption * 
        cancellationToken : CancellationToken * 
        progress : IProgress<LoadBalancer> -> Task<Node>

Parameters

loadBalancerId: Type: net.openstack.Providers.Rackspace.Objects.LoadBalancers.LoadBalancerId
The load balancer ID. This is obtained from LoadBalancer.Id.
nodeConfiguration: Type: net.openstack.Providers.Rackspace.Objects.LoadBalancers.NodeConfiguration
A NodeConfiguration object describing the load balancer node to add.
completionOption: Type: net.openstack.Core.AsyncCompletionOption
Specifies when the Task representing the asynchronous server operation should be considered complete.
cancellationToken: Type: System.Threading.CancellationToken
The CancellationToken that the task will observe.
progress: Type: System.IProgress<LoadBalancer>
An optional callback object to receive progress notifications, if completionOption is RequestCompleted. If this is null, no progress notifications are sent.

Return Value

Type: Task<Node>
A Task object representing the asynchronous operation. When the operation completes, the Result property will contain a Node object describing the new load balancer node. If completionOption is RequestCompleted, the task will not be considered complete until the load balancer transitions out of the PendingUpdate state.

Implements

ILoadBalancerService.AddNodeAsync(LoadBalancerId, NodeConfiguration, AsyncCompletionOption, CancellationToken, IProgress<LoadBalancer>)

Exceptions

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

Exception

Condition

ArgumentNullException

If loadBalancerId is null.

-or-

If nodeConfiguration is null.

ArgumentException

If completionOption is not a valid AsyncCompletionOption.

WebException

If the REST request does not return successfully.

Version Information