Package com.atlan.model.contracts

Class DataContractSpec

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.contracts.DataContractSpec

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DCS_V_0_0_2

public class DataContractSpec
extends AtlanObject

Capture the detailed specification of a data contract for an asset.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DataContractSpec.Announcement
static final class	DataContractSpec.Certification
static class	DataContractSpec.DataContractSpecBuilder<C extends DataContractSpec,B extends DataContractSpec.DataContractSpecBuilder<C,B>>
static final class	DataContractSpec.DCColumn
static final class	DataContractSpec.DCTag
static final class	DataContractSpec.Owners

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject

AtlanObject.AtlanObjectBuilder<C extends AtlanObject,B extends AtlanObject.AtlanObjectBuilder<C,B>>

Field Summary

Fields inherited from class com.atlan.model.core.AtlanObject

rawJsonObject

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DataContractSpec(DataContractSpec.DataContractSpecBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static DataContractSpec.DataContractSpecBuilder<?,?>	_internal()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static DataContractSpec	fromString(String spec)	Parse a DataContractSpec object from the provided string form of the specification.
DataContractSpec.Announcement	getAnnouncement()	Announcement to apply to the dataset.
DataContractSpec.Certification	getCertification()	Certification to apply to the dataset.
List<String>	getChecks()	List of checks to run to verify data quality of the dataset.
List<DataContractSpec.DCColumn>	getColumns()	Details of each column in the dataset to be governed.
Map<String,CustomMetadataAttributes>	getCustomMetadataSets()	Custom metadata for the dataset.
String	getDataset()	Name of the asset as it exists inside Atlan.
String	getDatasource()	Name that must match a data source defined in your config file.
String	getDescription()	Description of this dataset.
Map<String,Object>	getExtraProperties()
String	getKind()	Controls the specification as one for a data contract.
DataContractSpec.Owners	getOwners()	Owners of the dataset, which can include users (by username) and / or groups (by internal Atlan alias).
DataContractStatus	getStatus()	State of the contract.
List<DataContractSpec.DCTag>	getTags()	Atlan tags for the dataset.
String	getTemplateVersion()	Version of the template for the data contract.
List<String>	getTerms()	Glossary terms to assign to the dataset.
String	getType()	Type of the dataset in Atlan.
int	hashCode()
DataContractSpec.DataContractSpecBuilder<?,?>	toBuilder()
String	toString()	Translate this DataContractSpec object into a YAML string representation.

Methods inherited from class com.atlan.model.core.AtlanObject

getRawJsonObject, setRawJsonObject, toJson

Methods inherited from class java.lang.Object

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

Constructor Details

DataContractSpec

protected DataContractSpec(DataContractSpec.DataContractSpecBuilder<?,?> b)

Method Details

getExtraProperties

public Map<String,Object> getExtraProperties()

fromString

public static DataContractSpec fromString(String spec)
                                   throws IOException

Parse a DataContractSpec object from the provided string form of the specification. Note: all comments and empty fields will be lost during conversion to an object.

Parameters:

spec - YAML string form of the data contract specification

Returns:

object representing the data contract

Throws:

IOException - on any errors parsing the provided string as a data contract specification

toString

public String toString()

Translate this DataContractSpec object into a YAML string representation. Note: will not contain any comments or empty fields.

Overrides:

toString in class AtlanObject

Returns:

YAML string representation of the data contract specification

_internal

public static DataContractSpec.DataContractSpecBuilder<?,?> _internal()

toBuilder

public DataContractSpec.DataContractSpecBuilder<?,?> toBuilder()

getKind

public String getKind()

Controls the specification as one for a data contract.

getStatus

public DataContractStatus getStatus()

State of the contract.

getTemplateVersion

public String getTemplateVersion()

Version of the template for the data contract.

getDataset

public String getDataset()

Name of the asset as it exists inside Atlan.

getType

public String getType()

Type of the dataset in Atlan.

getDescription

public String getDescription()

Description of this dataset.

getDatasource

public String getDatasource()

Name that must match a data source defined in your config file.

getOwners

public DataContractSpec.Owners getOwners()

Owners of the dataset, which can include users (by username) and / or groups (by internal Atlan alias).

getCertification

public DataContractSpec.Certification getCertification()

Certification to apply to the dataset.

getAnnouncement

public DataContractSpec.Announcement getAnnouncement()

Announcement to apply to the dataset.

getTerms

public List<String> getTerms()

Glossary terms to assign to the dataset.

getTags

public List<DataContractSpec.DCTag> getTags()

Atlan tags for the dataset.

getCustomMetadataSets

public Map<String,CustomMetadataAttributes> getCustomMetadataSets()

Custom metadata for the dataset.

getColumns

public List<DataContractSpec.DCColumn> getColumns()

Details of each column in the dataset to be governed.

getChecks

public List<String> getChecks()

List of checks to run to verify data quality of the dataset.

equals

public boolean equals(Object o)

Overrides:

equals in class AtlanObject

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AtlanObject

hashCode

public int hashCode()

Overrides:

hashCode in class AtlanObject