Class: OCI::AnnouncementsService::Models::BaseAnnouncementsPreferences

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

Overview

The object that contains the announcement email preferences configured for the tenancy (root compartment). This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BaseAnnouncementsPreferences

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String) —

    The value to assign to the #type property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :id (String) —

    The value to assign to the #id property

  • :is_unsubscribed (BOOLEAN) —

    The value to assign to the #is_unsubscribed property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :preference_type (String) —

    The value to assign to the #preference_type property

  • :preferred_time_zone (String) —

    The value to assign to the #preferred_time_zone property



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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/announcements_service/models/base_announcements_preferences.rb', line 110

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

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

  self.is_unsubscribed = attributes[:'isUnsubscribed'] unless attributes[:'isUnsubscribed'].nil?

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

  self.is_unsubscribed = attributes[:'is_unsubscribed'] unless attributes[:'is_unsubscribed'].nil?

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.preference_type = attributes[:'preferenceType'] if attributes[:'preferenceType']

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

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

  self.preferred_time_zone = attributes[:'preferredTimeZone'] if attributes[:'preferredTimeZone']
  self.preferred_time_zone = "UTC" if preferred_time_zone.nil? && !attributes.key?(:'preferredTimeZone') # rubocop:disable Style/StringLiterals

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

  self.preferred_time_zone = attributes[:'preferred_time_zone'] if attributes[:'preferred_time_zone']
  self.preferred_time_zone = "UTC" if preferred_time_zone.nil? && !attributes.key?(:'preferredTimeZone') && !attributes.key?(:'preferred_time_zone') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment for which the email preferences apply. Because announcements are specific to a tenancy, specify the tenancy by providing the root compartment OCID.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/announcements_service/models/base_announcements_preferences.rb', line 20

def compartment_id
  @compartment_id
end

#id ⇒ String

The ID of the preferences.

Returns:

  • (String) 


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

def id
  @id
end

#is_unsubscribed ⇒ BOOLEAN

A Boolean value to indicate whether the specified compartment chooses to not to receive informational announcements by email. (Manage preferences for receiving announcements by email by specifying the preferenceType attribute instead.)

Returns:

  • (BOOLEAN) 


30
31
32
 
# File 'lib/oci/announcements_service/models/base_announcements_preferences.rb', line 30

def is_unsubscribed
  @is_unsubscribed
end

#preference_type ⇒ String

The string representing the user's preference regarding receiving announcements by email.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/announcements_service/models/base_announcements_preferences.rb', line 42

def preference_type
  @preference_type
end

#preferred_time_zone ⇒ String

The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/announcements_service/models/base_announcements_preferences.rb', line 46

def preferred_time_zone
  @preferred_time_zone
end

#time_created ⇒ DateTime

When the preferences were set initially.

Returns:

  • (DateTime) 


34
35
36
 
# File 'lib/oci/announcements_service/models/base_announcements_preferences.rb', line 34

def time_created
  @time_created
end

#time_updated ⇒ DateTime

When the preferences were last updated.

Returns:

  • (DateTime) 


38
39
40
 
# File 'lib/oci/announcements_service/models/base_announcements_preferences.rb', line 38

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The entity type, which specifies either an object or a summary object for announcement email preferences.

Returns:

  • (String) 


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

def type
  @type
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
62
 
# File 'lib/oci/announcements_service/models/base_announcements_preferences.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'compartment_id': :'compartmentId',
    'id': :'id',
    'is_unsubscribed': :'isUnsubscribed',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'preference_type': :'preferenceType',
    'preferred_time_zone': :'preferredTimeZone'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/announcements_service/models/base_announcements_preferences.rb', line 85

def self.get_subtype(object_hash)
  type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::AnnouncementsService::Models::AnnouncementsPreferencesSummary' if type == 'AnnouncementsPreferencesSummary'
  return 'OCI::AnnouncementsService::Models::AnnouncementsPreferences' if type == 'AnnouncementsPreferences'

  # TODO: Log a warning when the subtype is not found.
  'OCI::AnnouncementsService::Models::BaseAnnouncementsPreferences'
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/announcements_service/models/base_announcements_preferences.rb', line 65

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'compartment_id': :'String',
    'id': :'String',
    'is_unsubscribed': :'BOOLEAN',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'preference_type': :'String',
    'preferred_time_zone': :'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



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/announcements_service/models/base_announcements_preferences.rb', line 166

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

  self.class == other.class &&
    type == other.type &&
    compartment_id == other.compartment_id &&
    id == other.id &&
    is_unsubscribed == other.is_unsubscribed &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    preference_type == other.preference_type &&
    preferred_time_zone == other.preferred_time_zone
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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/announcements_service/models/base_announcements_preferences.rb', line 203

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


183
184
185
 
# File 'lib/oci/announcements_service/models/base_announcements_preferences.rb', line 183

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



192
193
194
 
# File 'lib/oci/announcements_service/models/base_announcements_preferences.rb', line 192

def hash
  [type, compartment_id, id, is_unsubscribed, time_created, time_updated, preference_type, preferred_time_zone].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/oci/announcements_service/models/base_announcements_preferences.rb', line 236

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



230
231
232
 
# File 'lib/oci/announcements_service/models/base_announcements_preferences.rb', line 230

def to_s
  to_hash.to_s
end