Thinkcode.RabbitMQ.OpenAPI.Api.QueuesApi

May 13, 2019 · View on GitHub

All URIs are relative to http://mb1.bus.adaptive.me/rabbitmq/api

Method	HTTP request	Description
ConsumeMessage	POST /queues/{vhost}/{queue}/get	Consume Message
CreateQueue	PUT /queues/{vhost}/{queue}	Create Queue
CreateQueueActions	POST /queues/{vhost}/{queue}/actions	Create Actions for Queue
DeleteQueue	DELETE /queues/{vhost}/{queue}	Delete Queue
DeleteQueueContents	DELETE /queues/{vhost}/{queue}/contents	Delete Queue Contents (Purge)
GetQueue	GET /queues/{vhost}/{queue}	Get Queue
ListBindingsForQueue	GET /queues/{vhost}/{queue}/bindings	List All Bindings for Queue
ListQueues	GET /queues	List Queues
ListQueuesForVirtualHost	GET /queues/{vhost}	List Queues for VHost

ConsumeMessage

List ConsumeMessage (string vhost, string queue, ConsumeRequest body = null)

Consume Message

Example

using System;
using System.Diagnostics;
using Thinkcode.RabbitMQ.OpenAPI.Api;
using Thinkcode.RabbitMQ.OpenAPI.Client;
using Thinkcode.RabbitMQ.OpenAPI.Model;

namespace Example
{
    public class ConsumeMessageExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basic_auth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new QueuesApi();
            var vhost = vhost_example;  // string | 
            var queue = queue_example;  // string | 
            var body = new ConsumeRequest(); // ConsumeRequest |  (optional) 

            try
            {
                // Consume Message
                List&lt;ConsumeResponse&gt; result = apiInstance.ConsumeMessage(vhost, queue, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueuesApi.ConsumeMessage: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Notes
vhost	string
queue	string
body	ConsumeRequest	[optional]

Return type

List

Authorization

basic_auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateQueue

void CreateQueue (string vhost, string queue, QueueRequest body = null)

Create Queue

Example

using System;
using System.Diagnostics;
using Thinkcode.RabbitMQ.OpenAPI.Api;
using Thinkcode.RabbitMQ.OpenAPI.Client;
using Thinkcode.RabbitMQ.OpenAPI.Model;

namespace Example
{
    public class CreateQueueExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basic_auth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new QueuesApi();
            var vhost = vhost_example;  // string | 
            var queue = queue_example;  // string | 
            var body = new QueueRequest(); // QueueRequest |  (optional) 

            try
            {
                // Create Queue
                apiInstance.CreateQueue(vhost, queue, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueuesApi.CreateQueue: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Notes
vhost	string
queue	string
body	QueueRequest	[optional]

Return type

void (empty response body)

Authorization

basic_auth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateQueueActions

void CreateQueueActions (string vhost, string queue, QueueAction body = null)

Create Actions for Queue

Example

using System;
using System.Diagnostics;
using Thinkcode.RabbitMQ.OpenAPI.Api;
using Thinkcode.RabbitMQ.OpenAPI.Client;
using Thinkcode.RabbitMQ.OpenAPI.Model;

namespace Example
{
    public class CreateQueueActionsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basic_auth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new QueuesApi();
            var vhost = vhost_example;  // string | 
            var queue = queue_example;  // string | 
            var body = new QueueAction(); // QueueAction |  (optional) 

            try
            {
                // Create Actions for Queue
                apiInstance.CreateQueueActions(vhost, queue, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueuesApi.CreateQueueActions: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Notes
vhost	string
queue	string
body	QueueAction	[optional]

Return type

void (empty response body)

Authorization

basic_auth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteQueue

void DeleteQueue (string vhost, string queue, bool? ifEmpty = null, bool? ifUnused = null)

Delete Queue

Example

using System;
using System.Diagnostics;
using Thinkcode.RabbitMQ.OpenAPI.Api;
using Thinkcode.RabbitMQ.OpenAPI.Client;
using Thinkcode.RabbitMQ.OpenAPI.Model;

namespace Example
{
    public class DeleteQueueExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basic_auth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new QueuesApi();
            var vhost = vhost_example;  // string | 
            var queue = queue_example;  // string | 
            var ifEmpty = true;  // bool? |  (optional)  (default to true)
            var ifUnused = true;  // bool? |  (optional)  (default to true)

            try
            {
                // Delete Queue
                apiInstance.DeleteQueue(vhost, queue, ifEmpty, ifUnused);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueuesApi.DeleteQueue: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Notes
vhost	string
queue	string
ifEmpty	bool?	[optional] [default to true]
ifUnused	bool?	[optional] [default to true]

Return type

void (empty response body)

Authorization

basic_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteQueueContents

void DeleteQueueContents (string vhost, string queue)

Delete Queue Contents (Purge)

Example

using System;
using System.Diagnostics;
using Thinkcode.RabbitMQ.OpenAPI.Api;
using Thinkcode.RabbitMQ.OpenAPI.Client;
using Thinkcode.RabbitMQ.OpenAPI.Model;

namespace Example
{
    public class DeleteQueueContentsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basic_auth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new QueuesApi();
            var vhost = vhost_example;  // string | 
            var queue = queue_example;  // string | 

            try
            {
                // Delete Queue Contents (Purge)
                apiInstance.DeleteQueueContents(vhost, queue);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueuesApi.DeleteQueueContents: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
vhost	string
queue	string

Return type

void (empty response body)

Authorization

basic_auth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetQueue

Queue GetQueue (string vhost, string queue)

Get Queue

Example

using System;
using System.Diagnostics;
using Thinkcode.RabbitMQ.OpenAPI.Api;
using Thinkcode.RabbitMQ.OpenAPI.Client;
using Thinkcode.RabbitMQ.OpenAPI.Model;

namespace Example
{
    public class GetQueueExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basic_auth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new QueuesApi();
            var vhost = vhost_example;  // string | 
            var queue = queue_example;  // string | 

            try
            {
                // Get Queue
                Queue result = apiInstance.GetQueue(vhost, queue);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueuesApi.GetQueue: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
vhost	string
queue	string

Return type

Queue

Authorization

basic_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListBindingsForQueue

List ListBindingsForQueue (string vhost, string queue)

List All Bindings for Queue

Example

using System;
using System.Diagnostics;
using Thinkcode.RabbitMQ.OpenAPI.Api;
using Thinkcode.RabbitMQ.OpenAPI.Client;
using Thinkcode.RabbitMQ.OpenAPI.Model;

namespace Example
{
    public class ListBindingsForQueueExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basic_auth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new QueuesApi();
            var vhost = vhost_example;  // string | 
            var queue = queue_example;  // string | 

            try
            {
                // List All Bindings for Queue
                List&lt;Binding&gt; result = apiInstance.ListBindingsForQueue(vhost, queue);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueuesApi.ListBindingsForQueue: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
vhost	string
queue	string

Return type

List

Authorization

basic_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListQueues

List ListQueues ()

List Queues

Example

using System;
using System.Diagnostics;
using Thinkcode.RabbitMQ.OpenAPI.Api;
using Thinkcode.RabbitMQ.OpenAPI.Client;
using Thinkcode.RabbitMQ.OpenAPI.Model;

namespace Example
{
    public class ListQueuesExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basic_auth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new QueuesApi();

            try
            {
                // List Queues
                List&lt;Queue&gt; result = apiInstance.ListQueues();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueuesApi.ListQueues: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

basic_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListQueuesForVirtualHost

List ListQueuesForVirtualHost (string vhost)

List Queues for VHost

Example

using System;
using System.Diagnostics;
using Thinkcode.RabbitMQ.OpenAPI.Api;
using Thinkcode.RabbitMQ.OpenAPI.Client;
using Thinkcode.RabbitMQ.OpenAPI.Model;

namespace Example
{
    public class ListQueuesForVirtualHostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basic_auth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new QueuesApi();
            var vhost = vhost_example;  // string | 

            try
            {
                // List Queues for VHost
                List&lt;Queue&gt; result = apiInstance.ListQueuesForVirtualHost(vhost);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueuesApi.ListQueuesForVirtualHost: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
vhost	string

Return type

List

Authorization

basic_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]