Class CassandraKeyspace

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

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

  • Constructor Details

  • Method Details

    • trimToReference

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

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

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

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

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

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

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

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

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

      public static CassandraKeyspace get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException
      Retrieves a CassandraKeyspace 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 CassandraKeyspace to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the CassandraKeyspace, including any relationships
      Returns:
      the requested CassandraKeyspace, 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 CassandraKeyspace does not exist or the provided GUID is not a CassandraKeyspace
    • get

      public static CassandraKeyspace get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException
      Retrieves a CassandraKeyspace 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 CassandraKeyspace to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the CassandraKeyspace, including any relationships
      attributesOnRelated - to retrieve on each relationship retrieved for the CassandraKeyspace
      Returns:
      the requested CassandraKeyspace, 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 CassandraKeyspace does not exist or the provided GUID is not a CassandraKeyspace
    • restore

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

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

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

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

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

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

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

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

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

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

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

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

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

      @Deprecated public static CassandraKeyspace appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a CassandraKeyspace, without replacing existing Atlan tags linked to the CassandraKeyspace. Note: this operation must make two API calls — one to retrieve the CassandraKeyspace'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 CassandraKeyspace
      qualifiedName - of the CassandraKeyspace
      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 CassandraKeyspace
      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 CassandraKeyspace.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a CassandraKeyspace
      qualifiedName - of the CassandraKeyspace
      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 CassandraKeyspace
    • _internal

      public static CassandraKeyspace.CassandraKeyspaceBuilder<?,?> _internal()
    • toBuilder

      Overrides:
      toBuilder in class Reference
    • getCassandraKeyspaceDurableWrites

      public Boolean getCassandraKeyspaceDurableWrites()
      Indicates whether durable writes are enabled for the CassandraKeyspace.
      Specified by:
      getCassandraKeyspaceDurableWrites in interface ICassandraKeyspace
    • getCassandraKeyspaceName

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

      public String getCassandraKeyspaceQuery()
      Query associated with the CassandraKeyspace.
      Specified by:
      getCassandraKeyspaceQuery in interface ICassandraKeyspace
    • getCassandraKeyspaceReplication

      public Map<String,String> getCassandraKeyspaceReplication()
      Replication class for the CassandraKeyspace.
      Specified by:
      getCassandraKeyspaceReplication in interface ICassandraKeyspace
    • getCassandraKeyspaceVirtual

      public Boolean getCassandraKeyspaceVirtual()
      Indicates whether the CassandraKeyspace is virtual.
      Specified by:
      getCassandraKeyspaceVirtual in interface ICassandraKeyspace
    • getCassandraTableName

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

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

      public SortedSet<ICassandraTable> getCassandraTables()
      Individual tables contained in the keyspace.
      Specified by:
      getCassandraTables in interface ICassandraKeyspace
    • getCassandraViewName

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

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

      public SortedSet<ICassandraView> getCassandraViews()
      Individual views contained in the keyspace.
      Specified by:
      getCassandraViews in interface ICassandraKeyspace
    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface ICassandra
      Specified by:
      getInputToAirflowTasks in interface ICassandraKeyspace
      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 ICassandraKeyspace
      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 ICassandraKeyspace
      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 ICassandraKeyspace
      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 ICassandraKeyspace
      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 ICassandraKeyspace
      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 ICassandraKeyspace
      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 ICassandraKeyspace
      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 ICassandraKeyspace
      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 CassandraKeyspaces.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICassandra
      Specified by:
      getTypeName in interface ICassandraKeyspace
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface INoSQL
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference