SoftLayer.messaging

class SoftLayer.managers.messaging.MessagingConnection(id, endpoint=None)

Message Queue Service Connection

Parameters:

• id – Message Queue Account id
• endpoint – Endpoint URL

authenticate(username, api_key, auth_token=None)

Make request. Generally not called directly

Parameters:

• username – SoftLayer username
• api_key – SoftLayer API Key
• auth_token – (optional) Starting auth token

create_queue(queue_name, **kwargs)

Create Queue

Parameters:

• queue_name – Queue Name
• **kwargs (dict) – queue options

create_subscription(topic_name, type, **kwargs)

Create Subscription

Parameters:

• topic_name – Topic Name
• type – type (‘queue’ or ‘http’)
• **kwargs (dict) – Subscription options

create_topic(topic_name, **kwargs)

Create Topic

Parameters:

• topic_name – Topic Name
• **kwargs (dict) – Topic options

delete_message(queue_name, message_id)

Delete a message

Parameters:

• queue_name – Queue Name
• message_id – Message id

delete_queue(queue_name, force=False)

Delete Queue

Parameters:

• queue_name – Queue Name
• force – (optional) Force queue to be deleted even if there are pending messages

delete_subscription(topic_name, subscription_id)

Delete a subscription

Parameters:

• topic_name – Topic Name
• subscription_id – Subscription id

delete_topic(topic_name, force=False)

Delete Topic

Parameters:

• topic_name – Topic Name
• force – (optional) Force topic to be deleted even if there are attached subscribers

get_queue(queue_name)

Get queue details

Parameters:queue_name – Queue Name

get_queues(tags=None)

Get listing of queues

Parameters:tags (list) – (optional) list of tags to filter by

get_subscriptions(topic_name)

Listing of subscriptions on a topic

Parameters:topic_name – Topic Name

get_topic(topic_name)

Get topic details

Parameters:topic_name – Topic Name

get_topics(tags=None)

Get listing of topics

Parameters:tags (list) – (optional) list of tags to filter by

modify_queue(queue_name, **kwargs)

Modify Queue

Parameters:

• queue_name – Queue Name
• **kwargs (dict) – queue options

modify_topic(topic_name, **kwargs)

Modify Topic

Parameters:

• topic_name – Topic Name
• **kwargs (dict) – Topic options

pop_message(queue_name, count=1)

Pop message from a queue

Parameters:

• queue_name – Queue Name
• count – (optional) number of messages to retrieve

push_queue_message(queue_name, body, **kwargs)

Create Queue Message

Parameters:

• queue_name – Queue Name
• body – Message body
• **kwargs (dict) – Message options

push_topic_message(topic_name, body, **kwargs)

Create Topic Message

Parameters:

• topic_name – Topic Name
• body – Message body
• **kwargs (dict) – Topic message options

stats(period='hour')

Get account stats

Parameters:period – ‘hour’, ‘day’, ‘week’, ‘month’

class SoftLayer.managers.messaging.MessagingManager(client)

Manage SoftLayer Message Queue

get_connection(id, username, api_key, datacenter=None, network=None)

Get connection to Message Queue Service

Parameters:

• id – Message Queue Account id
• username – SoftLayer username
• api_key – SoftLayer API key
• datacenter – Datacenter code
• network – network (‘public’ or ‘private’)

get_endpoint(datacenter=None, network=None)

Get a message queue endpoint based on datacenter/network type

Parameters:

• datacenter – datacenter code
• network – network (‘public’ or ‘private’)

get_endpoints()

Get all known message queue endpoints

list_accounts(**kwargs)

List message queue accounts

Parameters:**kwargs (dict) – response-level arguments (limit, offset, etc.)

ping(datacenter=None, network=None)

class SoftLayer.managers.messaging.QueueAuth(endpoint, username, api_key, auth_token=None)

Message Queue authentication for requests

Parameters:

• endpoint – endpoint URL
• username – SoftLayer username
• api_key – SoftLayer API Key
• auth_token – (optional) Starting auth token

auth()

Do Authentication

handle_error(r, **kwargs)

Handle errors