Class: OCI::Opsi::Models::NewsReport
- Inherits:
-
Object
- Object
- OCI::Opsi::Models::NewsReport
- Defined in:
- lib/oci/opsi/models/news_report.rb
Overview
News report resource.
Constant Summary collapse
- NEWS_FREQUENCY_ENUM =
[ NEWS_FREQUENCY_WEEKLY = 'WEEKLY'.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
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment.
-
#content_types ⇒ OCI::Opsi::Models::NewsContentTypes
This attribute is required.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
The description of the news report.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] The OCID of the news report resource.
-
#lifecycle_details ⇒ String
A message describing the current state in more detail.
-
#lifecycle_state ⇒ String
The current state of the news report.
-
#locale ⇒ String
Language of the news report.
-
#name ⇒ String
The news report name.
-
#news_frequency ⇒ String
[Required] News report frequency.
-
#ons_topic_id ⇒ String
[Required] The OCID of the ONS topic.
-
#status ⇒ String
Indicates the status of a news report in Operations Insights.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource.
-
#time_created ⇒ DateTime
The time the the news report was first enabled.
-
#time_updated ⇒ DateTime
The time the news report was updated.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ NewsReport
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ NewsReport
Initializes the object
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 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 |
# File 'lib/oci/opsi/models/news_report.rb', line 181 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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = 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'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment.
63 64 65 |
# File 'lib/oci/opsi/models/news_report.rb', line 63 def compartment_id @compartment_id end |
#content_types ⇒ OCI::Opsi::Models::NewsContentTypes
This attribute is required.
46 47 48 |
# File 'lib/oci/opsi/models/news_report.rb', line 46 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\"}}
83 84 85 |
# File 'lib/oci/opsi/models/news_report.rb', line 83 def @defined_tags end |
#description ⇒ String
The description of the news report.
59 60 61 |
# File 'lib/oci/opsi/models/news_report.rb', line 59 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\"}
77 78 79 |
# File 'lib/oci/opsi/models/news_report.rb', line 77 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the news report resource.
54 55 56 |
# File 'lib/oci/opsi/models/news_report.rb', line 54 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.
109 110 111 |
# File 'lib/oci/opsi/models/news_report.rb', line 109 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
The current state of the news report.
105 106 107 |
# File 'lib/oci/opsi/models/news_report.rb', line 105 def lifecycle_state @lifecycle_state end |
#locale ⇒ String
Language of the news report.
50 51 52 |
# File 'lib/oci/opsi/models/news_report.rb', line 50 def locale @locale end |
#name ⇒ String
The news report name.
67 68 69 |
# File 'lib/oci/opsi/models/news_report.rb', line 67 def name @name end |
#news_frequency ⇒ String
[Required] News report frequency.
42 43 44 |
# File 'lib/oci/opsi/models/news_report.rb', line 42 def news_frequency @news_frequency end |
#ons_topic_id ⇒ String
[Required] The OCID of the ONS topic.
71 72 73 |
# File 'lib/oci/opsi/models/news_report.rb', line 71 def ons_topic_id @ons_topic_id end |
#status ⇒ String
Indicates the status of a news report in Operations Insights.
93 94 95 |
# File 'lib/oci/opsi/models/news_report.rb', line 93 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\"}}
89 90 91 |
# File 'lib/oci/opsi/models/news_report.rb', line 89 def @system_tags end |
#time_created ⇒ DateTime
The time the the news report was first enabled. An RFC3339 formatted datetime string.
97 98 99 |
# File 'lib/oci/opsi/models/news_report.rb', line 97 def time_created @time_created end |
#time_updated ⇒ DateTime
The time the news report was updated. An RFC3339 formatted datetime string.
101 102 103 |
# File 'lib/oci/opsi/models/news_report.rb', line 101 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/oci/opsi/models/news_report.rb', line 112 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' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/oci/opsi/models/news_report.rb', line 136 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' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 |
# File 'lib/oci/opsi/models/news_report.rb', line 323 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 && == other. && == other. && == other. && status == other.status && time_created == other.time_created && time_updated == other.time_updated && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 |
# File 'lib/oci/opsi/models/news_report.rb', line 368 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
348 349 350 |
# File 'lib/oci/opsi/models/news_report.rb', line 348 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
357 358 359 |
# File 'lib/oci/opsi/models/news_report.rb', line 357 def hash [news_frequency, content_types, locale, id, description, compartment_id, name, ons_topic_id, , , , status, time_created, time_updated, lifecycle_state, lifecycle_details].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
401 402 403 404 405 406 407 408 409 410 |
# File 'lib/oci/opsi/models/news_report.rb', line 401 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
395 396 397 |
# File 'lib/oci/opsi/models/news_report.rb', line 395 def to_s to_hash.to_s end |