hera/io.dataos.hera.client.models

Package-level declarations

Types

data class Action(val namespace: String, val name: String, val type: Action.Type? = null, val facets: ActionFacet? = null)

Represents an action.

ActionFacet

data class ActionFacet(val documentation: DocumentationActionFacet? = null, val sourceCodeLocation: SourceCodeLocationActionFacet? = null, val sql: SQLActionFacet? = null)

Represents the facets associated with an action.

ActionId

data class ActionId(val namespace: NamespaceName? = null, val name: ActionName? = null)

Represents the ID of an action.

ActionLink

data class ActionLink(val namespace: String, val name: String)

Represents a link to an action.

ActionName

data class ActionName(val value: String? = null)

Represents the name of an action.

ActionVersion

data class ActionVersion(val id: ActionVersionId? = null, val name: ActionName? = null, val createdAt: Long? = null, val version: Version? = null, val namespace: NamespaceName? = null, val location: String? = null, val context: Map<String, String>? = null, val inputs: Array<DatasetId>? = null, val outputs: Array<DatasetId>? = null, val latestRun: Run? = null)

Represents an action version.

ActionVersionId

data class ActionVersionId(val namespace: NamespaceName? = null, val name: ActionName? = null, val version: UUID? = null)

Represents the ID of an action version.

Dataset

data class Dataset(val namespace: String, val name: String, val facets: DatasetFacets? = null)

Represents a dataset.

DatasetFacets

data class DatasetFacets(val documentation: DocumentationDatasetFacet? = null, val schema: SchemaDatasetFacet? = null, val dataSource: DatasourceDatasetFacet? = null, val description: String? = null, val lifecycleStateChange: LifecycleStateChangeFacet? = null)

Represents the facets associated with a dataset.

DatasetId

data class DatasetId(val namespace: NamespaceName? = null, val name: DatasetName? = null)

Represents the ID of a dataset.

DatasetName

data class DatasetName(val value: String? = null)

Represents the name of a dataset.

DatasetVersion

data class DatasetVersion(val id: DatasetId? = null, val type: DatasetVersion.Type? = null, val name: DatasetName? = null, val physicalName: DatasetName? = null, val createdAt: Long? = null, val version: Version? = null, val namespace: NamespaceName? = null, val sourceName: SourceName? = null, val fields: Array<Field>? = null, val tags: Array<TagName>? = null, val lifecycleState: String? = null, val description: String? = null, val createdByRun: Run? = null, val facets: Map<String, Any>? = null)

Represents a dataset version.

DatasetVersionId

data class DatasetVersionId(val namespace: NamespaceName? = null, val name: DatasetName? = null, val version: UUID? = null)

Represents the ID of a dataset version.

DatasourceDatasetFacet

data class DatasourceDatasetFacet(val getProducer: String, val getSchemaURL: String, val name: String? = null, val uri: String? = null)

Represents the data source facet of a dataset.

DocumentationActionFacet

data class DocumentationActionFacet(val getProducer: String, val getSchemaURL: String, val description: String)

Represents the documentation facet of an action.

DocumentationDatasetFacet

data class DocumentationDatasetFacet(val getProducer: String, val getSchemaURL: String, val description: String)

Represents the documentation facet of a dataset.

Edge

data class Edge(val origin: NodeId? = null, val destination: NodeId? = null)

Represents an edge between two nodes.

EntityTag

data class EntityTag(val value: String? = null, val weak: Boolean? = null)

Represents an entity tag.

Field

data class Field(val value: String? = null, val type: String? = null, val tags: Array<TagName>? = null, val description: String? = null)

Represents a field.

LifecycleStateChangeFacet

data class LifecycleStateChangeFacet(val getProducer: String, val getSchemaURL: String, val lifecycleStateChange: String? = null)

Represents the lifecycle state change facet of a dataset.

Lineage

data class Lineage(val graph: Array<Node>? = null)

Represents a lineage graph.

LineageEvent

data class LineageEvent(val eventType: String? = null, val eventTime: LocalDateTime, val run: Run, val action: Action, val inputs: Array<Dataset>? = null, val outputs: Array<Dataset>? = null, val producer: String)

Represents a lineage event.

Namespace

data class Namespace(val name: NamespaceName? = null, val createdAt: Long? = null, val updatedAt: Long? = null, val ownerName: OwnerName? = null, val description: String? = null)

Represents a namespace.

NamespaceName

data class NamespaceName(val value: String? = null)

Represents the name of a namespace.

Node

data class Node(val id: NodeId? = null, val type: Node.Type? = null, val data: NodeData? = null, val inEdges: Array<Edge>? = null, val outEdges: Array<Edge>? = null)

Represents a node in a lineage graph.

NodeData

class NodeData

Represents the data associated with a node in a lineage graph.

NodeId

data class NodeId(val value: String? = null)

Represents the ID of a node in a lineage graph.

NominalTimeRunFacet

data class NominalTimeRunFacet(val getProducer: String, val getSchemaURL: String, val nominalStartTime: LocalDateTime, val nominalEndTime: LocalDateTime? = null)

Represents the nominal time facet of a run.

OwnerName

data class OwnerName(val value: String? = null)

Represents the name of an owner.

ParentRunFacet

data class ParentRunFacet(val getProducer: String, val getSchemaURL: String, val run: RunLink, val action: ActionLink)

Represents the parent run facet.

Run

data class Run(val runId: String, val facets: RunFacet? = null)

Represents a run.

RunFacet

data class RunFacet(val nominalTime: NominalTimeRunFacet? = null, val parent: ParentRunFacet? = null)

Represents the facets associated with a run.

RunId

data class RunId(val value: UUID? = null)

Represents the ID of a run.

RunLink

data class RunLink(val runId: String)

Represents a link to a run.

SchemaDatasetFacet

data class SchemaDatasetFacet(val getProducer: String, val getSchemaURL: String, val fields: Array<SchemaField>? = null)

Represents a dataset facet in a schema.

SchemaField

data class SchemaField(val name: String, val type: String? = null, val description: String? = null)

Represents a field in a schema.

SearchFilter

enum SearchFilter : Enum<SearchFilter>

An enum class representing the different types of filters that can be used in a search.

SearchResults

class SearchResults constructor(results: List<SearchResult>)

A class representing the results of a search.

SearchSort

enum SearchSort : Enum<SearchSort>

An enum class representing the different ways that search results can be sorted.

SourceCodeLocationActionFacet

data class SourceCodeLocationActionFacet(val getProducer: String, val getSchemaURL: String, val type: String? = null, val url: String? = null)

Represents a source code location action facet.

SourceName

data class SourceName(val value: String? = null)

Represents a source name.

SQLActionFacet

data class SQLActionFacet(val getProducer: String, val getSchemaURL: String, val query: String)

Represents a SQL action facet.

TagName

data class TagName(val value: String? = null)

Represents a tag name.

Version

data class Version(val value: UUID? = null)

Represents a version number.