IQueueingService.GetQueueMetadataAsync Method (QueueName, CancellationToken)

IQueueingServiceGetQueueMetadataAsync Method (QueueName, CancellationToken)

This API is preliminary and subject to change.

Gets the metadata associated with a queue.

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

Syntax

C++

Copy

Task<JObject> GetQueueMetadataAsync(
	QueueName queueName,
	CancellationToken cancellationToken
)

Function GetQueueMetadataAsync ( 
	queueName As QueueName,
	cancellationToken As CancellationToken
) As Task(Of JObject)

Task<JObject^>^ GetQueueMetadataAsync(
	QueueName^ queueName, 
	CancellationToken cancellationToken
)

abstract GetQueueMetadataAsync : 
        queueName : QueueName * 
        cancellationToken : CancellationToken -> Task<JObject>

Parameters

queueName: Type: net.openstack.Core.Domain.QueuesQueueName
The queue name.
cancellationToken: Type: System.ThreadingCancellationToken
The CancellationToken that the task will observe.

Return Value

Type: TaskJObject
A Task object representing the asynchronous operation. When the task completes successfully, the Result property will contain a JObject object containing the metadata associated with the queue.

Exceptions

Exception	Condition
ArgumentNullException	If queueName is .
WebException	If the REST request does not return successfully.

Version Information

.NET Framework

Supported in: 4.5

openstack.net

Supported in: 1.6, 1.5, 1.4, 1.3.6

Reference

IQueueingService Interface

GetQueueMetadataAsync Overload

net.openstack.Core.Providers Namespace

Other Resources

Get Queue Metadata (OpenStack Marconi API v1 Blueprint)