Class: OCI::AnnouncementsService::Models::CreateAnnouncementSubscriptionDetails

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

Overview

The details for creating a new announcement subscription.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateAnnouncementSubscriptionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
158
159
160
161
162
 
# File 'lib/oci/announcements_service/models/create_announcement_subscription_details.rb', line 103

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

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

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

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

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

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

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

  self.filter_groups = attributes[:'filterGroups'] if attributes[:'filterGroups']

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

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

  self.preferred_language = attributes[:'preferredLanguage'] if attributes[:'preferredLanguage']
  self.preferred_language = "en-US" if preferred_language.nil? && !attributes.key?(:'preferredLanguage') # rubocop:disable Style/StringLiterals

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

  self.preferred_language = attributes[:'preferred_language'] if attributes[:'preferred_language']
  self.preferred_language = "en-US" if preferred_language.nil? && !attributes.key?(:'preferredLanguage') && !attributes.key?(:'preferred_language') # rubocop:disable Style/StringLiterals

  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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment where you want to create the announcement subscription.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/announcements_service/models/create_announcement_subscription_details.rb', line 22

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


52
53
54
 
# File 'lib/oci/announcements_service/models/create_announcement_subscription_details.rb', line 52

def defined_tags
  @defined_tags
end

#description ⇒ String

A description of the announcement subscription. Avoid entering confidential information.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/announcements_service/models/create_announcement_subscription_details.rb', line 17

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/announcements_service/models/create_announcement_subscription_details.rb', line 13

def display_name
  @display_name
end

#filter_groups ⇒ Hash<String, OCI::AnnouncementsService::Models::FilterGroupDetails>

A list of filter groups for the announcement subscription. A filter group combines one or more filters that the Announcements service applies to announcements for matching purposes.

Returns:



32
33
34
 
# File 'lib/oci/announcements_service/models/create_announcement_subscription_details.rb', line 32

def filter_groups
  @filter_groups
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#ons_topic_id ⇒ String

[Required] The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see Details for Notifications.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/announcements_service/models/create_announcement_subscription_details.rb', line 27

def ons_topic_id
  @ons_topic_id
end

#preferred_language ⇒ String

(For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/announcements_service/models/create_announcement_subscription_details.rb', line 36

def preferred_language
  @preferred_language
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) 


40
41
42
 
# File 'lib/oci/announcements_service/models/create_announcement_subscription_details.rb', line 40

def preferred_time_zone
  @preferred_time_zone
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/announcements_service/models/create_announcement_subscription_details.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'ons_topic_id': :'onsTopicId',
    'filter_groups': :'filterGroups',
    'preferred_language': :'preferredLanguage',
    'preferred_time_zone': :'preferredTimeZone',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/announcements_service/models/create_announcement_subscription_details.rb', line 72

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'ons_topic_id': :'String',
    'filter_groups': :'Hash<String, OCI::AnnouncementsService::Models::FilterGroupDetails>',
    'preferred_language': :'String',
    'preferred_time_zone': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/announcements_service/models/create_announcement_subscription_details.rb', line 171

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    ons_topic_id == other.ons_topic_id &&
    filter_groups == other.filter_groups &&
    preferred_language == other.preferred_language &&
    preferred_time_zone == other.preferred_time_zone &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/oci/announcements_service/models/create_announcement_subscription_details.rb', line 209

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


189
190
191
 
# File 'lib/oci/announcements_service/models/create_announcement_subscription_details.rb', line 189

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



198
199
200
 
# File 'lib/oci/announcements_service/models/create_announcement_subscription_details.rb', line 198

def hash
  [display_name, description, compartment_id, ons_topic_id, filter_groups, preferred_language, preferred_time_zone, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



242
243
244
245
246
247
248
249
250
251
 
# File 'lib/oci/announcements_service/models/create_announcement_subscription_details.rb', line 242

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



236
237
238
 
# File 'lib/oci/announcements_service/models/create_announcement_subscription_details.rb', line 236

def to_s
  to_hash.to_s
end