Class: OCI::FleetAppsManagement::Models::CatalogItem

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

Overview

A description of a CatalogItem resource.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Constant Summary collapse

CONFIG_SOURCE_TYPE_ENUM =
[
  CONFIG_SOURCE_TYPE_PAR_CATALOG_SOURCE = 'PAR_CATALOG_SOURCE'.freeze,
  CONFIG_SOURCE_TYPE_GIT_CATALOG_SOURCE = 'GIT_CATALOG_SOURCE'.freeze,
  CONFIG_SOURCE_TYPE_MARKETPLACE_CATALOG_SOURCE = 'MARKETPLACE_CATALOG_SOURCE'.freeze,
  CONFIG_SOURCE_TYPE_STACK_TEMPLATE_CATALOG_SOURCE = 'STACK_TEMPLATE_CATALOG_SOURCE'.freeze,
  CONFIG_SOURCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
PACKAGE_TYPE_ENUM =
[
  PACKAGE_TYPE_TF_PACKAGE = 'TF_PACKAGE'.freeze,
  PACKAGE_TYPE_NON_TF_PACKAGE = 'NON_TF_PACKAGE'.freeze,
  PACKAGE_TYPE_CONFIG_FILE = 'CONFIG_FILE'.freeze,
  PACKAGE_TYPE_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_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CatalogItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 245

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.should_list_public_items = attributes[:'shouldListPublicItems'] unless attributes[:'shouldListPublicItems'].nil?
  self.should_list_public_items = false if should_list_public_items.nil? && !attributes.key?(:'shouldListPublicItems') # rubocop:disable Style/StringLiterals

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

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

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

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

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

  self.time_last_checked = attributes[:'timeLastChecked'] if attributes[:'timeLastChecked']

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

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

  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_payloadOCI::FleetAppsManagement::Models::CatalogResultPayload



67
68
69
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 67

def catalog_result_payload
  @catalog_result_payload
end

#catalog_source_payloadOCI::FleetAppsManagement::Models::CatalogSourcePayload



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

def catalog_source_payload
  @catalog_source_payload
end

#compartment_idString

[Required] The OCID of the compartment.

Returns:

  • (String)


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

def compartment_id
  @compartment_id
end

#config_source_typeString

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

Returns:

  • (String)


53
54
55
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 53

def config_source_type
  @config_source_type
end

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


146
147
148
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 146

def defined_tags
  @defined_tags
end

#descriptionString

[Required] Description about the catalog item.

Returns:

  • (String)


61
62
63
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 61

def description
  @description
end

#display_nameString

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

Returns:

  • (String)


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

def display_name
  @display_name
end

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


140
141
142
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 140

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the catalog.

Returns:

  • (String)


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

def id
  @id
end

#lifecycle_detailsString

[Required] The details of lifecycle state CatalogItem.

Returns:

  • (String)


102
103
104
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 102

def lifecycle_details
  @lifecycle_details
end

#lifecycle_stateString

[Required] The current state of the CatalogItem.

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#listing_idString

[Required] The catalog listing Id.

Returns:

  • (String)


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

def listing_id
  @listing_id
end

#listing_versionString

[Required] The catalog package version.

Returns:

  • (String)


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

def listing_version
  @listing_version
end

#package_typeString

[Required] Config package type Eg: TF_PACKAGE, NON_TF_PACKAGE, CONFIG_FILE.

Returns:

  • (String)


94
95
96
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 94

def package_type
  @package_type
end

#short_descriptionString

Short description about the catalog item.

Returns:

  • (String)


89
90
91
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 89

def short_description
  @short_description
end

#should_list_public_itemsBOOLEAN

The indicator to append Public Items from the root compartment to any query, when set to TRUE.

Returns:

  • (BOOLEAN)


57
58
59
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 57

def should_list_public_items
  @should_list_public_items
end

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


152
153
154
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 152

def system_tags
  @system_tags
end

#time_backfill_last_checkedDateTime

The date and time the CatalogItem was last checked by backfill job, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime)


127
128
129
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 127

def time_backfill_last_checked
  @time_backfill_last_checked
end

#time_createdDateTime

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


108
109
110
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 108

def time_created
  @time_created
end

#time_last_checkedDateTime

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

Returns:

  • (DateTime)


134
135
136
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 134

def time_last_checked
  @time_last_checked
end

#time_releasedDateTime

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

Returns:

  • (DateTime)


120
121
122
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 120

def time_released
  @time_released
end

#time_updatedDateTime

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


114
115
116
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 114

def time_updated
  @time_updated
end

#version_descriptionString

Version description about the catalog item.

Returns:

  • (String)


85
86
87
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 85

def version_description
  @version_description
end

Class Method Details

.attribute_mapObject

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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 155

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

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'config_source_type': :'String',
    'should_list_public_items': :'BOOLEAN',
    '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',
    'version_description': :'String',
    'short_description': :'String',
    'package_type': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'time_released': :'DateTime',
    'time_backfill_last_checked': :'DateTime',
    'time_last_checked': :'DateTime',
    '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



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 430

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 &&
    should_list_public_items == other.should_list_public_items &&
    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 &&
    version_description == other.version_description &&
    short_description == other.short_description &&
    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 &&
    time_released == other.time_released &&
    time_backfill_last_checked == other.time_backfill_last_checked &&
    time_last_checked == other.time_last_checked &&
    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



482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 482

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


462
463
464
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 462

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



471
472
473
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 471

def hash
  [id, compartment_id, config_source_type, should_list_public_items, description, catalog_source_payload, catalog_result_payload, listing_id, listing_version, display_name, version_description, short_description, package_type, lifecycle_state, lifecycle_details, time_created, time_updated, time_released, time_backfill_last_checked, time_last_checked, freeform_tags, defined_tags, system_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



515
516
517
518
519
520
521
522
523
524
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 515

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



509
510
511
# File 'lib/oci/fleet_apps_management/models/catalog_item.rb', line 509

def to_s
  to_hash.to_s
end