Class: OCI::AnnouncementsService::Models::AnnouncementUserStatusDetails

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

Overview

An announcement's status regarding whether it has been acknowledged by a user.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnnouncementUserStatusDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/announcements_service/models/announcement_user_status_details.rb', line 57

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

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

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

  self.user_id = attributes[:'userId'] if attributes[:'userId']

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

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

  self.time_acknowledged = attributes[:'timeAcknowledged'] if attributes[:'timeAcknowledged']

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

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

Instance Attribute Details

#time_acknowledged ⇒ DateTime

The date and time the announcement was acknowledged, expressed in RFC 3339 timestamp format. Example: 2019-01-01T17:43:01.389+0000

Returns:

  • (DateTime) 


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

def time_acknowledged
  @time_acknowledged
end

#user_id ⇒ String

[Required] The OCID of the user that this status is associated with.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/announcements_service/models/announcement_user_status_details.rb', line 18

def user_id
  @user_id
end

#user_status_announcement_id ⇒ String

[Required] The OCID of the announcement that this status is associated with.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/announcements_service/models/announcement_user_status_details.rb', line 14

def user_status_announcement_id
  @user_status_announcement_id
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
35
 
# File 'lib/oci/announcements_service/models/announcement_user_status_details.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'user_status_announcement_id': :'userStatusAnnouncementId',
    'user_id': :'userId',
    'time_acknowledged': :'timeAcknowledged'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/announcements_service/models/announcement_user_status_details.rb', line 38

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'user_status_announcement_id': :'String',
    'user_id': :'String',
    'time_acknowledged': :'DateTime'
    # 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



89
90
91
92
93
94
95
96
 
# File 'lib/oci/announcements_service/models/announcement_user_status_details.rb', line 89

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

  self.class == other.class &&
    user_status_announcement_id == other.user_status_announcement_id &&
    user_id == other.user_id &&
    time_acknowledged == other.time_acknowledged
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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/announcements_service/models/announcement_user_status_details.rb', line 121

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


101
102
103
 
# File 'lib/oci/announcements_service/models/announcement_user_status_details.rb', line 101

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



110
111
112
 
# File 'lib/oci/announcements_service/models/announcement_user_status_details.rb', line 110

def hash
  [user_status_announcement_id, user_id, time_acknowledged].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/announcements_service/models/announcement_user_status_details.rb', line 154

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



148
149
150
 
# File 'lib/oci/announcements_service/models/announcement_user_status_details.rb', line 148

def to_s
  to_hash.to_s
end