io.datahubproject.openapi.generated

Class SchemaField

java.lang.Object

io.datahubproject.openapi.generated.SchemaField

@Validated
 @Generated(value="io.swagger.codegen.v3.generators.java.SpringCodegen",
           date="2022-09-21T05:34:26.783Z[Etc/UTC]")
public class SchemaField
extends java.lang.Object

SchemaField to describe metadata related to dataset schema.

Constructor Summary

Constructors

Constructor and Description
SchemaField()

Method Summary

Modifier and Type	Method and Description
SchemaField	created(AuditStamp created)
SchemaField	description(java.lang.String description)
boolean	equals(java.lang.Object o)
SchemaField	fieldPath(java.lang.String fieldPath)
@Valid AuditStamp	getCreated() Get created
java.lang.String	getDescription() Description
@NotNull java.lang.String	getFieldPath() Flattened name of the field.
@Valid GlobalTags	getGlobalTags() Get globalTags
@Valid GlossaryTerms	getGlossaryTerms() Get glossaryTerms
java.lang.String	getJsonPath() Flattened name of a field in JSON Path notation.
java.lang.String	getJsonProps() For schema fields that have other properties that are not modeled explicitly, use this field to serialize those properties into a JSON string
java.lang.String	getLabel() Label of the field.
@Valid AuditStamp	getLastModified() Get lastModified
@NotNull java.lang.String	getNativeDataType() The native type of the field in the dataset's platform as declared by platform schema.
@NotNull @Valid SchemaFieldDataType	getType() Get type
SchemaField	globalTags(GlobalTags globalTags)
SchemaField	glossaryTerms(GlossaryTerms glossaryTerms)
int	hashCode()
java.lang.Boolean	isIsPartitioningKey() For Datasets which are partitioned, this determines the partitioning key.
@NotNull java.lang.Boolean	isIsPartOfKey() For schema fields that are part of complex keys, set this field to true We do this to easily distinguish between value and key fields
@NotNull java.lang.Boolean	isNullable() Indicates if this field is optional or nullable
SchemaField	isPartitioningKey(java.lang.Boolean isPartitioningKey)
SchemaField	isPartOfKey(java.lang.Boolean isPartOfKey)
@NotNull java.lang.Boolean	isRecursive() There are use cases when a field in type B references type A.
SchemaField	jsonPath(java.lang.String jsonPath)
SchemaField	jsonProps(java.lang.String jsonProps)
SchemaField	label(java.lang.String label)
SchemaField	lastModified(AuditStamp lastModified)
SchemaField	nativeDataType(java.lang.String nativeDataType)
SchemaField	nullable(java.lang.Boolean nullable)
SchemaField	recursive(java.lang.Boolean recursive)
void	setCreated(AuditStamp created)
void	setDescription(java.lang.String description)
void	setFieldPath(java.lang.String fieldPath)
void	setGlobalTags(GlobalTags globalTags)
void	setGlossaryTerms(GlossaryTerms glossaryTerms)
void	setIsPartitioningKey(java.lang.Boolean isPartitioningKey)
void	setIsPartOfKey(java.lang.Boolean isPartOfKey)
void	setJsonPath(java.lang.String jsonPath)
void	setJsonProps(java.lang.String jsonProps)
void	setLabel(java.lang.String label)
void	setLastModified(AuditStamp lastModified)
void	setNativeDataType(java.lang.String nativeDataType)
void	setNullable(java.lang.Boolean nullable)
void	setRecursive(java.lang.Boolean recursive)
void	setType(SchemaFieldDataType type)
java.lang.String	toString()
SchemaField	type(SchemaFieldDataType type)

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaField

public SchemaField()

Method Detail

fieldPath

public SchemaField fieldPath(java.lang.String fieldPath)

getFieldPath

@NotNull
public @NotNull java.lang.String getFieldPath()

Flattened name of the field. Field is computed from jsonPath field.

Returns:

fieldPath

setFieldPath

public void setFieldPath(java.lang.String fieldPath)

jsonPath

public SchemaField jsonPath(java.lang.String jsonPath)

getJsonPath

public java.lang.String getJsonPath()

Flattened name of a field in JSON Path notation.

Returns:

jsonPath

setJsonPath

public void setJsonPath(java.lang.String jsonPath)

nullable

public SchemaField nullable(java.lang.Boolean nullable)

isNullable

@NotNull
public @NotNull java.lang.Boolean isNullable()

Indicates if this field is optional or nullable

Returns:

nullable

setNullable

public void setNullable(java.lang.Boolean nullable)

description

public SchemaField description(java.lang.String description)

getDescription

public java.lang.String getDescription()

Description

Returns:

description

setDescription

public void setDescription(java.lang.String description)

label

public SchemaField label(java.lang.String label)

getLabel

public java.lang.String getLabel()

Label of the field. Provides a more human-readable name for the field than field path. Some sources will provide this metadata but not all sources have the concept of a label. If just one string is associated with a field in a source, that is most likely a description.

Returns:

label

setLabel

public void setLabel(java.lang.String label)

created

public SchemaField created(AuditStamp created)

getCreated

@Valid
public @Valid AuditStamp getCreated()

Get created

Returns:

created

setCreated

public void setCreated(AuditStamp created)

lastModified

public SchemaField lastModified(AuditStamp lastModified)

getLastModified

@Valid
public @Valid AuditStamp getLastModified()

Get lastModified

Returns:

lastModified

setLastModified

public void setLastModified(AuditStamp lastModified)

type

public SchemaField type(SchemaFieldDataType type)

getType

@NotNull
 @Valid
public @NotNull @Valid SchemaFieldDataType getType()

Get type

Returns:

type

setType

public void setType(SchemaFieldDataType type)

nativeDataType

public SchemaField nativeDataType(java.lang.String nativeDataType)

getNativeDataType

@NotNull
public @NotNull java.lang.String getNativeDataType()

The native type of the field in the dataset's platform as declared by platform schema.

Returns:

nativeDataType

setNativeDataType

public void setNativeDataType(java.lang.String nativeDataType)

recursive

public SchemaField recursive(java.lang.Boolean recursive)

isRecursive

@NotNull
public @NotNull java.lang.Boolean isRecursive()

There are use cases when a field in type B references type A. A field in A references field of type B. In such cases, we will mark the first field as recursive.

Returns:

recursive

setRecursive

public void setRecursive(java.lang.Boolean recursive)

globalTags

public SchemaField globalTags(GlobalTags globalTags)

getGlobalTags

@Valid
public @Valid GlobalTags getGlobalTags()

Get globalTags

Returns:

globalTags

setGlobalTags

public void setGlobalTags(GlobalTags globalTags)

glossaryTerms

public SchemaField glossaryTerms(GlossaryTerms glossaryTerms)

getGlossaryTerms

@Valid
public @Valid GlossaryTerms getGlossaryTerms()

Get glossaryTerms

Returns:

glossaryTerms

setGlossaryTerms

public void setGlossaryTerms(GlossaryTerms glossaryTerms)

isPartOfKey

public SchemaField isPartOfKey(java.lang.Boolean isPartOfKey)

isIsPartOfKey

@NotNull
public @NotNull java.lang.Boolean isIsPartOfKey()

For schema fields that are part of complex keys, set this field to true We do this to easily distinguish between value and key fields

Returns:

isPartOfKey

setIsPartOfKey

public void setIsPartOfKey(java.lang.Boolean isPartOfKey)

isPartitioningKey

public SchemaField isPartitioningKey(java.lang.Boolean isPartitioningKey)

isIsPartitioningKey

public java.lang.Boolean isIsPartitioningKey()

For Datasets which are partitioned, this determines the partitioning key.

Returns:

isPartitioningKey

setIsPartitioningKey

public void setIsPartitioningKey(java.lang.Boolean isPartitioningKey)

jsonProps

public SchemaField jsonProps(java.lang.String jsonProps)

getJsonProps

public java.lang.String getJsonProps()

For schema fields that have other properties that are not modeled explicitly, use this field to serialize those properties into a JSON string

Returns:

jsonProps

setJsonProps

public void setJsonProps(java.lang.String jsonProps)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object