Class: OCI::DataIntegration::Models::ShapeField

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

Overview

The shape field object.

Constant Summary

Constants inherited from TypedObject

TypedObject::MODEL_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from TypedObject

#config_values, #description, #key, #model_type, #model_version, #name, #object_status, #parent_ref

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from TypedObject

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ ShapeField

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/oci/data_integration/models/shape_field.rb', line 77

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

Instance Attribute Details

#labelsArray<String>

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.

Returns:

  • (Array<String>)


18
19
20
# File 'lib/oci/data_integration/models/shape_field.rb', line 18

def labels
  @labels
end

#native_shape_fieldOCI::DataIntegration::Models::NativeShapeField



21
22
23
# File 'lib/oci/data_integration/models/shape_field.rb', line 21

def native_shape_field
  @native_shape_field
end

#typeObject

The reference to the type.

Returns:

  • (Object)


14
15
16
# File 'lib/oci/data_integration/models/shape_field.rb', line 14

def type
  @type
end

Class Method Details

.attribute_mapObject

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



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# File 'lib/oci/data_integration/models/shape_field.rb', line 24

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

.swagger_typesObject

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/oci/data_integration/models/shape_field.rb', line 43

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'lib/oci/data_integration/models/shape_field.rb', line 105

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# File 'lib/oci/data_integration/models/shape_field.rb', line 145

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


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

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



134
135
136
# File 'lib/oci/data_integration/models/shape_field.rb', line 134

def hash
  [model_type, key, model_version, parent_ref, config_values, object_status, name, description, type, labels, native_shape_field].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



178
179
180
181
182
183
184
185
186
187
# File 'lib/oci/data_integration/models/shape_field.rb', line 178

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



172
173
174
# File 'lib/oci/data_integration/models/shape_field.rb', line 172

def to_s
  to_hash.to_s
end