Package com.atlan.model.assets

Class Procedure

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.Procedure
All Implemented Interfaces:
IAsset, ICatalog, IProcedure, IReferenceable, ISQL, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class Procedure extends Asset implements IProcedure, ISQL, ICatalog, IAsset, IReferenceable
Instance of a stored procedure (routine) in Atlan.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

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

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

      public static Procedure appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a Procedure, without replacing existing Atlan tags linked to the Procedure. Note: this operation must make two API calls — one to retrieve the Procedure's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the Procedure
      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 Procedure
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

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

    • removeAtlanTag

      public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a Procedure.
      Parameters:
      qualifiedName - of the Procedure
      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 Procedure

    • removeAtlanTag

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

    • _internal

      public static Procedure.ProcedureBuilder<?,?> _internal()

    • toBuilder

      public Procedure.ProcedureBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getCalculationViewName

      public String getCalculationViewName()
      Simple name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.
      Specified by:
      getCalculationViewName in interface IProcedure
      Specified by:
      getCalculationViewName in interface ISQL

    • getCalculationViewQualifiedName

      public String getCalculationViewQualifiedName()
      Unique name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.
      Specified by:
      getCalculationViewQualifiedName in interface IProcedure
      Specified by:
      getCalculationViewQualifiedName in interface ISQL

    • getDatabaseName

      public String getDatabaseName()
      Simple name of the database in which this SQL asset exists, or empty if it does not exist within a database.
      Specified by:
      getDatabaseName in interface IProcedure
      Specified by:
      getDatabaseName in interface ISQL

    • getDatabaseQualifiedName

      public String getDatabaseQualifiedName()
      Unique name of the database in which this SQL asset exists, or empty if it does not exist within a database.
      Specified by:
      getDatabaseQualifiedName in interface IProcedure
      Specified by:
      getDatabaseQualifiedName in interface ISQL

    • getDbtModels

      public SortedSet<IDbtModel> getDbtModels()
      TBC
      Specified by:
      getDbtModels in interface IProcedure
      Specified by:
      getDbtModels in interface ISQL

    • getDbtSources

      public SortedSet<IDbtSource> getDbtSources()
      TBC
      Specified by:
      getDbtSources in interface IProcedure
      Specified by:
      getDbtSources in interface ISQL

    • getDbtTests

      public SortedSet<IDbtTest> getDbtTests()
      TBC
      Specified by:
      getDbtTests in interface IProcedure
      Specified by:
      getDbtTests in interface ISQL

    • getDefinition

      public String getDefinition()
      SQL definition of the procedure.
      Specified by:
      getDefinition in interface IProcedure

    • getInputToAirflowTasks

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

    • getInputToProcesses

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

    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface IProcedure
      Specified by:
      getInputToSparkJobs in interface ISQL

    • getIsProfiled

      public Boolean getIsProfiled()
      Whether this asset has been profiled (true) or not (false).
      Specified by:
      getIsProfiled in interface IProcedure
      Specified by:
      getIsProfiled in interface ISQL

    • getLastProfiledAt

      public Long getLastProfiledAt()
      Time (epoch) at which this asset was last profiled, in milliseconds.
      Specified by:
      getLastProfiledAt in interface IProcedure
      Specified by:
      getLastProfiledAt in interface ISQL

    • getModelImplementedEntities

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

    • getOutputFromAirflowTasks

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

    • getOutputFromProcesses

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

    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface IProcedure
      Specified by:
      getOutputFromSparkJobs in interface ISQL

    • getQueryCount

      public Long getQueryCount()
      Number of times this asset has been queried.
      Specified by:
      getQueryCount in interface IProcedure
      Specified by:
      getQueryCount in interface ISQL

    • getQueryCountUpdatedAt

      public Long getQueryCountUpdatedAt()
      Time (epoch) at which the query count was last updated, in milliseconds.
      Specified by:
      getQueryCountUpdatedAt in interface IProcedure
      Specified by:
      getQueryCountUpdatedAt in interface ISQL

    • getQueryUserCount

      public Long getQueryUserCount()
      Number of unique users who have queried this asset.
      Specified by:
      getQueryUserCount in interface IProcedure
      Specified by:
      getQueryUserCount in interface ISQL

    • getQueryUserMap

      public Map<String,Long> getQueryUserMap()
      Map of unique users who have queried this asset to the number of times they have queried it.
      Specified by:
      getQueryUserMap in interface IProcedure
      Specified by:
      getQueryUserMap in interface ISQL

    • getSchema

      public ISchema getSchema()
      Schema in which this stored procedure exists.
      Specified by:
      getSchema in interface IProcedure

    • getSchemaName

      public String getSchemaName()
      Simple name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.
      Specified by:
      getSchemaName in interface IProcedure
      Specified by:
      getSchemaName in interface ISQL

    • getSchemaQualifiedName

      public String getSchemaQualifiedName()
      Unique name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.
      Specified by:
      getSchemaQualifiedName in interface IProcedure
      Specified by:
      getSchemaQualifiedName in interface ISQL

    • getSqlDBTSources

      public SortedSet<IDbtSource> getSqlDBTSources()
      TBC
      Specified by:
      getSqlDBTSources in interface IProcedure
      Specified by:
      getSqlDBTSources in interface ISQL

    • getSqlDbtModels

      public SortedSet<IDbtModel> getSqlDbtModels()
      TBC
      Specified by:
      getSqlDbtModels in interface IProcedure
      Specified by:
      getSqlDbtModels in interface ISQL

    • getTableName

      public String getTableName()
      Simple name of the table in which this SQL asset exists, or empty if it does not exist within a table.
      Specified by:
      getTableName in interface IProcedure
      Specified by:
      getTableName in interface ISQL

    • getTableQualifiedName

      public String getTableQualifiedName()
      Unique name of the table in which this SQL asset exists, or empty if it does not exist within a table.
      Specified by:
      getTableQualifiedName in interface IProcedure
      Specified by:
      getTableQualifiedName in interface ISQL

    • getViewName

      public String getViewName()
      Simple name of the view in which this SQL asset exists, or empty if it does not exist within a view.
      Specified by:
      getViewName in interface IProcedure
      Specified by:
      getViewName in interface ISQL

    • getViewQualifiedName

      public String getViewQualifiedName()
      Unique name of the view in which this SQL asset exists, or empty if it does not exist within a view.
      Specified by:
      getViewQualifiedName in interface IProcedure
      Specified by:
      getViewQualifiedName in interface ISQL

    • 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 Procedures.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IProcedure
      Specified by:
      getTypeName in interface IReferenceable
      Specified by:
      getTypeName in interface ISQL
      Overrides:
      getTypeName in class Reference