Package com.atlan.model.assets

Class CubeHierarchy

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

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • creator

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

    • creator

      public static CubeHierarchy.CubeHierarchyBuilder<?,?> creator(String name, String dimensionQualifiedName)
      Builds the minimal object necessary to create a CubeHierarchy.
      Parameters:
      name - of the CubeHierarchy
      dimensionQualifiedName - unique name of the cube dimension in which this CubeHierarchy exists
      Returns:
      the minimal request necessary to create the CubeHierarchy, as a builder

    • creator

      public static CubeHierarchy.CubeHierarchyBuilder<?,?> creator(String name, String connectionQualifiedName, String cubeName, String cubeQualifiedName, String dimensionName, String dimensionQualifiedName)
      Builds the minimal object necessary to create a CubeHierarchy.
      Parameters:
      name - of the CubeHierarchy
      connectionQualifiedName - unique name of the connection in which the CubeHierarchy should be created
      cubeName - simple name of the Cube in which the CubeHierarchy should be created
      cubeQualifiedName - unique name of the Cube in which the CubeHierarchy should be created
      dimensionName - simple name of the CubeDimension in which the CubeHierarchy should be created
      dimensionQualifiedName - unique name of the CubeDimension in which the CubeHierarchy should be created
      Returns:
      the minimal request necessary to create the CubeHierarchy, as a builder

    • updater

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

    • generateQualifiedName

      public static String generateQualifiedName(String name, String dimensionQualifiedName)
      Generate a unique CubeHierarchy name.
      Parameters:
      name - of the CubeHierarchy
      dimensionQualifiedName - unique name of the cube dimension in which this CubeHierarchy exists
      Returns:
      a unique name for the CubeHierarchy

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

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

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static CubeHierarchy.CubeHierarchyBuilder<?,?> _internal()

    • toBuilder

      public CubeHierarchy.CubeHierarchyBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getApplicationContainer

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

    • 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 ICubeHierarchy
      Specified by:
      getAssetApplicationQualifiedName in interface IMultiDimensionalDataset

    • getCubeDimension

      public ICubeDimension getCubeDimension()
      Dimension in which this hierarchy exists.
      Specified by:
      getCubeDimension in interface ICubeHierarchy

    • getCubeDimensionName

      public String getCubeDimensionName()
      Simple name of the cube dimension in which this asset exists, or empty if it is itself a dimension.
      Specified by:
      getCubeDimensionName in interface ICubeHierarchy
      Specified by:
      getCubeDimensionName in interface IMultiDimensionalDataset

    • getCubeDimensionQualifiedName

      public String getCubeDimensionQualifiedName()
      Unique name of the cube dimension in which this asset exists, or empty if it is itself a dimension.
      Specified by:
      getCubeDimensionQualifiedName in interface ICubeHierarchy
      Specified by:
      getCubeDimensionQualifiedName in interface IMultiDimensionalDataset

    • getCubeFieldCount

      public Long getCubeFieldCount()
      Number of total fields in the cube hierarchy.
      Specified by:
      getCubeFieldCount in interface ICubeHierarchy

    • getCubeFields

      public SortedSet<ICubeField> getCubeFields()
      Individual fields that make up the hierarchy.
      Specified by:
      getCubeFields in interface ICubeHierarchy

    • getCubeHierarchyName

      public String getCubeHierarchyName()
      Simple name of the dimension hierarchy in which this asset exists, or empty if it is itself a hierarchy.
      Specified by:
      getCubeHierarchyName in interface ICubeHierarchy
      Specified by:
      getCubeHierarchyName in interface IMultiDimensionalDataset

    • getCubeHierarchyQualifiedName

      public String getCubeHierarchyQualifiedName()
      Unique name of the dimension hierarchy in which this asset exists, or empty if it is itself a hierarchy.
      Specified by:
      getCubeHierarchyQualifiedName in interface ICubeHierarchy
      Specified by:
      getCubeHierarchyQualifiedName in interface IMultiDimensionalDataset

    • getCubeName

      public String getCubeName()
      Simple name of the cube in which this asset exists, or empty if it is itself a cube.
      Specified by:
      getCubeName in interface ICubeHierarchy
      Specified by:
      getCubeName in interface IMultiDimensionalDataset

    • getCubeQualifiedName

      public String getCubeQualifiedName()
      Unique name of the cube in which this asset exists, or empty if it is itself a cube.
      Specified by:
      getCubeQualifiedName in interface ICubeHierarchy
      Specified by:
      getCubeQualifiedName in interface IMultiDimensionalDataset

    • getInputToAirflowTasks

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

    • getInputToProcesses

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

    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface ICubeHierarchy
      Specified by:
      getInputToSparkJobs in interface IMultiDimensionalDataset

    • getModelImplementedEntities

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

    • getOutputFromAirflowTasks

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

    • 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 ICubeHierarchy
      Specified by:
      getOutputFromProcesses in interface IMultiDimensionalDataset

    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface ICubeHierarchy
      Specified by:
      getOutputFromSparkJobs in interface IMultiDimensionalDataset

    • 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 CubeHierarchys.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface ICubeHierarchy
      Specified by:
      getTypeName in interface IMultiDimensionalDataset
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference