gudusoft.gsqlparser.lineage.v2.model

Class Identity

Object

gudusoft.gsqlparser.lineage.v2.model.SqllrObject

gudusoft.gsqlparser.lineage.v2.model.Identity

public final class Identity
extends SqllrObject

The identity of an endpoint (Sections 6.3 and 10.6; algorithms/identity-v1.md, Section 4). Generated from the schema definition Identity 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	Identity.Builder Collects the members of a new Identity.

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<Identity>	READER Reads a JSON object as a Identity.
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 Identity.Builder	builder()
static Identity	fromJson(Object json) A Identity with the members of a JSON object, all kept.
String	getAlgorithmId() The member algorithmId.
String	getComparisonDomain() The member comparisonDomain.
String	getId() The member id.
String	getIssuer() The member issuer.
String	getNumericKey() The member numericKey.
String	getPolicyId() The member policyId.
String	getStatus() The member status.
String	getValue() The member value.
static Identity	local() An endpoint whose identity is document-local (Section 3.2, rule 6).
static Identity	opaque(String issuer, String algorithmId, String policyId, String comparisonDomain, String value) An endpoint with an opaque producer-local identity, comparable only within its comparison domain.
static Identity	portable(String id) An endpoint with a portable identity (identity-v1, Section 4): its ep1 id.
Identity.Builder	toBuilder() A builder holding every member of this object.
static Identity	unavailable(String status) An endpoint whose portable identity is unavailable: UNAVAILABLE_COLLATION or UNAVAILABLE_MIXED_PROFILE.

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<Identity> READER

Reads a JSON object as a Identity.

Method Detail

fromJson

public static Identity fromJson(Object json)

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

builder

public static Identity.Builder builder()

toBuilder

public Identity.Builder toBuilder()

A builder holding every member of this object.

getStatus

public String getStatus()

The member status. The status of an endpoint identity. Registry group 'identityStatus' (Section 6.3). Null when absent; throws IllegalStateException when the member holds another JSON type.

getId

public String getId()

The member id. Present when status is PORTABLE (identity stage: ID_MISSING when absent). An id computed by EndpointIdV1: 'ep1-' followed by 64 lowercase hexadecimal characters of a SHA-256 digest (algorithms/identity-v1.md). Null when absent; throws IllegalStateException when the member holds another JSON type.

getNumericKey

public String getNumericKey()

The member numericKey. A 128-bit numeric key (NumericKeyV1): the first 16 bytes of the SHA-256 digest of an id, big-endian, as 32 lowercase hexadecimal characters, which are the first 32 hexadecimal characters of the id (Section 11.5; algorithms/identity-v1.md, Section 5.10). Consumers keep the full id as the authority. Null when absent; throws IllegalStateException when the member holds another JSON type.

getIssuer

public String getIssuer()

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

getAlgorithmId

public String getAlgorithmId()

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

getPolicyId

public String getPolicyId()

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

getComparisonDomain

public String getComparisonDomain()

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

getValue

public String getValue()

The member value. The opaque producer-local identity. Null when absent; throws IllegalStateException when the member holds another JSON type.

portable

public static Identity portable(String id)

An endpoint with a portable identity (identity-v1, Section 4): its ep1 id.

local

public static Identity local()

An endpoint whose identity is document-local (Section 3.2, rule 6).

unavailable

public static Identity unavailable(String status)

An endpoint whose portable identity is unavailable: UNAVAILABLE_COLLATION or UNAVAILABLE_MIXED_PROFILE.

opaque

public static Identity opaque(String issuer,
                              String algorithmId,
                              String policyId,
                              String comparisonDomain,
                              String value)

An endpoint with an opaque producer-local identity, comparable only within its comparison domain.