Class: OCI::FleetAppsManagement::Models::AnnouncementSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fleet_apps_management/models/announcement_summary.rb

Overview

A summary of announcements for Fleet Application Management.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnnouncementSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :resource_region (String) —

    The value to assign to the #resource_region property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

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

  • :type (String) —

    The value to assign to the #type property

  • :summary (String) —

    The value to assign to the #summary property

  • :details (String) —

    The value to assign to the #details property

  • :url (String) —

    The value to assign to the #url property

  • :announcement_start (DateTime) —

    The value to assign to the #announcement_start property

  • :announcement_end (DateTime) —

    The value to assign to the #announcement_end property

  • :lifecycle_state (String) —

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



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
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 173

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

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

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

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

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

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

  self.announcement_start = attributes[:'announcementStart'] if attributes[:'announcementStart']

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

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

  self.announcement_end = attributes[:'announcementEnd'] if attributes[:'announcementEnd']

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

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

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

Instance Attribute Details

#announcement_end ⇒ DateTime

[Required] Announcement end date.

Returns:

  • (DateTime) 


76
77
78
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 76

def announcement_end
  @announcement_end
end

#announcement_start ⇒ DateTime

[Required] Announcement start date.

Returns:

  • (DateTime) 


72
73
74
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 72

def announcement_start
  @announcement_start
end

#compartment_id ⇒ String

[Required] Tenancy OCID

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 26

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


92
93
94
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 92

def defined_tags
  @defined_tags
end

#description ⇒ String

A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 44

def description
  @description
end

#details ⇒ String

Announcement details.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 64

def details
  @details
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Example: My new resource

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 38

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


86
87
88
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 86

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 22

def id
  @id
end

#lifecycle_state ⇒ String

The lifecycle state of the announcement.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 80

def lifecycle_state
  @lifecycle_state
end

#resource_region ⇒ String

Associated region

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 30

def resource_region
  @resource_region
end

#summary ⇒ String

[Required] Summary of the announcement.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 60

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


98
99
100
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 98

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The time this resource was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


48
49
50
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 48

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time this resource was last updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


52
53
54
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 52

def time_updated
  @time_updated
end

#type ⇒ String

[Required] Type of announcement.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 56

def type
  @type
end

#url ⇒ String

URL to the announcement.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 68

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 101

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'resource_region': :'resourceRegion',
    'display_name': :'displayName',
    'description': :'description',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'type': :'type',
    'summary': :'summary',
    'details': :'details',
    'url': :'url',
    'announcement_start': :'announcementStart',
    'announcement_end': :'announcementEnd',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 126

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'resource_region': :'String',
    'display_name': :'String',
    'description': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'type': :'String',
    'summary': :'String',
    'details': :'String',
    'url': :'String',
    'announcement_start': :'DateTime',
    'announcement_end': :'DateTime',
    'lifecycle_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 278

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    resource_region == other.resource_region &&
    display_name == other.display_name &&
    description == other.description &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    type == other.type &&
    summary == other.summary &&
    details == other.details &&
    url == other.url &&
    announcement_start == other.announcement_start &&
    announcement_end == other.announcement_end &&
    lifecycle_state == other.lifecycle_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 324

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


304
305
306
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 304

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



313
314
315
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 313

def hash
  [id, compartment_id, resource_region, display_name, description, time_created, time_updated, type, summary, details, url, announcement_start, announcement_end, lifecycle_state, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



357
358
359
360
361
362
363
364
365
366
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 357

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



351
352
353
 
# File 'lib/oci/fleet_apps_management/models/announcement_summary.rb', line 351

def to_s
  to_hash.to_s
end