class OCI::AnnouncementsService::Models::BaseCreateAnnouncementsPreferencesDetails
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
Constants
- PREFERENCE_TYPE_ENUM
Attributes
The OCID of the compartment for which you want to manage announcement email preferences. (Specify the tenancy by providing the root compartment OCID.)
@return [String]
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.)
@return [BOOLEAN]
[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. @return [String]
[Required] The entity type, which specifies a model that either creates new announcement email preferences or updates existing preferences.
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb, line 39 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'type': :'type', 'is_unsubscribed': :'isUnsubscribed', 'compartment_id': :'compartmentId', 'preference_type': :'preferenceType' # rubocop:enable Style/SymbolLiteral } end
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
# File lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb, line 67 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :type The value to assign to the {#type} property @option attributes [BOOLEAN] :is_unsubscribed The value to assign to the {#is_unsubscribed} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :preference_type The value to assign to the {#preference_type} property
# File lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb, line 88 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'] end
Attribute type mapping.
# File lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb, line 51 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'type': :'String', 'is_unsubscribed': :'BOOLEAN', 'compartment_id': :'String', 'preference_type': :'String' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb, line 130 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 end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb, line 163 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb, line 143 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb, line 152 def hash [type, is_unsubscribed, compartment_id, preference_type].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] preference_type
Object
to be assigned
# File lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb, line 119 def preference_type=(preference_type) raise "Invalid value for 'preference_type': this must be one of the values in PREFERENCE_TYPE_ENUM." if preference_type && !PREFERENCE_TYPE_ENUM.include?(preference_type) @preference_type = preference_type end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb, line 196 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb, line 190 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/announcements_service/models/base_create_announcements_preferences_details.rb, line 213 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end