Package com.atlan.model.assets

Class TablePartition

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

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • creator

      public static TablePartition.TablePartitionBuilder<?,?> creator(String name, Table table) throws InvalidRequestException
      Builds the minimal object necessary to create a table partition.
      Parameters:
      name - of the table partition
      table - in which the partition should be created, which must have at least a qualifiedName
      Returns:
      the minimal request necessary to create the table partition, as a builder
      Throws:
      InvalidRequestException - if the table provided is without a qualifiedName

    • creator

      public static TablePartition.TablePartitionBuilder<?,?> creator(String name, String tableQualifiedName)
      Builds the minimal object necessary to create a table partition.
      Parameters:
      name - of the table partition
      tableQualifiedName - unique name of the table in which this table partition exists
      Returns:
      the minimal request necessary to create the table partition, as a builder

    • generateQualifiedName

      public static String generateQualifiedName(String name, String tableQualifiedName)
      Generate a unique table partition name.
      Parameters:
      name - of the table partition
      tableQualifiedName - unique name of the table in which this partition exists
      Returns:
      a unique name for the table partition

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

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

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static TablePartition.TablePartitionBuilder<?,?> _internal()

    • toBuilder

      public TablePartition.TablePartitionBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getAlias

      public String getAlias()
      Alias for this partition.
      Specified by:
      getAlias in interface ITablePartition

    • getApplicationContainer

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

    • 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 ISQL
      Specified by:
      getAssetApplicationQualifiedName in interface ITablePartition

    • 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 ISQL
      Specified by:
      getCalculationViewName in interface ITablePartition

    • 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 ISQL
      Specified by:
      getCalculationViewQualifiedName in interface ITablePartition

    • getChildTablePartitions

      public SortedSet<ITablePartition> getChildTablePartitions()
      Partitions that exist within this partition.
      Specified by:
      getChildTablePartitions in interface ITablePartition

    • getColumnCount

      public Long getColumnCount()
      Number of columns in this partition.
      Specified by:
      getColumnCount in interface ITablePartition

    • getColumns

      public SortedSet<IColumn> getColumns()
      Columns that exist within this table partition.
      Specified by:
      getColumns in interface ITablePartition

    • getConstraint

      public String getConstraint()
      Constraint that defines this table partition.
      Specified by:
      getConstraint in interface ITablePartition

    • 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 ISQL
      Specified by:
      getDatabaseName in interface ITablePartition

    • 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 ISQL
      Specified by:
      getDatabaseQualifiedName in interface ITablePartition

    • getDbtModels

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

    • getDbtSources

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

    • getDbtTests

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

    • getExternalLocation

      public String getExternalLocation()
      External location of this partition, for example: an S3 object location.
      Specified by:
      getExternalLocation in interface ITablePartition

    • getExternalLocationFormat

      public String getExternalLocationFormat()
      Format of the external location of this partition, for example: JSON, CSV, PARQUET, etc.
      Specified by:
      getExternalLocationFormat in interface ITablePartition

    • getExternalLocationRegion

      public String getExternalLocationRegion()
      Region of the external location of this partition, for example: S3 region.
      Specified by:
      getExternalLocationRegion in interface ITablePartition

    • getInputToAirflowTasks

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

    • getInputToProcesses

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

    • getInputToSparkJobs

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

    • getIsPartitioned

      public Boolean getIsPartitioned()
      Whether this partition is further partitioned (true) or not (false).
      Specified by:
      getIsPartitioned in interface ITablePartition

    • getIsProfiled

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

    • getIsQueryPreview

      public Boolean getIsQueryPreview()
      Whether preview queries for this partition are allowed (true) or not (false).
      Specified by:
      getIsQueryPreview in interface ITablePartition

    • getIsTemporary

      public Boolean getIsTemporary()
      Whether this partition is temporary (true) or not (false).
      Specified by:
      getIsTemporary in interface ITablePartition

    • getLastProfiledAt

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

    • getModelImplementedEntities

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

    • getOutputFromAirflowTasks

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

    • 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 ISQL
      Specified by:
      getOutputFromProcesses in interface ITablePartition

    • getOutputFromSparkJobs

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

    • getParentTable

      public ITable getParentTable()
      Table in which this partition exists.
      Specified by:
      getParentTable in interface ITablePartition

    • getParentTablePartition

      public ITablePartition getParentTablePartition()
      Partition in which this partition exists.
      Specified by:
      getParentTablePartition in interface ITablePartition

    • getPartitionCount

      public Long getPartitionCount()
      Number of sub-partitions of this partition.
      Specified by:
      getPartitionCount in interface ITablePartition

    • getPartitionList

      public String getPartitionList()
      List of sub-partitions in this partition.
      Specified by:
      getPartitionList in interface ITablePartition

    • getPartitionStrategy

      public String getPartitionStrategy()
      Partition strategy of this partition.
      Specified by:
      getPartitionStrategy in interface ITablePartition

    • getQueryCount

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

    • getQueryCountUpdatedAt

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

    • getQueryPreviewConfig

      public Map<String,String> getQueryPreviewConfig()
      Configuration for the preview queries.
      Specified by:
      getQueryPreviewConfig in interface ITablePartition

    • getQueryUserCount

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

    • 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 ISQL
      Specified by:
      getQueryUserMap in interface ITablePartition

    • getRowCount

      public Long getRowCount()
      Number of rows in this partition.
      Specified by:
      getRowCount in interface ITablePartition

    • 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 ISQL
      Specified by:
      getSchemaName in interface ITablePartition

    • 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 ISQL
      Specified by:
      getSchemaQualifiedName in interface ITablePartition

    • getSizeBytes

      public Long getSizeBytes()
      Size of this partition, in bytes.
      Specified by:
      getSizeBytes in interface ITablePartition

    • getSqlDBTSources

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

    • getSqlDbtModels

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

    • 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 ISQL
      Specified by:
      getTableName in interface ITablePartition

    • 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 ISQL
      Specified by:
      getTableQualifiedName in interface ITablePartition

    • 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 ISQL
      Specified by:
      getViewName in interface ITablePartition

    • 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 ISQL
      Specified by:
      getViewQualifiedName in interface ITablePartition

    • 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 TablePartitions.
      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 ISQL
      Specified by:
      getTypeName in interface ITablePartition
      Overrides:
      getTypeName in class Reference