Package com.atlan.model.assets

Class CubeField

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

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • creator

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

    • creator

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

    • creator

      public static CubeField.CubeFieldBuilder<?,?> creator(String name, String parentQualifiedName)
      Builds the minimal object necessary to create a CubeField.
      Parameters:
      name - of the CubeField
      parentQualifiedName - unique name of the parent of the CubeField (either of its hierarchy or parent field)
      Returns:
      the minimal request necessary to create the CubeField, as a builder

    • creator

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

    • updater

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

    • getHierarchyQualifiedName

      public static String getHierarchyQualifiedName(String parentQualifiedName)
      Extracts the unique name of the hierarchy from the qualified name of the CubeField's parent.
      Parameters:
      parentQualifiedName - unique name of the hierarchy or parent field in which this CubeField exists
      Returns:
      the unique name of the CubeHierarchy in which the field exists

    • generateQualifiedName

      public static String generateQualifiedName(String name, String parentQualifiedName)
      Generate a unique CubeField name.
      Parameters:
      name - of the CubeField
      parentQualifiedName - unique name of the hierarchy or parent field in which this CubeField exists
      Returns:
      a unique name for the CubeField

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

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

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static CubeField.CubeFieldBuilder<?,?> _internal()

    • toBuilder

      public CubeField.CubeFieldBuilder<?,?> 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 ICubeField
      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 ICubeField
      Specified by:
      getAssetApplicationQualifiedName in interface IMultiDimensionalDataset

    • 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 ICubeField
      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 ICubeField
      Specified by:
      getCubeDimensionQualifiedName in interface IMultiDimensionalDataset

    • getCubeFieldGeneration

      public Long getCubeFieldGeneration()
      Generation of the field in the cube hierarchy.
      Specified by:
      getCubeFieldGeneration in interface ICubeField

    • getCubeFieldLevel

      public Long getCubeFieldLevel()
      Level of the field in the cube hierarchy.
      Specified by:
      getCubeFieldLevel in interface ICubeField

    • getCubeFieldMeasureExpression

      public String getCubeFieldMeasureExpression()
      Expression used to calculate this measure.
      Specified by:
      getCubeFieldMeasureExpression in interface ICubeField

    • getCubeHierarchy

      public ICubeHierarchy getCubeHierarchy()
      Hierarchy in which this field exists.
      Specified by:
      getCubeHierarchy in interface ICubeField

    • 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 ICubeField
      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 ICubeField
      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 ICubeField
      Specified by:
      getCubeName in interface IMultiDimensionalDataset

    • getCubeNestedFields

      public SortedSet<ICubeField> getCubeNestedFields()
      Individual fields nested within this cube field.
      Specified by:
      getCubeNestedFields in interface ICubeField

    • getCubeParentField

      public ICubeField getCubeParentField()
      Parent field in which this field is nested.
      Specified by:
      getCubeParentField in interface ICubeField

    • getCubeParentFieldName

      public String getCubeParentFieldName()
      Name of the parent field in which this field is nested.
      Specified by:
      getCubeParentFieldName in interface ICubeField

    • getCubeParentFieldQualifiedName

      public String getCubeParentFieldQualifiedName()
      Unique name of the parent field in which this field is nested.
      Specified by:
      getCubeParentFieldQualifiedName in interface ICubeField

    • 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 ICubeField
      Specified by:
      getCubeQualifiedName in interface IMultiDimensionalDataset

    • getCubeSubFieldCount

      public Long getCubeSubFieldCount()
      Number of sub-fields that are direct children of this field.
      Specified by:
      getCubeSubFieldCount in interface ICubeField

    • getInputToAirflowTasks

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

    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface ICubeField
      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 ICubeField
      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 ICubeField
      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 ICubeField
      Specified by:
      getOutputFromProcesses in interface IMultiDimensionalDataset

    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface ICubeField
      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 CubeFields.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface ICubeField
      Specified by:
      getTypeName in interface IMultiDimensionalDataset
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference