Class: OCI::DataIntegration::Models::BaseType
- Inherits:
-
Object
- Object
- OCI::DataIntegration::Models::BaseType
- Defined in:
- lib/oci/data_integration/models/base_type.rb
Overview
Base type for the type system. 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
Direct Known Subclasses
ArrayType, CompositeType, ConfiguredType, DataType, DerivedType, DynamicType, JavaType, MapType, MaterializedCompositeType
Constant Summary collapse
- MODEL_TYPE_ENUM =
[ MODEL_TYPE_DYNAMIC_TYPE = 'DYNAMIC_TYPE'.freeze, MODEL_TYPE_STRUCTURED_TYPE = 'STRUCTURED_TYPE'.freeze, MODEL_TYPE_DATA_TYPE = 'DATA_TYPE'.freeze, MODEL_TYPE_JAVA_TYPE = 'JAVA_TYPE'.freeze, MODEL_TYPE_CONFIGURED_TYPE = 'CONFIGURED_TYPE'.freeze, MODEL_TYPE_COMPOSITE_TYPE = 'COMPOSITE_TYPE'.freeze, MODEL_TYPE_DERIVED_TYPE = 'DERIVED_TYPE'.freeze, MODEL_TYPE_ARRAY_TYPE = 'ARRAY_TYPE'.freeze, MODEL_TYPE_MAP_TYPE = 'MAP_TYPE'.freeze, MODEL_TYPE_MATERIALIZED_COMPOSITE_TYPE = 'MATERIALIZED_COMPOSITE_TYPE'.freeze, MODEL_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#description ⇒ String
A user defined description for the object.
-
#key ⇒ String
The key of the object.
-
#model_type ⇒ String
[Required] The property which disciminates the subtypes.
-
#model_version ⇒ String
The model version of an object.
-
#name ⇒ String
Free form text without any restriction on permitted characters.
-
#object_status ⇒ Integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
- #parent_ref ⇒ OCI::DataIntegration::Models::ParentReference
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.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.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ BaseType
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ BaseType
Initializes the object
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/oci/data_integration/models/base_type.rb', line 120 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.model_type = attributes[:'modelType'] if attributes[:'modelType'] raise 'You cannot provide both :modelType and :model_type' if attributes.key?(:'modelType') && attributes.key?(:'model_type') self.model_type = attributes[:'model_type'] if attributes[:'model_type'] self.key = attributes[:'key'] if attributes[:'key'] self.model_version = attributes[:'modelVersion'] if attributes[:'modelVersion'] raise 'You cannot provide both :modelVersion and :model_version' if attributes.key?(:'modelVersion') && attributes.key?(:'model_version') self.model_version = attributes[:'model_version'] if attributes[:'model_version'] self.parent_ref = attributes[:'parentRef'] if attributes[:'parentRef'] raise 'You cannot provide both :parentRef and :parent_ref' if attributes.key?(:'parentRef') && attributes.key?(:'parent_ref') self.parent_ref = attributes[:'parent_ref'] if attributes[:'parent_ref'] self.name = attributes[:'name'] if attributes[:'name'] self.object_status = attributes[:'objectStatus'] if attributes[:'objectStatus'] raise 'You cannot provide both :objectStatus and :object_status' if attributes.key?(:'objectStatus') && attributes.key?(:'object_status') self.object_status = attributes[:'object_status'] if attributes[:'object_status'] self.description = attributes[:'description'] if attributes[:'description'] end |
Instance Attribute Details
#description ⇒ String
A user defined description for the object.
52 53 54 |
# File 'lib/oci/data_integration/models/base_type.rb', line 52 def description @description end |
#key ⇒ String
The key of the object.
33 34 35 |
# File 'lib/oci/data_integration/models/base_type.rb', line 33 def key @key end |
#model_type ⇒ String
[Required] The property which disciminates the subtypes.
29 30 31 |
# File 'lib/oci/data_integration/models/base_type.rb', line 29 def model_type @model_type end |
#model_version ⇒ String
The model version of an object.
37 38 39 |
# File 'lib/oci/data_integration/models/base_type.rb', line 37 def model_version @model_version end |
#name ⇒ String
Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
44 45 46 |
# File 'lib/oci/data_integration/models/base_type.rb', line 44 def name @name end |
#object_status ⇒ Integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
48 49 50 |
# File 'lib/oci/data_integration/models/base_type.rb', line 48 def object_status @object_status end |
#parent_ref ⇒ OCI::DataIntegration::Models::ParentReference
40 41 42 |
# File 'lib/oci/data_integration/models/base_type.rb', line 40 def parent_ref @parent_ref end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
55 56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/oci/data_integration/models/base_type.rb', line 55 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'model_type': :'modelType', 'key': :'key', 'model_version': :'modelVersion', 'parent_ref': :'parentRef', 'name': :'name', 'object_status': :'objectStatus', 'description': :'description' # 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.
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
# File 'lib/oci/data_integration/models/base_type.rb', line 89 def self.get_subtype(object_hash) type = object_hash[:'modelType'] # rubocop:disable Style/SymbolLiteral return 'OCI::DataIntegration::Models::ArrayType' if type == 'ARRAY_TYPE' return 'OCI::DataIntegration::Models::ConfiguredType' if type == 'CONFIGURED_TYPE' return 'OCI::DataIntegration::Models::JavaType' if type == 'JAVA_TYPE' return 'OCI::DataIntegration::Models::DynamicType' if type == 'DYNAMIC_TYPE' return 'OCI::DataIntegration::Models::DerivedType' if type == 'DERIVED_TYPE' return 'OCI::DataIntegration::Models::DataType' if type == 'DATA_TYPE' return 'OCI::DataIntegration::Models::MaterializedCompositeType' if type == 'MATERIALIZED_COMPOSITE_TYPE' return 'OCI::DataIntegration::Models::MapType' if type == 'MAP_TYPE' return 'OCI::DataIntegration::Models::CompositeType' if type == 'COMPOSITE_TYPE' # TODO: Log a warning when the subtype is not found. 'OCI::DataIntegration::Models::BaseType' end |
.swagger_types ⇒ Object
Attribute type mapping.
70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/oci/data_integration/models/base_type.rb', line 70 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'model_type': :'String', 'key': :'String', 'model_version': :'String', 'parent_ref': :'OCI::DataIntegration::Models::ParentReference', 'name': :'String', 'object_status': :'Integer', 'description': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
177 178 179 180 181 182 183 184 185 186 187 188 |
# File 'lib/oci/data_integration/models/base_type.rb', line 177 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 && name == other.name && object_status == other.object_status && description == other.description end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/oci/data_integration/models/base_type.rb', line 213 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
193 194 195 |
# File 'lib/oci/data_integration/models/base_type.rb', line 193 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
202 203 204 |
# File 'lib/oci/data_integration/models/base_type.rb', line 202 def hash [model_type, key, model_version, parent_ref, name, object_status, description].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
246 247 248 249 250 251 252 253 254 255 |
# File 'lib/oci/data_integration/models/base_type.rb', line 246 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
240 241 242 |
# File 'lib/oci/data_integration/models/base_type.rb', line 240 def to_s to_hash.to_s end |