Class: OCI::DataCatalog::Models::ObjectRelationship

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_catalog/models/object_relationship.rb

Overview

Details regarding a specific object and its relationship to the referencing object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ObjectRelationship

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :relationship_type (String)

    The value to assign to the #relationship_type property

  • :key (String)

    The value to assign to the #key property

  • :name (String)

    The value to assign to the #name property

  • :type_name (String)

    The value to assign to the #type_name property

  • :type_key (String)

    The value to assign to the #type_key property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :time_updated (DateTime)

    The value to assign to the #time_updated property

  • :path (String)

    The value to assign to the #path property

  • :parent_key (String)

    The value to assign to the #parent_key property

  • :parent_path (String)

    The value to assign to the #parent_path property



106
107
108
109
110
111
112
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
159
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 106

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

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

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

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

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

  self.type_name = attributes[:'typeName'] if attributes[:'typeName']

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

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

  self.type_key = attributes[:'typeKey'] if attributes[:'typeKey']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

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

  self.parent_key = attributes[:'parentKey'] if attributes[:'parentKey']

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

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

  self.parent_path = attributes[:'parentPath'] if attributes[:'parentPath']

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

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

Instance Attribute Details

#keyString

Unique id of the object.

Returns:

  • (String)


17
18
19
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 17

def key
  @key
end

#nameString

Name of the object.

Returns:

  • (String)


21
22
23
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 21

def name
  @name
end

#parent_keyString

Key of the parent object for the resource.

Returns:

  • (String)


48
49
50
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 48

def parent_key
  @parent_key
end

#parent_pathString

Full path of the parent object.

Returns:

  • (String)


52
53
54
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 52

def parent_path
  @parent_path
end

#pathString

Full path of the object.

Returns:

  • (String)


44
45
46
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 44

def path
  @path
end

#relationship_typeString

Type of relationship with the referencing object.

Returns:

  • (String)


13
14
15
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 13

def relationship_type
  @relationship_type
end

#time_createdDateTime

The date and time the relationship was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Returns:

  • (DateTime)


35
36
37
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 35

def time_created
  @time_created
end

#time_updatedDateTime

The last time a change was made to this reference. An RFC3339 formatted datetime string.

Returns:

  • (DateTime)


40
41
42
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 40

def time_updated
  @time_updated
end

#type_keyString

Type key of the object. Type keys can be found via the '/types' endpoint.

Returns:

  • (String)


29
30
31
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 29

def type_key
  @type_key
end

#type_nameString

Type name of the object. Type names can be found via the '/types' endpoint.

Returns:

  • (String)


25
26
27
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 25

def type_name
  @type_name
end

Class Method Details

.attribute_mapObject

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'relationship_type': :'relationshipType',
    'key': :'key',
    'name': :'name',
    'type_name': :'typeName',
    'type_key': :'typeKey',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'path': :'path',
    'parent_key': :'parentKey',
    'parent_path': :'parentPath'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 73

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'relationship_type': :'String',
    'key': :'String',
    'name': :'String',
    'type_name': :'String',
    'type_key': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'path': :'String',
    'parent_key': :'String',
    'parent_path': :'String'
    # 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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 168

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

  self.class == other.class &&
    relationship_type == other.relationship_type &&
    key == other.key &&
    name == other.name &&
    type_name == other.type_name &&
    type_key == other.type_key &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    path == other.path &&
    parent_key == other.parent_key &&
    parent_path == other.parent_path
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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 207

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


187
188
189
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 187

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



196
197
198
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 196

def hash
  [relationship_type, key, name, type_name, type_key, time_created, time_updated, path, parent_key, parent_path].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



240
241
242
243
244
245
246
247
248
249
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 240

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



234
235
236
# File 'lib/oci/data_catalog/models/object_relationship.rb', line 234

def to_s
  to_hash.to_s
end