All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.atlan.model.assets.CubeHierarchy Maven / Gradle / Ivy

There is a newer version: 3.0.0
Show newest version
// Generated by delombok at Wed Oct 16 22:16:03 UTC 2024
/* SPDX-License-Identifier: Apache-2.0
   Copyright 2022 Atlan Pte. Ltd. */
package com.atlan.model.assets;

import com.atlan.Atlan;
import com.atlan.AtlanClient;
import com.atlan.exception.AtlanException;
import com.atlan.exception.ErrorCode;
import com.atlan.exception.InvalidRequestException;
import com.atlan.exception.NotFoundException;
import com.atlan.model.enums.AtlanAnnouncementType;
import com.atlan.model.enums.AtlanConnectorType;
import com.atlan.model.enums.CertificateStatus;
import com.atlan.model.relations.Reference;
import com.atlan.model.relations.UniqueAttributes;
import com.atlan.model.search.FluentSearch;
import com.atlan.util.StringUtils;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.SortedSet;
import java.util.concurrent.ThreadLocalRandom;
import javax.annotation.processing.Generated;
import lombok.*;

/**
 * Instance of a cube hierarchy in Atlan.
 */
@Generated("com.atlan.generators.ModelGeneratorV2")
public class CubeHierarchy extends Asset implements ICubeHierarchy, IMultiDimensionalDataset, ICatalog, IAsset, IReferenceable {
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(CubeHierarchy.class);
    private static final long serialVersionUID = 2L;
    public static final String TYPE_NAME = "CubeHierarchy";
    /**
     * Fixed typeName for CubeHierarchys.
     */
    String typeName;
    /**
     * Dimension in which this hierarchy exists.
     */
    @Attribute
    ICubeDimension cubeDimension;
    /**
     * Simple name of the cube dimension in which this asset exists, or empty if it is itself a dimension.
     */
    @Attribute
    String cubeDimensionName;
    /**
     * Unique name of the cube dimension in which this asset exists, or empty if it is itself a dimension.
     */
    @Attribute
    String cubeDimensionQualifiedName;
    /**
     * Number of total fields in the cube hierarchy.
     */
    @Attribute
    Long cubeFieldCount;
    /**
     * Individual fields that make up the hierarchy.
     */
    @Attribute
    SortedSet cubeFields;
    /**
     * Simple name of the dimension hierarchy in which this asset exists, or empty if it is itself a hierarchy.
     */
    @Attribute
    String cubeHierarchyName;
    /**
     * Unique name of the dimension hierarchy in which this asset exists, or empty if it is itself a hierarchy.
     */
    @Attribute
    String cubeHierarchyQualifiedName;
    /**
     * Simple name of the cube in which this asset exists, or empty if it is itself a cube.
     */
    @Attribute
    String cubeName;
    /**
     * Unique name of the cube in which this asset exists, or empty if it is itself a cube.
     */
    @Attribute
    String cubeQualifiedName;
    /**
     * Tasks to which this asset provides input.
     */
    @Attribute
    SortedSet inputToAirflowTasks;
    /**
     * Processes to which this asset provides input.
     */
    @Attribute
    SortedSet inputToProcesses;
    /**
     * TBC
     */
    @Attribute
    SortedSet inputToSparkJobs;
    /**
     * Entities implemented by this asset.
     */
    @Attribute
    @JsonProperty("modelEntityImplemented")
    SortedSet modelImplementedEntities;
    /**
     * Tasks from which this asset is output.
     */
    @Attribute
    SortedSet outputFromAirflowTasks;
    /**
     * Processes from which this asset is produced as output.
     */
    @Attribute
    SortedSet outputFromProcesses;
    /**
     * TBC
     */
    @Attribute
    SortedSet outputFromSparkJobs;

    /**
     * Builds the minimal object necessary to create a relationship to a CubeHierarchy, from a potentially
     * more-complete CubeHierarchy object.
     *
     * @return 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
     */
    @Override
    public CubeHierarchy trimToReference() throws InvalidRequestException {
        if (this.getGuid() != null && !this.getGuid().isEmpty()) {
            return refByGuid(this.getGuid());
        }
        if (this.getQualifiedName() != null && !this.getQualifiedName().isEmpty()) {
            return refByQualifiedName(this.getQualifiedName());
        }
        if (this.getUniqueAttributes() != null && this.getUniqueAttributes().getQualifiedName() != null && !this.getUniqueAttributes().getQualifiedName().isEmpty()) {
            return refByQualifiedName(this.getUniqueAttributes().getQualifiedName());
        }
        throw new InvalidRequestException(ErrorCode.MISSING_REQUIRED_RELATIONSHIP_PARAM, TYPE_NAME, "guid, qualifiedName");
    }

    /**
     * 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.
     *
     * @return a fluent search that includes all CubeHierarchy assets
     */
    public static FluentSearch.FluentSearchBuilder select() {
        return select(Atlan.getDefaultClient());
    }

    /**
     * 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.
     *
     * @param client connectivity to the Atlan tenant from which to retrieve the assets
     * @return a fluent search that includes all CubeHierarchy assets
     */
    public static FluentSearch.FluentSearchBuilder select(AtlanClient client) {
        return select(client, false);
    }

    /**
     * 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.
     *
     * @param includeArchived when true, archived (soft-deleted) CubeHierarchys will be included
     * @return a fluent search that includes all CubeHierarchy assets
     */
    public static FluentSearch.FluentSearchBuilder select(boolean includeArchived) {
        return select(Atlan.getDefaultClient(), 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.
     *
     * @param client connectivity to the Atlan tenant from which to retrieve the assets
     * @param includeArchived when true, archived (soft-deleted) CubeHierarchys will be included
     * @return a fluent search that includes all CubeHierarchy assets
     */
    public static FluentSearch.FluentSearchBuilder select(AtlanClient client, boolean includeArchived) {
        FluentSearch.FluentSearchBuilder builder = FluentSearch.builder(client).where(Asset.TYPE_NAME.eq(TYPE_NAME));
        if (!includeArchived) {
            builder.active();
        }
        return builder;
    }

    /**
     * Reference to a CubeHierarchy by GUID. Use this to create a relationship to this CubeHierarchy,
     * where the relationship should be replaced.
     *
     * @param guid the GUID of the CubeHierarchy to reference
     * @return reference to a CubeHierarchy that can be used for defining a relationship to a CubeHierarchy
     */
    public static CubeHierarchy refByGuid(String guid) {
        return refByGuid(guid, Reference.SaveSemantic.REPLACE);
    }

    /**
     * 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).
     *
     * @param guid the GUID of the CubeHierarchy to reference
     * @param semantic how to save this relationship (replace all with this, append it, or remove it)
     * @return reference to a CubeHierarchy that can be used for defining a relationship to a CubeHierarchy
     */
    public static CubeHierarchy refByGuid(String guid, Reference.SaveSemantic semantic) {
        return CubeHierarchy._internal().guid(guid).semantic(semantic).build();
    }

    /**
     * Reference to a CubeHierarchy by qualifiedName. Use this to create a relationship to this CubeHierarchy,
     * where the relationship should be replaced.
     *
     * @param qualifiedName the qualifiedName of the CubeHierarchy to reference
     * @return reference to a CubeHierarchy that can be used for defining a relationship to a CubeHierarchy
     */
    public static CubeHierarchy refByQualifiedName(String qualifiedName) {
        return refByQualifiedName(qualifiedName, Reference.SaveSemantic.REPLACE);
    }

    /**
     * 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).
     *
     * @param qualifiedName the qualifiedName of the CubeHierarchy to reference
     * @param semantic how to save this relationship (replace all with this, append it, or remove it)
     * @return reference to a CubeHierarchy that can be used for defining a relationship to a CubeHierarchy
     */
    public static CubeHierarchy refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic) {
        return CubeHierarchy._internal().uniqueAttributes(UniqueAttributes.builder().qualifiedName(qualifiedName).build()).semantic(semantic).build();
    }

    /**
     * Retrieves a CubeHierarchy by one of its identifiers, complete with all of its relationships.
     *
     * @param id of the CubeHierarchy to retrieve, either its GUID or its full qualifiedName
     * @return the requested full CubeHierarchy, complete with all of its relationships
     * @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the CubeHierarchy does not exist or the provided GUID is not a CubeHierarchy
     */
    @JsonIgnore
    public static CubeHierarchy get(String id) throws AtlanException {
        return get(Atlan.getDefaultClient(), id);
    }

    /**
     * Retrieves a CubeHierarchy by one of its identifiers, complete with all of its relationships.
     *
     * @param client connectivity to the Atlan tenant from which to retrieve the asset
     * @param id of the CubeHierarchy to retrieve, either its GUID or its full qualifiedName
     * @return the requested full CubeHierarchy, complete with all of its relationships
     * @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the CubeHierarchy does not exist or the provided GUID is not a CubeHierarchy
     */
    @JsonIgnore
    public static CubeHierarchy get(AtlanClient client, String id) throws AtlanException {
        return get(client, id, true);
    }

    /**
     * Retrieves a CubeHierarchy by one of its identifiers, optionally complete with all of its relationships.
     *
     * @param client connectivity to the Atlan tenant from which to retrieve the asset
     * @param id of the CubeHierarchy to retrieve, either its GUID or its full qualifiedName
     * @param includeRelationships if true, all of the asset's relationships will also be retrieved; if false, no relationships will be retrieved
     * @return the requested full CubeHierarchy, optionally complete with all of its relationships
     * @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the CubeHierarchy does not exist or the provided GUID is not a CubeHierarchy
     */
    @JsonIgnore
    public static CubeHierarchy get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException {
        if (id == null) {
            throw new NotFoundException(ErrorCode.ASSET_NOT_FOUND_BY_GUID, "(null)");
        } else if (StringUtils.isUUID(id)) {
            Asset asset = Asset.get(client, id, includeRelationships);
            if (asset == null) {
                throw new NotFoundException(ErrorCode.ASSET_NOT_FOUND_BY_GUID, id);
            } else if (asset instanceof CubeHierarchy) {
                return (CubeHierarchy) asset;
            } else {
                throw new NotFoundException(ErrorCode.ASSET_NOT_TYPE_REQUESTED, id, TYPE_NAME);
            }
        } else {
            Asset asset = Asset.get(client, TYPE_NAME, id, includeRelationships);
            if (asset instanceof CubeHierarchy) {
                return (CubeHierarchy) asset;
            } else {
                throw new NotFoundException(ErrorCode.ASSET_NOT_FOUND_BY_QN, id, TYPE_NAME);
            }
        }
    }

    /**
     * Restore the archived (soft-deleted) CubeHierarchy to active.
     *
     * @param qualifiedName for the CubeHierarchy
     * @return true if the CubeHierarchy is now active, and false otherwise
     * @throws AtlanException on any API problems
     */
    public static boolean restore(String qualifiedName) throws AtlanException {
        return restore(Atlan.getDefaultClient(), qualifiedName);
    }

    /**
     * Restore the archived (soft-deleted) CubeHierarchy to active.
     *
     * @param client connectivity to the Atlan tenant on which to restore the asset
     * @param qualifiedName for the CubeHierarchy
     * @return true if the CubeHierarchy is now active, and false otherwise
     * @throws AtlanException on any API problems
     */
    public static boolean restore(AtlanClient client, String qualifiedName) throws AtlanException {
        return Asset.restore(client, TYPE_NAME, qualifiedName);
    }

    /**
     * Builds the minimal object necessary to create a CubeHierarchy.
     *
     * @param name of the CubeHierarchy
     * @param dimension in which the hierarchy should be created, which must have at least a qualifiedName
     * @return the minimal request necessary to create the CubeHierarchy, as a builder
     * @throws InvalidRequestException if the dimension provided is without a qualifiedName
     */
    public static CubeHierarchyBuilder creator(String name, CubeDimension dimension) throws InvalidRequestException {
        Map map = new HashMap<>();
        map.put("connectionQualifiedName", dimension.getConnectionQualifiedName());
        map.put("cubeName", dimension.getCubeName());
        map.put("cubeQualifiedName", dimension.getCubeQualifiedName());
        map.put("name", dimension.getName());
        map.put("qualifiedName", dimension.getQualifiedName());
        validateRelationship(CubeDimension.TYPE_NAME, map);
        return creator(name, dimension.getConnectionQualifiedName(), dimension.getCubeName(), dimension.getCubeQualifiedName(), dimension.getName(), dimension.getQualifiedName()).cubeDimension(dimension.trimToReference());
    }

    /**
     * Builds the minimal object necessary to create a CubeHierarchy.
     *
     * @param name of the CubeHierarchy
     * @param dimensionQualifiedName unique name of the cube dimension in which this CubeHierarchy exists
     * @return the minimal request necessary to create the CubeHierarchy, as a builder
     */
    public static CubeHierarchyBuilder creator(String name, String dimensionQualifiedName) {
        String dimensionSlug = StringUtils.getNameFromQualifiedName(dimensionQualifiedName);
        String dimensionName = IMultiDimensionalDataset.getNameFromSlug(dimensionSlug);
        String cubeQualifiedName = StringUtils.getParentQualifiedNameFromQualifiedName(dimensionQualifiedName);
        String cubeSlug = StringUtils.getNameFromQualifiedName(cubeQualifiedName);
        String cubeName = IMultiDimensionalDataset.getNameFromSlug(cubeSlug);
        String connectionQualifiedName = StringUtils.getConnectionQualifiedName(cubeQualifiedName);
        AtlanConnectorType connectorType = Connection.getConnectorTypeFromQualifiedName(connectionQualifiedName);
        return creator(name, connectionQualifiedName, cubeName, cubeQualifiedName, dimensionName, dimensionQualifiedName);
    }

    /**
     * Builds the minimal object necessary to create a CubeHierarchy.
     *
     * @param name of the CubeHierarchy
     * @param connectionQualifiedName unique name of the connection in which the CubeHierarchy should be created
     * @param cubeName simple name of the Cube in which the CubeHierarchy should be created
     * @param cubeQualifiedName unique name of the Cube in which the CubeHierarchy should be created
     * @param dimensionName simple name of the CubeDimension in which the CubeHierarchy should be created
     * @param dimensionQualifiedName unique name of the CubeDimension in which the CubeHierarchy should be created
     * @return the minimal request necessary to create the CubeHierarchy, as a builder
     */
    public static CubeHierarchyBuilder creator(String name, String connectionQualifiedName, String cubeName, String cubeQualifiedName, String dimensionName, String dimensionQualifiedName) {
        AtlanConnectorType connectorType = Connection.getConnectorTypeFromQualifiedName(connectionQualifiedName);
        return CubeHierarchy._internal().guid("-" + ThreadLocalRandom.current().nextLong(0, Long.MAX_VALUE - 1)).name(name).qualifiedName(generateQualifiedName(name, dimensionQualifiedName)).cubeName(cubeName).cubeQualifiedName(cubeQualifiedName).cubeDimensionName(dimensionName).cubeDimensionQualifiedName(dimensionQualifiedName).cubeDimension(CubeDimension.refByQualifiedName(dimensionQualifiedName)).connectorType(connectorType).connectionQualifiedName(connectionQualifiedName);
    }

    /**
     * Builds the minimal object necessary to update a CubeHierarchy.
     *
     * @param qualifiedName of the CubeHierarchy
     * @param name of the CubeHierarchy
     * @return the minimal request necessary to update the CubeHierarchy, as a builder
     */
    public static CubeHierarchyBuilder updater(String qualifiedName, String name) {
        return CubeHierarchy._internal().guid("-" + ThreadLocalRandom.current().nextLong(0, Long.MAX_VALUE - 1)).qualifiedName(qualifiedName).name(name);
    }

    /**
     * Generate a unique CubeHierarchy name.
     *
     * @param name of the CubeHierarchy
     * @param dimensionQualifiedName unique name of the cube dimension in which this CubeHierarchy exists
     * @return a unique name for the CubeHierarchy
     */
    public static String generateQualifiedName(String name, String dimensionQualifiedName) {
        return dimensionQualifiedName + "/" + IMultiDimensionalDataset.getSlugForName(name);
    }

    /**
     * Builds the minimal object necessary to apply an update to a CubeHierarchy, from a potentially
     * more-complete CubeHierarchy object.
     *
     * @return 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
     */
    @Override
    public CubeHierarchyBuilder trimToRequired() throws InvalidRequestException {
        Map map = new HashMap<>();
        map.put("qualifiedName", this.getQualifiedName());
        map.put("name", this.getName());
        validateRequired(TYPE_NAME, map);
        return updater(this.getQualifiedName(), this.getName());
    }

    /**
     * Remove the system description from a CubeHierarchy.
     *
     * @param qualifiedName of the CubeHierarchy
     * @param name of the CubeHierarchy
     * @return the updated CubeHierarchy, or null if the removal failed
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy removeDescription(String qualifiedName, String name) throws AtlanException {
        return removeDescription(Atlan.getDefaultClient(), qualifiedName, name);
    }

    /**
     * Remove the system description from a CubeHierarchy.
     *
     * @param client connectivity to the Atlan tenant on which to remove the asset's description
     * @param qualifiedName of the CubeHierarchy
     * @param name of the CubeHierarchy
     * @return the updated CubeHierarchy, or null if the removal failed
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException {
        return (CubeHierarchy) Asset.removeDescription(client, updater(qualifiedName, name));
    }

    /**
     * Remove the user's description from a CubeHierarchy.
     *
     * @param qualifiedName of the CubeHierarchy
     * @param name of the CubeHierarchy
     * @return the updated CubeHierarchy, or null if the removal failed
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy removeUserDescription(String qualifiedName, String name) throws AtlanException {
        return removeUserDescription(Atlan.getDefaultClient(), qualifiedName, name);
    }

    /**
     * Remove the user's description from a CubeHierarchy.
     *
     * @param client connectivity to the Atlan tenant on which to remove the asset's description
     * @param qualifiedName of the CubeHierarchy
     * @param name of the CubeHierarchy
     * @return the updated CubeHierarchy, or null if the removal failed
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException {
        return (CubeHierarchy) Asset.removeUserDescription(client, updater(qualifiedName, name));
    }

    /**
     * Remove the owners from a CubeHierarchy.
     *
     * @param qualifiedName of the CubeHierarchy
     * @param name of the CubeHierarchy
     * @return the updated CubeHierarchy, or null if the removal failed
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy removeOwners(String qualifiedName, String name) throws AtlanException {
        return removeOwners(Atlan.getDefaultClient(), qualifiedName, name);
    }

    /**
     * Remove the owners from a CubeHierarchy.
     *
     * @param client connectivity to the Atlan tenant from which to remove the CubeHierarchy's owners
     * @param qualifiedName of the CubeHierarchy
     * @param name of the CubeHierarchy
     * @return the updated CubeHierarchy, or null if the removal failed
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException {
        return (CubeHierarchy) Asset.removeOwners(client, updater(qualifiedName, name));
    }

    /**
     * Update the certificate on a CubeHierarchy.
     *
     * @param qualifiedName of the CubeHierarchy
     * @param certificate to use
     * @param message (optional) message, or null if no message
     * @return the updated CubeHierarchy, or null if the update failed
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException {
        return updateCertificate(Atlan.getDefaultClient(), qualifiedName, certificate, message);
    }

    /**
     * Update the certificate on a CubeHierarchy.
     *
     * @param client connectivity to the Atlan tenant on which to update the CubeHierarchy's certificate
     * @param qualifiedName of the CubeHierarchy
     * @param certificate to use
     * @param message (optional) message, or null if no message
     * @return the updated CubeHierarchy, or null if the update failed
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException {
        return (CubeHierarchy) Asset.updateCertificate(client, _internal(), TYPE_NAME, qualifiedName, certificate, message);
    }

    /**
     * Remove the certificate from a CubeHierarchy.
     *
     * @param qualifiedName of the CubeHierarchy
     * @param name of the CubeHierarchy
     * @return the updated CubeHierarchy, or null if the removal failed
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy removeCertificate(String qualifiedName, String name) throws AtlanException {
        return removeCertificate(Atlan.getDefaultClient(), qualifiedName, name);
    }

    /**
     * Remove the certificate from a CubeHierarchy.
     *
     * @param client connectivity to the Atlan tenant from which to remove the CubeHierarchy's certificate
     * @param qualifiedName of the CubeHierarchy
     * @param name of the CubeHierarchy
     * @return the updated CubeHierarchy, or null if the removal failed
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException {
        return (CubeHierarchy) Asset.removeCertificate(client, updater(qualifiedName, name));
    }

    /**
     * Update the announcement on a CubeHierarchy.
     *
     * @param qualifiedName of the CubeHierarchy
     * @param type type of announcement to set
     * @param title (optional) title of the announcement to set (or null for no title)
     * @param message (optional) message of the announcement to set (or null for no message)
     * @return the result of the update, or null if the update failed
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException {
        return updateAnnouncement(Atlan.getDefaultClient(), qualifiedName, type, title, message);
    }

    /**
     * Update the announcement on a CubeHierarchy.
     *
     * @param client connectivity to the Atlan tenant on which to update the CubeHierarchy's announcement
     * @param qualifiedName of the CubeHierarchy
     * @param type type of announcement to set
     * @param title (optional) title of the announcement to set (or null for no title)
     * @param message (optional) message of the announcement to set (or null for no message)
     * @return the result of the update, or null if the update failed
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException {
        return (CubeHierarchy) Asset.updateAnnouncement(client, _internal(), TYPE_NAME, qualifiedName, type, title, message);
    }

    /**
     * Remove the announcement from a CubeHierarchy.
     *
     * @param qualifiedName of the CubeHierarchy
     * @param name of the CubeHierarchy
     * @return the updated CubeHierarchy, or null if the removal failed
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy removeAnnouncement(String qualifiedName, String name) throws AtlanException {
        return removeAnnouncement(Atlan.getDefaultClient(), qualifiedName, name);
    }

    /**
     * Remove the announcement from a CubeHierarchy.
     *
     * @param client connectivity to the Atlan client from which to remove the CubeHierarchy's announcement
     * @param qualifiedName of the CubeHierarchy
     * @param name of the CubeHierarchy
     * @return the updated CubeHierarchy, or null if the removal failed
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException {
        return (CubeHierarchy) Asset.removeAnnouncement(client, updater(qualifiedName, name));
    }

    /**
     * Replace the terms linked to the CubeHierarchy.
     *
     * @param qualifiedName for the CubeHierarchy
     * @param name human-readable name of the CubeHierarchy
     * @param terms the list of terms to replace on the CubeHierarchy, or null to remove all terms from the CubeHierarchy
     * @return the CubeHierarchy that was updated (note that it will NOT contain details of the replaced terms)
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy replaceTerms(String qualifiedName, String name, List terms) throws AtlanException {
        return replaceTerms(Atlan.getDefaultClient(), qualifiedName, name, terms);
    }

    /**
     * Replace the terms linked to the CubeHierarchy.
     *
     * @param client connectivity to the Atlan tenant on which to replace the CubeHierarchy's assigned terms
     * @param qualifiedName for the CubeHierarchy
     * @param name human-readable name of the CubeHierarchy
     * @param terms the list of terms to replace on the CubeHierarchy, or null to remove all terms from the CubeHierarchy
     * @return the CubeHierarchy that was updated (note that it will NOT contain details of the replaced terms)
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy replaceTerms(AtlanClient client, String qualifiedName, String name, List terms) throws AtlanException {
        return (CubeHierarchy) Asset.replaceTerms(client, updater(qualifiedName, name), terms);
    }

    /**
     * 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.
     *
     * @param qualifiedName for the CubeHierarchy
     * @param terms the list of terms to append to the CubeHierarchy
     * @return the CubeHierarchy that was updated  (note that it will NOT contain details of the appended terms)
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy appendTerms(String qualifiedName, List terms) throws AtlanException {
        return appendTerms(Atlan.getDefaultClient(), qualifiedName, terms);
    }

    /**
     * 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.
     *
     * @param client connectivity to the Atlan tenant on which to append terms to the CubeHierarchy
     * @param qualifiedName for the CubeHierarchy
     * @param terms the list of terms to append to the CubeHierarchy
     * @return the CubeHierarchy that was updated  (note that it will NOT contain details of the appended terms)
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy appendTerms(AtlanClient client, String qualifiedName, List terms) throws AtlanException {
        return (CubeHierarchy) Asset.appendTerms(client, TYPE_NAME, qualifiedName, terms);
    }

    /**
     * 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.
     *
     * @param qualifiedName for the CubeHierarchy
     * @param terms the list of terms to remove from the CubeHierarchy, which must be referenced by GUID
     * @return the CubeHierarchy that was updated (note that it will NOT contain details of the resulting terms)
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy removeTerms(String qualifiedName, List terms) throws AtlanException {
        return removeTerms(Atlan.getDefaultClient(), qualifiedName, terms);
    }

    /**
     * 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.
     *
     * @param client connectivity to the Atlan tenant from which to remove terms from the CubeHierarchy
     * @param qualifiedName for the CubeHierarchy
     * @param terms the list of terms to remove from the CubeHierarchy, which must be referenced by GUID
     * @return the CubeHierarchy that was updated (note that it will NOT contain details of the resulting terms)
     * @throws AtlanException on any API problems
     */
    public static CubeHierarchy removeTerms(AtlanClient client, String qualifiedName, List terms) throws AtlanException {
        return (CubeHierarchy) Asset.removeTerms(client, TYPE_NAME, qualifiedName, terms);
    }

    /**
     * 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.
     *
     * @param qualifiedName of the CubeHierarchy
     * @param atlanTagNames human-readable names of the Atlan tags to add
     * @throws AtlanException on any API problems
     * @return the updated CubeHierarchy
     */
    public static CubeHierarchy appendAtlanTags(String qualifiedName, List atlanTagNames) throws AtlanException {
        return appendAtlanTags(Atlan.getDefaultClient(), qualifiedName, atlanTagNames);
    }

    /**
     * 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.
     *
     * @param client connectivity to the Atlan tenant on which to append Atlan tags to the CubeHierarchy
     * @param qualifiedName of the CubeHierarchy
     * @param atlanTagNames human-readable names of the Atlan tags to add
     * @throws AtlanException on any API problems
     * @return the updated CubeHierarchy
     */
    public static CubeHierarchy appendAtlanTags(AtlanClient client, String qualifiedName, List atlanTagNames) throws AtlanException {
        return (CubeHierarchy) Asset.appendAtlanTags(client, TYPE_NAME, qualifiedName, atlanTagNames);
    }

    /**
     * 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.
     *
     * @param qualifiedName of the CubeHierarchy
     * @param atlanTagNames human-readable names of the Atlan tags to add
     * @param propagate whether to propagate the Atlan tag (true) or not (false)
     * @param removePropagationsOnDelete whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
     * @param restrictLineagePropagation whether to avoid propagating through lineage (true) or do propagate through lineage (false)
     * @throws AtlanException on any API problems
     * @return the updated CubeHierarchy
     */
    public static CubeHierarchy appendAtlanTags(String qualifiedName, List atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException {
        return appendAtlanTags(Atlan.getDefaultClient(), qualifiedName, atlanTagNames, propagate, removePropagationsOnDelete, restrictLineagePropagation);
    }

    /**
     * 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.
     *
     * @param client connectivity to the Atlan tenant on which to append Atlan tags to the CubeHierarchy
     * @param qualifiedName of the CubeHierarchy
     * @param atlanTagNames human-readable names of the Atlan tags to add
     * @param propagate whether to propagate the Atlan tag (true) or not (false)
     * @param removePropagationsOnDelete whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
     * @param restrictLineagePropagation whether to avoid propagating through lineage (true) or do propagate through lineage (false)
     * @throws AtlanException on any API problems
     * @return the updated CubeHierarchy
     */
    public static CubeHierarchy appendAtlanTags(AtlanClient client, String qualifiedName, List atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException {
        return (CubeHierarchy) Asset.appendAtlanTags(client, TYPE_NAME, qualifiedName, atlanTagNames, propagate, removePropagationsOnDelete, restrictLineagePropagation);
    }

    /**
     * Remove an Atlan tag from a CubeHierarchy.
     *
     * @param qualifiedName of the CubeHierarchy
     * @param 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
     */
    public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException {
        removeAtlanTag(Atlan.getDefaultClient(), qualifiedName, atlanTagName);
    }

    /**
     * Remove an Atlan tag from a CubeHierarchy.
     *
     * @param client connectivity to the Atlan tenant from which to remove an Atlan tag from a CubeHierarchy
     * @param qualifiedName of the CubeHierarchy
     * @param 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
     */
    public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException {
        Asset.removeAtlanTag(client, TYPE_NAME, qualifiedName, atlanTagName);
    }

    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    private static String $default$typeName() {
        return TYPE_NAME;
    }


    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public static abstract class CubeHierarchyBuilder> extends Asset.AssetBuilder {
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private boolean typeName$set;
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private String typeName$value;
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private ICubeDimension cubeDimension;
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private String cubeDimensionName;
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private String cubeDimensionQualifiedName;
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private Long cubeFieldCount;
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private java.util.ArrayList cubeFields;
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private String cubeHierarchyName;
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private String cubeHierarchyQualifiedName;
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private String cubeName;
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private String cubeQualifiedName;
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private java.util.ArrayList inputToAirflowTasks;
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private java.util.ArrayList inputToProcesses;
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private java.util.ArrayList inputToSparkJobs;
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private java.util.ArrayList modelImplementedEntities;
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private java.util.ArrayList outputFromAirflowTasks;
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private java.util.ArrayList outputFromProcesses;
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private java.util.ArrayList outputFromSparkJobs;

        @java.lang.Override
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        protected B $fillValuesFrom(final C instance) {
            super.$fillValuesFrom(instance);
            CubeHierarchy.CubeHierarchyBuilder.$fillValuesFromInstanceIntoBuilder(instance, this);
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private static void $fillValuesFromInstanceIntoBuilder(final CubeHierarchy instance, final CubeHierarchy.CubeHierarchyBuilder b) {
            b.typeName(instance.typeName);
            b.cubeDimension(instance.cubeDimension);
            b.cubeDimensionName(instance.cubeDimensionName);
            b.cubeDimensionQualifiedName(instance.cubeDimensionQualifiedName);
            b.cubeFieldCount(instance.cubeFieldCount);
            b.cubeFields(instance.cubeFields == null ? java.util.Collections.emptySortedSet() : instance.cubeFields);
            b.cubeHierarchyName(instance.cubeHierarchyName);
            b.cubeHierarchyQualifiedName(instance.cubeHierarchyQualifiedName);
            b.cubeName(instance.cubeName);
            b.cubeQualifiedName(instance.cubeQualifiedName);
            b.inputToAirflowTasks(instance.inputToAirflowTasks == null ? java.util.Collections.emptySortedSet() : instance.inputToAirflowTasks);
            b.inputToProcesses(instance.inputToProcesses == null ? java.util.Collections.emptySortedSet() : instance.inputToProcesses);
            b.inputToSparkJobs(instance.inputToSparkJobs == null ? java.util.Collections.emptySortedSet() : instance.inputToSparkJobs);
            b.modelImplementedEntities(instance.modelImplementedEntities == null ? java.util.Collections.emptySortedSet() : instance.modelImplementedEntities);
            b.outputFromAirflowTasks(instance.outputFromAirflowTasks == null ? java.util.Collections.emptySortedSet() : instance.outputFromAirflowTasks);
            b.outputFromProcesses(instance.outputFromProcesses == null ? java.util.Collections.emptySortedSet() : instance.outputFromProcesses);
            b.outputFromSparkJobs(instance.outputFromSparkJobs == null ? java.util.Collections.emptySortedSet() : instance.outputFromSparkJobs);
        }

        /**
         * Fixed typeName for CubeHierarchys.
         * @return {@code this}.
         */
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B typeName(final String typeName) {
            this.typeName$value = typeName;
            typeName$set = true;
            return self();
        }

        /**
         * Dimension in which this hierarchy exists.
         * @return {@code this}.
         */
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B cubeDimension(final ICubeDimension cubeDimension) {
            this.cubeDimension = cubeDimension;
            return self();
        }

        /**
         * Simple name of the cube dimension in which this asset exists, or empty if it is itself a dimension.
         * @return {@code this}.
         */
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B cubeDimensionName(final String cubeDimensionName) {
            this.cubeDimensionName = cubeDimensionName;
            return self();
        }

        /**
         * Unique name of the cube dimension in which this asset exists, or empty if it is itself a dimension.
         * @return {@code this}.
         */
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B cubeDimensionQualifiedName(final String cubeDimensionQualifiedName) {
            this.cubeDimensionQualifiedName = cubeDimensionQualifiedName;
            return self();
        }

        /**
         * Number of total fields in the cube hierarchy.
         * @return {@code this}.
         */
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B cubeFieldCount(final Long cubeFieldCount) {
            this.cubeFieldCount = cubeFieldCount;
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B cubeField(final ICubeField cubeField) {
            if (this.cubeFields == null) this.cubeFields = new java.util.ArrayList();
            this.cubeFields.add(cubeField);
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B cubeFields(final java.util.Collection cubeFields) {
            if (cubeFields == null) {
                throw new java.lang.NullPointerException("cubeFields cannot be null");
            }
            if (this.cubeFields == null) this.cubeFields = new java.util.ArrayList();
            this.cubeFields.addAll(cubeFields);
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B clearCubeFields() {
            if (this.cubeFields != null) this.cubeFields.clear();
            return self();
        }

        /**
         * Simple name of the dimension hierarchy in which this asset exists, or empty if it is itself a hierarchy.
         * @return {@code this}.
         */
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B cubeHierarchyName(final String cubeHierarchyName) {
            this.cubeHierarchyName = cubeHierarchyName;
            return self();
        }

        /**
         * Unique name of the dimension hierarchy in which this asset exists, or empty if it is itself a hierarchy.
         * @return {@code this}.
         */
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B cubeHierarchyQualifiedName(final String cubeHierarchyQualifiedName) {
            this.cubeHierarchyQualifiedName = cubeHierarchyQualifiedName;
            return self();
        }

        /**
         * Simple name of the cube in which this asset exists, or empty if it is itself a cube.
         * @return {@code this}.
         */
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B cubeName(final String cubeName) {
            this.cubeName = cubeName;
            return self();
        }

        /**
         * Unique name of the cube in which this asset exists, or empty if it is itself a cube.
         * @return {@code this}.
         */
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B cubeQualifiedName(final String cubeQualifiedName) {
            this.cubeQualifiedName = cubeQualifiedName;
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B inputToAirflowTask(final IAirflowTask inputToAirflowTask) {
            if (this.inputToAirflowTasks == null) this.inputToAirflowTasks = new java.util.ArrayList();
            this.inputToAirflowTasks.add(inputToAirflowTask);
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B inputToAirflowTasks(final java.util.Collection inputToAirflowTasks) {
            if (inputToAirflowTasks == null) {
                throw new java.lang.NullPointerException("inputToAirflowTasks cannot be null");
            }
            if (this.inputToAirflowTasks == null) this.inputToAirflowTasks = new java.util.ArrayList();
            this.inputToAirflowTasks.addAll(inputToAirflowTasks);
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B clearInputToAirflowTasks() {
            if (this.inputToAirflowTasks != null) this.inputToAirflowTasks.clear();
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B inputToProcess(final ILineageProcess inputToProcess) {
            if (this.inputToProcesses == null) this.inputToProcesses = new java.util.ArrayList();
            this.inputToProcesses.add(inputToProcess);
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B inputToProcesses(final java.util.Collection inputToProcesses) {
            if (inputToProcesses == null) {
                throw new java.lang.NullPointerException("inputToProcesses cannot be null");
            }
            if (this.inputToProcesses == null) this.inputToProcesses = new java.util.ArrayList();
            this.inputToProcesses.addAll(inputToProcesses);
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B clearInputToProcesses() {
            if (this.inputToProcesses != null) this.inputToProcesses.clear();
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B inputToSparkJob(final ISparkJob inputToSparkJob) {
            if (this.inputToSparkJobs == null) this.inputToSparkJobs = new java.util.ArrayList();
            this.inputToSparkJobs.add(inputToSparkJob);
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B inputToSparkJobs(final java.util.Collection inputToSparkJobs) {
            if (inputToSparkJobs == null) {
                throw new java.lang.NullPointerException("inputToSparkJobs cannot be null");
            }
            if (this.inputToSparkJobs == null) this.inputToSparkJobs = new java.util.ArrayList();
            this.inputToSparkJobs.addAll(inputToSparkJobs);
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B clearInputToSparkJobs() {
            if (this.inputToSparkJobs != null) this.inputToSparkJobs.clear();
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B modelImplementedEntity(final IModelEntity modelImplementedEntity) {
            if (this.modelImplementedEntities == null) this.modelImplementedEntities = new java.util.ArrayList();
            this.modelImplementedEntities.add(modelImplementedEntity);
            return self();
        }

        @JsonProperty("modelEntityImplemented")
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B modelImplementedEntities(final java.util.Collection modelImplementedEntities) {
            if (modelImplementedEntities == null) {
                throw new java.lang.NullPointerException("modelImplementedEntities cannot be null");
            }
            if (this.modelImplementedEntities == null) this.modelImplementedEntities = new java.util.ArrayList();
            this.modelImplementedEntities.addAll(modelImplementedEntities);
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B clearModelImplementedEntities() {
            if (this.modelImplementedEntities != null) this.modelImplementedEntities.clear();
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B outputFromAirflowTask(final IAirflowTask outputFromAirflowTask) {
            if (this.outputFromAirflowTasks == null) this.outputFromAirflowTasks = new java.util.ArrayList();
            this.outputFromAirflowTasks.add(outputFromAirflowTask);
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B outputFromAirflowTasks(final java.util.Collection outputFromAirflowTasks) {
            if (outputFromAirflowTasks == null) {
                throw new java.lang.NullPointerException("outputFromAirflowTasks cannot be null");
            }
            if (this.outputFromAirflowTasks == null) this.outputFromAirflowTasks = new java.util.ArrayList();
            this.outputFromAirflowTasks.addAll(outputFromAirflowTasks);
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B clearOutputFromAirflowTasks() {
            if (this.outputFromAirflowTasks != null) this.outputFromAirflowTasks.clear();
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B outputFromProcess(final ILineageProcess outputFromProcess) {
            if (this.outputFromProcesses == null) this.outputFromProcesses = new java.util.ArrayList();
            this.outputFromProcesses.add(outputFromProcess);
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B outputFromProcesses(final java.util.Collection outputFromProcesses) {
            if (outputFromProcesses == null) {
                throw new java.lang.NullPointerException("outputFromProcesses cannot be null");
            }
            if (this.outputFromProcesses == null) this.outputFromProcesses = new java.util.ArrayList();
            this.outputFromProcesses.addAll(outputFromProcesses);
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B clearOutputFromProcesses() {
            if (this.outputFromProcesses != null) this.outputFromProcesses.clear();
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B outputFromSparkJob(final ISparkJob outputFromSparkJob) {
            if (this.outputFromSparkJobs == null) this.outputFromSparkJobs = new java.util.ArrayList();
            this.outputFromSparkJobs.add(outputFromSparkJob);
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B outputFromSparkJobs(final java.util.Collection outputFromSparkJobs) {
            if (outputFromSparkJobs == null) {
                throw new java.lang.NullPointerException("outputFromSparkJobs cannot be null");
            }
            if (this.outputFromSparkJobs == null) this.outputFromSparkJobs = new java.util.ArrayList();
            this.outputFromSparkJobs.addAll(outputFromSparkJobs);
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public B clearOutputFromSparkJobs() {
            if (this.outputFromSparkJobs != null) this.outputFromSparkJobs.clear();
            return self();
        }

        @java.lang.Override
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        protected abstract B self();

        @java.lang.Override
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public abstract C build();

        @java.lang.Override
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public java.lang.String toString() {
            return "CubeHierarchy.CubeHierarchyBuilder(super=" + super.toString() + ", typeName$value=" + this.typeName$value + ", cubeDimension=" + this.cubeDimension + ", cubeDimensionName=" + this.cubeDimensionName + ", cubeDimensionQualifiedName=" + this.cubeDimensionQualifiedName + ", cubeFieldCount=" + this.cubeFieldCount + ", cubeFields=" + this.cubeFields + ", cubeHierarchyName=" + this.cubeHierarchyName + ", cubeHierarchyQualifiedName=" + this.cubeHierarchyQualifiedName + ", cubeName=" + this.cubeName + ", cubeQualifiedName=" + this.cubeQualifiedName + ", inputToAirflowTasks=" + this.inputToAirflowTasks + ", inputToProcesses=" + this.inputToProcesses + ", inputToSparkJobs=" + this.inputToSparkJobs + ", modelImplementedEntities=" + this.modelImplementedEntities + ", outputFromAirflowTasks=" + this.outputFromAirflowTasks + ", outputFromProcesses=" + this.outputFromProcesses + ", outputFromSparkJobs=" + this.outputFromSparkJobs + ")";
        }
    }


    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    private static final class CubeHierarchyBuilderImpl extends CubeHierarchy.CubeHierarchyBuilder {
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private CubeHierarchyBuilderImpl() {
        }

        @java.lang.Override
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        protected CubeHierarchy.CubeHierarchyBuilderImpl self() {
            return this;
        }

        @java.lang.Override
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public CubeHierarchy build() {
            return new CubeHierarchy(this);
        }
    }

    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    protected CubeHierarchy(final CubeHierarchy.CubeHierarchyBuilder b) {
        super(b);
        if (b.typeName$set) this.typeName = b.typeName$value;
         else this.typeName = CubeHierarchy.$default$typeName();
        this.cubeDimension = b.cubeDimension;
        this.cubeDimensionName = b.cubeDimensionName;
        this.cubeDimensionQualifiedName = b.cubeDimensionQualifiedName;
        this.cubeFieldCount = b.cubeFieldCount;
        java.util.SortedSet cubeFields = new java.util.TreeSet();
        if (b.cubeFields != null) cubeFields.addAll(b.cubeFields);
        cubeFields = java.util.Collections.unmodifiableSortedSet(cubeFields);
        this.cubeFields = cubeFields;
        this.cubeHierarchyName = b.cubeHierarchyName;
        this.cubeHierarchyQualifiedName = b.cubeHierarchyQualifiedName;
        this.cubeName = b.cubeName;
        this.cubeQualifiedName = b.cubeQualifiedName;
        java.util.SortedSet inputToAirflowTasks = new java.util.TreeSet();
        if (b.inputToAirflowTasks != null) inputToAirflowTasks.addAll(b.inputToAirflowTasks);
        inputToAirflowTasks = java.util.Collections.unmodifiableSortedSet(inputToAirflowTasks);
        this.inputToAirflowTasks = inputToAirflowTasks;
        java.util.SortedSet inputToProcesses = new java.util.TreeSet();
        if (b.inputToProcesses != null) inputToProcesses.addAll(b.inputToProcesses);
        inputToProcesses = java.util.Collections.unmodifiableSortedSet(inputToProcesses);
        this.inputToProcesses = inputToProcesses;
        java.util.SortedSet inputToSparkJobs = new java.util.TreeSet();
        if (b.inputToSparkJobs != null) inputToSparkJobs.addAll(b.inputToSparkJobs);
        inputToSparkJobs = java.util.Collections.unmodifiableSortedSet(inputToSparkJobs);
        this.inputToSparkJobs = inputToSparkJobs;
        java.util.SortedSet modelImplementedEntities = new java.util.TreeSet();
        if (b.modelImplementedEntities != null) modelImplementedEntities.addAll(b.modelImplementedEntities);
        modelImplementedEntities = java.util.Collections.unmodifiableSortedSet(modelImplementedEntities);
        this.modelImplementedEntities = modelImplementedEntities;
        java.util.SortedSet outputFromAirflowTasks = new java.util.TreeSet();
        if (b.outputFromAirflowTasks != null) outputFromAirflowTasks.addAll(b.outputFromAirflowTasks);
        outputFromAirflowTasks = java.util.Collections.unmodifiableSortedSet(outputFromAirflowTasks);
        this.outputFromAirflowTasks = outputFromAirflowTasks;
        java.util.SortedSet outputFromProcesses = new java.util.TreeSet();
        if (b.outputFromProcesses != null) outputFromProcesses.addAll(b.outputFromProcesses);
        outputFromProcesses = java.util.Collections.unmodifiableSortedSet(outputFromProcesses);
        this.outputFromProcesses = outputFromProcesses;
        java.util.SortedSet outputFromSparkJobs = new java.util.TreeSet();
        if (b.outputFromSparkJobs != null) outputFromSparkJobs.addAll(b.outputFromSparkJobs);
        outputFromSparkJobs = java.util.Collections.unmodifiableSortedSet(outputFromSparkJobs);
        this.outputFromSparkJobs = outputFromSparkJobs;
    }

    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public static CubeHierarchy.CubeHierarchyBuilder _internal() {
        return new CubeHierarchy.CubeHierarchyBuilderImpl();
    }

    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public CubeHierarchy.CubeHierarchyBuilder toBuilder() {
        return new CubeHierarchy.CubeHierarchyBuilderImpl().$fillValuesFrom(this);
    }

    /**
     * Dimension in which this hierarchy exists.
     */
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public ICubeDimension getCubeDimension() {
        return this.cubeDimension;
    }

    /**
     * Simple name of the cube dimension in which this asset exists, or empty if it is itself a dimension.
     */
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public String getCubeDimensionName() {
        return this.cubeDimensionName;
    }

    /**
     * Unique name of the cube dimension in which this asset exists, or empty if it is itself a dimension.
     */
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public String getCubeDimensionQualifiedName() {
        return this.cubeDimensionQualifiedName;
    }

    /**
     * Number of total fields in the cube hierarchy.
     */
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public Long getCubeFieldCount() {
        return this.cubeFieldCount;
    }

    /**
     * Individual fields that make up the hierarchy.
     */
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public SortedSet getCubeFields() {
        return this.cubeFields;
    }

    /**
     * Simple name of the dimension hierarchy in which this asset exists, or empty if it is itself a hierarchy.
     */
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public String getCubeHierarchyName() {
        return this.cubeHierarchyName;
    }

    /**
     * Unique name of the dimension hierarchy in which this asset exists, or empty if it is itself a hierarchy.
     */
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public String getCubeHierarchyQualifiedName() {
        return this.cubeHierarchyQualifiedName;
    }

    /**
     * Simple name of the cube in which this asset exists, or empty if it is itself a cube.
     */
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public String getCubeName() {
        return this.cubeName;
    }

    /**
     * Unique name of the cube in which this asset exists, or empty if it is itself a cube.
     */
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public String getCubeQualifiedName() {
        return this.cubeQualifiedName;
    }

    /**
     * Tasks to which this asset provides input.
     */
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public SortedSet getInputToAirflowTasks() {
        return this.inputToAirflowTasks;
    }

    /**
     * Processes to which this asset provides input.
     */
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public SortedSet getInputToProcesses() {
        return this.inputToProcesses;
    }

    /**
     * TBC
     */
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public SortedSet getInputToSparkJobs() {
        return this.inputToSparkJobs;
    }

    /**
     * Entities implemented by this asset.
     */
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public SortedSet getModelImplementedEntities() {
        return this.modelImplementedEntities;
    }

    /**
     * Tasks from which this asset is output.
     */
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public SortedSet getOutputFromAirflowTasks() {
        return this.outputFromAirflowTasks;
    }

    /**
     * Processes from which this asset is produced as output.
     */
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public SortedSet getOutputFromProcesses() {
        return this.outputFromProcesses;
    }

    /**
     * TBC
     */
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public SortedSet getOutputFromSparkJobs() {
        return this.outputFromSparkJobs;
    }

    @java.lang.Override
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public boolean equals(final java.lang.Object o) {
        if (o == this) return true;
        if (!(o instanceof CubeHierarchy)) return false;
        final CubeHierarchy other = (CubeHierarchy) o;
        if (!other.canEqual((java.lang.Object) this)) return false;
        if (!super.equals(o)) return false;
        final java.lang.Object this$cubeFieldCount = this.getCubeFieldCount();
        final java.lang.Object other$cubeFieldCount = other.getCubeFieldCount();
        if (this$cubeFieldCount == null ? other$cubeFieldCount != null : !this$cubeFieldCount.equals(other$cubeFieldCount)) return false;
        final java.lang.Object this$typeName = this.getTypeName();
        final java.lang.Object other$typeName = other.getTypeName();
        if (this$typeName == null ? other$typeName != null : !this$typeName.equals(other$typeName)) return false;
        final java.lang.Object this$cubeDimension = this.getCubeDimension();
        final java.lang.Object other$cubeDimension = other.getCubeDimension();
        if (this$cubeDimension == null ? other$cubeDimension != null : !this$cubeDimension.equals(other$cubeDimension)) return false;
        final java.lang.Object this$cubeDimensionName = this.getCubeDimensionName();
        final java.lang.Object other$cubeDimensionName = other.getCubeDimensionName();
        if (this$cubeDimensionName == null ? other$cubeDimensionName != null : !this$cubeDimensionName.equals(other$cubeDimensionName)) return false;
        final java.lang.Object this$cubeDimensionQualifiedName = this.getCubeDimensionQualifiedName();
        final java.lang.Object other$cubeDimensionQualifiedName = other.getCubeDimensionQualifiedName();
        if (this$cubeDimensionQualifiedName == null ? other$cubeDimensionQualifiedName != null : !this$cubeDimensionQualifiedName.equals(other$cubeDimensionQualifiedName)) return false;
        final java.lang.Object this$cubeFields = this.getCubeFields();
        final java.lang.Object other$cubeFields = other.getCubeFields();
        if (this$cubeFields == null ? other$cubeFields != null : !this$cubeFields.equals(other$cubeFields)) return false;
        final java.lang.Object this$cubeHierarchyName = this.getCubeHierarchyName();
        final java.lang.Object other$cubeHierarchyName = other.getCubeHierarchyName();
        if (this$cubeHierarchyName == null ? other$cubeHierarchyName != null : !this$cubeHierarchyName.equals(other$cubeHierarchyName)) return false;
        final java.lang.Object this$cubeHierarchyQualifiedName = this.getCubeHierarchyQualifiedName();
        final java.lang.Object other$cubeHierarchyQualifiedName = other.getCubeHierarchyQualifiedName();
        if (this$cubeHierarchyQualifiedName == null ? other$cubeHierarchyQualifiedName != null : !this$cubeHierarchyQualifiedName.equals(other$cubeHierarchyQualifiedName)) return false;
        final java.lang.Object this$cubeName = this.getCubeName();
        final java.lang.Object other$cubeName = other.getCubeName();
        if (this$cubeName == null ? other$cubeName != null : !this$cubeName.equals(other$cubeName)) return false;
        final java.lang.Object this$cubeQualifiedName = this.getCubeQualifiedName();
        final java.lang.Object other$cubeQualifiedName = other.getCubeQualifiedName();
        if (this$cubeQualifiedName == null ? other$cubeQualifiedName != null : !this$cubeQualifiedName.equals(other$cubeQualifiedName)) return false;
        final java.lang.Object this$inputToAirflowTasks = this.getInputToAirflowTasks();
        final java.lang.Object other$inputToAirflowTasks = other.getInputToAirflowTasks();
        if (this$inputToAirflowTasks == null ? other$inputToAirflowTasks != null : !this$inputToAirflowTasks.equals(other$inputToAirflowTasks)) return false;
        final java.lang.Object this$inputToProcesses = this.getInputToProcesses();
        final java.lang.Object other$inputToProcesses = other.getInputToProcesses();
        if (this$inputToProcesses == null ? other$inputToProcesses != null : !this$inputToProcesses.equals(other$inputToProcesses)) return false;
        final java.lang.Object this$inputToSparkJobs = this.getInputToSparkJobs();
        final java.lang.Object other$inputToSparkJobs = other.getInputToSparkJobs();
        if (this$inputToSparkJobs == null ? other$inputToSparkJobs != null : !this$inputToSparkJobs.equals(other$inputToSparkJobs)) return false;
        final java.lang.Object this$modelImplementedEntities = this.getModelImplementedEntities();
        final java.lang.Object other$modelImplementedEntities = other.getModelImplementedEntities();
        if (this$modelImplementedEntities == null ? other$modelImplementedEntities != null : !this$modelImplementedEntities.equals(other$modelImplementedEntities)) return false;
        final java.lang.Object this$outputFromAirflowTasks = this.getOutputFromAirflowTasks();
        final java.lang.Object other$outputFromAirflowTasks = other.getOutputFromAirflowTasks();
        if (this$outputFromAirflowTasks == null ? other$outputFromAirflowTasks != null : !this$outputFromAirflowTasks.equals(other$outputFromAirflowTasks)) return false;
        final java.lang.Object this$outputFromProcesses = this.getOutputFromProcesses();
        final java.lang.Object other$outputFromProcesses = other.getOutputFromProcesses();
        if (this$outputFromProcesses == null ? other$outputFromProcesses != null : !this$outputFromProcesses.equals(other$outputFromProcesses)) return false;
        final java.lang.Object this$outputFromSparkJobs = this.getOutputFromSparkJobs();
        final java.lang.Object other$outputFromSparkJobs = other.getOutputFromSparkJobs();
        if (this$outputFromSparkJobs == null ? other$outputFromSparkJobs != null : !this$outputFromSparkJobs.equals(other$outputFromSparkJobs)) return false;
        return true;
    }

    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    protected boolean canEqual(final java.lang.Object other) {
        return other instanceof CubeHierarchy;
    }

    @java.lang.Override
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public int hashCode() {
        final int PRIME = 59;
        int result = super.hashCode();
        final java.lang.Object $cubeFieldCount = this.getCubeFieldCount();
        result = result * PRIME + ($cubeFieldCount == null ? 43 : $cubeFieldCount.hashCode());
        final java.lang.Object $typeName = this.getTypeName();
        result = result * PRIME + ($typeName == null ? 43 : $typeName.hashCode());
        final java.lang.Object $cubeDimension = this.getCubeDimension();
        result = result * PRIME + ($cubeDimension == null ? 43 : $cubeDimension.hashCode());
        final java.lang.Object $cubeDimensionName = this.getCubeDimensionName();
        result = result * PRIME + ($cubeDimensionName == null ? 43 : $cubeDimensionName.hashCode());
        final java.lang.Object $cubeDimensionQualifiedName = this.getCubeDimensionQualifiedName();
        result = result * PRIME + ($cubeDimensionQualifiedName == null ? 43 : $cubeDimensionQualifiedName.hashCode());
        final java.lang.Object $cubeFields = this.getCubeFields();
        result = result * PRIME + ($cubeFields == null ? 43 : $cubeFields.hashCode());
        final java.lang.Object $cubeHierarchyName = this.getCubeHierarchyName();
        result = result * PRIME + ($cubeHierarchyName == null ? 43 : $cubeHierarchyName.hashCode());
        final java.lang.Object $cubeHierarchyQualifiedName = this.getCubeHierarchyQualifiedName();
        result = result * PRIME + ($cubeHierarchyQualifiedName == null ? 43 : $cubeHierarchyQualifiedName.hashCode());
        final java.lang.Object $cubeName = this.getCubeName();
        result = result * PRIME + ($cubeName == null ? 43 : $cubeName.hashCode());
        final java.lang.Object $cubeQualifiedName = this.getCubeQualifiedName();
        result = result * PRIME + ($cubeQualifiedName == null ? 43 : $cubeQualifiedName.hashCode());
        final java.lang.Object $inputToAirflowTasks = this.getInputToAirflowTasks();
        result = result * PRIME + ($inputToAirflowTasks == null ? 43 : $inputToAirflowTasks.hashCode());
        final java.lang.Object $inputToProcesses = this.getInputToProcesses();
        result = result * PRIME + ($inputToProcesses == null ? 43 : $inputToProcesses.hashCode());
        final java.lang.Object $inputToSparkJobs = this.getInputToSparkJobs();
        result = result * PRIME + ($inputToSparkJobs == null ? 43 : $inputToSparkJobs.hashCode());
        final java.lang.Object $modelImplementedEntities = this.getModelImplementedEntities();
        result = result * PRIME + ($modelImplementedEntities == null ? 43 : $modelImplementedEntities.hashCode());
        final java.lang.Object $outputFromAirflowTasks = this.getOutputFromAirflowTasks();
        result = result * PRIME + ($outputFromAirflowTasks == null ? 43 : $outputFromAirflowTasks.hashCode());
        final java.lang.Object $outputFromProcesses = this.getOutputFromProcesses();
        result = result * PRIME + ($outputFromProcesses == null ? 43 : $outputFromProcesses.hashCode());
        final java.lang.Object $outputFromSparkJobs = this.getOutputFromSparkJobs();
        result = result * PRIME + ($outputFromSparkJobs == null ? 43 : $outputFromSparkJobs.hashCode());
        return result;
    }

    @java.lang.Override
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public java.lang.String toString() {
        return "CubeHierarchy(super=" + super.toString() + ", typeName=" + this.getTypeName() + ", cubeDimension=" + this.getCubeDimension() + ", cubeDimensionName=" + this.getCubeDimensionName() + ", cubeDimensionQualifiedName=" + this.getCubeDimensionQualifiedName() + ", cubeFieldCount=" + this.getCubeFieldCount() + ", cubeFields=" + this.getCubeFields() + ", cubeHierarchyName=" + this.getCubeHierarchyName() + ", cubeHierarchyQualifiedName=" + this.getCubeHierarchyQualifiedName() + ", cubeName=" + this.getCubeName() + ", cubeQualifiedName=" + this.getCubeQualifiedName() + ", inputToAirflowTasks=" + this.getInputToAirflowTasks() + ", inputToProcesses=" + this.getInputToProcesses() + ", inputToSparkJobs=" + this.getInputToSparkJobs() + ", modelImplementedEntities=" + this.getModelImplementedEntities() + ", outputFromAirflowTasks=" + this.getOutputFromAirflowTasks() + ", outputFromProcesses=" + this.getOutputFromProcesses() + ", outputFromSparkJobs=" + this.getOutputFromSparkJobs() + ")";
    }

    /**
     * Fixed typeName for CubeHierarchys.
     */
    @Override
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public String getTypeName() {
        return this.typeName;
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy