Class: OCI::Opsi::Models::CreateNewsReportDetails

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

Overview

The information about the news report to be created.

Constant Summary collapse

NEWS_FREQUENCY_ENUM = 
[
  NEWS_FREQUENCY_WEEKLY = 'WEEKLY'.freeze
].freeze
LOCALE_ENUM = 
[
  LOCALE_EN = 'EN'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_DISABLED = 'DISABLED'.freeze,
  STATUS_ENABLED = 'ENABLED'.freeze,
  STATUS_TERMINATED = 'TERMINATED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateNewsReportDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :news_frequency (String) —

    The value to assign to the #news_frequency property

  • :description (String) —

    The value to assign to the #description property

  • :ons_topic_id (String) —

    The value to assign to the #ons_topic_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_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

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

    The value to assign to the #content_types property

  • :locale (String) —

    The value to assign to the #locale property

  • :status (String) —

    The value to assign to the #status property



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
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 122

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] Compartment Identifier where the news report will be created.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 44

def compartment_id
  @compartment_id
end

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

This attribute is required.

Returns:



60
61
62
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 60

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


56
57
58
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 56

def defined_tags
  @defined_tags
end

#description ⇒ String

[Required] The description of the news report.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 36

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


50
51
52
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 50

def freeform_tags
  @freeform_tags
end

#locale ⇒ String

[Required] Language of the news report.

Returns:

  • (String) 


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

def locale
  @locale
end

#name ⇒ String

[Required] The news report name.

Returns:

  • (String) 


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

def name
  @name
end

#news_frequency ⇒ String

[Required] News report frequency.

Returns:

  • (String) 


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

def news_frequency
  @news_frequency
end

#ons_topic_id ⇒ String

[Required] The OCID of the ONS topic.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 40

def ons_topic_id
  @ons_topic_id
end

#status ⇒ String

Defines if the news report will be enabled or disabled.

Returns:

  • (String) 


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

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 89

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 204

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

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 243

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


223
224
225
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 223

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



232
233
234
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 232

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



276
277
278
279
280
281
282
283
284
285
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 276

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



270
271
272
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 270

def to_s
  to_hash.to_s
end