class OCI::DataIntegration::Models::ShapeField

The shape field object.

Attributes

labels[RW]

Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. @return [Array<String>]

native_shape_field[RW]

@return [OCI::DataIntegration::Models::NativeShapeField]

type[RW]

The reference to the type. @return [Object]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/data_integration/models/shape_field.rb, line 23
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'key': :'key',
    'model_version': :'modelVersion',
    'parent_ref': :'parentRef',
    'config_values': :'configValues',
    'object_status': :'objectStatus',
    'name': :'name',
    'description': :'description',
    'type': :'type',
    'labels': :'labels',
    'native_shape_field': :'nativeShapeField'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :key The value to assign to the {OCI::DataIntegration::Models::TypedObject#key key} proprety @option attributes [String] :model_version The value to assign to the {OCI::DataIntegration::Models::TypedObject#model_version model_version} proprety @option attributes [OCI::DataIntegration::Models::ParentReference] :parent_ref The value to assign to the {OCI::DataIntegration::Models::TypedObject#parent_ref parent_ref} proprety @option attributes [OCI::DataIntegration::Models::ConfigValues] :config_values The value to assign to the {OCI::DataIntegration::Models::TypedObject#config_values config_values} proprety @option attributes [Integer] :object_status The value to assign to the {OCI::DataIntegration::Models::TypedObject#object_status object_status} proprety @option attributes [String] :name The value to assign to the {OCI::DataIntegration::Models::TypedObject#name name} proprety @option attributes [String] :description The value to assign to the {OCI::DataIntegration::Models::TypedObject#description description} proprety @option attributes [Object] :type The value to assign to the {#type} property @option attributes [Array<String>] :labels The value to assign to the {#labels} property @option attributes [OCI::DataIntegration::Models::NativeShapeField] :native_shape_field The value to assign to the {#native_shape_field} property

# File lib/oci/data_integration/models/shape_field.rb, line 76
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['modelType'] = 'SHAPE_FIELD'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

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

  self.native_shape_field = attributes[:'nativeShapeField'] if attributes[:'nativeShapeField']

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

  self.native_shape_field = attributes[:'native_shape_field'] if attributes[:'native_shape_field']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/data_integration/models/shape_field.rb, line 42
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'key': :'String',
    'model_version': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'config_values': :'OCI::DataIntegration::Models::ConfigValues',
    'object_status': :'Integer',
    'name': :'String',
    'description': :'String',
    'type': :'Object',
    'labels': :'Array<String>',
    'native_shape_field': :'OCI::DataIntegration::Models::NativeShapeField'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/data_integration/models/shape_field.rb, line 104
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    model_type == other.model_type &&
    key == other.key &&
    model_version == other.model_version &&
    parent_ref == other.parent_ref &&
    config_values == other.config_values &&
    object_status == other.object_status &&
    name == other.name &&
    description == other.description &&
    type == other.type &&
    labels == other.labels &&
    native_shape_field == other.native_shape_field
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/data_integration/models/shape_field.rb, line 144
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/data_integration/models/shape_field.rb, line 124
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/data_integration/models/shape_field.rb, line 133
def hash
  [model_type, key, model_version, parent_ref, config_values, object_status, name, description, type, labels, native_shape_field].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/data_integration/models/shape_field.rb, line 177
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/data_integration/models/shape_field.rb, line 171
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/data_integration/models/shape_field.rb, line 194
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end