The zaqar.api.v2.endpoints module

class Endpoints(storage, control, validate, defaults)

Bases: object

v2 API Endpoints.

claim_create(*args, **kwargs)

Creates a claim

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

claim_delete(*args, **kwargs)

Deletes a claim

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

claim_get(*args, **kwargs)

Gets a claim

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

claim_update(*args, **kwargs)

Updates a claim

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

message_delete(*args, **kwargs)

Delete a message from a queue

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

message_delete_many(*args, **kwargs)

Deletes a set of messages from a queue

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

message_get(*args, **kwargs)

Gets a message from a queue

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

message_get_many(*args, **kwargs)

Gets a set of messages from a queue

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

message_list(*args, **kwargs)

Gets a list of messages on a queue

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

message_post(*args, **kwargs)

Post a set of messages to a queue

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

queue_create(*args, **kwargs)

Creates a queue

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

queue_delete(*args, **kwargs)

Deletes a queue

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

queue_get(*args, **kwargs)

Gets a queue

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

queue_get_stats(*args, **kwargs)

Gets queue stats

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

queue_list(*args, **kwargs)

Gets a list of queues

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

subscription_create(*args, **kwargs)

Create a subscription for a queue.

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

subscription_delete(*args, **kwargs)

Delete a specific subscription by ID.

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

subscription_get(*args, **kwargs)

Retrieve details about an existing subscription.

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response

subscription_list(*args, **kwargs)

List all subscriptions for a queue.

Parameters:req (api.common.Request) – Request instance ready to be sent. Returns:resp: Response instance Type:resp: api.common.Response