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

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

Overview

The information about a new consumer group.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateConsumerGroupDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :filter (String) —

    The value to assign to the #filter property

  • :queue_id (String) —

    The value to assign to the #queue_id property

  • :is_enabled (BOOLEAN) —

    The value to assign to the #is_enabled property

  • :dead_letter_queue_delivery_count (Integer) —

    The value to assign to the #dead_letter_queue_delivery_count 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



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

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

  self.queue_id = attributes[:'queueId'] if attributes[:'queueId']

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

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

  self.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?
  self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil?
  self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') && !attributes.key?(:'is_enabled') # rubocop:disable Style/StringLiterals

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

#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. If the value isn't specified, it will be using the value defined at the queue level.

Returns:

  • (Integer) 


34
35
36
 
# File 'lib/oci/queue/models/create_consumer_group_details.rb', line 34

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The user-friendly name of the consumer group.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#filter ⇒ String

The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group.

Returns:

  • (String) 


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

def filter
  @filter
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>) 


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

def freeform_tags
  @freeform_tags
end

#is_enabled ⇒ BOOLEAN

Used to enable or disable the consumer group. An enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.

Returns:

  • (BOOLEAN) 


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

def is_enabled
  @is_enabled
end

#queue_id ⇒ String

[Required] The OCID of the associated queue.

Returns:

  • (String) 


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

def queue_id
  @queue_id
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/queue/models/create_consumer_group_details.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'filter': :'filter',
    'queue_id': :'queueId',
    'is_enabled': :'isEnabled',
    'dead_letter_queue_delivery_count': :'deadLetterQueueDeliveryCount',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'filter': :'String',
    'queue_id': :'String',
    'is_enabled': :'BOOLEAN',
    'dead_letter_queue_delivery_count': :'Integer',
    '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



145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/queue/models/create_consumer_group_details.rb', line 145

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

  self.class == other.class &&
    display_name == other.display_name &&
    filter == other.filter &&
    queue_id == other.queue_id &&
    is_enabled == other.is_enabled &&
    dead_letter_queue_delivery_count == other.dead_letter_queue_delivery_count &&
    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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/queue/models/create_consumer_group_details.rb', line 181

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


161
162
163
 
# File 'lib/oci/queue/models/create_consumer_group_details.rb', line 161

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



170
171
172
 
# File 'lib/oci/queue/models/create_consumer_group_details.rb', line 170

def hash
  [display_name, filter, queue_id, is_enabled, dead_letter_queue_delivery_count, 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



214
215
216
217
218
219
220
221
222
223
 
# File 'lib/oci/queue/models/create_consumer_group_details.rb', line 214

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



208
209
210
 
# File 'lib/oci/queue/models/create_consumer_group_details.rb', line 208

def to_s
  to_hash.to_s
end