Class: OCI::OsManagementHub::Models::CreateSoftwareSourceDetails

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

Overview

Provides the information used to create a software source. 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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSoftwareSourceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

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

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



105
106
107
108
109
110
111
112
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
140
141
142
 
# File 'lib/oci/os_management_hub/models/create_software_source_details.rb', line 105

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/os_management_hub/models/create_software_source_details.rb', line 20

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


46
47
48
 
# File 'lib/oci/os_management_hub/models/create_software_source_details.rb', line 46

def defined_tags
  @defined_tags
end

#description ⇒ String

User-specified description for the software source. Avoid entering confidential information.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/os_management_hub/models/create_software_source_details.rb', line 28

def description
  @description
end

#display_name ⇒ String

User-friendly name for the software source. Does not have to be unique and you can change the name later. Avoid entering confidential information.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/os_management_hub/models/create_software_source_details.rb', line 24

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


39
40
41
 
# File 'lib/oci/os_management_hub/models/create_software_source_details.rb', line 39

def freeform_tags
  @freeform_tags
end

#software_source_type ⇒ String

[Required] Type of software source.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/os_management_hub/models/create_software_source_details.rb', line 32

def software_source_type
  @software_source_type
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/os_management_hub/models/create_software_source_details.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'software_source_type': :'softwareSourceType',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # 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.



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/os_management_hub/models/create_software_source_details.rb', line 81

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

  return 'OCI::OsManagementHub::Models::CreateCustomSoftwareSourceDetails' if type == 'CUSTOM'
  return 'OCI::OsManagementHub::Models::CreateVendorSoftwareSourceDetails' if type == 'VENDOR'
  return 'OCI::OsManagementHub::Models::CreateVersionedCustomSoftwareSourceDetails' if type == 'VERSIONED'

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

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/os_management_hub/models/create_software_source_details.rb', line 63

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'software_source_type': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/os_management_hub/models/create_software_source_details.rb', line 159

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    software_source_type == other.software_source_type &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/oci/os_management_hub/models/create_software_source_details.rb', line 194

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


174
175
176
 
# File 'lib/oci/os_management_hub/models/create_software_source_details.rb', line 174

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



183
184
185
 
# File 'lib/oci/os_management_hub/models/create_software_source_details.rb', line 183

def hash
  [compartment_id, display_name, description, software_source_type, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



227
228
229
230
231
232
233
234
235
236
 
# File 'lib/oci/os_management_hub/models/create_software_source_details.rb', line 227

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



221
222
223
 
# File 'lib/oci/os_management_hub/models/create_software_source_details.rb', line 221

def to_s
  to_hash.to_s
end