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

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

Overview

The information about a new queue.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateQueueDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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.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.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.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']

  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.capabilities = attributes[:'capabilities'] if attributes[:'capabilities']

  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']
end

Instance Attribute Details

#capabilities ⇒ Array<OCI::Queue::Models::CapabilityDetails>

The capability to add on the queue

Returns:



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

def capabilities
  @capabilities
end

#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) 


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

def channel_consumption_limit
  @channel_consumption_limit
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/queue/models/create_queue_details.rb', line 17

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) 


41
42
43
 
# File 'lib/oci/queue/models/create_queue_details.rb', line 41

def custom_encryption_key_id
  @custom_encryption_key_id
end

#dead_letter_queue_delivery_count ⇒ Integer

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) 


37
38
39
 
# File 'lib/oci/queue/models/create_queue_details.rb', line 37

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>>) 


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The user-friendly name of the queue.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/queue/models/create_queue_details.rb', line 13

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>) 


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

def freeform_tags
  @freeform_tags
end

#retention_in_seconds ⇒ Integer

The retention period of messages in the queue, in seconds.

Returns:

  • (Integer) 


21
22
23
 
# File 'lib/oci/queue/models/create_queue_details.rb', line 21

def retention_in_seconds
  @retention_in_seconds
end

#timeout_in_seconds ⇒ Integer

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

Returns:

  • (Integer) 


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

def timeout_in_seconds
  @timeout_in_seconds
end

#visibility_in_seconds ⇒ Integer

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

Returns:

  • (Integer) 


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

def visibility_in_seconds
  @visibility_in_seconds
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/queue/models/create_queue_details.rb', line 60

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'retention_in_seconds': :'retentionInSeconds',
    'visibility_in_seconds': :'visibilityInSeconds',
    'timeout_in_seconds': :'timeoutInSeconds',
    'channel_consumption_limit': :'channelConsumptionLimit',
    'dead_letter_queue_delivery_count': :'deadLetterQueueDeliveryCount',
    'custom_encryption_key_id': :'customEncryptionKeyId',
    'capabilities': :'capabilities',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/queue/models/create_queue_details.rb', line 79

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'compartment_id': :'String',
    'retention_in_seconds': :'Integer',
    'visibility_in_seconds': :'Integer',
    'timeout_in_seconds': :'Integer',
    'channel_consumption_limit': :'Integer',
    'dead_letter_queue_delivery_count': :'Integer',
    'custom_encryption_key_id': :'String',
    'capabilities': :'Array<OCI::Queue::Models::CapabilityDetails>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/queue/models/create_queue_details.rb', line 190

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

  self.class == other.class &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    retention_in_seconds == other.retention_in_seconds &&
    visibility_in_seconds == other.visibility_in_seconds &&
    timeout_in_seconds == other.timeout_in_seconds &&
    channel_consumption_limit == other.channel_consumption_limit &&
    dead_letter_queue_delivery_count == other.dead_letter_queue_delivery_count &&
    custom_encryption_key_id == other.custom_encryption_key_id &&
    capabilities == other.capabilities &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/queue/models/create_queue_details.rb', line 230

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


210
211
212
 
# File 'lib/oci/queue/models/create_queue_details.rb', line 210

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



219
220
221
 
# File 'lib/oci/queue/models/create_queue_details.rb', line 219

def hash
  [display_name, compartment_id, retention_in_seconds, visibility_in_seconds, timeout_in_seconds, channel_consumption_limit, dead_letter_queue_delivery_count, custom_encryption_key_id, capabilities, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



263
264
265
266
267
268
269
270
271
272
 
# File 'lib/oci/queue/models/create_queue_details.rb', line 263

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



257
258
259
 
# File 'lib/oci/queue/models/create_queue_details.rb', line 257

def to_s
  to_hash.to_s
end