Class: OCI::AnnouncementsService::Models::BaseCreateAnnouncementsPreferencesDetails
- Inherits:
-
Object
- Object
- OCI::AnnouncementsService::Models::BaseCreateAnnouncementsPreferencesDetails
- Defined in:
- lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb
Overview
The model for the parameters of 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
Direct Known Subclasses
CreateAnnouncementsPreferencesDetails, UpdateAnnouncementsPreferencesDetails
Constant Summary collapse
- PREFERENCE_TYPE_ENUM =
[ PREFERENCE_TYPE_OPT_IN_TENANT_ANNOUNCEMENTS = 'OPT_IN_TENANT_ANNOUNCEMENTS'.freeze, PREFERENCE_TYPE_OPT_IN_TENANT_AND_INFORMATIONAL_ANNOUNCEMENTS = 'OPT_IN_TENANT_AND_INFORMATIONAL_ANNOUNCEMENTS'.freeze, PREFERENCE_TYPE_OPT_OUT_ALL_ANNOUNCEMENTS = 'OPT_OUT_ALL_ANNOUNCEMENTS'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
The OCID of the compartment for which you want to manage announcement email preferences.
-
#is_unsubscribed ⇒ BOOLEAN
A Boolean value to indicate whether the specified compartment chooses to not to receive informational announcements by email.
-
#preference_type ⇒ String
[Required] The string representing the user's preference, whether to opt in to only required announcements, to opt in to all announcements, including informational announcements, or to opt out of all announcements.
-
#preferred_time_zone ⇒ String
The time zone in which the user prefers to receive announcements.
-
#type ⇒ String
[Required] The entity type, which specifies a model that either creates new announcement email preferences or updates existing preferences.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.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.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ BaseCreateAnnouncementsPreferencesDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ BaseCreateAnnouncementsPreferencesDetails
Initializes the object
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 |
# File 'lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb', line 96 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.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.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.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 you want to manage announcement email preferences. (Specify the tenancy by providing the root compartment OCID.)
33 34 35 |
# File 'lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb', line 33 def compartment_id @compartment_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.)
27 28 29 |
# File 'lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb', line 27 def is_unsubscribed @is_unsubscribed end |
#preference_type ⇒ String
[Required] The string representing the user's preference, whether to opt in to only required announcements, to opt in to all announcements, including informational announcements, or to opt out of all announcements.
37 38 39 |
# File 'lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb', line 37 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
41 42 43 |
# File 'lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb', line 41 def preferred_time_zone @preferred_time_zone end |
#type ⇒ String
[Required] The entity type, which specifies a model that either creates new announcement email preferences or updates existing preferences.
21 22 23 |
# File 'lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb', line 21 def type @type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb', line 44 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'type': :'type', 'is_unsubscribed': :'isUnsubscribed', 'compartment_id': :'compartmentId', '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.
74 75 76 77 78 79 80 81 82 |
# File 'lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb', line 74 def self.get_subtype(object_hash) type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral return 'OCI::AnnouncementsService::Models::CreateAnnouncementsPreferencesDetails' if type == 'CreateAnnouncementsPreferencesDetails' return 'OCI::AnnouncementsService::Models::UpdateAnnouncementsPreferencesDetails' if type == 'UpdateAnnouncementsPreferencesDetails' # TODO: Log a warning when the subtype is not found. 'OCI::AnnouncementsService::Models::BaseCreateAnnouncementsPreferencesDetails' end |
.swagger_types ⇒ Object
Attribute type mapping.
57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb', line 57 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'type': :'String', 'is_unsubscribed': :'BOOLEAN', 'compartment_id': :'String', 'preference_type': :'String', 'preferred_time_zone': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
146 147 148 149 150 151 152 153 154 155 |
# File 'lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb', line 146 def ==(other) return true if equal?(other) self.class == other.class && type == other.type && is_unsubscribed == other.is_unsubscribed && compartment_id == other.compartment_id && preference_type == other.preference_type && preferred_time_zone == other.preferred_time_zone end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb', line 180 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
160 161 162 |
# File 'lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb', line 160 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
169 170 171 |
# File 'lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb', line 169 def hash [type, is_unsubscribed, compartment_id, preference_type, preferred_time_zone].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
213 214 215 216 217 218 219 220 221 222 |
# File 'lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb', line 213 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
207 208 209 |
# File 'lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb', line 207 def to_s to_hash.to_s end |