Class CassandraColumn

All Implemented Interfaces:
IAsset, ICassandra, ICassandraColumn, ICatalog, INoSQL, IReferenceable, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class CassandraColumn extends Asset implements ICassandraColumn, ICassandra, INoSQL, ICatalog, IAsset, IReferenceable
Instances of a CassandraColumn in Atlan.
See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      public static CassandraColumn.CassandraColumnBuilder<?,?> _internal()
    • toBuilder

      public CassandraColumn.CassandraColumnBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference
    • getCassandraColumnClusteringOrder

      public String getCassandraColumnClusteringOrder()
      Clustering order of the CassandraColumn.
      Specified by:
      getCassandraColumnClusteringOrder in interface ICassandraColumn
    • getCassandraColumnIsClusteringKey

      public Boolean getCassandraColumnIsClusteringKey()
      Is the CassandraColumn clustering key.
      Specified by:
      getCassandraColumnIsClusteringKey in interface ICassandraColumn
    • getCassandraColumnIsPartitionKey

      public Boolean getCassandraColumnIsPartitionKey()
      Is the CassandraColumn partition key.
      Specified by:
      getCassandraColumnIsPartitionKey in interface ICassandraColumn
    • getCassandraColumnIsStatic

      public Boolean getCassandraColumnIsStatic()
      Indicates whether the CassandraColumn is static.
      Specified by:
      getCassandraColumnIsStatic in interface ICassandraColumn
    • getCassandraColumnKind

      public String getCassandraColumnKind()
      Kind of CassandraColumn (e.g. partition key, clustering column, etc).
      Specified by:
      getCassandraColumnKind in interface ICassandraColumn
    • getCassandraColumnPosition

      public Long getCassandraColumnPosition()
      Position of the CassandraColumn.
      Specified by:
      getCassandraColumnPosition in interface ICassandraColumn
    • getCassandraColumnType

      public String getCassandraColumnType()
      Type of the CassandraColumn.
      Specified by:
      getCassandraColumnType in interface ICassandraColumn
    • getCassandraKeyspaceName

      public String getCassandraKeyspaceName()
      Name of the keyspace for the Cassandra asset.
      Specified by:
      getCassandraKeyspaceName in interface ICassandra
      Specified by:
      getCassandraKeyspaceName in interface ICassandraColumn
    • getCassandraTable

      public ICassandraTable getCassandraTable()
      Table containing the column.
      Specified by:
      getCassandraTable in interface ICassandraColumn
    • getCassandraTableName

      public String getCassandraTableName()
      Name of the table for the Cassandra asset.
      Specified by:
      getCassandraTableName in interface ICassandra
      Specified by:
      getCassandraTableName in interface ICassandraColumn
    • getCassandraTableQualifiedName

      public String getCassandraTableQualifiedName()
      Unique name of table for Cassandra asset
      Specified by:
      getCassandraTableQualifiedName in interface ICassandra
      Specified by:
      getCassandraTableQualifiedName in interface ICassandraColumn
    • getCassandraView

      public ICassandraView getCassandraView()
      View containing the column.
      Specified by:
      getCassandraView in interface ICassandraColumn
    • getCassandraViewName

      public String getCassandraViewName()
      Name of view for Cassandra asset
      Specified by:
      getCassandraViewName in interface ICassandra
      Specified by:
      getCassandraViewName in interface ICassandraColumn
    • getCassandraViewQualifiedName

      public String getCassandraViewQualifiedName()
      Unique name of view for Cassandra asset
      Specified by:
      getCassandraViewQualifiedName in interface ICassandra
      Specified by:
      getCassandraViewQualifiedName in interface ICassandraColumn
    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface ICassandra
      Specified by:
      getInputToAirflowTasks in interface ICassandraColumn
      Specified by:
      getInputToAirflowTasks in interface ICatalog
      Specified by:
      getInputToAirflowTasks in interface INoSQL
    • getInputToProcesses

      public SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
      Specified by:
      getInputToProcesses in interface ICassandra
      Specified by:
      getInputToProcesses in interface ICassandraColumn
      Specified by:
      getInputToProcesses in interface ICatalog
      Specified by:
      getInputToProcesses in interface INoSQL
    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICassandra
      Specified by:
      getInputToSparkJobs in interface ICassandraColumn
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface INoSQL
    • getModelImplementedAttributes

      public SortedSet<IModelAttribute> getModelImplementedAttributes()
      Attributes implemented by this asset.
      Specified by:
      getModelImplementedAttributes in interface ICassandra
      Specified by:
      getModelImplementedAttributes in interface ICassandraColumn
      Specified by:
      getModelImplementedAttributes in interface ICatalog
      Specified by:
      getModelImplementedAttributes in interface INoSQL
    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface ICassandra
      Specified by:
      getModelImplementedEntities in interface ICassandraColumn
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface INoSQL
    • getNoSQLSchemaDefinition

      public String getNoSQLSchemaDefinition()
      Represents attributes for describing the key schema for the table and indexes.
      Specified by:
      getNoSQLSchemaDefinition in interface ICassandra
      Specified by:
      getNoSQLSchemaDefinition in interface ICassandraColumn
      Specified by:
      getNoSQLSchemaDefinition in interface INoSQL
    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface ICassandra
      Specified by:
      getOutputFromAirflowTasks in interface ICassandraColumn
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface INoSQL
    • getOutputFromProcesses

      public SortedSet<ILineageProcess> getOutputFromProcesses()
      Processes from which this asset is produced as output.
      Specified by:
      getOutputFromProcesses in interface ICassandra
      Specified by:
      getOutputFromProcesses in interface ICassandraColumn
      Specified by:
      getOutputFromProcesses in interface ICatalog
      Specified by:
      getOutputFromProcesses in interface INoSQL
    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICassandra
      Specified by:
      getOutputFromSparkJobs in interface ICassandraColumn
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface INoSQL
    • 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 CassandraColumns.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICassandra
      Specified by:
      getTypeName in interface ICassandraColumn
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface INoSQL
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference