Class: Azure::ServiceBus::Mgmt::V2015_08_01::Models::TopicResource

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb

Overview

Description of topic resource.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #location, #name, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#accessed_at ⇒ DateTime

received, for this topic.

Returns:

  • (DateTime) —

    Last time the message was sent, or a request was



17
18
19
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 17

def accessed_at
  @accessed_at
end

#auto_delete_on_idle ⇒ String

automatically deleted. The minimum duration is 5 minutes.

Returns:

  • (String) —

    TimeSpan idle interval after which the topic is



21
22
23
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 21

def auto_delete_on_idle
  @auto_delete_on_idle
end

#count_details ⇒ MessageCountDetails

Returns:



32
33
34
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 32

def count_details
  @count_details
end

#created_at ⇒ DateTime

Returns Exact time the message was created.

Returns:

  • (DateTime) —

    Exact time the message was created.



29
30
31
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 29

def created_at
  @created_at
end

#default_message_time_to_live ⇒ String

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:

  • (String) —

    Default message time to live value. This is the



38
39
40
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 38

def default_message_time_to_live
  @default_message_time_to_live
end

#duplicate_detection_history_time_window ⇒ String

duplicate detection history. The default value is 10 minutes.

Returns:

  • (String) —

    TimeSpan structure that defines the duration of the



42
43
44
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 42

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



46
47
48
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 46

def enable_batched_operations
  @enable_batched_operations
end

#enable_express ⇒ Boolean

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

Returns:

  • (Boolean) —

    Value that indicates whether Express Entities are



51
52
53
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 51

def enable_express
  @enable_express
end

#enable_partitioning ⇒ Boolean

partitioned across multiple message brokers is enabled.

Returns:

  • (Boolean) —

    Value that indicates whether the topic to be



55
56
57
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 55

def enable_partitioning
  @enable_partitioning
end

#entity_availability_status ⇒ EntityAvailabilityStatus

topic. Possible values include: ‘Available’, ‘Limited’, ‘Renaming’, ‘Restoring’, ‘Unknown’

Returns:



26
27
28
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 26

def entity_availability_status
  @entity_availability_status
end

#filtering_messages_before_publishing ⇒ Boolean

publishing.

Returns:

  • (Boolean) —

    Whether messages should be filtered before



59
60
61
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 59

def filtering_messages_before_publishing
  @filtering_messages_before_publishing
end

#is_anonymous_accessible ⇒ Boolean

accessible anonymously.

Returns:

  • (Boolean) —

    Value that indicates whether the message is



63
64
65
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 63

def is_anonymous_accessible
  @is_anonymous_accessible
end

#is_express ⇒ Boolean

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 66

def is_express
  @is_express
end

#max_size_in_megabytes ⇒ Integer

size of the memory allocated for the topic.

Returns:

  • (Integer) —

    Maximum size of the topic in megabytes, which is the



70
71
72
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 70

def max_size_in_megabytes
  @max_size_in_megabytes
end

#requires_duplicate_detection ⇒ Boolean

detection.

Returns:

  • (Boolean) —

    Value indicating if this topic requires duplicate



74
75
76
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 74

def requires_duplicate_detection
  @requires_duplicate_detection
end

#size_in_bytes ⇒ Integer

Returns Size of the topic, in bytes.

Returns:

  • (Integer) —

    Size of the topic, in bytes.



77
78
79
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 77

def size_in_bytes
  @size_in_bytes
end

#status ⇒ EntityStatus

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

Returns:

  • (EntityStatus) —

    Enumerates the possible values for the status of



83
84
85
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 83

def status
  @status
end

#subscription_count ⇒ Integer

Returns Number of subscriptions.

Returns:

  • (Integer) —

    Number of subscriptions.



86
87
88
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 86

def subscription_count
  @subscription_count
end

#support_ordering ⇒ Boolean

ordering.

Returns:

  • (Boolean) —

    Value that indicates whether the topic supports



90
91
92
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 90

def support_ordering
  @support_ordering
end

#updated_at ⇒ DateTime

Returns The exact time the message was updated.

Returns:

  • (DateTime) —

    The exact time the message was updated.



93
94
95
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 93

def updated_at
  @updated_at
end

Class Method Details

.mapper ⇒ Object

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



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
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
 
# File 'lib/2015-08-01/generated/azure_mgmt_service_bus/models/topic_resource.rb', line 100

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'TopicResource',
    type: {
      name: 'Composite',
      class_name: 'TopicResource',
      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'
          }
        },
        location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        accessed_at: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.accessedAt',
          type: {
            name: 'DateTime'
          }
        },
        auto_delete_on_idle: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.autoDeleteOnIdle',
          type: {
            name: 'String'
          }
        },
        entity_availability_status: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.entityAvailabilityStatus',
          type: {
            name: 'Enum',
            module: 'EntityAvailabilityStatus'
          }
        },
        created_at: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.createdAt',
          type: {
            name: 'DateTime'
          }
        },
        count_details: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.countDetails',
          type: {
            name: 'Composite',
            class_name: 'MessageCountDetails'
          }
        },
        default_message_time_to_live: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.defaultMessageTimeToLive',
          type: {
            name: 'String'
          }
        },
        duplicate_detection_history_time_window: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.duplicateDetectionHistoryTimeWindow',
          type: {
            name: 'String'
          }
        },
        enable_batched_operations: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableBatchedOperations',
          type: {
            name: 'Boolean'
          }
        },
        enable_express: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableExpress',
          type: {
            name: 'Boolean'
          }
        },
        enable_partitioning: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enablePartitioning',
          type: {
            name: 'Boolean'
          }
        },
        filtering_messages_before_publishing: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.filteringMessagesBeforePublishing',
          type: {
            name: 'Boolean'
          }
        },
        is_anonymous_accessible: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.isAnonymousAccessible',
          type: {
            name: 'Boolean'
          }
        },
        is_express: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.isExpress',
          type: {
            name: 'Boolean'
          }
        },
        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'
          }
        },
        size_in_bytes: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.sizeInBytes',
          type: {
            name: 'Number'
          }
        },
        status: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.status',
          type: {
            name: 'Enum',
            module: 'EntityStatus'
          }
        },
        subscription_count: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.subscriptionCount',
          type: {
            name: 'Number'
          }
        },
        support_ordering: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.supportOrdering',
          type: {
            name: 'Boolean'
          }
        },
        updated_at: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.updatedAt',
          type: {
            name: 'DateTime'
          }
        }
      }
    }
  }
end