Class: OCI::DataCatalog::Models::FetchEntityLineageDetails

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

Overview

The information needed to obtain desired lineage.

Constant Summary collapse

DIRECTION_ENUM = 
[
  DIRECTION_UPSTREAM = 'UPSTREAM'.freeze,
  DIRECTION_BOTH = 'BOTH'.freeze,
  DIRECTION_DOWNSTREAM = 'DOWNSTREAM'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FetchEntityLineageDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :level (Integer) —

    The value to assign to the #level property

  • :direction (String) —

    The value to assign to the #direction property

  • :is_intra_lineage (BOOLEAN) —

    The value to assign to the #is_intra_lineage property

  • :intra_lineage_object_key (String) —

    The value to assign to the #intra_lineage_object_key property



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

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

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

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

  self.is_intra_lineage = attributes[:'isIntraLineage'] unless attributes[:'isIntraLineage'].nil?
  self.is_intra_lineage = false if is_intra_lineage.nil? && !attributes.key?(:'isIntraLineage') # rubocop:disable Style/StringLiterals

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

  self.is_intra_lineage = attributes[:'is_intra_lineage'] unless attributes[:'is_intra_lineage'].nil?
  self.is_intra_lineage = false if is_intra_lineage.nil? && !attributes.key?(:'isIntraLineage') && !attributes.key?(:'is_intra_lineage') # rubocop:disable Style/StringLiterals

  self.intra_lineage_object_key = attributes[:'intraLineageObjectKey'] if attributes[:'intraLineageObjectKey']

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

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

Instance Attribute Details

#direction ⇒ String

Direction of the lineage returned.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/data_catalog/models/fetch_entity_lineage_details.rb', line 24

def direction
  @direction
end

#intra_lineage_object_key ⇒ String

Unique object key for which intra-lineage needs to be fetched. Only drill-down lineage corresponding to the object whose object key is passed is returned.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/data_catalog/models/fetch_entity_lineage_details.rb', line 36

def intra_lineage_object_key
  @intra_lineage_object_key
end

#is_intra_lineage ⇒ BOOLEAN

Intra-lineages are drill down lineages. This field indicates whether all intra-lineages need to be expanded inline in the lineage returned.

Returns:

  • (BOOLEAN) 


30
31
32
 
# File 'lib/oci/data_catalog/models/fetch_entity_lineage_details.rb', line 30

def is_intra_lineage
  @is_intra_lineage
end

#level ⇒ Integer

Object level at which the lineage is returned.

Returns:

  • (Integer) 


20
21
22
 
# File 'lib/oci/data_catalog/models/fetch_entity_lineage_details.rb', line 20

def level
  @level
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/data_catalog/models/fetch_entity_lineage_details.rb', line 39

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'level': :'level',
    'direction': :'direction',
    'is_intra_lineage': :'isIntraLineage',
    'intra_lineage_object_key': :'intraLineageObjectKey'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/data_catalog/models/fetch_entity_lineage_details.rb', line 51

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'level': :'Integer',
    'direction': :'String',
    'is_intra_lineage': :'BOOLEAN',
    'intra_lineage_object_key': :'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



109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/data_catalog/models/fetch_entity_lineage_details.rb', line 109

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

  self.class == other.class &&
    level == other.level &&
    direction == other.direction &&
    is_intra_lineage == other.is_intra_lineage &&
    intra_lineage_object_key == other.intra_lineage_object_key
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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/data_catalog/models/fetch_entity_lineage_details.rb', line 142

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


122
123
124
 
# File 'lib/oci/data_catalog/models/fetch_entity_lineage_details.rb', line 122

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



131
132
133
 
# File 'lib/oci/data_catalog/models/fetch_entity_lineage_details.rb', line 131

def hash
  [level, direction, is_intra_lineage, intra_lineage_object_key].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/data_catalog/models/fetch_entity_lineage_details.rb', line 175

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

Returns:

  • (String) —

    String presentation of the object



169
170
171
 
# File 'lib/oci/data_catalog/models/fetch_entity_lineage_details.rb', line 169

def to_s
  to_hash.to_s
end