v1 Package¶
v1 Package¶
agent Module¶
- class payload.api.controllers.v1.agent.Agent(**kwargs)¶
Bases: payload.api.controllers.v1.base.APIBase
API representation of an agent.
- 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)
- 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.agent.AgentsController¶
Bases: pecan.rest.RestController
REST Controller for Agents.
- delete(*args, **kwargs)¶
Delete an agent.
- get_all(*args, **kwargs)¶
Retrieve a list of agents.
- get_one(*args, **kwargs)¶
Retrieve information about the given agent.
- post(*args, **kwargs)¶
Create a new agent.
- put(*args, **kwargs)¶
Update an existing agent.
base Module¶
- class payload.api.controllers.v1.base.APIBase(**kw)¶
Bases: wsme.types.Base
- as_dict()¶
- 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)
- 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)
controller Module¶
- class payload.api.controllers.v1.controller.Controller¶
Bases: object
- agents = <payload.api.controllers.v1.agent.AgentsController object at 0x341d250>¶
- queues = <payload.api.controllers.v1.queue.QueuesController object at 0x341d390>¶
- schemas = <payload.api.controllers.v1.schema.SchemasController object at 0x341d3d0>¶