Class: Azure::ServiceBus::BrokeredMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/azure/service_bus/brokered_message.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(body, properties = {}) {|_self| ... } ⇒ BrokeredMessage

Public: Constructor.

body - String. The body of the message properties - Hash. The properties of the message (optional)

Yields:

  • (_self)

Yield Parameters:


117
118
119
120
121
# File 'lib/azure/service_bus/brokered_message.rb', line 117

def initialize(body, properties={})
  @body = body
  @properties = properties
  yield self if block_given?
end

Instance Attribute Details

#bodyObject

Public: Get/Set the body of the message

Returns a String


106
107
108
# File 'lib/azure/service_bus/brokered_message.rb', line 106

def body
  @body
end

#content_typeObject

Public: Get/Set the ContentType of the message

Returns a String


25
26
27
# File 'lib/azure/service_bus/brokered_message.rb', line 25

def content_type
  @content_type
end

#correlation_idObject

Public: Get/Set the CorrelationID of the message

Returns a String


30
31
32
# File 'lib/azure/service_bus/brokered_message.rb', line 30

def correlation_id
  @correlation_id
end

#delivery_countObject

Public: Get/Set the DeliveryCount of the message

Returns an Integer


40
41
42
# File 'lib/azure/service_bus/brokered_message.rb', line 40

def delivery_count
  @delivery_count
end

#enqueued_time_utcObject

Public: Get/Set the EnqueuedTimeUtc for the message

Returns a DateTime


71
72
73
# File 'lib/azure/service_bus/brokered_message.rb', line 71

def enqueued_time_utc
  @enqueued_time_utc
end

#labelObject

Public: Get/Set the Label for the message

Returns a String


61
62
63
# File 'lib/azure/service_bus/brokered_message.rb', line 61

def label
  @label
end

#locationObject

Public: Get/Set the URI of the locked message. This URI is needed to unlock or delete the message

Returns an URI


111
112
113
# File 'lib/azure/service_bus/brokered_message.rb', line 111

def location
  @location
end

#lock_tokenObject

Public: Get/Set the LockToken of the message

Returns a String (GUID)


50
51
52
# File 'lib/azure/service_bus/brokered_message.rb', line 50

def lock_token
  @lock_token
end

#locked_until_utcObject

Public: Get/Set the LockedUntilUtc for the message

Returns a DateTime


45
46
47
# File 'lib/azure/service_bus/brokered_message.rb', line 45

def locked_until_utc
  @locked_until_utc
end

#message_idObject Also known as: id

Public: Get/Set the MessageID of the message

Returns a String


55
56
57
# File 'lib/azure/service_bus/brokered_message.rb', line 55

def message_id
  @message_id
end

#propertiesObject

Public: Get/Set custom key-value properties of the message

Returns a Hash


101
102
103
# File 'lib/azure/service_bus/brokered_message.rb', line 101

def properties
  @properties
end

#reply_toObject

Public: Get/Set the ReplyTo for the message

Returns a String


66
67
68
# File 'lib/azure/service_bus/brokered_message.rb', line 66

def reply_to
  @reply_to
end

#reply_to_session_idObject

Public: Get/Set the ReplyToSessionId for the message

Returns a String


96
97
98
# File 'lib/azure/service_bus/brokered_message.rb', line 96

def reply_to_session_id
  @reply_to_session_id
end

#scheduled_enqueue_time_utcObject

Public: Get/Set the ScheduledEnqueueTimeUtc for the message

Returns a DateTime


91
92
93
# File 'lib/azure/service_bus/brokered_message.rb', line 91

def scheduled_enqueue_time_utc
  @scheduled_enqueue_time_utc
end

#sequence_numberObject

Public: Get/Set the SequenceNumber for the message

Returns an Integer


76
77
78
# File 'lib/azure/service_bus/brokered_message.rb', line 76

def sequence_number
  @sequence_number
end

#session_idObject

Public: Get/Set the SessionID of the message

Returns a String


35
36
37
# File 'lib/azure/service_bus/brokered_message.rb', line 35

def session_id
  @session_id
end

#time_to_liveObject

Public: Get/Set the TimeToLive for the message

Returns an Integer


81
82
83
# File 'lib/azure/service_bus/brokered_message.rb', line 81

def time_to_live
  @time_to_live
end

#toObject

Public: Get/Set the To field for the message

Returns a String


86
87
88
# File 'lib/azure/service_bus/brokered_message.rb', line 86

def to
  @to
end