Class: Azure::ServiceBus::Mgmt::V2017_04_01::Models::SBQueue

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb

Overview

Description of queue Resource.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #name, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#accessed_at ⇒ DateTime

was a receive request to this queue.

Returns:

  • (DateTime) —

    Last time a message was sent, or the last time there



26
27
28
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 26

def accessed_at
  @accessed_at
end

#auto_delete_on_idle ⇒ Duration

queue is automatically deleted. The minimum duration is 5 minutes.

Returns:

  • (Duration) —

    ISO 8061 timeSpan idle interval after which the



84
85
86
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 84

def auto_delete_on_idle
  @auto_delete_on_idle
end

#count_details ⇒ MessageCountDetails

Returns Message Count Details.

Returns:



16
17
18
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 16

def count_details
  @count_details
end

#created_at ⇒ DateTime

Returns The exact time the message was created.

Returns:

  • (DateTime) —

    The exact time the message was created.



19
20
21
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 19

def created_at
  @created_at
end

#dead_lettering_on_message_expiration ⇒ Boolean

letter support when a message expires.

Returns:

  • (Boolean) —

    A value that indicates whether this queue has dead



60
61
62
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 60

def dead_lettering_on_message_expiration
  @dead_lettering_on_message_expiration
end

#default_message_time_to_live ⇒ Duration

This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

Returns:

  • (Duration) —

    ISO 8601 default message timespan to live value.



56
57
58
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 56

def default_message_time_to_live
  @default_message_time_to_live
end

#duplicate_detection_history_time_window ⇒ Duration

duration of the duplicate detection history. The default value is 10 minutes.

Returns:

  • (Duration) —

    ISO 8601 timeSpan structure that defines the



65
66
67
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 65

def duplicate_detection_history_time_window
  @duplicate_detection_history_time_window
end

#enable_batched_operations ⇒ Boolean

operations are enabled.

Returns:

  • (Boolean) —

    Value that indicates whether server-side batched



80
81
82
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 80

def enable_batched_operations
  @enable_batched_operations
end

#enable_express ⇒ Boolean

enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.

Returns:

  • (Boolean) —

    A value that indicates whether Express Entities are



93
94
95
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 93

def enable_express
  @enable_express
end

#enable_partitioning ⇒ Boolean

partitioned across multiple message brokers.

Returns:

  • (Boolean) —

    A value that indicates whether the queue is to be



88
89
90
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 88

def enable_partitioning
  @enable_partitioning
end

#forward_dead_lettered_messages_to ⇒ String

Returns Queue/Topic name to forward the Dead Letter message.

Returns:

  • (String) —

    Queue/Topic name to forward the Dead Letter message



99
100
101
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 99

def forward_dead_lettered_messages_to
  @forward_dead_lettered_messages_to
end

#forward_to ⇒ String

Returns Queue/Topic name to forward the messages.

Returns:

  • (String) —

    Queue/Topic name to forward the messages



96
97
98
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 96

def forward_to
  @forward_to
end

#lock_duration ⇒ Duration

the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.

Returns:

  • (Duration) —

    ISO 8601 timespan duration of a peek-lock; that is,



38
39
40
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 38

def lock_duration
  @lock_duration
end

#max_delivery_count ⇒ Integer

automatically deadlettered after this number of deliveries. default value is 10.

Returns:

  • (Integer) —

    The maximum delivery count. A message is



70
71
72
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 70

def max_delivery_count
  @max_delivery_count
end

#max_size_in_megabytes ⇒ Integer

the size of memory allocated for the queue. Default is 1024.

Returns:

  • (Integer) —

    The maximum size of the queue in megabytes, which is



42
43
44
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 42

def max_size_in_megabytes
  @max_size_in_megabytes
end

#message_count ⇒ Integer

Returns The number of messages in the queue.

Returns:

  • (Integer) —

    The number of messages in the queue.



32
33
34
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 32

def message_count
  @message_count
end

#requires_duplicate_detection ⇒ Boolean

detection.

Returns:

  • (Boolean) —

    A value indicating if this queue requires duplicate



46
47
48
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 46

def requires_duplicate_detection
  @requires_duplicate_detection
end

#requires_session ⇒ Boolean

concept of sessions.

Returns:

  • (Boolean) —

    A value that indicates whether the queue supports the



50
51
52
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 50

def requires_session
  @requires_session
end

#size_in_bytes ⇒ Integer

Returns The size of the queue, in bytes.

Returns:

  • (Integer) —

    The size of the queue, in bytes.



29
30
31
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 29

def size_in_bytes
  @size_in_bytes
end

#status ⇒ EntityStatus

a messaging entity. Possible values include: ‘Active’, ‘Disabled’, ‘Restoring’, ‘SendDisabled’, ‘ReceiveDisabled’, ‘Creating’, ‘Deleting’, ‘Renaming’, ‘Unknown’

Returns:

  • (EntityStatus) —

    Enumerates the possible values for the status of



76
77
78
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 76

def status
  @status
end

#updated_at ⇒ DateTime

Returns The exact time the message was updated.

Returns:

  • (DateTime) —

    The exact time the message was updated.



22
23
24
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 22

def updated_at
  @updated_at
end

Class Method Details

.mapper ⇒ Object

Mapper for SBQueue class as Ruby Hash. This will be used for serialization/deserialization.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbqueue.rb', line 106

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'SBQueue',
    type: {
      name: 'Composite',
      class_name: 'SBQueue',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        count_details: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.countDetails',
          type: {
            name: 'Composite',
            class_name: 'MessageCountDetails'
          }
        },
        created_at: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.createdAt',
          type: {
            name: 'DateTime'
          }
        },
        updated_at: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.updatedAt',
          type: {
            name: 'DateTime'
          }
        },
        accessed_at: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.accessedAt',
          type: {
            name: 'DateTime'
          }
        },
        size_in_bytes: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.sizeInBytes',
          type: {
            name: 'Number'
          }
        },
        message_count: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.messageCount',
          type: {
            name: 'Number'
          }
        },
        lock_duration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.lockDuration',
          type: {
            name: 'TimeSpan'
          }
        },
        max_size_in_megabytes: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.maxSizeInMegabytes',
          type: {
            name: 'Number'
          }
        },
        requires_duplicate_detection: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.requiresDuplicateDetection',
          type: {
            name: 'Boolean'
          }
        },
        requires_session: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.requiresSession',
          type: {
            name: 'Boolean'
          }
        },
        default_message_time_to_live: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.defaultMessageTimeToLive',
          type: {
            name: 'TimeSpan'
          }
        },
        dead_lettering_on_message_expiration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.deadLetteringOnMessageExpiration',
          type: {
            name: 'Boolean'
          }
        },
        duplicate_detection_history_time_window: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.duplicateDetectionHistoryTimeWindow',
          type: {
            name: 'TimeSpan'
          }
        },
        max_delivery_count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.maxDeliveryCount',
          type: {
            name: 'Number'
          }
        },
        status: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.status',
          type: {
            name: 'Enum',
            module: 'EntityStatus'
          }
        },
        enable_batched_operations: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableBatchedOperations',
          type: {
            name: 'Boolean'
          }
        },
        auto_delete_on_idle: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.autoDeleteOnIdle',
          type: {
            name: 'TimeSpan'
          }
        },
        enable_partitioning: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enablePartitioning',
          type: {
            name: 'Boolean'
          }
        },
        enable_express: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableExpress',
          type: {
            name: 'Boolean'
          }
        },
        forward_to: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.forwardTo',
          type: {
            name: 'String'
          }
        },
        forward_dead_lettered_messages_to: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.forwardDeadLetteredMessagesTo',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end