Package com.atlan.model.assets

Class APISpec

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.APISpec
All Implemented Interfaces:
IAPI, IAPISpec, IAsset, ICatalog, IReferenceable, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class APISpec extends Asset implements IAPISpec, IAPI, ICatalog, IAsset, IReferenceable
Instance of an API specification in Atlan.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

      public APISpec trimToReference() throws InvalidRequestException
      Builds the minimal object necessary to create a relationship to a APISpec, from a potentially more-complete APISpec object.
      Overrides:
      trimToReference in class Asset
      Returns:
      the minimal object necessary to relate to the APISpec
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for a APISpec relationship are not found in the initial object

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select()
      Start a fluent search that will return all APISpec assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) APISpec assets will be included.
      Returns:
      a fluent search that includes all APISpec assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
      Start a fluent search that will return all APISpec assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) APISpec assets will be included.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      Returns:
      a fluent search that includes all APISpec assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(boolean includeArchived)
      Start a fluent search that will return all APISpec assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
      Parameters:
      includeArchived - when true, archived (soft-deleted) APISpecs will be included
      Returns:
      a fluent search that includes all APISpec assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
      Start a fluent search that will return all APISpec assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      includeArchived - when true, archived (soft-deleted) APISpecs will be included
      Returns:
      a fluent search that includes all APISpec assets

    • refByGuid

      public static APISpec refByGuid(String guid)
      Reference to a APISpec by GUID. Use this to create a relationship to this APISpec, where the relationship should be replaced.
      Parameters:
      guid - the GUID of the APISpec to reference
      Returns:
      reference to a APISpec that can be used for defining a relationship to a APISpec

    • refByGuid

      public static APISpec refByGuid(String guid, Reference.SaveSemantic semantic)
      Reference to a APISpec by GUID. Use this to create a relationship to this APISpec, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      guid - the GUID of the APISpec to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a APISpec that can be used for defining a relationship to a APISpec

    • refByQualifiedName

      public static APISpec refByQualifiedName(String qualifiedName)
      Reference to a APISpec by qualifiedName. Use this to create a relationship to this APISpec, where the relationship should be replaced.
      Parameters:
      qualifiedName - the qualifiedName of the APISpec to reference
      Returns:
      reference to a APISpec that can be used for defining a relationship to a APISpec

    • refByQualifiedName

      public static APISpec refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)
      Reference to a APISpec by qualifiedName. Use this to create a relationship to this APISpec, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      qualifiedName - the qualifiedName of the APISpec to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a APISpec that can be used for defining a relationship to a APISpec

    • get

      public static APISpec get(String id) throws AtlanException
      Retrieves a APISpec by one of its identifiers, complete with all of its relationships.
      Parameters:
      id - of the APISpec to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full APISpec, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the APISpec does not exist or the provided GUID is not a APISpec

    • get

      public static APISpec get(AtlanClient client, String id) throws AtlanException
      Retrieves a APISpec by one of its identifiers, complete with all of its relationships.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the APISpec to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full APISpec, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the APISpec does not exist or the provided GUID is not a APISpec

    • get

      public static APISpec get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException
      Retrieves a APISpec by one of its identifiers, optionally complete with all of its relationships.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the APISpec to retrieve, either its GUID or its full qualifiedName
      includeRelationships - if true, all of the asset's relationships will also be retrieved; if false, no relationships will be retrieved
      Returns:
      the requested full APISpec, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the APISpec does not exist or the provided GUID is not a APISpec

    • restore

      public static boolean restore(String qualifiedName) throws AtlanException
      Restore the archived (soft-deleted) APISpec to active.
      Parameters:
      qualifiedName - for the APISpec
      Returns:
      true if the APISpec is now active, and false otherwise
      Throws:
      AtlanException - on any API problems

    • restore

      public static boolean restore(AtlanClient client, String qualifiedName) throws AtlanException
      Restore the archived (soft-deleted) APISpec to active.
      Parameters:
      client - connectivity to the Atlan tenant on which to restore the asset
      qualifiedName - for the APISpec
      Returns:
      true if the APISpec is now active, and false otherwise
      Throws:
      AtlanException - on any API problems

    • creator

      public static APISpec.APISpecBuilder<?,?> creator(String name, String connectionQualifiedName)
      Builds the minimal object necessary to create an API spec.
      Parameters:
      name - of the API spec
      connectionQualifiedName - unique name of the connection through which the spec is accessible
      Returns:
      the minimal object necessary to create the API spec, as a builder

    • updater

      public static APISpec.APISpecBuilder<?,?> updater(String qualifiedName, String name)
      Builds the minimal object necessary to update a APISpec.
      Parameters:
      qualifiedName - of the APISpec
      name - of the APISpec
      Returns:
      the minimal request necessary to update the APISpec, as a builder

    • trimToRequired

      public APISpec.APISpecBuilder<?,?> trimToRequired() throws InvalidRequestException
      Builds the minimal object necessary to apply an update to a APISpec, from a potentially more-complete APISpec object.
      Overrides:
      trimToRequired in class Asset
      Returns:
      the minimal object necessary to update the APISpec, as a builder
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for APISpec are not found in the initial object

    • removeDescription

      public static APISpec removeDescription(String qualifiedName, String name) throws AtlanException
      Remove the system description from a APISpec.
      Parameters:
      qualifiedName - of the APISpec
      name - of the APISpec
      Returns:
      the updated APISpec, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeDescription

      public static APISpec removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the system description from a APISpec.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's description
      qualifiedName - of the APISpec
      name - of the APISpec
      Returns:
      the updated APISpec, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeUserDescription

      public static APISpec removeUserDescription(String qualifiedName, String name) throws AtlanException
      Remove the user's description from a APISpec.
      Parameters:
      qualifiedName - of the APISpec
      name - of the APISpec
      Returns:
      the updated APISpec, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeUserDescription

      public static APISpec removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the user's description from a APISpec.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's description
      qualifiedName - of the APISpec
      name - of the APISpec
      Returns:
      the updated APISpec, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeOwners

      public static APISpec removeOwners(String qualifiedName, String name) throws AtlanException
      Remove the owners from a APISpec.
      Parameters:
      qualifiedName - of the APISpec
      name - of the APISpec
      Returns:
      the updated APISpec, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeOwners

      public static APISpec removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the owners from a APISpec.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the APISpec's owners
      qualifiedName - of the APISpec
      name - of the APISpec
      Returns:
      the updated APISpec, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • updateCertificate

      public static APISpec updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a APISpec.
      Parameters:
      qualifiedName - of the APISpec
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated APISpec, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • updateCertificate

      public static APISpec updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a APISpec.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the APISpec's certificate
      qualifiedName - of the APISpec
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated APISpec, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • removeCertificate

      public static APISpec removeCertificate(String qualifiedName, String name) throws AtlanException
      Remove the certificate from a APISpec.
      Parameters:
      qualifiedName - of the APISpec
      name - of the APISpec
      Returns:
      the updated APISpec, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeCertificate

      public static APISpec removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the certificate from a APISpec.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the APISpec's certificate
      qualifiedName - of the APISpec
      name - of the APISpec
      Returns:
      the updated APISpec, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • updateAnnouncement

      public static APISpec updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a APISpec.
      Parameters:
      qualifiedName - of the APISpec
      type - type of announcement to set
      title - (optional) title of the announcement to set (or null for no title)
      message - (optional) message of the announcement to set (or null for no message)
      Returns:
      the result of the update, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • updateAnnouncement

      public static APISpec updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a APISpec.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the APISpec's announcement
      qualifiedName - of the APISpec
      type - type of announcement to set
      title - (optional) title of the announcement to set (or null for no title)
      message - (optional) message of the announcement to set (or null for no message)
      Returns:
      the result of the update, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • removeAnnouncement

      public static APISpec removeAnnouncement(String qualifiedName, String name) throws AtlanException
      Remove the announcement from a APISpec.
      Parameters:
      qualifiedName - of the APISpec
      name - of the APISpec
      Returns:
      the updated APISpec, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeAnnouncement

      public static APISpec removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the announcement from a APISpec.
      Parameters:
      client - connectivity to the Atlan client from which to remove the APISpec's announcement
      qualifiedName - of the APISpec
      name - of the APISpec
      Returns:
      the updated APISpec, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • replaceTerms

      public static APISpec replaceTerms(String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
      Replace the terms linked to the APISpec.
      Parameters:
      qualifiedName - for the APISpec
      name - human-readable name of the APISpec
      terms - the list of terms to replace on the APISpec, or null to remove all terms from the APISpec
      Returns:
      the APISpec that was updated (note that it will NOT contain details of the replaced terms)
      Throws:
      AtlanException - on any API problems

    • replaceTerms

      public static APISpec replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
      Replace the terms linked to the APISpec.
      Parameters:
      client - connectivity to the Atlan tenant on which to replace the APISpec's assigned terms
      qualifiedName - for the APISpec
      name - human-readable name of the APISpec
      terms - the list of terms to replace on the APISpec, or null to remove all terms from the APISpec
      Returns:
      the APISpec that was updated (note that it will NOT contain details of the replaced terms)
      Throws:
      AtlanException - on any API problems

    • appendTerms

      public static APISpec appendTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the APISpec, without replacing existing terms linked to the APISpec. Note: this operation must make two API calls — one to retrieve the APISpec's existing terms, and a second to append the new terms.
      Parameters:
      qualifiedName - for the APISpec
      terms - the list of terms to append to the APISpec
      Returns:
      the APISpec that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • appendTerms

      public static APISpec appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the APISpec, without replacing existing terms linked to the APISpec. Note: this operation must make two API calls — one to retrieve the APISpec's existing terms, and a second to append the new terms.
      Parameters:
      client - connectivity to the Atlan tenant on which to append terms to the APISpec
      qualifiedName - for the APISpec
      terms - the list of terms to append to the APISpec
      Returns:
      the APISpec that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

      public static APISpec removeTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a APISpec, without replacing all existing terms linked to the APISpec. Note: this operation must make two API calls — one to retrieve the APISpec's existing terms, and a second to remove the provided terms.
      Parameters:
      qualifiedName - for the APISpec
      terms - the list of terms to remove from the APISpec, which must be referenced by GUID
      Returns:
      the APISpec that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

      public static APISpec removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a APISpec, without replacing all existing terms linked to the APISpec. Note: this operation must make two API calls — one to retrieve the APISpec's existing terms, and a second to remove the provided terms.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove terms from the APISpec
      qualifiedName - for the APISpec
      terms - the list of terms to remove from the APISpec, which must be referenced by GUID
      Returns:
      the APISpec that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static APISpec appendAtlanTags(String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a APISpec, without replacing existing Atlan tags linked to the APISpec. Note: this operation must make two API calls — one to retrieve the APISpec's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the APISpec
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated APISpec
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static APISpec appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a APISpec, without replacing existing Atlan tags linked to the APISpec. Note: this operation must make two API calls — one to retrieve the APISpec's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      client - connectivity to the Atlan tenant on which to append Atlan tags to the APISpec
      qualifiedName - of the APISpec
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated APISpec
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static APISpec appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a APISpec, without replacing existing Atlan tags linked to the APISpec. Note: this operation must make two API calls — one to retrieve the APISpec's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the APISpec
      atlanTagNames - human-readable names of the Atlan tags to add
      propagate - whether to propagate the Atlan tag (true) or not (false)
      removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
      restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
      Returns:
      the updated APISpec
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static APISpec appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a APISpec, without replacing existing Atlan tags linked to the APISpec. Note: this operation must make two API calls — one to retrieve the APISpec's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      client - connectivity to the Atlan tenant on which to append Atlan tags to the APISpec
      qualifiedName - of the APISpec
      atlanTagNames - human-readable names of the Atlan tags to add
      propagate - whether to propagate the Atlan tag (true) or not (false)
      removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
      restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
      Returns:
      the updated APISpec
      Throws:
      AtlanException - on any API problems

    • removeAtlanTag

      public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a APISpec.
      Parameters:
      qualifiedName - of the APISpec
      atlanTagName - human-readable name of the Atlan tag to remove
      Throws:
      AtlanException - on any API problems, or if the Atlan tag does not exist on the APISpec

    • removeAtlanTag

      public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a APISpec.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a APISpec
      qualifiedName - of the APISpec
      atlanTagName - human-readable name of the Atlan tag to remove
      Throws:
      AtlanException - on any API problems, or if the Atlan tag does not exist on the APISpec

    • _internal

      public static APISpec.APISpecBuilder<?,?> _internal()

    • toBuilder

      public APISpec.APISpecBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getApiExternalDocs

      public Map<String,String> getApiExternalDocs()
      External documentation of the API.
      Specified by:
      getApiExternalDocs in interface IAPI
      Specified by:
      getApiExternalDocs in interface IAPISpec

    • getApiIsAuthOptional

      public Boolean getApiIsAuthOptional()
      Whether authentication is optional (true) or required (false).
      Specified by:
      getApiIsAuthOptional in interface IAPI
      Specified by:
      getApiIsAuthOptional in interface IAPISpec

    • getApiIsObjectReference

      public Boolean getApiIsObjectReference()
      If this asset refers to an APIObject
      Specified by:
      getApiIsObjectReference in interface IAPI
      Specified by:
      getApiIsObjectReference in interface IAPISpec

    • getApiObjectQualifiedName

      public String getApiObjectQualifiedName()
      Qualified name of the APIObject that is referred to by this asset. When apiIsObjectReference is true.
      Specified by:
      getApiObjectQualifiedName in interface IAPI
      Specified by:
      getApiObjectQualifiedName in interface IAPISpec

    • getApiPaths

      public SortedSet<IAPIPath> getApiPaths()
      Paths that exist within this API specification.
      Specified by:
      getApiPaths in interface IAPISpec

    • getApiSpecContactEmail

      public String getApiSpecContactEmail()
      Email address for a contact responsible for the API specification.
      Specified by:
      getApiSpecContactEmail in interface IAPISpec

    • getApiSpecContactName

      public String getApiSpecContactName()
      Name of the contact responsible for the API specification.
      Specified by:
      getApiSpecContactName in interface IAPISpec

    • getApiSpecContactURL

      public String getApiSpecContactURL()
      URL pointing to the contact information.
      Specified by:
      getApiSpecContactURL in interface IAPISpec

    • getApiSpecContractVersion

      public String getApiSpecContractVersion()
      Version of the contract for the API specification.
      Specified by:
      getApiSpecContractVersion in interface IAPISpec

    • getApiSpecLicenseName

      public String getApiSpecLicenseName()
      Name of the license under which the API specification is available.
      Specified by:
      getApiSpecLicenseName in interface IAPISpec

    • getApiSpecLicenseURL

      public String getApiSpecLicenseURL()
      URL to the license under which the API specification is available.
      Specified by:
      getApiSpecLicenseURL in interface IAPISpec

    • getApiSpecName

      public String getApiSpecName()
      Simple name of the API spec, if this asset is contained in an API spec.
      Specified by:
      getApiSpecName in interface IAPI
      Specified by:
      getApiSpecName in interface IAPISpec

    • getApiSpecQualifiedName

      public String getApiSpecQualifiedName()
      Unique name of the API spec, if this asset is contained in an API spec.
      Specified by:
      getApiSpecQualifiedName in interface IAPI
      Specified by:
      getApiSpecQualifiedName in interface IAPISpec

    • getApiSpecServiceAlias

      public String getApiSpecServiceAlias()
      Service alias for the API specification.
      Specified by:
      getApiSpecServiceAlias in interface IAPISpec

    • getApiSpecTermsOfServiceURL

      public String getApiSpecTermsOfServiceURL()
      URL to the terms of service for the API specification.
      Specified by:
      getApiSpecTermsOfServiceURL in interface IAPISpec

    • getApiSpecType

      public String getApiSpecType()
      Type of API, for example: OpenAPI, GraphQL, etc.
      Specified by:
      getApiSpecType in interface IAPI
      Specified by:
      getApiSpecType in interface IAPISpec

    • getApiSpecVersion

      public String getApiSpecVersion()
      Version of the API specification.
      Specified by:
      getApiSpecVersion in interface IAPI
      Specified by:
      getApiSpecVersion in interface IAPISpec

    • getApplicationContainer

      public IApplicationContainer getApplicationContainer()
      ApplicationContainer asset containing this Catalog asset.
      Specified by:
      getApplicationContainer in interface IAPI
      Specified by:
      getApplicationContainer in interface IAPISpec
      Specified by:
      getApplicationContainer in interface ICatalog

    • getAssetApplicationQualifiedName

      public String getAssetApplicationQualifiedName()
      Qualified name of the Application Container that contains this asset.
      Specified by:
      getAssetApplicationQualifiedName in interface IAPI
      Specified by:
      getAssetApplicationQualifiedName in interface IAPISpec
      Specified by:
      getAssetApplicationQualifiedName in interface ICatalog

    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface IAPI
      Specified by:
      getInputToAirflowTasks in interface IAPISpec
      Specified by:
      getInputToAirflowTasks in interface ICatalog

    • getInputToProcesses

      public SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
      Specified by:
      getInputToProcesses in interface IAPI
      Specified by:
      getInputToProcesses in interface IAPISpec
      Specified by:
      getInputToProcesses in interface ICatalog

    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface IAPI
      Specified by:
      getInputToSparkJobs in interface IAPISpec
      Specified by:
      getInputToSparkJobs in interface ICatalog

    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface IAPI
      Specified by:
      getModelImplementedEntities in interface IAPISpec
      Specified by:
      getModelImplementedEntities in interface ICatalog

    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface IAPI
      Specified by:
      getOutputFromAirflowTasks in interface IAPISpec
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog

    • getOutputFromProcesses

      public SortedSet<ILineageProcess> getOutputFromProcesses()
      Processes from which this asset is produced as output.
      Specified by:
      getOutputFromProcesses in interface IAPI
      Specified by:
      getOutputFromProcesses in interface IAPISpec
      Specified by:
      getOutputFromProcesses in interface ICatalog

    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface IAPI
      Specified by:
      getOutputFromSparkJobs in interface IAPISpec
      Specified by:
      getOutputFromSparkJobs in interface ICatalog

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Asset

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class Asset

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Asset

    • toString

      public String toString()
      Description copied from class: AtlanObject
      Overrides:
      toString in class Asset

    • getTypeName

      public String getTypeName()
      Fixed typeName for APISpecs.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAPI
      Specified by:
      getTypeName in interface IAPISpec
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference