Class: Azure::ServiceBus::Mgmt::V2017_04_01::Models::SBSubscription

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

Overview

Description of subscription 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

subscription.

Returns:

  • (DateTime) —

    Last time there was a receive request to this



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

def accessed_at
  @accessed_at
end

#auto_delete_on_idle ⇒ Duration

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

Returns:

  • (Duration) —

    ISO 8061 timeSpan idle interval after which the



73
74
75
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbsubscription.rb', line 73

def auto_delete_on_idle
  @auto_delete_on_idle
end

#count_details ⇒ MessageCountDetails

Returns Message count details.

Returns:



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

def count_details
  @count_details
end

#created_at ⇒ DateTime

Returns Exact time the message was created.

Returns:

  • (DateTime) —

    Exact time the message was created.



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

def created_at
  @created_at
end

#dead_lettering_on_filter_evaluation_exceptions ⇒ Boolean

letter support on filter evaluation exceptions.

Returns:

  • (Boolean) —

    Value that indicates whether a subscription has dead



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

def dead_lettering_on_filter_evaluation_exceptions
  @dead_lettering_on_filter_evaluation_exceptions
end

#dead_lettering_on_message_expiration ⇒ Boolean

letter support when a message expires.

Returns:

  • (Boolean) —

    Value that indicates whether a subscription has dead



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

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 8061 Default message timespan to live value.



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

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



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

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



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

def enable_batched_operations
  @enable_batched_operations
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



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

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



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

def forward_to
  @forward_to
end

#lock_duration ⇒ Duration

subscription. The default value is 1 minute.

Returns:

  • (Duration) —

    ISO 8061 lock duration timespan for the



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

def lock_duration
  @lock_duration
end

#max_delivery_count ⇒ Integer

Returns Number of maximum deliveries.

Returns:

  • (Integer) —

    Number of maximum deliveries.



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

def max_delivery_count
  @max_delivery_count
end

#message_count ⇒ Integer

Returns Number of messages.

Returns:

  • (Integer) —

    Number of messages.



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

def message_count
  @message_count
end

#requires_session ⇒ Boolean

concept of sessions.

Returns:

  • (Boolean) —

    Value indicating if a subscription supports the



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

def requires_session
  @requires_session
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



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

def status
  @status
end

#updated_at ⇒ DateTime

Returns The exact time the message was updated.

Returns:

  • (DateTime) —

    The exact time the message was updated.



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

def updated_at
  @updated_at
end

Class Method Details

.mapper ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'lib/2017-04-01/generated/azure_mgmt_service_bus/models/sbsubscription.rb', line 86

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'SBSubscription',
    type: {
      name: 'Composite',
      class_name: 'SBSubscription',
      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'
          }
        },
        message_count: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.messageCount',
          type: {
            name: 'Number'
          }
        },
        created_at: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.createdAt',
          type: {
            name: 'DateTime'
          }
        },
        accessed_at: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.accessedAt',
          type: {
            name: 'DateTime'
          }
        },
        updated_at: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.updatedAt',
          type: {
            name: 'DateTime'
          }
        },
        count_details: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.countDetails',
          type: {
            name: 'Composite',
            class_name: 'MessageCountDetails'
          }
        },
        lock_duration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.lockDuration',
          type: {
            name: 'TimeSpan'
          }
        },
        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_filter_evaluation_exceptions: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.deadLetteringOnFilterEvaluationExceptions',
          type: {
            name: 'Boolean'
          }
        },
        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'
          }
        },
        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