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

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

Overview

Object that represents metadata for message.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MessageMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :channel_id (String) —

    The value to assign to the #channel_id property

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

    The value to assign to the #custom_properties property



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/queue/models/message_metadata.rb', line 47

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

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

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

  self.custom_properties = attributes[:'customProperties'] if attributes[:'customProperties']

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

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

Instance Attribute Details

#channel_id ⇒ String

[Required] The channel ID which specifies the channel to publish or retrieve messages.

Returns:

  • (String) 


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

def channel_id
  @channel_id
end

#custom_properties ⇒ Hash<String, String>

Additional message properties

Returns:

  • (Hash<String, String>) 


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

def custom_properties
  @custom_properties
end

Class Method Details

.attribute_map ⇒ Object

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



20
21
22
23
24
25
26
27
 
# File 'lib/oci/queue/models/message_metadata.rb', line 20

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'channel_id': :'channelId',
    'custom_properties': :'customProperties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



30
31
32
33
34
35
36
37
 
# File 'lib/oci/queue/models/message_metadata.rb', line 30

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'channel_id': :'String',
    'custom_properties': :'Hash<String, 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



73
74
75
76
77
78
79
 
# File 'lib/oci/queue/models/message_metadata.rb', line 73

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

  self.class == other.class &&
    channel_id == other.channel_id &&
    custom_properties == other.custom_properties
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



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

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



93
94
95
 
# File 'lib/oci/queue/models/message_metadata.rb', line 93

def hash
  [channel_id, custom_properties].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



137
138
139
140
141
142
143
144
145
146
 
# File 'lib/oci/queue/models/message_metadata.rb', line 137

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



131
132
133
 
# File 'lib/oci/queue/models/message_metadata.rb', line 131

def to_s
  to_hash.to_s
end