CloudLoadBalancerProvider.AddLoadBalancerMetadataAsync Method

CloudLoadBalancerProviderAddLoadBalancerMetadataAsync Method

This API is preliminary and subject to change.

Updates the metadata associated with 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<ReadOnlyCollection<LoadBalancerMetadataItem>> AddLoadBalancerMetadataAsync(
	LoadBalancerId loadBalancerId,
	IEnumerable<KeyValuePair<string, string>> metadata,
	CancellationToken cancellationToken
)

Public Function AddLoadBalancerMetadataAsync ( 
	loadBalancerId As LoadBalancerId,
	metadata As IEnumerable(Of KeyValuePair(Of String, String)),
	cancellationToken As CancellationToken
) As Task(Of ReadOnlyCollection(Of LoadBalancerMetadataItem))

public:
virtual Task<ReadOnlyCollection<LoadBalancerMetadataItem^>^>^ AddLoadBalancerMetadataAsync(
	LoadBalancerId^ loadBalancerId, 
	IEnumerable<KeyValuePair<String^, String^>>^ metadata, 
	CancellationToken cancellationToken
) sealed

abstract AddLoadBalancerMetadataAsync : 
        loadBalancerId : LoadBalancerId * 
        metadata : IEnumerable<KeyValuePair<string, string>> * 
        cancellationToken : CancellationToken -> Task<ReadOnlyCollection<LoadBalancerMetadataItem>> 
override AddLoadBalancerMetadataAsync : 
        loadBalancerId : LoadBalancerId * 
        metadata : IEnumerable<KeyValuePair<string, string>> * 
        cancellationToken : CancellationToken -> Task<ReadOnlyCollection<LoadBalancerMetadataItem>>

Parameters

loadBalancerId: Type: net.openstack.Providers.Rackspace.Objects.LoadBalancersLoadBalancerId
The load balancer ID. This is obtained from LoadBalancer.Id.
metadata: Type: System.Collections.GenericIEnumerableKeyValuePairString, String
A collection of metadata items to associate with the load balancer.
cancellationToken: Type: System.ThreadingCancellationToken
The CancellationToken that the task will observe.

Return Value

Type: TaskReadOnlyCollectionLoadBalancerMetadataItem
A Task object representing the asynchronous operation. When the operation completes successfully, the Result property will contain a a collection of LoadBalancerMetadataItem objects describing the updated metadata associated with the load balancer.

Implements

ILoadBalancerServiceAddLoadBalancerMetadataAsync(LoadBalancerId, IEnumerableKeyValuePairString, String, CancellationToken)

Exceptions

Exception	Condition
ArgumentNullException	If loadBalancerId is . -or- If metadata is .
ArgumentException	If metadata contains a pair whose Key is or empty, or whose Value is is .
WebException	If the REST request does not return successfully.

Exception

Condition

ArgumentNullException

If loadBalancerId is .

-or-

If metadata is .

ArgumentException

If metadata contains a pair whose Key is or empty, or whose Value is is .

WebException

If the REST request does not return successfully.

Remarks