io.datahubproject.openapi.generated

Class SchemaMetadata

java.lang.Object

io.datahubproject.openapi.generated.SchemaMetadata

All Implemented Interfaces:

OneOfDatasetSnapshotAspectsItems, OneOfEnvelopedAspectValue, OneOfGenericAspectValue, OneOfVersionedAspectAspect

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

SchemaMetadata to describe metadata related to store schema

Constructor Summary

Constructors

Constructor and Description
SchemaMetadata()

Method Summary

Modifier and Type	Method and Description
SchemaMetadata	addFieldsItem(SchemaField fieldsItem)
SchemaMetadata	addForeignKeysItem(ForeignKeyConstraint foreignKeysItem)
SchemaMetadata	addPrimaryKeysItem(java.lang.String primaryKeysItem)
SchemaMetadata	cluster(java.lang.String cluster)
SchemaMetadata	created(AuditStamp created)
SchemaMetadata	dataset(java.lang.String dataset)
SchemaMetadata	deleted(AuditStamp deleted)
boolean	equals(java.lang.Object o)
SchemaMetadata	fields(java.util.List<SchemaField> fields)
SchemaMetadata	foreignKeys(java.util.List<ForeignKeyConstraint> foreignKeys)
SchemaMetadata	foreignKeysSpecs(java.util.Map<java.lang.String,ForeignKeySpec> foreignKeysSpecs)
@NotNull java.lang.String	get__type() Name of this subclass in SimpleClassName format
java.lang.String	getCluster() The cluster this schema metadata resides from
@NotNull @Valid AuditStamp	getCreated() Get created
java.lang.String	getDataset() Dataset this schema metadata is associated with.
@Valid AuditStamp	getDeleted() Get deleted
@NotNull @Valid java.util.List<SchemaField>	getFields() Client provided a list of fields from document schema.
@Valid java.util.List<ForeignKeyConstraint>	getForeignKeys() List of foreign key constraints for the schema
@Valid java.util.Map<java.lang.String,ForeignKeySpec>	getForeignKeysSpecs() Map captures all the references schema makes to external datasets.
@NotNull java.lang.String	getHash() the SHA1 hash of the schema content
@NotNull @Valid AuditStamp	getLastModified() Get lastModified
@NotNull java.lang.String	getPlatform() Standardized platform urn where schema is defined.
@NotNull OneOfSchemaMetadataPlatformSchema	getPlatformSchema() The native schema in the dataset's platform.
java.util.List<java.lang.String>	getPrimaryKeys() Client provided list of fields that define primary keys to access record.
@NotNull java.lang.String	getSchemaName() Schema name e.g.
@NotNull @Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getVersion() Every change to SchemaMetadata in the resource results in a new version.
SchemaMetadata	hash(java.lang.String hash)
int	hashCode()
SchemaMetadata	lastModified(AuditStamp lastModified)
SchemaMetadata	platform(java.lang.String platform)
SchemaMetadata	platformSchema(OneOfSchemaMetadataPlatformSchema platformSchema)
SchemaMetadata	primaryKeys(java.util.List<java.lang.String> primaryKeys)
SchemaMetadata	putForeignKeysSpecsItem(java.lang.String key, ForeignKeySpec foreignKeysSpecsItem)
SchemaMetadata	schemaName(java.lang.String schemaName)
void	setCluster(java.lang.String cluster)
void	setCreated(AuditStamp created)
void	setDataset(java.lang.String dataset)
void	setDeleted(AuditStamp deleted)
void	setFields(java.util.List<SchemaField> fields)
void	setForeignKeys(java.util.List<ForeignKeyConstraint> foreignKeys)
void	setForeignKeysSpecs(java.util.Map<java.lang.String,ForeignKeySpec> foreignKeysSpecs)
void	setHash(java.lang.String hash)
void	setLastModified(AuditStamp lastModified)
void	setPlatform(java.lang.String platform)
void	setPlatformSchema(OneOfSchemaMetadataPlatformSchema platformSchema)
void	setPrimaryKeys(java.util.List<java.lang.String> primaryKeys)
void	setSchemaName(java.lang.String schemaName)
void	setVersion(java.lang.Long version)
java.lang.String	toString()
SchemaMetadata	version(java.lang.Long version)

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaMetadata

public SchemaMetadata()

Method Detail

get__type

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

Name of this subclass in SimpleClassName format

Returns:

__type

schemaName

public SchemaMetadata schemaName(java.lang.String schemaName)

getSchemaName

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

Schema name e.g. PageViewEvent, identity.Profile, ams.account_management_tracking

Returns:

schemaName

setSchemaName

public void setSchemaName(java.lang.String schemaName)

platform

public SchemaMetadata platform(java.lang.String platform)

getPlatform

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

Standardized platform urn where schema is defined. The data platform Urn (urn:li:platform:{platform_name})

Returns:

platform

setPlatform

public void setPlatform(java.lang.String platform)

version

public SchemaMetadata version(java.lang.Long version)

getVersion

@NotNull
 @Min(value=-9223372036854775808L)
 @Max(value=9223372036854775807L)
public @NotNull @Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long getVersion()

Every change to SchemaMetadata in the resource results in a new version. Version is server assigned. This version is differ from platform native schema version. minimum: -9223372036854775808 maximum: 9223372036854775807

Returns:

version

setVersion

public void setVersion(java.lang.Long version)

created

public SchemaMetadata created(AuditStamp created)

getCreated

@NotNull
 @Valid
public @NotNull @Valid AuditStamp getCreated()

Get created

Returns:

created

setCreated

public void setCreated(AuditStamp created)

lastModified

public SchemaMetadata lastModified(AuditStamp lastModified)

getLastModified

@NotNull
 @Valid
public @NotNull @Valid AuditStamp getLastModified()

Get lastModified

Returns:

lastModified

setLastModified

public void setLastModified(AuditStamp lastModified)

deleted

public SchemaMetadata deleted(AuditStamp deleted)

getDeleted

@Valid
public @Valid AuditStamp getDeleted()

Get deleted

Returns:

deleted

setDeleted

public void setDeleted(AuditStamp deleted)

dataset

public SchemaMetadata dataset(java.lang.String dataset)

getDataset

public java.lang.String getDataset()

Dataset this schema metadata is associated with.

Returns:

dataset

setDataset

public void setDataset(java.lang.String dataset)

cluster

public SchemaMetadata cluster(java.lang.String cluster)

getCluster

public java.lang.String getCluster()

The cluster this schema metadata resides from

Returns:

cluster

setCluster

public void setCluster(java.lang.String cluster)

hash

public SchemaMetadata hash(java.lang.String hash)

getHash

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

the SHA1 hash of the schema content

Returns:

hash

setHash

public void setHash(java.lang.String hash)

platformSchema

public SchemaMetadata platformSchema(OneOfSchemaMetadataPlatformSchema platformSchema)

getPlatformSchema

@NotNull
public @NotNull OneOfSchemaMetadataPlatformSchema getPlatformSchema()

The native schema in the dataset's platform.

Returns:

platformSchema

setPlatformSchema

public void setPlatformSchema(OneOfSchemaMetadataPlatformSchema platformSchema)

fields

public SchemaMetadata fields(java.util.List<SchemaField> fields)

addFieldsItem

public SchemaMetadata addFieldsItem(SchemaField fieldsItem)

getFields

@NotNull
 @Valid
public @NotNull @Valid java.util.List<SchemaField> getFields()

Client provided a list of fields from document schema.

Returns:

fields

setFields

public void setFields(java.util.List<SchemaField> fields)

primaryKeys

public SchemaMetadata primaryKeys(java.util.List<java.lang.String> primaryKeys)

addPrimaryKeysItem

public SchemaMetadata addPrimaryKeysItem(java.lang.String primaryKeysItem)

getPrimaryKeys

public java.util.List<java.lang.String> getPrimaryKeys()

Client provided list of fields that define primary keys to access record. Field order defines hierarchical espresso keys. Empty lists indicates absence of primary key access patter. Value is a SchemaField@fieldPath.

Returns:

primaryKeys

setPrimaryKeys

public void setPrimaryKeys(java.util.List<java.lang.String> primaryKeys)

foreignKeysSpecs

public SchemaMetadata foreignKeysSpecs(java.util.Map<java.lang.String,ForeignKeySpec> foreignKeysSpecs)

putForeignKeysSpecsItem

public SchemaMetadata putForeignKeysSpecsItem(java.lang.String key,
                                              ForeignKeySpec foreignKeysSpecsItem)

getForeignKeysSpecs

@Valid
public @Valid java.util.Map<java.lang.String,ForeignKeySpec> getForeignKeysSpecs()

Map captures all the references schema makes to external datasets. Map key is ForeignKeySpecName typeref.

Returns:

foreignKeysSpecs

setForeignKeysSpecs

public void setForeignKeysSpecs(java.util.Map<java.lang.String,ForeignKeySpec> foreignKeysSpecs)

foreignKeys

public SchemaMetadata foreignKeys(java.util.List<ForeignKeyConstraint> foreignKeys)

addForeignKeysItem

public SchemaMetadata addForeignKeysItem(ForeignKeyConstraint foreignKeysItem)

getForeignKeys

@Valid
public @Valid java.util.List<ForeignKeyConstraint> getForeignKeys()

List of foreign key constraints for the schema

Returns:

foreignKeys

setForeignKeys

public void setForeignKeys(java.util.List<ForeignKeyConstraint> foreignKeys)

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