Class: OCI::Opsi::Models::UpdateNewsReportDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/opsi/models/update_news_report_details.rb

Overview

The information about the news report to be updated.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_DISABLED = 'DISABLED'.freeze,
  STATUS_ENABLED = 'ENABLED'.freeze,
  STATUS_TERMINATED = 'TERMINATED'.freeze
].freeze
NEWS_FREQUENCY_ENUM = 
[
  NEWS_FREQUENCY_WEEKLY = 'WEEKLY'.freeze
].freeze
LOCALE_ENUM = 
[
  LOCALE_EN = 'EN'.freeze
].freeze
DAY_OF_WEEK_ENUM = 
[
  DAY_OF_WEEK_MONDAY = 'MONDAY'.freeze,
  DAY_OF_WEEK_TUESDAY = 'TUESDAY'.freeze,
  DAY_OF_WEEK_WEDNESDAY = 'WEDNESDAY'.freeze,
  DAY_OF_WEEK_THURSDAY = 'THURSDAY'.freeze,
  DAY_OF_WEEK_FRIDAY = 'FRIDAY'.freeze,
  DAY_OF_WEEK_SATURDAY = 'SATURDAY'.freeze,
  DAY_OF_WEEK_SUNDAY = 'SUNDAY'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateNewsReportDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :status (String) —

    The value to assign to the #status property

  • :news_frequency (String) —

    The value to assign to the #news_frequency property

  • :locale (String) —

    The value to assign to the #locale property

  • :content_types (OCI::Opsi::Models::NewsContentTypes) —

    The value to assign to the #content_types property

  • :ons_topic_id (String) —

    The value to assign to the #ons_topic_id property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :name (String) —

    The value to assign to the #name property

  • :description (String) —

    The value to assign to the #description property

  • :day_of_week (String) —

    The value to assign to the #day_of_week property

  • :are_child_compartments_included (BOOLEAN) —

    The value to assign to the #are_child_compartments_included property



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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 138

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

  self.news_frequency = attributes[:'newsFrequency'] if attributes[:'newsFrequency']

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

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

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

  self.content_types = attributes[:'contentTypes'] if attributes[:'contentTypes']

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

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

  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.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']

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

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

  self.day_of_week = attributes[:'dayOfWeek'] if attributes[:'dayOfWeek']

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

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

  self.are_child_compartments_included = attributes[:'areChildCompartmentsIncluded'] unless attributes[:'areChildCompartmentsIncluded'].nil?
  self.are_child_compartments_included = false if are_child_compartments_included.nil? && !attributes.key?(:'areChildCompartmentsIncluded') # rubocop:disable Style/StringLiterals

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

  self.are_child_compartments_included = attributes[:'are_child_compartments_included'] unless attributes[:'are_child_compartments_included'].nil?
  self.are_child_compartments_included = false if are_child_compartments_included.nil? && !attributes.key?(:'areChildCompartmentsIncluded') && !attributes.key?(:'are_child_compartments_included') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#are_child_compartments_included ⇒ BOOLEAN

A flag to consider the resources within a given compartment and all sub-compartments.

Returns:

  • (BOOLEAN) 


81
82
83
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 81

def are_child_compartments_included
  @are_child_compartments_included
end

#content_types ⇒ OCI::Opsi::Models::NewsContentTypes

Returns:



48
49
50
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 48

def content_types
  @content_types
end

#day_of_week ⇒ String

Day of the week in which the news report will be sent if the frequency is set to WEEKLY.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 77

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


64
65
66
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 64

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the news report.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 73

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


58
59
60
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 58

def freeform_tags
  @freeform_tags
end

#locale ⇒ String

Language of the news report.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 45

def locale
  @locale
end

#name ⇒ String

The news report name.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 68

def name
  @name
end

#news_frequency ⇒ String

News report frequency.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 41

def news_frequency
  @news_frequency
end

#ons_topic_id ⇒ String

The OCID of the ONS topic.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 52

def ons_topic_id
  @ons_topic_id
end

#status ⇒ String

Defines if the news report will be enabled or disabled.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 37

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 84

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'status',
    'news_frequency': :'newsFrequency',
    'locale': :'locale',
    'content_types': :'contentTypes',
    'ons_topic_id': :'onsTopicId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'name': :'name',
    'description': :'description',
    'day_of_week': :'dayOfWeek',
    'are_child_compartments_included': :'areChildCompartmentsIncluded'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 103

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'String',
    'news_frequency': :'String',
    'locale': :'String',
    'content_types': :'OCI::Opsi::Models::NewsContentTypes',
    'ons_topic_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'name': :'String',
    'description': :'String',
    'day_of_week': :'String',
    'are_child_compartments_included': :'BOOLEAN'
    # 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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 236

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

  self.class == other.class &&
    status == other.status &&
    news_frequency == other.news_frequency &&
    locale == other.locale &&
    content_types == other.content_types &&
    ons_topic_id == other.ons_topic_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    name == other.name &&
    description == other.description &&
    day_of_week == other.day_of_week &&
    are_child_compartments_included == other.are_child_compartments_included
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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 276

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


256
257
258
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 256

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



265
266
267
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 265

def hash
  [status, news_frequency, locale, content_types, ons_topic_id, freeform_tags, defined_tags, name, description, day_of_week, are_child_compartments_included].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



309
310
311
312
313
314
315
316
317
318
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 309

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



303
304
305
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 303

def to_s
  to_hash.to_s
end