queue Package¶

`queue` Package¶

class payload.api.controllers.v1.queue.Queue(**kwargs)¶

Bases: payload.api.controllers.v1.base.APIBase

API representation of a queue.

created_at¶

Complex type attribute definition.

Example:

class MyComplexType(wsme.types.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(wsme.types.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)

description¶

Complex type attribute definition.

Example:

class MyComplexType(wsme.types.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(wsme.types.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)

disabled¶

Complex type attribute definition.

Example:

class MyComplexType(wsme.types.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(wsme.types.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)

name¶

Complex type attribute definition.

Example:

class MyComplexType(wsme.types.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(wsme.types.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)

project_id¶

Complex type attribute definition.

Example:

class MyComplexType(wsme.types.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(wsme.types.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)

updated_at¶

Complex type attribute definition.

Example:

class MyComplexType(wsme.types.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(wsme.types.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)

user_id¶

Complex type attribute definition.

Example:

class MyComplexType(wsme.types.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(wsme.types.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)

uuid¶

Complex type attribute definition.

Example:

class MyComplexType(wsme.types.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(wsme.types.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)

class payload.api.controllers.v1.queue.QueuesController¶

Bases: pecan.rest.RestController

REST Controller for queues.

callers = <payload.api.controllers.v1.queue.caller.QueueCallersController object at 0x341a690>¶

delete(*args, **kwargs)¶: Delete a queue.

get_all(*args, **kwargs)¶: Retrieve a list of queues.

get_one(*args, **kwargs)¶: Retrieve information about the given queue.

members = <payload.api.controllers.v1.queue.member.QueueMembersController object at 0x341ac50>¶

post(*args, **kwargs)¶: Create a new queue.

put(*args, **kwargs)¶

stats = <payload.api.controllers.v1.queue.stat.QueueStatsController object at 0x341ac90>¶

`caller` Module¶

class payload.api.controllers.v1.queue.caller.QueueCallersController¶

Bases: pecan.rest.RestController

REST Controller for queue callers.

delete(*args, **kwargs)¶: Delete a queue caller.

get_all(*args, **kwargs)¶: Retrieve a list of queue callers.

get_one(*args, **kwargs)¶: Retrieve information about the given queue.

post(*args, **kwargs)¶: Create a new queue caller.

`member` Module¶

class payload.api.controllers.v1.queue.member.QueueMember(**kwargs)¶

Bases: payload.api.controllers.v1.base.APIBase

API representation of a queue member.

agent_uuid¶

Complex type attribute definition.

Example:

class MyComplexType(wsme.types.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(wsme.types.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)

created_at¶

Complex type attribute definition.

Example:

class MyComplexType(wsme.types.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(wsme.types.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)

queue_uuid¶

Complex type attribute definition.

Example:

class MyComplexType(wsme.types.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(wsme.types.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)

updated_at¶

Complex type attribute definition.

Example:

class MyComplexType(wsme.types.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(wsme.types.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)

class payload.api.controllers.v1.queue.member.QueueMembersController¶

Bases: pecan.rest.RestController

REST Controller for queue members.

delete(*args, **kwargs)¶: Delete a queue member.

get_all(*args, **kwargs)¶: Retrieve a list of queue members.

get_one(*args, **kwargs)¶: Retrieve information about the given queue member.

post(*args, **kwargs)¶: Create a new queue member.

`stat` Module¶

class payload.api.controllers.v1.queue.stat.QueueStatsController¶

Bases: pecan.rest.RestController

REST Controller for queue stats.

get_all(*args, **kwargs)¶: Retrieve a list of queue stats.

queue Package¶

queue Package¶

caller Module¶

member Module¶

stat Module¶

`queue` Package¶

`caller` Module¶

`member` Module¶

`stat` Module¶