Package io.openlineage.client

Class OpenLineage

java.lang.Object

io.openlineage.client.OpenLineage

public final class OpenLineage
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OpenLineage.BaseFacet
static class	OpenLineage.CustomFacet
static interface	OpenLineage.Dataset
static class	OpenLineage.DatasetFacets
static class	OpenLineage.DatasourceDatasetFacet
static class	OpenLineage.DocumentationDatasetFacet
static class	OpenLineage.DocumentationJobFacet
static class	OpenLineage.InputDataset
static class	OpenLineage.InputDatasetInputFacets
static class	OpenLineage.Job
static class	OpenLineage.JobFacets
static class	OpenLineage.NominalTimeRunFacet
static class	OpenLineage.OutputDataset
static class	OpenLineage.OutputDatasetOutputFacets
static class	OpenLineage.ParentRunFacet
static class	OpenLineage.ParentRunFacetJob
static class	OpenLineage.ParentRunFacetRun
static class	OpenLineage.Run
static class	OpenLineage.RunEvent
static class	OpenLineage.RunFacets
static class	OpenLineage.SchemaDatasetFacet
static class	OpenLineage.SchemaDatasetFacetFields
static class	OpenLineage.SourceCodeLocationJobFacet
static class	OpenLineage.SQLJobFacet

Constructor Summary

Constructors

Constructor	Description
OpenLineage(java.net.URI producer)

Method Summary

Modifier and Type	Method	Description
OpenLineage.CustomFacet	newCustomFacet()
OpenLineage.DatasetFacets	newDatasetFacets(OpenLineage.DocumentationDatasetFacet documentation, OpenLineage.SchemaDatasetFacet schema, OpenLineage.DatasourceDatasetFacet dataSource)
OpenLineage.DatasourceDatasetFacet	newDatasourceDatasetFacet(java.lang.String name, java.net.URI uri)
OpenLineage.DocumentationDatasetFacet	newDocumentationDatasetFacet(java.lang.String description)
OpenLineage.DocumentationJobFacet	newDocumentationJobFacet(java.lang.String description)
OpenLineage.InputDataset	newInputDataset(java.lang.String namespace, java.lang.String name, OpenLineage.DatasetFacets facets, OpenLineage.InputDatasetInputFacets inputFacets)
OpenLineage.InputDatasetInputFacets	newInputDatasetInputFacets()
OpenLineage.Job	newJob(java.lang.String namespace, java.lang.String name, OpenLineage.JobFacets facets)
OpenLineage.JobFacets	newJobFacets(OpenLineage.DocumentationJobFacet documentation, OpenLineage.SourceCodeLocationJobFacet sourceCodeLocation, OpenLineage.SQLJobFacet sql)
OpenLineage.NominalTimeRunFacet	newNominalTimeRunFacet(java.time.ZonedDateTime nominalStartTime, java.time.ZonedDateTime nominalEndTime)
OpenLineage.OutputDataset	newOutputDataset(java.lang.String namespace, java.lang.String name, OpenLineage.DatasetFacets facets, OpenLineage.OutputDatasetOutputFacets outputFacets)
OpenLineage.OutputDatasetOutputFacets	newOutputDatasetOutputFacets()
OpenLineage.ParentRunFacet	newParentRunFacet(OpenLineage.ParentRunFacetRun run, OpenLineage.ParentRunFacetJob job)
OpenLineage.ParentRunFacetJob	newParentRunFacetJob(java.lang.String namespace, java.lang.String name)
OpenLineage.ParentRunFacetRun	newParentRunFacetRun(java.lang.String runId)
OpenLineage.Run	newRun(java.lang.String runId, OpenLineage.RunFacets facets)
OpenLineage.RunEvent	newRunEvent(java.lang.String eventType, java.time.ZonedDateTime eventTime, OpenLineage.Run run, OpenLineage.Job job, java.util.List<OpenLineage.InputDataset> inputs, java.util.List<OpenLineage.OutputDataset> outputs)
OpenLineage.RunFacets	newRunFacets(OpenLineage.NominalTimeRunFacet nominalTime, OpenLineage.ParentRunFacet parent)
OpenLineage.SchemaDatasetFacet	newSchemaDatasetFacet(java.util.List<OpenLineage.SchemaDatasetFacetFields> fields)
OpenLineage.SchemaDatasetFacetFields	newSchemaDatasetFacetFields(java.lang.String name, java.lang.String type, java.lang.String description)
OpenLineage.SourceCodeLocationJobFacet	newSourceCodeLocationJobFacet(java.lang.String type, java.net.URI url)
OpenLineage.SQLJobFacet	newSQLJobFacet(java.lang.String query)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenLineage

public OpenLineage(java.net.URI producer)

Method Details

newSourceCodeLocationJobFacet

public OpenLineage.SourceCodeLocationJobFacet newSourceCodeLocationJobFacet(java.lang.String type, java.net.URI url)

Parameters:

type - the type

url - the url

Returns:

SourceCodeLocationJobFacet

newParentRunFacet

public OpenLineage.ParentRunFacet newParentRunFacet(OpenLineage.ParentRunFacetRun run, OpenLineage.ParentRunFacetJob job)

Parameters:

run - the run

job - the job

Returns:

ParentRunFacet

newOutputDatasetOutputFacets

public OpenLineage.OutputDatasetOutputFacets newOutputDatasetOutputFacets()

Returns:

OutputDatasetOutputFacets

newDatasetFacets

public OpenLineage.DatasetFacets newDatasetFacets(OpenLineage.DocumentationDatasetFacet documentation, OpenLineage.SchemaDatasetFacet schema, OpenLineage.DatasourceDatasetFacet dataSource)

Parameters:

documentation - the documentation

schema - the schema

dataSource - the dataSource

Returns:

DatasetFacets

newNominalTimeRunFacet

public OpenLineage.NominalTimeRunFacet newNominalTimeRunFacet(java.time.ZonedDateTime nominalStartTime, java.time.ZonedDateTime nominalEndTime)

Parameters:

nominalStartTime - An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp representing the nominal start time (included) of the run. AKA the schedule time

nominalEndTime - An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp representing the nominal end time (excluded) of the run. (Should be the nominal start time of the next run)

Returns:

NominalTimeRunFacet

newSchemaDatasetFacet

public OpenLineage.SchemaDatasetFacet newSchemaDatasetFacet(java.util.List<OpenLineage.SchemaDatasetFacetFields> fields)

Parameters:

fields - The fields of the table.

Returns:

SchemaDatasetFacet

newSQLJobFacet

public OpenLineage.SQLJobFacet newSQLJobFacet(java.lang.String query)

Parameters:

query - the query

Returns:

SQLJobFacet

newRun

public OpenLineage.Run newRun(java.lang.String runId, OpenLineage.RunFacets facets)

Parameters:

runId - The id of the run, unique relative to the job

facets - The run facets.

Returns:

Run

newCustomFacet

public OpenLineage.CustomFacet newCustomFacet()

Returns:

CustomFacet

newParentRunFacetRun

public OpenLineage.ParentRunFacetRun newParentRunFacetRun(java.lang.String runId)

Parameters:

runId - the runId

Returns:

ParentRunFacetRun

newDatasourceDatasetFacet

public OpenLineage.DatasourceDatasetFacet newDatasourceDatasetFacet(java.lang.String name, java.net.URI uri)

Parameters:

name - the name

uri - the uri

Returns:

DatasourceDatasetFacet

newInputDataset

public OpenLineage.InputDataset newInputDataset(java.lang.String namespace, java.lang.String name, OpenLineage.DatasetFacets facets, OpenLineage.InputDatasetInputFacets inputFacets)

Parameters:

namespace - The namespace containing that dataset

name - The unique name for that dataset within that namespace

facets - The facets for this dataset

inputFacets - The input facets for this dataset.

Returns:

InputDataset

newDocumentationJobFacet

public OpenLineage.DocumentationJobFacet newDocumentationJobFacet(java.lang.String description)

Parameters:

description - The description of the job.

Returns:

DocumentationJobFacet

newOutputDataset

public OpenLineage.OutputDataset newOutputDataset(java.lang.String namespace, java.lang.String name, OpenLineage.DatasetFacets facets, OpenLineage.OutputDatasetOutputFacets outputFacets)

Parameters:

namespace - The namespace containing that dataset

name - The unique name for that dataset within that namespace

facets - The facets for this dataset

outputFacets - The output facets for this dataset

Returns:

OutputDataset

newRunFacets

public OpenLineage.RunFacets newRunFacets(OpenLineage.NominalTimeRunFacet nominalTime, OpenLineage.ParentRunFacet parent)

Parameters:

nominalTime - the nominalTime

parent - the parent

Returns:

RunFacets

newJobFacets

public OpenLineage.JobFacets newJobFacets(OpenLineage.DocumentationJobFacet documentation, OpenLineage.SourceCodeLocationJobFacet sourceCodeLocation, OpenLineage.SQLJobFacet sql)

Parameters:

documentation - the documentation

sourceCodeLocation - the sourceCodeLocation

sql - the sql

Returns:

JobFacets

newJob

public OpenLineage.Job newJob(java.lang.String namespace, java.lang.String name, OpenLineage.JobFacets facets)

Parameters:

namespace - The namespace containing that job

name - The unique name for that job within that namespace

facets - The job facets.

Returns:

Job

newRunEvent

public OpenLineage.RunEvent newRunEvent(java.lang.String eventType, java.time.ZonedDateTime eventTime, OpenLineage.Run run, OpenLineage.Job job, java.util.List<OpenLineage.InputDataset> inputs, java.util.List<OpenLineage.OutputDataset> outputs)

Parameters:

eventType - the current transition of the run state. It is required to issue 1 START event and 1 of [ COMPLETE, ABORT, FAIL ] event per run. Additional events with OTHER eventType can be added to the same run. For example to send additional metadata after the run is complete

eventTime - the time the event occured at

run - the run

job - the job

inputs - The set of **input** datasets.

outputs - The set of **output** datasets.

Returns:

RunEvent

newParentRunFacetJob

public OpenLineage.ParentRunFacetJob newParentRunFacetJob(java.lang.String namespace, java.lang.String name)

Parameters:

namespace - The namespace containing that job

name - The unique name for that job within that namespace

Returns:

ParentRunFacetJob

newDocumentationDatasetFacet

public OpenLineage.DocumentationDatasetFacet newDocumentationDatasetFacet(java.lang.String description)

Parameters:

description - The description of the dataset.

Returns:

DocumentationDatasetFacet

newSchemaDatasetFacetFields

public OpenLineage.SchemaDatasetFacetFields newSchemaDatasetFacetFields(java.lang.String name, java.lang.String type, java.lang.String description)

Parameters:

name - The name of the field.

type - The type of the field.

description - The description of the field.

Returns:

SchemaDatasetFacetFields

newInputDatasetInputFacets

public OpenLineage.InputDatasetInputFacets newInputDatasetInputFacets()

Returns:

InputDatasetInputFacets