Class SnowflakePipe

All Implemented Interfaces:
IAsset, ICatalog, IReferenceable, ISnowflakePipe, ISQL, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class SnowflakePipe extends Asset implements ISnowflakePipe, ISQL, ICatalog, IAsset, IReferenceable
Instance of a Snowflake pipe in Atlan. These are used to ingest data from external sources into Snowflake.
See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      public static SnowflakePipe.SnowflakePipeBuilder<?,?> _internal()
    • toBuilder

      public SnowflakePipe.SnowflakePipeBuilder<?,?> 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 ISnowflakePipe
      Specified by:
      getApplicationContainer in interface ISQL
    • 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 ISnowflakePipe
      Specified by:
      getAssetApplicationQualifiedName in interface ISQL
    • 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 ISnowflakePipe
      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 ISnowflakePipe
      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 ISnowflakePipe
      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 ISnowflakePipe
      Specified by:
      getDatabaseQualifiedName in interface ISQL
    • getDbtModels

      public SortedSet<IDbtModel> getDbtModels()
      TBC
      Specified by:
      getDbtModels in interface ISnowflakePipe
      Specified by:
      getDbtModels in interface ISQL
    • getDbtSources

      public SortedSet<IDbtSource> getDbtSources()
      TBC
      Specified by:
      getDbtSources in interface ISnowflakePipe
      Specified by:
      getDbtSources in interface ISQL
    • getDbtTests

      public SortedSet<IDbtTest> getDbtTests()
      TBC
      Specified by:
      getDbtTests in interface ISnowflakePipe
      Specified by:
      getDbtTests in interface ISQL
    • getDefinition

      public String getDefinition()
      SQL definition of this pipe.
      Specified by:
      getDefinition in interface ISnowflakePipe
    • getInputToAirflowTasks

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

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface ISnowflakePipe
      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 ISnowflakePipe
      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 ISnowflakePipe
      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 ISnowflakePipe
      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 ISnowflakePipe
      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 ISnowflakePipe
      Specified by:
      getOutputFromProcesses in interface ISQL
    • getOutputFromSparkJobs

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

      public Long getQueryCount()
      Number of times this asset has been queried.
      Specified by:
      getQueryCount in interface ISnowflakePipe
      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 ISnowflakePipe
      Specified by:
      getQueryCountUpdatedAt in interface ISQL
    • getQueryUserCount

      public Long getQueryUserCount()
      Number of unique users who have queried this asset.
      Specified by:
      getQueryUserCount in interface ISnowflakePipe
      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 ISnowflakePipe
      Specified by:
      getQueryUserMap in interface ISQL
    • getSchema

      public ISchema getSchema()
      Schema in which this Snowflake pipe exists.
      Specified by:
      getSchema in interface ISnowflakePipe
    • 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 ISnowflakePipe
      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 ISnowflakePipe
      Specified by:
      getSchemaQualifiedName in interface ISQL
    • getSnowflakePipeIsAutoIngestEnabled

      public Boolean getSnowflakePipeIsAutoIngestEnabled()
      Whether auto-ingest is enabled for this pipe (true) or not (false).
      Specified by:
      getSnowflakePipeIsAutoIngestEnabled in interface ISnowflakePipe
    • getSnowflakePipeNotificationChannelName

      public String getSnowflakePipeNotificationChannelName()
      Name of the notification channel for this pipe.
      Specified by:
      getSnowflakePipeNotificationChannelName in interface ISnowflakePipe
    • getSqlDBTSources

      public SortedSet<IDbtSource> getSqlDBTSources()
      TBC
      Specified by:
      getSqlDBTSources in interface ISnowflakePipe
      Specified by:
      getSqlDBTSources in interface ISQL
    • getSqlDbtModels

      public SortedSet<IDbtModel> getSqlDbtModels()
      TBC
      Specified by:
      getSqlDbtModels in interface ISnowflakePipe
      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 ISnowflakePipe
      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 ISnowflakePipe
      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 ISnowflakePipe
      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 ISnowflakePipe
      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 SnowflakePipes.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IReferenceable
      Specified by:
      getTypeName in interface ISnowflakePipe
      Specified by:
      getTypeName in interface ISQL
      Overrides:
      getTypeName in class Reference