Class: OCI::Queue::Models::Queue

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/queue/models/queue.rb

Overview

A detailed representation of a queue and its configuration.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Queue

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :messages_endpoint (String) —

    The value to assign to the #messages_endpoint property

  • :retention_in_seconds (Integer) —

    The value to assign to the #retention_in_seconds property

  • :visibility_in_seconds (Integer) —

    The value to assign to the #visibility_in_seconds property

  • :timeout_in_seconds (Integer) —

    The value to assign to the #timeout_in_seconds property

  • :dead_letter_queue_delivery_count (Integer) —

    The value to assign to the #dead_letter_queue_delivery_count property

  • :custom_encryption_key_id (String) —

    The value to assign to the #custom_encryption_key_id property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property

  • :channel_consumption_limit (Integer) —

    The value to assign to the #channel_consumption_limit property



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
 
# File 'lib/oci/queue/models/queue.rb', line 175

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

  raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated')

  self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

  raise 'You cannot provide both :lifecycleDetails and :lifecycle_details' if attributes.key?(:'lifecycleDetails') && attributes.key?(:'lifecycle_details')

  self.lifecycle_details = attributes[:'lifecycle_details'] if attributes[:'lifecycle_details']

  self.messages_endpoint = attributes[:'messagesEndpoint'] if attributes[:'messagesEndpoint']

  raise 'You cannot provide both :messagesEndpoint and :messages_endpoint' if attributes.key?(:'messagesEndpoint') && attributes.key?(:'messages_endpoint')

  self.messages_endpoint = attributes[:'messages_endpoint'] if attributes[:'messages_endpoint']

  self.retention_in_seconds = attributes[:'retentionInSeconds'] if attributes[:'retentionInSeconds']

  raise 'You cannot provide both :retentionInSeconds and :retention_in_seconds' if attributes.key?(:'retentionInSeconds') && attributes.key?(:'retention_in_seconds')

  self.retention_in_seconds = attributes[:'retention_in_seconds'] if attributes[:'retention_in_seconds']

  self.visibility_in_seconds = attributes[:'visibilityInSeconds'] if attributes[:'visibilityInSeconds']

  raise 'You cannot provide both :visibilityInSeconds and :visibility_in_seconds' if attributes.key?(:'visibilityInSeconds') && attributes.key?(:'visibility_in_seconds')

  self.visibility_in_seconds = attributes[:'visibility_in_seconds'] if attributes[:'visibility_in_seconds']

  self.timeout_in_seconds = attributes[:'timeoutInSeconds'] if attributes[:'timeoutInSeconds']

  raise 'You cannot provide both :timeoutInSeconds and :timeout_in_seconds' if attributes.key?(:'timeoutInSeconds') && attributes.key?(:'timeout_in_seconds')

  self.timeout_in_seconds = attributes[:'timeout_in_seconds'] if attributes[:'timeout_in_seconds']

  self.dead_letter_queue_delivery_count = attributes[:'deadLetterQueueDeliveryCount'] if attributes[:'deadLetterQueueDeliveryCount']

  raise 'You cannot provide both :deadLetterQueueDeliveryCount and :dead_letter_queue_delivery_count' if attributes.key?(:'deadLetterQueueDeliveryCount') && attributes.key?(:'dead_letter_queue_delivery_count')

  self.dead_letter_queue_delivery_count = attributes[:'dead_letter_queue_delivery_count'] if attributes[:'dead_letter_queue_delivery_count']

  self.custom_encryption_key_id = attributes[:'customEncryptionKeyId'] if attributes[:'customEncryptionKeyId']

  raise 'You cannot provide both :customEncryptionKeyId and :custom_encryption_key_id' if attributes.key?(:'customEncryptionKeyId') && attributes.key?(:'custom_encryption_key_id')

  self.custom_encryption_key_id = attributes[:'custom_encryption_key_id'] if attributes[:'custom_encryption_key_id']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

  raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags')

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']

  self.channel_consumption_limit = attributes[:'channelConsumptionLimit'] if attributes[:'channelConsumptionLimit']

  raise 'You cannot provide both :channelConsumptionLimit and :channel_consumption_limit' if attributes.key?(:'channelConsumptionLimit') && attributes.key?(:'channel_consumption_limit')

  self.channel_consumption_limit = attributes[:'channel_consumption_limit'] if attributes[:'channel_consumption_limit']
end

Instance Attribute Details

#channel_consumption_limit ⇒ Integer

The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.

Returns:

  • (Integer) 


100
101
102
 
# File 'lib/oci/queue/models/queue.rb', line 100

def channel_consumption_limit
  @channel_consumption_limit
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the queue.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/queue/models/queue.rb', line 32

def compartment_id
  @compartment_id
end

#custom_encryption_key_id ⇒ String

The OCID of the custom encryption key to be used to encrypt messages content.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/queue/models/queue.rb', line 78

def custom_encryption_key_id
  @custom_encryption_key_id
end

#dead_letter_queue_delivery_count ⇒ Integer

[Required] The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.

Returns:

  • (Integer) 


74
75
76
 
# File 'lib/oci/queue/models/queue.rb', line 74

def dead_letter_queue_delivery_count
  @dead_letter_queue_delivery_count
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


90
91
92
 
# File 'lib/oci/queue/models/queue.rb', line 90

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/queue/models/queue.rb', line 28

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


84
85
86
 
# File 'lib/oci/queue/models/queue.rb', line 84

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] A unique identifier for the queue that is immutable on creation.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/queue/models/queue.rb', line 24

def id
  @id
end

#lifecycle_details ⇒ String

Any additional details about the current state of the queue.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/queue/models/queue.rb', line 54

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the queue.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/queue/models/queue.rb', line 50

def lifecycle_state
  @lifecycle_state
end

#messages_endpoint ⇒ String

[Required] The endpoint to use to consume or publish messages in the queue.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/queue/models/queue.rb', line 58

def messages_endpoint
  @messages_endpoint
end

#retention_in_seconds ⇒ Integer

[Required] The retention period of the messages in the queue, in seconds.

Returns:

  • (Integer) 


62
63
64
 
# File 'lib/oci/queue/models/queue.rb', line 62

def retention_in_seconds
  @retention_in_seconds
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


96
97
98
 
# File 'lib/oci/queue/models/queue.rb', line 96

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time that the queue was created, expressed in RFC 3339 timestamp format.

Example: 2018-04-20T00:00:07.405Z

Returns:

  • (DateTime) 


39
40
41
 
# File 'lib/oci/queue/models/queue.rb', line 39

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time that the queue was updated, expressed in RFC 3339 timestamp format.

Example: 2018-04-20T00:00:07.405Z

Returns:

  • (DateTime) 


46
47
48
 
# File 'lib/oci/queue/models/queue.rb', line 46

def time_updated
  @time_updated
end

#timeout_in_seconds ⇒ Integer

[Required] The default polling timeout of the messages in the queue, in seconds.

Returns:

  • (Integer) 


70
71
72
 
# File 'lib/oci/queue/models/queue.rb', line 70

def timeout_in_seconds
  @timeout_in_seconds
end

#visibility_in_seconds ⇒ Integer

[Required] The default visibility timeout of the messages consumed from the queue, in seconds.

Returns:

  • (Integer) 


66
67
68
 
# File 'lib/oci/queue/models/queue.rb', line 66

def visibility_in_seconds
  @visibility_in_seconds
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/queue/models/queue.rb', line 103

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'messages_endpoint': :'messagesEndpoint',
    'retention_in_seconds': :'retentionInSeconds',
    'visibility_in_seconds': :'visibilityInSeconds',
    'timeout_in_seconds': :'timeoutInSeconds',
    'dead_letter_queue_delivery_count': :'deadLetterQueueDeliveryCount',
    'custom_encryption_key_id': :'customEncryptionKeyId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'channel_consumption_limit': :'channelConsumptionLimit'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/queue/models/queue.rb', line 128

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'messages_endpoint': :'String',
    'retention_in_seconds': :'Integer',
    'visibility_in_seconds': :'Integer',
    'timeout_in_seconds': :'Integer',
    'dead_letter_queue_delivery_count': :'Integer',
    'custom_encryption_key_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'channel_consumption_limit': :'Integer'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/oci/queue/models/queue.rb', line 300

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    messages_endpoint == other.messages_endpoint &&
    retention_in_seconds == other.retention_in_seconds &&
    visibility_in_seconds == other.visibility_in_seconds &&
    timeout_in_seconds == other.timeout_in_seconds &&
    dead_letter_queue_delivery_count == other.dead_letter_queue_delivery_count &&
    custom_encryption_key_id == other.custom_encryption_key_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    channel_consumption_limit == other.channel_consumption_limit
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/oci/queue/models/queue.rb', line 346

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


326
327
328
 
# File 'lib/oci/queue/models/queue.rb', line 326

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



335
336
337
 
# File 'lib/oci/queue/models/queue.rb', line 335

def hash
  [id, display_name, compartment_id, time_created, time_updated, lifecycle_state, lifecycle_details, messages_endpoint, retention_in_seconds, visibility_in_seconds, timeout_in_seconds, dead_letter_queue_delivery_count, custom_encryption_key_id, freeform_tags, defined_tags, system_tags, channel_consumption_limit].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



379
380
381
382
383
384
385
386
387
388
 
# File 'lib/oci/queue/models/queue.rb', line 379

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



373
374
375
 
# File 'lib/oci/queue/models/queue.rb', line 373

def to_s
  to_hash.to_s
end