Class: OCI::Opsi::Models::NewsReportSummary

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

Overview

Summary of a news report resource.

Constant Summary collapse

NEWS_FREQUENCY_ENUM = 
[
  NEWS_FREQUENCY_WEEKLY = 'WEEKLY'.freeze,
  NEWS_FREQUENCY_DAILY = 'DAILY'.freeze,
  NEWS_FREQUENCY_HOURLY = 'HOURLY'.freeze,
  NEWS_FREQUENCY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LOCALE_ENUM = 
[
  LOCALE_EN = 'EN'.freeze,
  LOCALE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_DISABLED = 'DISABLED'.freeze,
  STATUS_ENABLED = 'ENABLED'.freeze,
  STATUS_TERMINATED = 'TERMINATED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.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,
  DAY_OF_WEEK_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
MATCH_RULE_ENUM = 
[
  MATCH_RULE_MATCH_ANY = 'MATCH_ANY'.freeze,
  MATCH_RULE_MATCH_ALL = 'MATCH_ALL'.freeze,
  MATCH_RULE_MATCH_NONE = 'MATCH_NONE'.freeze,
  MATCH_RULE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NewsReportSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :news_frequency (String) —

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

  • :id (String) —

    The value to assign to the #id property

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :name (String) —

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

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

    The value to assign to the #system_tags property

  • :status (String) —

    The value to assign to the #status property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

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

  • :tag_filters (Array<String>) —

    The value to assign to the #tag_filters property

  • :match_rule (String) —

    The value to assign to the #match_rule property



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 232

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

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

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

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

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  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

  self.tag_filters = attributes[:'tagFilters'] if attributes[:'tagFilters']

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

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

  self.match_rule = attributes[:'matchRule'] if attributes[:'matchRule']

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

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


137
138
139
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 137

def are_child_compartments_included
  @are_child_compartments_included
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 83

def compartment_id
  @compartment_id
end

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

This attribute is required.

Returns:



66
67
68
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 66

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) 


133
134
135
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 133

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


103
104
105
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 103

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the news report.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 79

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


97
98
99
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 97

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the news report resource.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 74

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


129
130
131
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 129

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the news report.

Returns:

  • (String) 


125
126
127
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 125

def lifecycle_state
  @lifecycle_state
end

#locale ⇒ String

Language of the news report.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 70

def locale
  @locale
end

#match_rule ⇒ String

Match rule used for tag filters.

Returns:

  • (String) 


148
149
150
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 148

def match_rule
  @match_rule
end

#name ⇒ String

The news report name.

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 87

def name
  @name
end

#news_frequency ⇒ String

[Required] News report frequency.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 62

def news_frequency
  @news_frequency
end

#ons_topic_id ⇒ String

The OCID of the ONS topic.

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 91

def ons_topic_id
  @ons_topic_id
end

#status ⇒ String

Indicates the status of a news report in Ops Insights.

Returns:

  • (String) 


113
114
115
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 113

def status
  @status
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


109
110
111
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 109

def system_tags
  @system_tags
end

#tag_filters ⇒ Array<String>

List of tag filters; each filter composed by a namespace, key, and value. Example for defined tags - '<TagNamespace>.<TagKey>=<TagValue>'. Example for freeform tags - '<TagKey>=<TagValue>'.

Returns:

  • (Array<String>) 


144
145
146
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 144

def tag_filters
  @tag_filters
end

#time_created ⇒ DateTime

The time the the news report was first enabled. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


117
118
119
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 117

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the news report was updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


121
122
123
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 121

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'news_frequency': :'newsFrequency',
    'content_types': :'contentTypes',
    'locale': :'locale',
    'id': :'id',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'name': :'name',
    'ons_topic_id': :'onsTopicId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'status': :'status',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'day_of_week': :'dayOfWeek',
    'are_child_compartments_included': :'areChildCompartmentsIncluded',
    'tag_filters': :'tagFilters',
    'match_rule': :'matchRule'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 179

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'news_frequency': :'String',
    'content_types': :'OCI::Opsi::Models::NewsContentTypes',
    'locale': :'String',
    'id': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'name': :'String',
    'ons_topic_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'status': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'day_of_week': :'String',
    'are_child_compartments_included': :'BOOLEAN',
    'tag_filters': :'Array<String>',
    'match_rule': :'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



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 426

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

  self.class == other.class &&
    news_frequency == other.news_frequency &&
    content_types == other.content_types &&
    locale == other.locale &&
    id == other.id &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    name == other.name &&
    ons_topic_id == other.ons_topic_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    status == other.status &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    day_of_week == other.day_of_week &&
    are_child_compartments_included == other.are_child_compartments_included &&
    tag_filters == other.tag_filters &&
    match_rule == other.match_rule
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



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 475

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


455
456
457
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 455

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



464
465
466
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 464

def hash
  [news_frequency, content_types, locale, id, description, compartment_id, name, ons_topic_id, freeform_tags, defined_tags, system_tags, status, time_created, time_updated, lifecycle_state, lifecycle_details, day_of_week, are_child_compartments_included, tag_filters, match_rule].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



508
509
510
511
512
513
514
515
516
517
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 508

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



502
503
504
 
# File 'lib/oci/opsi/models/news_report_summary.rb', line 502

def to_s
  to_hash.to_s
end