Package com.atlan.model.assets

Class APIPath

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.APIPath
All Implemented Interfaces:
IAPI, IAPIPath, IAsset, ICatalog, IReferenceable, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class APIPath extends Asset implements IAPIPath, IAPI, ICatalog, IAsset, IReferenceable
Instance of an API path that could contain one or more endpoints in Atlan.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
      Start a fluent search that will return all APIPath 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) APIPath assets will be included.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      Returns:
      a fluent search that includes all APIPath assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
      Start a fluent search that will return all APIPath 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) APIPaths will be included
      Returns:
      a fluent search that includes all APIPath assets

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

      public static APIPath get(AtlanClient client, String id) throws AtlanException
      Retrieves a APIPath 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 APIPath to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full APIPath, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the APIPath does not exist or the provided GUID is not a APIPath

    • get

      public static APIPath get(AtlanClient client, String id, boolean includeAllRelationships) throws AtlanException
      Retrieves a APIPath 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 APIPath to retrieve, either its GUID or its full qualifiedName
      includeAllRelationships - if true, all the asset's relationships will also be retrieved; if false, no relationships will be retrieved
      Returns:
      the requested full APIPath, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the APIPath does not exist or the provided GUID is not a APIPath

    • get

      public static APIPath get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException
      Retrieves a APIPath by one of its identifiers, with only the requested attributes (and relationships).
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the APIPath to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the APIPath, including any relationships
      Returns:
      the requested APIPath, with only its minimal information and the requested attributes (and relationships)
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the APIPath does not exist or the provided GUID is not a APIPath

    • get

      public static APIPath get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException
      Retrieves a APIPath by one of its identifiers, with only the requested attributes (and relationships).
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the APIPath to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the APIPath, including any relationships
      attributesOnRelated - to retrieve on each relationship retrieved for the APIPath
      Returns:
      the requested APIPath, with only its minimal information and the requested attributes (and relationships)
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the APIPath does not exist or the provided GUID is not a APIPath

    • restore

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

    • creator

      public static APIPath.APIPathBuilder<?,?> creator(String name, APISpec apiSpec) throws InvalidRequestException
      Builds the minimal object necessary to create an API path.
      Parameters:
      name - of the API path
      apiSpec - in which the API path should be created, which must have at least a qualifiedName
      Returns:
      the minimal request necessary to create the API path, as a builder
      Throws:
      InvalidRequestException - if the apiSpec provided is without a qualifiedName

    • creator

      public static APIPath.APIPathBuilder<?,?> creator(String pathURI, String apiSpecQualifiedName)
      Builds the minimal object necessary to create an API path.
      Parameters:
      pathURI - unique URI of the API path
      apiSpecQualifiedName - unique name of the API spec through which the path is accessible
      Returns:
      the minimal object necessary to create the API path, as a builder

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • updateCertificate

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

    • removeCertificate

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

    • updateAnnouncement

      public static APIPath updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a APIPath.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the APIPath's announcement
      qualifiedName - of the APIPath
      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 APIPath removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the announcement from a APIPath.
      Parameters:
      client - connectivity to the Atlan client from which to remove the APIPath's announcement
      qualifiedName - of the APIPath
      name - of the APIPath
      Returns:
      the updated APIPath, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • replaceTerms

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

    • appendTerms

      @Deprecated public static APIPath appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Deprecated.
      see Asset.AssetBuilder.appendAssignedTerm(GlossaryTerm)
      Link additional terms to the APIPath, without replacing existing terms linked to the APIPath. Note: this operation must make two API calls — one to retrieve the APIPath'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 APIPath
      qualifiedName - for the APIPath
      terms - the list of terms to append to the APIPath
      Returns:
      the APIPath that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

      @Deprecated public static APIPath removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Deprecated.
      see Asset.AssetBuilder.removeAssignedTerm(GlossaryTerm)
      Remove terms from a APIPath, without replacing all existing terms linked to the APIPath. Note: this operation must make two API calls — one to retrieve the APIPath'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 APIPath
      qualifiedName - for the APIPath
      terms - the list of terms to remove from the APIPath, which must be referenced by GUID
      Returns:
      the APIPath that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      @Deprecated public static APIPath appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Deprecated.
      see Asset.AssetBuilder.appendAtlanTags(List)
      Add Atlan tags to a APIPath, without replacing existing Atlan tags linked to the APIPath. Note: this operation must make two API calls — one to retrieve the APIPath'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 APIPath
      qualifiedName - of the APIPath
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated APIPath
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      @Deprecated public static APIPath appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Deprecated.
      see Asset.AssetBuilder.appendAtlanTags(List, boolean, boolean, boolean, boolean)
      Add Atlan tags to a APIPath, without replacing existing Atlan tags linked to the APIPath. Note: this operation must make two API calls — one to retrieve the APIPath'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 APIPath
      qualifiedName - of the APIPath
      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 APIPath
      Throws:
      AtlanException - on any API problems

    • removeAtlanTag

      @Deprecated public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
      Deprecated.
      see Asset.AssetBuilder.removeAtlanTag(String)
      Remove an Atlan tag from a APIPath.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a APIPath
      qualifiedName - of the APIPath
      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 APIPath

    • _internal

      public static APIPath.APIPathBuilder<?,?> _internal()

    • toBuilder

      public APIPath.APIPathBuilder<?,?> 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 IAPIPath

    • getApiIsAuthOptional

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

    • getApiIsObjectReference

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

    • 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 IAPIPath

    • getApiPathAvailableOperations

      public SortedSet<String> getApiPathAvailableOperations()
      List of the operations available on the endpoint.
      Specified by:
      getApiPathAvailableOperations in interface IAPIPath

    • getApiPathAvailableResponseCodes

      public Map<String,String> getApiPathAvailableResponseCodes()
      Response codes available on the path across all operations.
      Specified by:
      getApiPathAvailableResponseCodes in interface IAPIPath

    • getApiPathIsIngressExposed

      public Boolean getApiPathIsIngressExposed()
      Whether the path is exposed as an ingress (true) or not (false).
      Specified by:
      getApiPathIsIngressExposed in interface IAPIPath

    • getApiPathIsTemplated

      public Boolean getApiPathIsTemplated()
      Whether the endpoint's path contains replaceable parameters (true) or not (false).
      Specified by:
      getApiPathIsTemplated in interface IAPIPath

    • getApiPathRawURI

      public String getApiPathRawURI()
      Absolute path to an individual endpoint.
      Specified by:
      getApiPathRawURI in interface IAPIPath

    • getApiPathSummary

      public String getApiPathSummary()
      Descriptive summary intended to apply to all operations in this path.
      Specified by:
      getApiPathSummary in interface IAPIPath

    • getApiSpec

      public IAPISpec getApiSpec()
      API specification in which this path exists.
      Specified by:
      getApiSpec in interface IAPIPath

    • 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 IAPIPath

    • 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 IAPIPath

    • getApiSpecType

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

    • getApiSpecVersion

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

    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface IAPI
      Specified by:
      getInputToAirflowTasks in interface IAPIPath
      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 IAPIPath
      Specified by:
      getInputToProcesses in interface ICatalog

    • getInputToSparkJobs

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

    • getModelImplementedAttributes

      public SortedSet<IModelAttribute> getModelImplementedAttributes()
      Attributes implemented by this asset.
      Specified by:
      getModelImplementedAttributes in interface IAPI
      Specified by:
      getModelImplementedAttributes in interface IAPIPath
      Specified by:
      getModelImplementedAttributes in interface ICatalog

    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface IAPI
      Specified by:
      getModelImplementedEntities in interface IAPIPath
      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 IAPIPath
      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 IAPIPath
      Specified by:
      getOutputFromProcesses in interface ICatalog

    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface IAPI
      Specified by:
      getOutputFromSparkJobs in interface IAPIPath
      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 APIPaths.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAPI
      Specified by:
      getTypeName in interface IAPIPath
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference