Class: OCI::OsManagementHub::Models::SoftwareSourceSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/os_management_hub/models/software_source_summary.rb

Overview

Provides summary information for a software source. A software source contains a collection of packages. For more information, see Managing Software Sources. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

SOFTWARE_SOURCE_TYPE_ENUM = 
[
  SOFTWARE_SOURCE_TYPE_VENDOR = 'VENDOR'.freeze,
  SOFTWARE_SOURCE_TYPE_CUSTOM = 'CUSTOM'.freeze,
  SOFTWARE_SOURCE_TYPE_VERSIONED = 'VERSIONED'.freeze,
  SOFTWARE_SOURCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
AVAILABILITY_ENUM = 
[
  AVAILABILITY_AVAILABLE = 'AVAILABLE'.freeze,
  AVAILABILITY_SELECTED = 'SELECTED'.freeze,
  AVAILABILITY_RESTRICTED = 'RESTRICTED'.freeze,
  AVAILABILITY_UNAVAILABLE = 'UNAVAILABLE'.freeze,
  AVAILABILITY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
AVAILABILITY_AT_OCI_ENUM = 
[
  AVAILABILITY_AT_OCI_AVAILABLE = 'AVAILABLE'.freeze,
  AVAILABILITY_AT_OCI_SELECTED = 'SELECTED'.freeze,
  AVAILABILITY_AT_OCI_RESTRICTED = 'RESTRICTED'.freeze,
  AVAILABILITY_AT_OCI_UNAVAILABLE = 'UNAVAILABLE'.freeze,
  AVAILABILITY_AT_OCI_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
OS_FAMILY_ENUM = 
[
  OS_FAMILY_ORACLE_LINUX_9 = 'ORACLE_LINUX_9'.freeze,
  OS_FAMILY_ORACLE_LINUX_8 = 'ORACLE_LINUX_8'.freeze,
  OS_FAMILY_ORACLE_LINUX_7 = 'ORACLE_LINUX_7'.freeze,
  OS_FAMILY_ORACLE_LINUX_6 = 'ORACLE_LINUX_6'.freeze,
  OS_FAMILY_WINDOWS_SERVER_2016 = 'WINDOWS_SERVER_2016'.freeze,
  OS_FAMILY_WINDOWS_SERVER_2019 = 'WINDOWS_SERVER_2019'.freeze,
  OS_FAMILY_WINDOWS_SERVER_2022 = 'WINDOWS_SERVER_2022'.freeze,
  OS_FAMILY_ALL = 'ALL'.freeze,
  OS_FAMILY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ARCH_TYPE_ENUM = 
[
  ARCH_TYPE_X86_64 = 'X86_64'.freeze,
  ARCH_TYPE_AARCH64 = 'AARCH64'.freeze,
  ARCH_TYPE_I686 = 'I686'.freeze,
  ARCH_TYPE_NOARCH = 'NOARCH'.freeze,
  ARCH_TYPE_SRC = 'SRC'.freeze,
  ARCH_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SoftwareSourceSummary

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :repo_id (String) —

    The value to assign to the #repo_id property

  • :url (String) —

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

  • :description (String) —

    The value to assign to the #description property

  • :software_source_type (String) —

    The value to assign to the #software_source_type property

  • :availability (String) —

    The value to assign to the #availability property

  • :availability_at_oci (String) —

    The value to assign to the #availability_at_oci property

  • :os_family (String) —

    The value to assign to the #os_family property

  • :arch_type (String) —

    The value to assign to the #arch_type property

  • :package_count (Integer) —

    The value to assign to the #package_count property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :size (Float) —

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



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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 239

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

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

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

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

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

  self.software_source_type = attributes[:'softwareSourceType'] if attributes[:'softwareSourceType']

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

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

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

  self.availability_at_oci = attributes[:'availabilityAtOci'] if attributes[:'availabilityAtOci']

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

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

  self.os_family = attributes[:'osFamily'] if attributes[:'osFamily']

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

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

  self.arch_type = attributes[:'archType'] if attributes[:'archType']

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

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

  self.package_count = attributes[:'packageCount'] if attributes[:'packageCount']

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

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

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

  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

#arch_type ⇒ String

[Required] The architecture type supported by the software source.

Returns:

  • (String) 


109
110
111
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 109

def arch_type
  @arch_type
end

#availability ⇒ String

[Required] Availability of the software source (for non-OCI environments).

Returns:

  • (String) 


97
98
99
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 97

def availability
  @availability
end

#availability_at_oci ⇒ String

[Required] Availability of the software source (for OCI environments).

Returns:

  • (String) 


101
102
103
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 101

def availability_at_oci
  @availability_at_oci
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the software source.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 63

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. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


135
136
137
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 135

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of the software source. For custom software sources, this is user-specified.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 89

def description
  @description
end

#display_name ⇒ String

[Required] User-friendly name for the software source.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 67

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


128
129
130
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 128

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the software source.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 59

def id
  @id
end

#lifecycle_state ⇒ String

The current state of the software source.

Returns:

  • (String) 


117
118
119
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 117

def lifecycle_state
  @lifecycle_state
end

#os_family ⇒ String

[Required] The OS family the software source belongs to.

Returns:

  • (String) 


105
106
107
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 105

def os_family
  @os_family
end

#package_count ⇒ Integer

Number of packages the software source contains.

Returns:

  • (Integer) 


113
114
115
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 113

def package_count
  @package_count
end

#repo_id ⇒ String

[Required] The repository ID for the software source.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 71

def repo_id
  @repo_id
end

#size ⇒ Float

The size of the software source in gigabytes (GB).

Returns:

  • (Float) 


121
122
123
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 121

def size
  @size
end

#software_source_type ⇒ String

[Required] Type of software source.

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 93

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


141
142
143
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 141

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the software source was created (in RFC 3339 format).

Returns:

  • (DateTime) 


80
81
82
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 80

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the software source was updated (in RFC 3339 format).

Returns:

  • (DateTime) 


85
86
87
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 85

def time_updated
  @time_updated
end

#url ⇒ String

[Required] URL for the repository. For vendor software sources, this is the URL to the regional yum server. For custom software sources, this is 'custom/<repoId>'.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 75

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



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/os_management_hub/models/software_source_summary.rb', line 144

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'repo_id': :'repoId',
    'url': :'url',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'description': :'description',
    'software_source_type': :'softwareSourceType',
    'availability': :'availability',
    'availability_at_oci': :'availabilityAtOci',
    'os_family': :'osFamily',
    'arch_type': :'archType',
    'package_count': :'packageCount',
    'lifecycle_state': :'lifecycleState',
    'size': :'size',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 202

def self.get_subtype(object_hash)
  type = object_hash[:'softwareSourceType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::OsManagementHub::Models::VendorSoftwareSourceSummary' if type == 'VENDOR'
  return 'OCI::OsManagementHub::Models::VersionedCustomSoftwareSourceSummary' if type == 'VERSIONED'
  return 'OCI::OsManagementHub::Models::CustomSoftwareSourceSummary' if type == 'CUSTOM'

  # TODO: Log a warning when the subtype is not found.
  'OCI::OsManagementHub::Models::SoftwareSourceSummary'
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'repo_id': :'String',
    'url': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'description': :'String',
    'software_source_type': :'String',
    'availability': :'String',
    'availability_at_oci': :'String',
    'os_family': :'String',
    'arch_type': :'String',
    'package_count': :'Integer',
    'lifecycle_state': :'String',
    'size': :'Float',
    '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



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 412

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    repo_id == other.repo_id &&
    url == other.url &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    description == other.description &&
    software_source_type == other.software_source_type &&
    availability == other.availability &&
    availability_at_oci == other.availability_at_oci &&
    os_family == other.os_family &&
    arch_type == other.arch_type &&
    package_count == other.package_count &&
    lifecycle_state == other.lifecycle_state &&
    size == other.size &&
    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



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 460

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


440
441
442
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 440

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



449
450
451
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 449

def hash
  [id, compartment_id, display_name, repo_id, url, time_created, time_updated, description, software_source_type, availability, availability_at_oci, os_family, arch_type, package_count, lifecycle_state, size, 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



493
494
495
496
497
498
499
500
501
502
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 493

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



487
488
489
 
# File 'lib/oci/os_management_hub/models/software_source_summary.rb', line 487

def to_s
  to_hash.to_s
end