Package com.atlan.api

Class ContractsEndpoint

java.lang.Object

com.atlan.api.AbstractEndpoint

com.atlan.api.HeraclesEndpoint

com.atlan.api.ContractsEndpoint

public class ContractsEndpoint
extends HeraclesEndpoint

API endpoints for data contract-specific operations.

Nested Class Summary

Nested classes/interfaces inherited from class com.atlan.api.AbstractEndpoint

AbstractEndpoint.RawResponse

Field Summary

Fields inherited from class com.atlan.api.AbstractEndpoint

client

Constructor Summary

Constructors

Constructor	Description
ContractsEndpoint(AtlanClient client)

Method Summary

Modifier and Type	Method	Description
String	generateInitialSpec(Asset asset)	Generate an initial contract spec for the provided asset.
String	generateInitialSpec(Asset asset, RequestOptions options)	Generate an initial contract spec for the provided asset.

Methods inherited from class com.atlan.api.HeraclesEndpoint

getBaseUrl

Methods inherited from class com.atlan.api.AbstractEndpoint

getBaseUrl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ContractsEndpoint

public ContractsEndpoint(AtlanClient client)

Method Details

generateInitialSpec

public String generateInitialSpec(Asset asset)
                           throws AtlanException

Generate an initial contract spec for the provided asset. The asset must have at least its qualifiedName (and type) populated.

Parameters:

asset - for which to generate the initial contract spec

Returns:

the YAML for the initial contract spec for the provided asset

Throws:

AtlanException - on any issue interacting with the API

generateInitialSpec

public String generateInitialSpec(Asset asset,
 RequestOptions options)
                           throws AtlanException

Generate an initial contract spec for the provided asset. The asset must have at least its qualifiedName (and type) populated.

Parameters:

asset - for which to generate the initial contract spec

options - to override default client settings

Returns:

the YAML for the initial contract spec for the provided asset

Throws:

AtlanException - on any issue interacting with the API