Class: OCI::DataIntegration::Models::ReferenceSummary

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

Overview

This is the reference summary information.

Constant Summary collapse

TYPE_ENUM =
[
  TYPE_ORACLE_DATA_ASSET = 'ORACLE_DATA_ASSET'.freeze,
  TYPE_ORACLE_OBJECT_STORAGE_DATA_ASSET = 'ORACLE_OBJECT_STORAGE_DATA_ASSET'.freeze,
  TYPE_ORACLE_ATP_DATA_ASSET = 'ORACLE_ATP_DATA_ASSET'.freeze,
  TYPE_ORACLE_ADWC_DATA_ASSET = 'ORACLE_ADWC_DATA_ASSET'.freeze,
  TYPE_MYSQL_DATA_ASSET = 'MYSQL_DATA_ASSET'.freeze,
  TYPE_GENERIC_JDBC_DATA_ASSET = 'GENERIC_JDBC_DATA_ASSET'.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 = {}) ⇒ ReferenceSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



113
114
115
116
117
118
119
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
156
157
158
# File 'lib/oci/data_integration/models/reference_summary.rb', line 113

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

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

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

  self.identifier_path = attributes[:'identifierPath'] if attributes[:'identifierPath']

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

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

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

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

  self.target_object = attributes[:'targetObject'] if attributes[:'targetObject']

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

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

  self.aggregator_key = attributes[:'aggregatorKey'] if attributes[:'aggregatorKey']

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

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

  self.used_by = attributes[:'usedBy'] if attributes[:'usedBy']

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

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

  self.child_references = attributes[:'childReferences'] if attributes[:'childReferences']

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

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

Instance Attribute Details

#aggregator_keyString

The aggregator of reference object.

Returns:

  • (String)


51
52
53
# File 'lib/oci/data_integration/models/reference_summary.rb', line 51

def aggregator_key
  @aggregator_key
end

#child_referencesArray<OCI::DataIntegration::Models::ChildReference>

List of references that are dependent on this reference.



59
60
61
# File 'lib/oci/data_integration/models/reference_summary.rb', line 59

def child_references
  @child_references
end

#descriptionString

The description of reference object.

Returns:

  • (String)


39
40
41
# File 'lib/oci/data_integration/models/reference_summary.rb', line 39

def description
  @description
end

#identifierString

The identifier of reference object.

Returns:

  • (String)


31
32
33
# File 'lib/oci/data_integration/models/reference_summary.rb', line 31

def identifier
  @identifier
end

#identifier_pathString

The identifier path of reference object.

Returns:

  • (String)


35
36
37
# File 'lib/oci/data_integration/models/reference_summary.rb', line 35

def identifier_path
  @identifier_path
end

#keyString

The reference's key, key of the object that is being used by a published object or its dependents.

Returns:

  • (String)


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

def key
  @key
end

#nameString

The name of reference object.

Returns:

  • (String)


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

def name
  @name
end

#target_objectObject

The target object referenced. References are made to data assets and child references are made to connections. The type defining this reference is mentioned in the property type.

Returns:

  • (Object)


47
48
49
# File 'lib/oci/data_integration/models/reference_summary.rb', line 47

def target_object
  @target_object
end

#typeString

The type of reference object.

Returns:

  • (String)


43
44
45
# File 'lib/oci/data_integration/models/reference_summary.rb', line 43

def type
  @type
end

#used_byArray<OCI::DataIntegration::Models::ReferenceUsedBy>

List of published objects where this is used.



55
56
57
# File 'lib/oci/data_integration/models/reference_summary.rb', line 55

def used_by
  @used_by
end

Class Method Details

.attribute_mapObject

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/oci/data_integration/models/reference_summary.rb', line 62

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'name': :'name',
    'identifier': :'identifier',
    'identifier_path': :'identifierPath',
    'description': :'description',
    'type': :'type',
    'target_object': :'targetObject',
    'aggregator_key': :'aggregatorKey',
    'used_by': :'usedBy',
    'child_references': :'childReferences'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'name': :'String',
    'identifier': :'String',
    'identifier_path': :'String',
    'description': :'String',
    'type': :'String',
    'target_object': :'Object',
    'aggregator_key': :'String',
    'used_by': :'Array<OCI::DataIntegration::Models::ReferenceUsedBy>',
    'child_references': :'Array<OCI::DataIntegration::Models::ChildReference>'
    # 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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'lib/oci/data_integration/models/reference_summary.rb', line 180

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

  self.class == other.class &&
    key == other.key &&
    name == other.name &&
    identifier == other.identifier &&
    identifier_path == other.identifier_path &&
    description == other.description &&
    type == other.type &&
    target_object == other.target_object &&
    aggregator_key == other.aggregator_key &&
    used_by == other.used_by &&
    child_references == other.child_references
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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
# File 'lib/oci/data_integration/models/reference_summary.rb', line 219

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


199
200
201
# File 'lib/oci/data_integration/models/reference_summary.rb', line 199

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



208
209
210
# File 'lib/oci/data_integration/models/reference_summary.rb', line 208

def hash
  [key, name, identifier, identifier_path, description, type, target_object, aggregator_key, used_by, child_references].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



252
253
254
255
256
257
258
259
260
261
# File 'lib/oci/data_integration/models/reference_summary.rb', line 252

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



246
247
248
# File 'lib/oci/data_integration/models/reference_summary.rb', line 246

def to_s
  to_hash.to_s
end