Class: OCI::FleetAppsManagement::Models::CatalogItemSummary

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

Overview

Summary information about a CatalogItem.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CatalogItemSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 197

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

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

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

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

  self.catalog_source_payload = attributes[:'catalogSourcePayload'] if attributes[:'catalogSourcePayload']

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

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

  self.catalog_result_payload = attributes[:'catalogResultPayload'] if attributes[:'catalogResultPayload']

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

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

  self.listing_id = attributes[:'listingId'] if attributes[:'listingId']

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

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

  self.listing_version = attributes[:'listingVersion'] if attributes[:'listingVersion']

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

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

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

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

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

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

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

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

  self.short_description = attributes[:'shortDescription'] if attributes[:'shortDescription']

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

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

  self.time_released = attributes[:'timeReleased'] if attributes[:'timeReleased']

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

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

  self.is_item_locked = attributes[:'isItemLocked'] unless attributes[:'isItemLocked'].nil?
  self.is_item_locked = false if is_item_locked.nil? && !attributes.key?(:'isItemLocked') # rubocop:disable Style/StringLiterals

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

  self.is_item_locked = attributes[:'is_item_locked'] unless attributes[:'is_item_locked'].nil?
  self.is_item_locked = false if is_item_locked.nil? && !attributes.key?(:'isItemLocked') && !attributes.key?(:'is_item_locked') # rubocop:disable Style/StringLiterals

  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

#catalog_result_payload ⇒ OCI::FleetAppsManagement::Models::CatalogResultPayload

Returns:



32
33
34
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 32

def catalog_result_payload
  @catalog_result_payload
end

#catalog_source_payload ⇒ OCI::FleetAppsManagement::Models::CatalogSourcePayload

Returns:



29
30
31
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 29

def catalog_source_payload
  @catalog_source_payload
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 17

def compartment_id
  @compartment_id
end

#config_source_type ⇒ String

[Required] Config source type Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, GIT_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE.

Returns:

  • (String) 


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

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


104
105
106
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 104

def defined_tags
  @defined_tags
end

#description ⇒ String

[Required] The description of the catalogItem.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 46

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the catalog.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 13

def id
  @id
end

#is_item_locked ⇒ BOOLEAN

Indicates if the CatalogItem is immutable or not.

Returns:

  • (BOOLEAN) 


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

def is_item_locked
  @is_item_locked
end

#lifecycle_details ⇒ String

[Required] The details of lifecycle state CatalogItem.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 59

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the CatalogItem.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 55

def lifecycle_state
  @lifecycle_state
end

#listing_id ⇒ String

[Required] The catalog listing Id.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 37

def listing_id
  @listing_id
end

#listing_version ⇒ String

[Required] The catalog package version.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 42

def listing_version
  @listing_version
end

#package_type ⇒ String

[Required] Config package type Eg: BASE_PACKAGE, EXTENSION_PACKAGE.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 51

def package_type
  @package_type
end

#short_description ⇒ String

[Required] Short description about the catalog item.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 81

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


110
111
112
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 110

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the CatalogItem was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


66
67
68
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 66

def time_created
  @time_created
end

#time_released ⇒ DateTime

[Required] The date and time the CatalogItem was released, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


88
89
90
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 88

def time_released
  @time_released
end

#time_updated ⇒ DateTime

[Required] The date and time the CatalogItem was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


73
74
75
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 73

def time_updated
  @time_updated
end

#version_description ⇒ String

[Required] Version description about the catalog item.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 77

def version_description
  @version_description
end

Class Method Details

.attribute_map ⇒ Object

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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 113

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'config_source_type': :'configSourceType',
    'description': :'description',
    'catalog_source_payload': :'catalogSourcePayload',
    'catalog_result_payload': :'catalogResultPayload',
    'listing_id': :'listingId',
    'listing_version': :'listingVersion',
    'display_name': :'displayName',
    'package_type': :'packageType',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'version_description': :'versionDescription',
    'short_description': :'shortDescription',
    'time_released': :'timeReleased',
    'is_item_locked': :'isItemLocked',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 142

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'config_source_type': :'String',
    'description': :'String',
    'catalog_source_payload': :'OCI::FleetAppsManagement::Models::CatalogSourcePayload',
    'catalog_result_payload': :'OCI::FleetAppsManagement::Models::CatalogResultPayload',
    'listing_id': :'String',
    'listing_version': :'String',
    'display_name': :'String',
    'package_type': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'version_description': :'String',
    'short_description': :'String',
    'time_released': :'DateTime',
    'is_item_locked': :'BOOLEAN',
    '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



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 331

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    config_source_type == other.config_source_type &&
    description == other.description &&
    catalog_source_payload == other.catalog_source_payload &&
    catalog_result_payload == other.catalog_result_payload &&
    listing_id == other.listing_id &&
    listing_version == other.listing_version &&
    display_name == other.display_name &&
    package_type == other.package_type &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    version_description == other.version_description &&
    short_description == other.short_description &&
    time_released == other.time_released &&
    is_item_locked == other.is_item_locked &&
    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



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 381

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


361
362
363
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 361

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



370
371
372
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 370

def hash
  [id, compartment_id, config_source_type, description, catalog_source_payload, catalog_result_payload, listing_id, listing_version, display_name, package_type, lifecycle_state, lifecycle_details, time_created, time_updated, version_description, short_description, time_released, is_item_locked, 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



414
415
416
417
418
419
420
421
422
423
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 414

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



408
409
410
 
# File 'lib/oci/fleet_apps_management/models/catalog_item_summary.rb', line 408

def to_s
  to_hash.to_s
end