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

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

Overview

Purge parameters.

Constant Summary collapse

PURGE_TYPE_ENUM = 
[
  PURGE_TYPE_NORMAL = 'NORMAL'.freeze,
  PURGE_TYPE_DLQ = 'DLQ'.freeze,
  PURGE_TYPE_BOTH = 'BOTH'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PurgeQueueDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :purge_type (String) —

    The value to assign to the #purge_type property

  • :channel_ids (Array<String>) —

    The value to assign to the #channel_ids property



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

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

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

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

  self.channel_ids = attributes[:'channelIds'] if attributes[:'channelIds']

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

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

Instance Attribute Details

#channel_ids ⇒ Array<String>

Optional parameter to specify the destination of purge operation. If the channel ID is specified, the purge operation will delete all the messages in the specific channels. If the channel ID is not specified, the purge operation will delete all the messages in the queue and in the child channels.

Returns:

  • (Array<String>) 


30
31
32
 
# File 'lib/oci/queue/models/purge_queue_details.rb', line 30

def channel_ids
  @channel_ids
end

#purge_type ⇒ String

[Required] Type of the purge to perform: - NORMAL - purge only the normal queue - DLQ - purge only the dead letter queue - BOTH - purge both the normal queue and the dead letter queue

Returns:

  • (String) 


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

def purge_type
  @purge_type
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
 
# File 'lib/oci/queue/models/purge_queue_details.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'purge_type': :'purgeType',
    'channel_ids': :'channelIds'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
 
# File 'lib/oci/queue/models/purge_queue_details.rb', line 43

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'purge_type': :'String',
    'channel_ids': :'Array<String>'
    # 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



94
95
96
97
98
99
100
 
# File 'lib/oci/queue/models/purge_queue_details.rb', line 94

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

  self.class == other.class &&
    purge_type == other.purge_type &&
    channel_ids == other.channel_ids
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



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

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


105
106
107
 
# File 'lib/oci/queue/models/purge_queue_details.rb', line 105

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



114
115
116
 
# File 'lib/oci/queue/models/purge_queue_details.rb', line 114

def hash
  [purge_type, channel_ids].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/queue/models/purge_queue_details.rb', line 158

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



152
153
154
 
# File 'lib/oci/queue/models/purge_queue_details.rb', line 152

def to_s
  to_hash.to_s
end