gudusoft.gsqlparser.lineage.v2.model

Class Header

Object

gudusoft.gsqlparser.lineage.v2.model.SqllrObject

gudusoft.gsqlparser.lineage.v2.model.Header

public final class Header
extends SqllrObject

The self-describing header (Section 6.2): the producer of this document (for a merged document, the merger), the registry version of its codes and its source embedding. Everything that describes an analysis is in analysisContexts. Generated from the schema definition Header by scripts/sqllr/gen_type_model.py; do not edit.

Since:

4.2.17

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Header.Builder Collects the members of a new Header.

Nested classes/interfaces inherited from class gudusoft.gsqlparser.lineage.v2.model.SqllrObject

SqllrObject.Reader<T>

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	MEMBERS The members the schema defines, in schema order.
static SqllrObject.Reader<Header>	READER Reads a JSON object as a Header.
static List<String>	REQUIRED The members the schema requires.

Fields inherited from class gudusoft.gsqlparser.lineage.v2.model.SqllrObject

ANY, BOOLEAN, INTEGER, JSON_NULL, OBJECT, STRING

Method Summary

Modifier and Type	Method and Description
static Header.Builder	builder()
static Header	fromJson(Object json) A Header with the members of a JSON object, all kept.
String	getCreatedAt() The member createdAt.
Map<String,Extension>	getExtensions() The member extensions.
Producer	getProducer() The member producer.
String	getRegistryVersion() The member registryVersion.
String	getSourceEmbedding() The member sourceEmbedding.
Header.Builder	toBuilder() A builder holding every member of this object.

Methods inherited from class gudusoft.gsqlparser.lineage.v2.model.SqllrObject

anyMember, bool, equals, get, has, hashCode, integer, list, listOf, map, mapOf, members, object, string, toJson, toString, typed

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MEMBERS

public static final List<String> MEMBERS

The members the schema defines, in schema order.

REQUIRED

public static final List<String> REQUIRED

The members the schema requires.

READER

public static final SqllrObject.Reader<Header> READER

Reads a JSON object as a Header.

Method Detail

fromJson

public static Header fromJson(Object json)

A Header with the members of a JSON object, all kept.

builder

public static Header.Builder builder()

toBuilder

public Header.Builder toBuilder()

A builder holding every member of this object.

getProducer

public Producer getProducer()

The member producer. The producer of this document; for a merged document, the merger. The producer of each analysis is in its analysis context. Null when absent; throws IllegalStateException when the member holds another JSON type.

getRegistryVersion

public String getRegistryVersion()

The member registryVersion. The core registry version whose codes the document uses. A consumer that supports an older range reports VERSION_REGISTRY_TOO_NEW, not a data error. Null when absent; throws IllegalStateException when the member holds another JSON type.

getSourceEmbedding

public String getSourceEmbedding()

The member sourceEmbedding. Whether and how source text is embedded. Registry group 'sourceEmbedding' (Section 12.3). Null when absent; throws IllegalStateException when the member holds another JSON type.

getCreatedAt

public String getCreatedAt()

The member createdAt. Creation time. Never part of any semantic digest (Section 5.3). Null when absent; throws IllegalStateException when the member holds another JSON type.

getExtensions

public Map<String,Extension> getExtensions()

The member extensions. Extension data keyed by namespace. Every core object may carry it; it never takes part in a core identity. Null when absent; throws IllegalStateException when the member holds another JSON type.