# pika.spec

## AMQP Specification

This module implements the constants and classes that comprise AMQP protocol level constructs. It should rarely be directly referenced outside of Pika’s own internal use. .. note:: Auto-generated code by codegen.py, do not edit directly. Pull requests to this file without accompanying `utils/codegen.py` changes will be rejected.

class pika.spec.Connection
  INDEX = 10
  NAME = 'Connection'
  class Start(version_major=0, version_minor=9, server_properties=None, mechanisms='PLAIN', locales='en_US')
    INDEX = 655370
    NAME = 'Connection.Start'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class StartOk(client_properties=None, mechanism='PLAIN', response=None, locale='en_US')
    INDEX = 655371
    NAME = 'Connection.StartOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Secure(challenge=None)
    INDEX = 655380
    NAME = 'Connection.Secure'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class SecureOk(response=None)
    INDEX = 655381
    NAME = 'Connection.SecureOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Tune(channel_max=0, frame_max=0, heartbeat=0)
    INDEX = 655390
    NAME = 'Connection.Tune'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class TuneOk(channel_max=0, frame_max=0, heartbeat=0)
    INDEX = 655391
    NAME = 'Connection.TuneOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Open(virtual_host='/', capabilities='', insist=False)
    INDEX = 655400
    NAME = 'Connection.Open'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class OpenOk(known_hosts='')
    INDEX = 655401
    NAME = 'Connection.OpenOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Close(reply_code=None, reply_text='', class_id=None, method_id=None)
    INDEX = 655410
    NAME = 'Connection.Close'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class CloseOk
    INDEX = 655411
    NAME = 'Connection.CloseOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Blocked(reason='')
    INDEX = 655420
    NAME = 'Connection.Blocked'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Unblocked
    INDEX = 655421
    NAME = 'Connection.Unblocked'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class UpdateSecret(new_secret, reason)
    INDEX = 655430
    NAME = 'Connection.UpdateSecret'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class UpdateSecretOk
    INDEX = 655431
    NAME = 'Connection.UpdateSecretOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

class pika.spec.Channel
  INDEX = 20
  NAME = 'Channel'
  class Open(out_of_band='')
    INDEX = 1310730
    NAME = 'Channel.Open'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class OpenOk(channel_id='')
    INDEX = 1310731
    NAME = 'Channel.OpenOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Flow(active=None)
    INDEX = 1310740
    NAME = 'Channel.Flow'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class FlowOk(active=None)
    INDEX = 1310741
    NAME = 'Channel.FlowOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Close(reply_code=None, reply_text='', class_id=None, method_id=None)
    INDEX = 1310760
    NAME = 'Channel.Close'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class CloseOk
    INDEX = 1310761
    NAME = 'Channel.CloseOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

class pika.spec.Access
  INDEX = 30
  NAME = 'Access'
  class Request(realm='/data', exclusive=False, passive=True, active=True, write=True, read=True)
    INDEX = 1966090
    NAME = 'Access.Request'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class RequestOk(ticket=1)
    INDEX = 1966091
    NAME = 'Access.RequestOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

class pika.spec.Exchange
  INDEX = 40
  NAME = 'Exchange'
  class Declare(ticket=0, exchange=None, type=ExchangeType.direct, passive=False, durable=False, auto_delete=False, internal=False, nowait=False, arguments=None)
    INDEX = 2621450
    NAME = 'Exchange.Declare'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class DeclareOk
    INDEX = 2621451
    NAME = 'Exchange.DeclareOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Delete(ticket=0, exchange=None, if_unused=False, nowait=False)
    INDEX = 2621460
    NAME = 'Exchange.Delete'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class DeleteOk
    INDEX = 2621461
    NAME = 'Exchange.DeleteOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Bind(ticket=0, destination=None, source=None, routing_key='', nowait=False, arguments=None)
    INDEX = 2621470
    NAME = 'Exchange.Bind'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class BindOk
    INDEX = 2621471
    NAME = 'Exchange.BindOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Unbind(ticket=0, destination=None, source=None, routing_key='', nowait=False, arguments=None)
    INDEX = 2621480
    NAME = 'Exchange.Unbind'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class UnbindOk
    INDEX = 2621491
    NAME = 'Exchange.UnbindOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

class pika.spec.Queue
  INDEX = 50
  NAME = 'Queue'
  class Declare(ticket=0, queue='', passive=False, durable=False, exclusive=False, auto_delete=False, nowait=False, arguments=None)
    INDEX = 3276810
    NAME = 'Queue.Declare'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class DeclareOk(queue=None, message_count=None, consumer_count=None)
    INDEX = 3276811
    NAME = 'Queue.DeclareOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Bind(ticket=0, queue='', exchange=None, routing_key='', nowait=False, arguments=None)
    INDEX = 3276820
    NAME = 'Queue.Bind'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class BindOk
    INDEX = 3276821
    NAME = 'Queue.BindOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Purge(ticket=0, queue='', nowait=False)
    INDEX = 3276830
    NAME = 'Queue.Purge'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class PurgeOk(message_count=None)
    INDEX = 3276831
    NAME = 'Queue.PurgeOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Delete(ticket=0, queue='', if_unused=False, if_empty=False, nowait=False)
    INDEX = 3276840
    NAME = 'Queue.Delete'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class DeleteOk(message_count=None)
    INDEX = 3276841
    NAME = 'Queue.DeleteOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Unbind(ticket=0, queue='', exchange=None, routing_key='', arguments=None)
    INDEX = 3276850
    NAME = 'Queue.Unbind'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class UnbindOk
    INDEX = 3276851
    NAME = 'Queue.UnbindOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

class pika.spec.Basic
  INDEX = 60
  NAME = 'Basic'
  class Qos(prefetch_size=0, prefetch_count=0, global_qos=False)
    INDEX = 3932170
    NAME = 'Basic.Qos'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class QosOk
    INDEX = 3932171
    NAME = 'Basic.QosOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Consume(ticket=0, queue='', consumer_tag='', no_local=False, no_ack=False, exclusive=False, nowait=False, arguments=None)
    INDEX = 3932180
    NAME = 'Basic.Consume'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class ConsumeOk(consumer_tag=None)
    INDEX = 3932181
    NAME = 'Basic.ConsumeOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Cancel(consumer_tag=None, nowait=False)
    INDEX = 3932190
    NAME = 'Basic.Cancel'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class CancelOk(consumer_tag=None)
    INDEX = 3932191
    NAME = 'Basic.CancelOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Publish(ticket=0, exchange='', routing_key='', mandatory=False, immediate=False)
    INDEX = 3932200
    NAME = 'Basic.Publish'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Return(reply_code=None, reply_text='', exchange=None, routing_key=None)
    INDEX = 3932210
    NAME = 'Basic.Return'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Deliver(consumer_tag=None, delivery_tag=None, redelivered=False, exchange=None, routing_key=None)
    INDEX = 3932220
    NAME = 'Basic.Deliver'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Get(ticket=0, queue='', no_ack=False)
    INDEX = 3932230
    NAME = 'Basic.Get'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class GetOk(delivery_tag=None, redelivered=False, exchange=None, routing_key=None, message_count=None)
    INDEX = 3932231
    NAME = 'Basic.GetOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class GetEmpty(cluster_id='')
    INDEX = 3932232
    NAME = 'Basic.GetEmpty'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Ack(delivery_tag=0, multiple=False)
    INDEX = 3932240
    NAME = 'Basic.Ack'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Reject(delivery_tag=None, requeue=True)
    INDEX = 3932250
    NAME = 'Basic.Reject'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class RecoverAsync(requeue=False)
    INDEX = 3932260
    NAME = 'Basic.RecoverAsync'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Recover(requeue=False)
    INDEX = 3932270
    NAME = 'Basic.Recover'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class RecoverOk
    INDEX = 3932271
    NAME = 'Basic.RecoverOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Nack(delivery_tag=0, multiple=False, requeue=True)
    INDEX = 3932280
    NAME = 'Basic.Nack'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

class pika.spec.Tx
  INDEX = 90
  NAME = 'Tx'
  class Select
    INDEX = 5898250
    NAME = 'Tx.Select'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class SelectOk
    INDEX = 5898251
    NAME = 'Tx.SelectOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Commit
    INDEX = 5898260
    NAME = 'Tx.Commit'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class CommitOk
    INDEX = 5898261
    NAME = 'Tx.CommitOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class Rollback
    INDEX = 5898270
    NAME = 'Tx.Rollback'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class RollbackOk
    INDEX = 5898271
    NAME = 'Tx.RollbackOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

class pika.spec.Confirm
  INDEX = 85
  NAME = 'Confirm'
  class Select(nowait=False)
    INDEX = 5570570
    NAME = 'Confirm.Select'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

  class SelectOk
    INDEX = 5570571
    NAME = 'Confirm.SelectOk'
    property synchronous

      Returns True when the argument is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    decode(encoded, offset=0)
    encode()
    get_body()

      Return the message body if it is set.

      Return type:

        str|unicode

    get_properties()

      Return the properties if they are set.

      Return type:

        pika.frame.Properties

class pika.spec.BasicProperties(content_type=None, content_encoding=None, headers=None, delivery_mode=None, priority=None, correlation_id=None, reply_to=None, expiration=None, message_id=None, timestamp=None, type=None, user_id=None, app_id=None, cluster_id=None)
  CLASS

    alias of `Basic`

  INDEX = 60
  NAME = 'BasicProperties'
  FLAG_CONTENT_TYPE = 32768
  FLAG_CONTENT_ENCODING = 16384
  FLAG_HEADERS = 8192
  FLAG_DELIVERY_MODE = 4096
  FLAG_PRIORITY = 2048
  FLAG_CORRELATION_ID = 1024
  FLAG_REPLY_TO = 512
  FLAG_EXPIRATION = 256
  FLAG_MESSAGE_ID = 128
  FLAG_TIMESTAMP = 64
  FLAG_TYPE = 32
  FLAG_USER_ID = 16
  FLAG_APP_ID = 8
  FLAG_CLUSTER_ID = 4
  decode(encoded, offset=0)
  encode()

pika.spec.has_content(methodNumber)