Class: OCI::DatabaseMigration::Models::DataPumpSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_migration/models/data_pump_settings.rb

Overview

Optional settings for Data Pump Export and Import jobs

Constant Summary collapse

JOB_MODE_ENUM = 
[
  JOB_MODE_FULL = 'FULL'.freeze,
  JOB_MODE_SCHEMA = 'SCHEMA'.freeze,
  JOB_MODE_TABLE = 'TABLE'.freeze,
  JOB_MODE_TABLESPACE = 'TABLESPACE'.freeze,
  JOB_MODE_TRANSPORTABLE = 'TRANSPORTABLE'.freeze,
  JOB_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DataPumpSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/oci/database_migration/models/data_pump_settings.rb', line 85

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

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

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

  self.data_pump_parameters = attributes[:'dataPumpParameters'] if attributes[:'dataPumpParameters']

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

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

  self.metadata_remaps = attributes[:'metadataRemaps'] if attributes[:'metadataRemaps']

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

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

  self.tablespace_details = attributes[:'tablespaceDetails'] if attributes[:'tablespaceDetails']

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

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

  self.export_directory_object = attributes[:'exportDirectoryObject'] if attributes[:'exportDirectoryObject']

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

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

  self.import_directory_object = attributes[:'importDirectoryObject'] if attributes[:'importDirectoryObject']

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

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

Instance Attribute Details

#data_pump_parameters ⇒ OCI::DatabaseMigration::Models::DataPumpParameters

Returns:



28
29
30
 
# File 'lib/oci/database_migration/models/data_pump_settings.rb', line 28

def data_pump_parameters
  @data_pump_parameters
end

#export_directory_object ⇒ OCI::DatabaseMigration::Models::DirectoryObject

Returns:



40
41
42
 
# File 'lib/oci/database_migration/models/data_pump_settings.rb', line 40

def export_directory_object
  @export_directory_object
end

#import_directory_object ⇒ OCI::DatabaseMigration::Models::DirectoryObject

Returns:



43
44
45
 
# File 'lib/oci/database_migration/models/data_pump_settings.rb', line 43

def import_directory_object
  @import_directory_object
end

#job_mode ⇒ String

Data Pump job mode. Refer to [Data Pump Export Modes ](docs.oracle.com/en/database/oracle/oracle-database/19/sutil/oracle-data-pump-export-utility.html#GUID-8E497131-6B9B-4CC8-AA50-35F480CAC2C4)

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/database_migration/models/data_pump_settings.rb', line 25

def job_mode
  @job_mode
end

#metadata_remaps ⇒ Array<OCI::DatabaseMigration::Models::MetadataRemap>

Defines remapping to be applied to objects as they are processed. Refer to [METADATA_REMAP Procedure ](docs.oracle.com/en/database/oracle/oracle-database/19/arpls/DBMS_DATAPUMP.html#GUID-0FC32790-91E6-4781-87A3-229DE024CB3D)

Returns:



34
35
36
 
# File 'lib/oci/database_migration/models/data_pump_settings.rb', line 34

def metadata_remaps
  @metadata_remaps
end

#tablespace_details ⇒ OCI::DatabaseMigration::Models::TargetTypeTablespaceDetails

Returns:



37
38
39
 
# File 'lib/oci/database_migration/models/data_pump_settings.rb', line 37

def tablespace_details
  @tablespace_details
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/database_migration/models/data_pump_settings.rb', line 46

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'job_mode': :'jobMode',
    'data_pump_parameters': :'dataPumpParameters',
    'metadata_remaps': :'metadataRemaps',
    'tablespace_details': :'tablespaceDetails',
    'export_directory_object': :'exportDirectoryObject',
    'import_directory_object': :'importDirectoryObject'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/database_migration/models/data_pump_settings.rb', line 60

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'job_mode': :'String',
    'data_pump_parameters': :'OCI::DatabaseMigration::Models::DataPumpParameters',
    'metadata_remaps': :'Array<OCI::DatabaseMigration::Models::MetadataRemap>',
    'tablespace_details': :'OCI::DatabaseMigration::Models::TargetTypeTablespaceDetails',
    'export_directory_object': :'OCI::DatabaseMigration::Models::DirectoryObject',
    'import_directory_object': :'OCI::DatabaseMigration::Models::DirectoryObject'
    # 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



148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/database_migration/models/data_pump_settings.rb', line 148

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

  self.class == other.class &&
    job_mode == other.job_mode &&
    data_pump_parameters == other.data_pump_parameters &&
    metadata_remaps == other.metadata_remaps &&
    tablespace_details == other.tablespace_details &&
    export_directory_object == other.export_directory_object &&
    import_directory_object == other.import_directory_object
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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/database_migration/models/data_pump_settings.rb', line 183

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


163
164
165
 
# File 'lib/oci/database_migration/models/data_pump_settings.rb', line 163

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



172
173
174
 
# File 'lib/oci/database_migration/models/data_pump_settings.rb', line 172

def hash
  [job_mode, data_pump_parameters, metadata_remaps, tablespace_details, export_directory_object, import_directory_object].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/database_migration/models/data_pump_settings.rb', line 216

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



210
211
212
 
# File 'lib/oci/database_migration/models/data_pump_settings.rb', line 210

def to_s
  to_hash.to_s
end