Class DbtMetric

All Implemented Interfaces:
IAsset, ICatalog, IDataQuality, IDbt, IDbtMetric, IMetric, IReferenceable, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class DbtMetric extends Asset implements IDbtMetric, IDbt, IMetric, ICatalog, IAsset, IReferenceable, IDataQuality
Instance of a dbt metric in Atlan.
See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      public static DbtMetric.DbtMetricBuilder<?,?> _internal()
    • toBuilder

      public DbtMetric.DbtMetricBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference
    • getApplicationContainer

      public IApplicationContainer getApplicationContainer()
      ApplicationContainer asset containing this Catalog asset.
      Specified by:
      getApplicationContainer in interface ICatalog
      Specified by:
      getApplicationContainer in interface IDataQuality
      Specified by:
      getApplicationContainer in interface IDbt
      Specified by:
      getApplicationContainer in interface IDbtMetric
      Specified by:
      getApplicationContainer in interface IMetric
    • getAssetApplicationQualifiedName

      public String getAssetApplicationQualifiedName()
      Qualified name of the Application Container that contains this asset.
      Specified by:
      getAssetApplicationQualifiedName in interface ICatalog
      Specified by:
      getAssetApplicationQualifiedName in interface IDataQuality
      Specified by:
      getAssetApplicationQualifiedName in interface IDbt
      Specified by:
      getAssetApplicationQualifiedName in interface IDbtMetric
      Specified by:
      getAssetApplicationQualifiedName in interface IMetric
    • getAssets

      public SortedSet<IAsset> getAssets()
      TBC
      Specified by:
      getAssets in interface IDbtMetric
      Specified by:
      getAssets in interface IMetric
    • getDbtAccountName

      public String getDbtAccountName()
      TBC
      Specified by:
      getDbtAccountName in interface IDbt
      Specified by:
      getDbtAccountName in interface IDbtMetric
    • getDbtAlias

      public String getDbtAlias()
      TBC
      Specified by:
      getDbtAlias in interface IDbt
      Specified by:
      getDbtAlias in interface IDbtMetric
    • getDbtConnectionContext

      public String getDbtConnectionContext()
      TBC
      Specified by:
      getDbtConnectionContext in interface IDbt
      Specified by:
      getDbtConnectionContext in interface IDbtMetric
    • getDbtEnvironmentDbtVersion

      public String getDbtEnvironmentDbtVersion()
      TBC
      Specified by:
      getDbtEnvironmentDbtVersion in interface IDbt
      Specified by:
      getDbtEnvironmentDbtVersion in interface IDbtMetric
    • getDbtEnvironmentName

      public String getDbtEnvironmentName()
      TBC
      Specified by:
      getDbtEnvironmentName in interface IDbt
      Specified by:
      getDbtEnvironmentName in interface IDbtMetric
    • getDbtJobLastRun

      public Long getDbtJobLastRun()
      TBC
      Specified by:
      getDbtJobLastRun in interface IDbt
      Specified by:
      getDbtJobLastRun in interface IDbtMetric
    • getDbtJobName

      public String getDbtJobName()
      TBC
      Specified by:
      getDbtJobName in interface IDbt
      Specified by:
      getDbtJobName in interface IDbtMetric
    • getDbtJobNextRun

      public Long getDbtJobNextRun()
      TBC
      Specified by:
      getDbtJobNextRun in interface IDbt
      Specified by:
      getDbtJobNextRun in interface IDbtMetric
    • getDbtJobNextRunHumanized

      public String getDbtJobNextRunHumanized()
      TBC
      Specified by:
      getDbtJobNextRunHumanized in interface IDbt
      Specified by:
      getDbtJobNextRunHumanized in interface IDbtMetric
    • getDbtJobRuns

      public List<DbtJobRun> getDbtJobRuns()
      List of latest DBT job runs across all environments
      Specified by:
      getDbtJobRuns in interface IDbt
      Specified by:
      getDbtJobRuns in interface IDbtMetric
    • getDbtJobSchedule

      public String getDbtJobSchedule()
      TBC
      Specified by:
      getDbtJobSchedule in interface IDbt
      Specified by:
      getDbtJobSchedule in interface IDbtMetric
    • getDbtJobScheduleCronHumanized

      public String getDbtJobScheduleCronHumanized()
      TBC
      Specified by:
      getDbtJobScheduleCronHumanized in interface IDbt
      Specified by:
      getDbtJobScheduleCronHumanized in interface IDbtMetric
    • getDbtJobStatus

      public String getDbtJobStatus()
      TBC
      Specified by:
      getDbtJobStatus in interface IDbt
      Specified by:
      getDbtJobStatus in interface IDbtMetric
    • getDbtMeta

      public String getDbtMeta()
      TBC
      Specified by:
      getDbtMeta in interface IDbt
      Specified by:
      getDbtMeta in interface IDbtMetric
    • getDbtMetricFilterColumns

      public SortedSet<IColumn> getDbtMetricFilterColumns()
      TBC
      Specified by:
      getDbtMetricFilterColumns in interface IDbtMetric
    • getDbtMetricFilters

      public List<DbtMetricFilter> getDbtMetricFilters()
      TBC
      Specified by:
      getDbtMetricFilters in interface IDbtMetric
    • getDbtModel

      public IDbtModel getDbtModel()
      Model in which this metric exists.
      Specified by:
      getDbtModel in interface IDbtMetric
    • getDbtPackageName

      public String getDbtPackageName()
      TBC
      Specified by:
      getDbtPackageName in interface IDbt
      Specified by:
      getDbtPackageName in interface IDbtMetric
    • getDbtProjectName

      public String getDbtProjectName()
      TBC
      Specified by:
      getDbtProjectName in interface IDbt
      Specified by:
      getDbtProjectName in interface IDbtMetric
    • getDbtSemanticLayerProxyUrl

      public String getDbtSemanticLayerProxyUrl()
      TBC
      Specified by:
      getDbtSemanticLayerProxyUrl in interface IDbt
      Specified by:
      getDbtSemanticLayerProxyUrl in interface IDbtMetric
    • getDbtTags

      public SortedSet<String> getDbtTags()
      TBC
      Specified by:
      getDbtTags in interface IDbt
      Specified by:
      getDbtTags in interface IDbtMetric
    • getDbtUniqueId

      public String getDbtUniqueId()
      TBC
      Specified by:
      getDbtUniqueId in interface IDbt
      Specified by:
      getDbtUniqueId in interface IDbtMetric
    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface ICatalog
      Specified by:
      getInputToAirflowTasks in interface IDataQuality
      Specified by:
      getInputToAirflowTasks in interface IDbt
      Specified by:
      getInputToAirflowTasks in interface IDbtMetric
      Specified by:
      getInputToAirflowTasks in interface IMetric
    • getInputToProcesses

      public SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
      Specified by:
      getInputToProcesses in interface ICatalog
      Specified by:
      getInputToProcesses in interface IDataQuality
      Specified by:
      getInputToProcesses in interface IDbt
      Specified by:
      getInputToProcesses in interface IDbtMetric
      Specified by:
      getInputToProcesses in interface IMetric
    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface IDataQuality
      Specified by:
      getInputToSparkJobs in interface IDbt
      Specified by:
      getInputToSparkJobs in interface IDbtMetric
      Specified by:
      getInputToSparkJobs in interface IMetric
    • getMetricDimensionColumns

      public SortedSet<IColumn> getMetricDimensionColumns()
      TBC
      Specified by:
      getMetricDimensionColumns in interface IDbtMetric
      Specified by:
      getMetricDimensionColumns in interface IMetric
    • getMetricFilters

      public String getMetricFilters()
      Filters to be applied to the metric query.
      Specified by:
      getMetricFilters in interface IDbtMetric
      Specified by:
      getMetricFilters in interface IMetric
    • getMetricSQL

      public String getMetricSQL()
      SQL query used to compute the metric.
      Specified by:
      getMetricSQL in interface IDbtMetric
      Specified by:
      getMetricSQL in interface IMetric
    • getMetricTimeGrains

      public SortedSet<String> getMetricTimeGrains()
      List of time grains to be applied to the metric query.
      Specified by:
      getMetricTimeGrains in interface IDbtMetric
      Specified by:
      getMetricTimeGrains in interface IMetric
    • getMetricTimestampColumn

      public IColumn getMetricTimestampColumn()
      TBC
      Specified by:
      getMetricTimestampColumn in interface IDbtMetric
      Specified by:
      getMetricTimestampColumn in interface IMetric
    • getMetricType

      public String getMetricType()
      Type of the metric.
      Specified by:
      getMetricType in interface IDbtMetric
      Specified by:
      getMetricType in interface IMetric
    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface IDataQuality
      Specified by:
      getModelImplementedEntities in interface IDbt
      Specified by:
      getModelImplementedEntities in interface IDbtMetric
      Specified by:
      getModelImplementedEntities in interface IMetric
    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface IDataQuality
      Specified by:
      getOutputFromAirflowTasks in interface IDbt
      Specified by:
      getOutputFromAirflowTasks in interface IDbtMetric
      Specified by:
      getOutputFromAirflowTasks in interface IMetric
    • 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 IDataQuality
      Specified by:
      getOutputFromProcesses in interface IDbt
      Specified by:
      getOutputFromProcesses in interface IDbtMetric
      Specified by:
      getOutputFromProcesses in interface IMetric
    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface IDataQuality
      Specified by:
      getOutputFromSparkJobs in interface IDbt
      Specified by:
      getOutputFromSparkJobs in interface IDbtMetric
      Specified by:
      getOutputFromSparkJobs in interface IMetric
    • 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 DbtMetrics.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IDataQuality
      Specified by:
      getTypeName in interface IDbt
      Specified by:
      getTypeName in interface IDbtMetric
      Specified by:
      getTypeName in interface IMetric
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference