EntityLineage

class oci.data_catalog.models.EntityLineage(**kwargs)

Bases: object

Lineage for a data entity.

Attributes:

DIRECTION_BOTH

A constant which can be used with the direction property of a EntityLineage.

DIRECTION_DOWNSTREAM

A constant which can be used with the direction property of a EntityLineage.

DIRECTION_UPSTREAM

A constant which can be used with the direction property of a EntityLineage.

annotations

Gets the annotations of this EntityLineage.

direction

[Required] Gets the direction of this EntityLineage.

level

[Required] Gets the level of this EntityLineage.

objects

Gets the objects of this EntityLineage.

relationships

Gets the relationships of this EntityLineage.

Methods:

__init__(**kwargs)

Initializes a new EntityLineage object with values from keyword arguments.

DIRECTION_BOTH = 'BOTH'

A constant which can be used with the direction property of a EntityLineage. This constant has a value of “BOTH”

DIRECTION_DOWNSTREAM = 'DOWNSTREAM'

A constant which can be used with the direction property of a EntityLineage. This constant has a value of “DOWNSTREAM”

DIRECTION_UPSTREAM = 'UPSTREAM'

A constant which can be used with the direction property of a EntityLineage. This constant has a value of “UPSTREAM”

__init__(**kwargs)

Initializes a new EntityLineage object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • level (int) – The value to assign to the level property of this EntityLineage.

  • direction (str) – The value to assign to the direction property of this EntityLineage. Allowed values for this property are: “UPSTREAM”, “BOTH”, “DOWNSTREAM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • objects (list[oci.data_catalog.models.LineageObject]) – The value to assign to the objects property of this EntityLineage.

  • relationships (list[oci.data_catalog.models.LineageRelationship]) – The value to assign to the relationships property of this EntityLineage.

  • annotations (dict(str, dict(str, str))) – The value to assign to the annotations property of this EntityLineage.

property annotations

Gets the annotations of this EntityLineage. A map of maps that contains additional information in explanation of the lineage returned. The map keys are categories of information and the values are maps of annotation names to their corresponding values. Every annotation is contained inside a category. Example: {“annotations”: { “category”: { “key”: “value”}}}

Returns

The annotations of this EntityLineage.

Return type

dict(str, dict(str, str))

property direction

[Required] Gets the direction of this EntityLineage. Direction of the lineage returned.

Allowed values for this property are: “UPSTREAM”, “BOTH”, “DOWNSTREAM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The direction of this EntityLineage.

Return type

str

property level

[Required] Gets the level of this EntityLineage. Object level at which the lineage is returned.

Returns

The level of this EntityLineage.

Return type

int

property objects

Gets the objects of this EntityLineage. Set of objects that are involved in the lineage.

Returns

The objects of this EntityLineage.

Return type

list[oci.data_catalog.models.LineageObject]

property relationships

Gets the relationships of this EntityLineage. Set of relationships between the objects in the ‘objects’ set.

Returns

The relationships of this EntityLineage.

Return type

list[oci.data_catalog.models.LineageRelationship]