Class: OCI::Core::Models::ExportImageDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/export_image_details.rb

Overview

The destination details for the image export.

Set destinationType to objectStorageTuple and use export_image_via_object_storage_tuple_details when specifying the namespace, bucket name, and object name.

Set destinationType to objectStorageUri and use export_image_via_object_storage_uri_details when specifying the Object Storage URL.

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

EXPORT_FORMAT_ENUM = 
[
  EXPORT_FORMAT_QCOW2 = 'QCOW2'.freeze,
  EXPORT_FORMAT_VMDK = 'VMDK'.freeze,
  EXPORT_FORMAT_OCI = 'OCI'.freeze,
  EXPORT_FORMAT_VHD = 'VHD'.freeze,
  EXPORT_FORMAT_VDI = 'VDI'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExportImageDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :destination_type (String) —

    The value to assign to the #destination_type property

  • :export_format (String) —

    The value to assign to the #export_format property



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/core/models/export_image_details.rb', line 93

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

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

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

  self.export_format = attributes[:'exportFormat'] if attributes[:'exportFormat']

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

  self.export_format = attributes[:'export_format'] if attributes[:'export_format']
end

Instance Attribute Details

#destination_type ⇒ String

[Required] The destination type. Use objectStorageTuple when specifying the namespace, bucket name, and object name. Use objectStorageUri when specifying the Object Storage URL.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/core/models/export_image_details.rb', line 33

def destination_type
  @destination_type
end

#export_format ⇒ String

The format to export the image to. The default value is OCI.

The following image formats are available:

  • OCI - Oracle Cloud Infrastructure file with a QCOW2 image and Oracle Cloud Infrastructure metadata (.oci). Use this format to export a custom image that you want to import into other tenancies or regions.

  • QCOW2 - QEMU Copy On Write (.qcow2)

  • VDI - Virtual Disk Image (.vdi) for Oracle VM VirtualBox

  • VHD - Virtual Hard Disk (.vhd) for Hyper-V

  • VMDK - Virtual Machine Disk (.vmdk)

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/core/models/export_image_details.rb', line 47

def export_format
  @export_format
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
 
# File 'lib/oci/core/models/export_image_details.rb', line 50

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'destination_type': :'destinationType',
    'export_format': :'exportFormat'
    # 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.



74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/core/models/export_image_details.rb', line 74

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

  return 'OCI::Core::Models::ExportImageViaObjectStorageUriDetails' if type == 'objectStorageUri'
  return 'OCI::Core::Models::ExportImageViaObjectStorageTupleDetails' if type == 'objectStorageTuple'

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

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
 
# File 'lib/oci/core/models/export_image_details.rb', line 60

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'destination_type': :'String',
    'export_format': :'String'
    # 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



127
128
129
130
131
132
133
 
# File 'lib/oci/core/models/export_image_details.rb', line 127

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

  self.class == other.class &&
    destination_type == other.destination_type &&
    export_format == other.export_format
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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/core/models/export_image_details.rb', line 158

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


138
139
140
 
# File 'lib/oci/core/models/export_image_details.rb', line 138

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



147
148
149
 
# File 'lib/oci/core/models/export_image_details.rb', line 147

def hash
  [destination_type, export_format].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/core/models/export_image_details.rb', line 191

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



185
186
187
 
# File 'lib/oci/core/models/export_image_details.rb', line 185

def to_s
  to_hash.to_s
end