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,
  NEWS_FREQUENCY_DAILY = 'DAILY'.freeze,
  NEWS_FREQUENCY_HOURLY = 'HOURLY'.freeze
].freeze
LOCALE_ENUM = 
[
  LOCALE_EN = 'EN'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_DISABLED = 'DISABLED'.freeze,
  STATUS_ENABLED = 'ENABLED'.freeze,
  STATUS_TERMINATED = 'TERMINATED'.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
MATCH_RULE_ENUM = 
[
  MATCH_RULE_MATCH_ANY = 'MATCH_ANY'.freeze,
  MATCH_RULE_MATCH_ALL = 'MATCH_ALL'.freeze,
  MATCH_RULE_MATCH_NONE = 'MATCH_NONE'.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

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



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

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

  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) 


94
95
96
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 94

def are_child_compartments_included
  @are_child_compartments_included
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

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

This attribute is required.

Returns:



78
79
80
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 78

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) 


90
91
92
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 90

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

[Required] The description of the news report.

Returns:

  • (String) 


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

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


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

def freeform_tags
  @freeform_tags
end

#locale ⇒ String

[Required] Language of the news report.

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 82

def locale
  @locale
end

#match_rule ⇒ String

Match rule used for tag filters.

Returns:

  • (String) 


105
106
107
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 105

def match_rule
  @match_rule
end

#name ⇒ String

[Required] The news report name.

Returns:

  • (String) 


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

def name
  @name
end

#news_frequency ⇒ String

[Required] News report frequency.

Returns:

  • (String) 


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

def news_frequency
  @news_frequency
end

#ons_topic_id ⇒ String

[Required] The OCID of the ONS topic.

Returns:

  • (String) 


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

def ons_topic_id
  @ons_topic_id
end

#status ⇒ String

Defines if the news report will be enabled or disabled.

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 86

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


101
102
103
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 101

def tag_filters
  @tag_filters
end

Class Method Details

.attribute_map ⇒ Object

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 108

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 130

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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 295

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 338

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


318
319
320
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 318

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



327
328
329
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 327

def hash
  [name, news_frequency, description, ons_topic_id, compartment_id, freeform_tags, defined_tags, content_types, locale, status, 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



371
372
373
374
375
376
377
378
379
380
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 371

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



365
366
367
 
# File 'lib/oci/opsi/models/create_news_report_details.rb', line 365

def to_s
  to_hash.to_s
end