Class: OCI::ServiceCatalog::Models::PrivateApplicationPackage

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/service_catalog/models/private_application_package.rb

Overview

A base object for all types of private application packages. 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

Direct Known Subclasses

PrivateApplicationStackPackage

Constant Summary collapse

PACKAGE_TYPE_ENUM =
[
  PACKAGE_TYPE_STACK = 'STACK'.freeze,
  PACKAGE_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 = {}) ⇒ PrivateApplicationPackage

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

  • :private_application_id (String)

    The value to assign to the #private_application_id property

  • :display_name (String)

    The value to assign to the #display_name property

  • :version (String)

    The value to assign to the #version property

  • :package_type (String)

    The value to assign to the #package_type property

  • :time_created (DateTime)

    The value to assign to the #time_created property



103
104
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
# File 'lib/oci/service_catalog/models/private_application_package.rb', line 103

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

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

  self.private_application_id = attributes[:'private_application_id'] if attributes[:'private_application_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.version = attributes[:'version'] if attributes[:'version']

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

Instance Attribute Details

#display_nameString

The display name of the package.

Returns:

  • (String)


30
31
32
# File 'lib/oci/service_catalog/models/private_application_package.rb', line 30

def display_name
  @display_name
end

#idString

[Required] The OCID of the private application package.

Returns:

  • (String)


21
22
23
# File 'lib/oci/service_catalog/models/private_application_package.rb', line 21

def id
  @id
end

#package_typeString

[Required] The specified package's type.

Returns:

  • (String)


38
39
40
# File 'lib/oci/service_catalog/models/private_application_package.rb', line 38

def package_type
  @package_type
end

#private_application_idString

[Required] The OCID of the private application where the package is hosted.

Returns:

  • (String)


26
27
28
# File 'lib/oci/service_catalog/models/private_application_package.rb', line 26

def private_application_id
  @private_application_id
end

#time_createdDateTime

[Required] The date and time the private application package was created, expressed in RFC 3339 timestamp format.

Example: 2021-05-27T21:10:29.600Z

Returns:

  • (DateTime)


46
47
48
# File 'lib/oci/service_catalog/models/private_application_package.rb', line 46

def time_created
  @time_created
end

#versionString

[Required] The package version.

Returns:

  • (String)


34
35
36
# File 'lib/oci/service_catalog/models/private_application_package.rb', line 34

def version
  @version
end

Class Method Details

.attribute_mapObject

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/service_catalog/models/private_application_package.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'private_application_id': :'privateApplicationId',
    'display_name': :'displayName',
    'version': :'version',
    'package_type': :'packageType',
    'time_created': :'timeCreated'
    # 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
# File 'lib/oci/service_catalog/models/private_application_package.rb', line 81

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

  return 'OCI::ServiceCatalog::Models::PrivateApplicationStackPackage' if type == 'STACK'

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

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'private_application_id': :'String',
    'display_name': :'String',
    'version': :'String',
    'package_type': :'String',
    'time_created': :'DateTime'
    # 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



158
159
160
161
162
163
164
165
166
167
168
# File 'lib/oci/service_catalog/models/private_application_package.rb', line 158

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

  self.class == other.class &&
    id == other.id &&
    private_application_id == other.private_application_id &&
    display_name == other.display_name &&
    version == other.version &&
    package_type == other.package_type &&
    time_created == other.time_created
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



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

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


173
174
175
# File 'lib/oci/service_catalog/models/private_application_package.rb', line 173

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



182
183
184
# File 'lib/oci/service_catalog/models/private_application_package.rb', line 182

def hash
  [id, private_application_id, display_name, version, package_type, time_created].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



226
227
228
229
230
231
232
233
234
235
# File 'lib/oci/service_catalog/models/private_application_package.rb', line 226

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



220
221
222
# File 'lib/oci/service_catalog/models/private_application_package.rb', line 220

def to_s
  to_hash.to_s
end