Class: OCI::DataIntegration::Models::DataFormat

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_integration/models/data_format.rb

Overview

The data format object.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_XML = 'XML'.freeze,
  TYPE_JSON = 'JSON'.freeze,
  TYPE_CSV = 'CSV'.freeze,
  TYPE_ORC = 'ORC'.freeze,
  TYPE_PARQUET = 'PARQUET'.freeze,
  TYPE_AVRO = 'AVRO'.freeze,
  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 = {}) ⇒ DataFormat

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/data_integration/models/data_format.rb', line 63

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

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

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

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

  self.compression_config = attributes[:'compressionConfig'] if attributes[:'compressionConfig']

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

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

Instance Attribute Details

#compression_config ⇒ OCI::DataIntegration::Models::Compression

Returns:



30
31
32
 
# File 'lib/oci/data_integration/models/data_format.rb', line 30

def compression_config
  @compression_config
end

#format_attribute ⇒ OCI::DataIntegration::Models::AbstractFormatAttribute

Returns:



23
24
25
 
# File 'lib/oci/data_integration/models/data_format.rb', line 23

def format_attribute
  @format_attribute
end

#type ⇒ String

type

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/data_integration/models/data_format.rb', line 27

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/oci/data_integration/models/data_format.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'format_attribute': :'formatAttribute',
    'type': :'type',
    'compression_config': :'compressionConfig'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/data_integration/models/data_format.rb', line 44

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'format_attribute': :'OCI::DataIntegration::Models::AbstractFormatAttribute',
    'type': :'String',
    'compression_config': :'OCI::DataIntegration::Models::Compression'
    # 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



104
105
106
107
108
109
110
111
 
# File 'lib/oci/data_integration/models/data_format.rb', line 104

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

  self.class == other.class &&
    format_attribute == other.format_attribute &&
    type == other.type &&
    compression_config == other.compression_config
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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/data_integration/models/data_format.rb', line 136

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


116
117
118
 
# File 'lib/oci/data_integration/models/data_format.rb', line 116

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



125
126
127
 
# File 'lib/oci/data_integration/models/data_format.rb', line 125

def hash
  [format_attribute, type, compression_config].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/data_integration/models/data_format.rb', line 169

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



163
164
165
 
# File 'lib/oci/data_integration/models/data_format.rb', line 163

def to_s
  to_hash.to_s
end