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

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



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
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 99

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

Instance Attribute Details

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

Returns:



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

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


54
55
56
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 54

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


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

def freeform_tags
  @freeform_tags
end

#locale ⇒ String

Language of the news report.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 35

def locale
  @locale
end

#news_frequency ⇒ String

News report frequency.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 31

def news_frequency
  @news_frequency
end

#ons_topic_id ⇒ String

The OCID of the ONS topic.

Returns:

  • (String) 


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

def ons_topic_id
  @ons_topic_id
end

#status ⇒ String

Defines if the news report will be enabled or disabled.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 27

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



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

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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>>'
    # 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
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 171

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
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



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

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


187
188
189
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 187

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



196
197
198
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 196

def hash
  [status, news_frequency, locale, content_types, ons_topic_id, 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



240
241
242
243
244
245
246
247
248
249
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 240

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



234
235
236
 
# File 'lib/oci/opsi/models/update_news_report_details.rb', line 234

def to_s
  to_hash.to_s
end