gudusoft.gsqlparser.lineage.v2.model

Class Endpoint

Object

gudusoft.gsqlparser.lineage.v2.model.SqllrObject

gudusoft.gsqlparser.lineage.v2.model.Endpoint

public final class Endpoint
extends SqllrObject

A nameable persistent asset, a ROW_SET, or a document-local result (Sections 3.1, 6.3 and 9.1). The kind is an observation; EndpointIdV1 frames its identity class (registry group endpointIdentityClasses, through the attribute identityClass of group endpointKinds). Generated from the schema definition Endpoint 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	Endpoint.Builder Collects the members of a new Endpoint.

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<Endpoint>	READER Reads a JSON object as a Endpoint.
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 Endpoint.Builder	builder()
static Endpoint	fromJson(Object json) A Endpoint with the members of a JSON object, all kept.
String	getDisplayName() The member displayName.
String	getDisplayPath() The member displayPath.
Map<String,Extension>	getExtensions() The member extensions.
Long	getGeneration() The member generation.
Identity	getIdentity() The member identity.
String	getKind() The member kind.
Name	getName() The member name.
Long	getOrdinal() The member ordinal.
Long	getOwnerRef() The member ownerRef.
List<PathSegment>	getPathSegments() The member pathSegments.
Long	getRef() The member ref.
Long	getResolvesToRef() The member resolvesToRef.
String	getRoutineKind() The member routineKind.
String	getRoutineNamespace() The member routineNamespace.
Long	getScopeRef() The member scopeRef.
Signature	getSignature() The member signature.
Long	getStatementRef() The member statementRef.
Endpoint.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<Endpoint> READER

Reads a JSON object as a Endpoint.

Method Detail

fromJson

public static Endpoint fromJson(Object json)

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

builder

public static Endpoint.Builder builder()

toBuilder

public Endpoint.Builder toBuilder()

A builder holding every member of this object.

getRef

public Long getRef()

The member ref. A document-local reference: an integer that is unique across the whole document (one reference space for every object that carries a ref). Local references are assigned after merging and have no meaning outside the document (Sections 6.1 and 13). Null when absent; throws IllegalStateException when the member holds another JSON type.

getKind

public String getKind()

The member kind. The kind of an endpoint. Registry group 'endpointKinds' (Sections 3.1, 7.4, 9.1 and 11.1). Null when absent; throws IllegalStateException when the member holds another JSON type.

getName

public Name getName()

The member name. Null when absent; throws IllegalStateException when the member holds another JSON type.

getOwnerRef

public Long getOwnerRef()

The member ownerRef. The owner endpoint of a FIELD or ROW_SET, or the STAGE of a STORAGE_LOCATION. A document-local reference: an integer that is unique across the whole document (one reference space for every object that carries a ref). Local references are assigned after merging and have no meaning outside the document (Sections 6.1 and 13). Null when absent; throws IllegalStateException when the member holds another JSON type.

getStatementRef

public Long getStatementRef()

The member statementRef. The statement whose top-level result a QUERY_RESULT is, or the statement that defines a LOCAL ROUTINE (Section 7.3). A document-local reference: an integer that is unique across the whole document (one reference space for every object that carries a ref). Local references are assigned after merging and have no meaning outside the document (Sections 6.1 and 13). Null when absent; throws IllegalStateException when the member holds another JSON type.

getScopeRef

public Long getScopeRef()

The member scopeRef. The scope that bounds the lifetime of a local endpoint (TEMP_TABLE, TABLE_VARIABLE, CTE, VARIABLE, PARAMETER). A document-local reference: an integer that is unique across the whole document (one reference space for every object that carries a ref). Local references are assigned after merging and have no meaning outside the document (Sections 6.1 and 13). Null when absent; throws IllegalStateException when the member holds another JSON type.

getGeneration

public Long getGeneration()

The member generation. The creation generation of a TEMP_TABLE within its scope; re-creating it after DROP gives a new generation. A 0-based ordinal. Null when absent; throws IllegalStateException when the member holds another JSON type.

getOrdinal

public Long getOrdinal()

The member ordinal. The 0-based select-list position of a FIELD owned by a QUERY_RESULT. A 0-based ordinal. Null when absent; throws IllegalStateException when the member holds another JSON type.

getResolvesToRef

public Long getResolvesToRef()

The member resolvesToRef. For a name as written through a synonym, linked server or database link: the resolved object, when the mapping is known. Absent when it is unknown; the chain is then not connected (Section 9.1). A document-local reference: an integer that is unique across the whole document (one reference space for every object that carries a ref). Local references are assigned after merging and have no meaning outside the document (Sections 6.1 and 13). Null when absent; throws IllegalStateException when the member holds another JSON type.

getIdentity

public Identity getIdentity()

The member identity. Null when absent; throws IllegalStateException when the member holds another JSON type.

getDisplayName

public String getDisplayName()

The member displayName. Display only; never identity. Null when absent; throws IllegalStateException when the member holds another JSON type.

getPathSegments

public List<PathSegment> getPathSegments()

The member pathSegments. Nested field path below the owner FIELD. Module nested-fields. Null when absent; throws IllegalStateException when the member holds another JSON type.

getDisplayPath

public String getDisplayPath()

The member displayPath. Display only. Module nested-fields. Null when absent; throws IllegalStateException when the member holds another JSON type.

getRoutineNamespace

public String getRoutineNamespace()

The member routineNamespace. ROUTINE only. Module routines. The namespace of a routine identity. Registry group 'routineNamespaces' (Section 7.3). Null when absent; throws IllegalStateException when the member holds another JSON type.

getRoutineKind

public String getRoutineKind()

The member routineKind. ROUTINE only. Module routines. The kind of a routine. Registry group 'routineKinds' (Section 7.3). Null when absent; throws IllegalStateException when the member holds another JSON type.

getSignature

public Signature getSignature()

The member signature. ROUTINE only; absent while the overload is not proven. Module routines. 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.