com.atlan.model.assets.AtlanCollection Maven / Gradle / Ivy
// Generated by delombok at Thu Oct 10 18:56:32 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.core.AssetMutationResponse;
import com.atlan.model.core.AsyncCreationResponse;
import com.atlan.model.enums.AtlanAnnouncementType;
import com.atlan.model.enums.CertificateStatus;
import com.atlan.model.enums.IconType;
import com.atlan.model.fields.AtlanField;
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 java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.SortedSet;
import java.util.UUID;
import java.util.concurrent.ThreadLocalRandom;
import javax.annotation.processing.Generated;
import lombok.*;
/**
* Instance of a query collection in Atlan.
*/
@Generated("com.atlan.generators.ModelGeneratorV2")
public class AtlanCollection extends Asset implements IAtlanCollection, INamespace, IAsset, IReferenceable {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(AtlanCollection.class);
private static final long serialVersionUID = 2L;
public static final String TYPE_NAME = "Collection";
/**
* Fixed typeName for AtlanCollections.
*/
String typeName;
/**
* TBC
*/
@Attribute
SortedSet childrenFolders;
/**
* TBC
*/
@Attribute
SortedSet childrenQueries;
/**
* TBC
*/
@Attribute
String icon;
/**
* TBC
*/
@Attribute
IconType iconType;
/**
* Builds the minimal object necessary to create a relationship to a AtlanCollection, from a potentially
* more-complete AtlanCollection object.
*
* @return the minimal object necessary to relate to the AtlanCollection
* @throws InvalidRequestException if any of the minimal set of required properties for a AtlanCollection relationship are not found in the initial object
*/
@Override
public AtlanCollection 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 AtlanCollection 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) AtlanCollection assets will be included.
*
* @return a fluent search that includes all AtlanCollection assets
*/
public static FluentSearch.FluentSearchBuilder select() {
return select(Atlan.getDefaultClient());
}
/**
* Start a fluent search that will return all AtlanCollection 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) AtlanCollection assets will be included.
*
* @param client connectivity to the Atlan tenant from which to retrieve the assets
* @return a fluent search that includes all AtlanCollection assets
*/
public static FluentSearch.FluentSearchBuilder select(AtlanClient client) {
return select(client, false);
}
/**
* Start a fluent search that will return all AtlanCollection 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) AtlanCollections will be included
* @return a fluent search that includes all AtlanCollection assets
*/
public static FluentSearch.FluentSearchBuilder select(boolean includeArchived) {
return select(Atlan.getDefaultClient(), includeArchived);
}
/**
* Start a fluent search that will return all AtlanCollection 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) AtlanCollections will be included
* @return a fluent search that includes all AtlanCollection 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 AtlanCollection by GUID. Use this to create a relationship to this AtlanCollection,
* where the relationship should be replaced.
*
* @param guid the GUID of the AtlanCollection to reference
* @return reference to a AtlanCollection that can be used for defining a relationship to a AtlanCollection
*/
public static AtlanCollection refByGuid(String guid) {
return refByGuid(guid, Reference.SaveSemantic.REPLACE);
}
/**
* Reference to a AtlanCollection by GUID. Use this to create a relationship to this AtlanCollection,
* where you want to further control how that relationship should be updated (i.e. replaced,
* appended, or removed).
*
* @param guid the GUID of the AtlanCollection to reference
* @param semantic how to save this relationship (replace all with this, append it, or remove it)
* @return reference to a AtlanCollection that can be used for defining a relationship to a AtlanCollection
*/
public static AtlanCollection refByGuid(String guid, Reference.SaveSemantic semantic) {
return AtlanCollection._internal().guid(guid).semantic(semantic).build();
}
/**
* Reference to a AtlanCollection by qualifiedName. Use this to create a relationship to this AtlanCollection,
* where the relationship should be replaced.
*
* @param qualifiedName the qualifiedName of the AtlanCollection to reference
* @return reference to a AtlanCollection that can be used for defining a relationship to a AtlanCollection
*/
public static AtlanCollection refByQualifiedName(String qualifiedName) {
return refByQualifiedName(qualifiedName, Reference.SaveSemantic.REPLACE);
}
/**
* Reference to a AtlanCollection by qualifiedName. Use this to create a relationship to this AtlanCollection,
* where you want to further control how that relationship should be updated (i.e. replaced,
* appended, or removed).
*
* @param qualifiedName the qualifiedName of the AtlanCollection to reference
* @param semantic how to save this relationship (replace all with this, append it, or remove it)
* @return reference to a AtlanCollection that can be used for defining a relationship to a AtlanCollection
*/
public static AtlanCollection refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic) {
return AtlanCollection._internal().uniqueAttributes(UniqueAttributes.builder().qualifiedName(qualifiedName).build()).semantic(semantic).build();
}
/**
* Retrieves a AtlanCollection by one of its identifiers, complete with all of its relationships.
*
* @param id of the AtlanCollection to retrieve, either its GUID or its full qualifiedName
* @return the requested full AtlanCollection, complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the AtlanCollection does not exist or the provided GUID is not a AtlanCollection
*/
@JsonIgnore
public static AtlanCollection get(String id) throws AtlanException {
return get(Atlan.getDefaultClient(), id);
}
/**
* Retrieves a AtlanCollection 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 AtlanCollection to retrieve, either its GUID or its full qualifiedName
* @return the requested full AtlanCollection, complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the AtlanCollection does not exist or the provided GUID is not a AtlanCollection
*/
@JsonIgnore
public static AtlanCollection get(AtlanClient client, String id) throws AtlanException {
return get(client, id, true);
}
/**
* Retrieves a AtlanCollection 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 AtlanCollection 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 AtlanCollection, optionally complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the AtlanCollection does not exist or the provided GUID is not a AtlanCollection
*/
@JsonIgnore
public static AtlanCollection 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 AtlanCollection) {
return (AtlanCollection) 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 AtlanCollection) {
return (AtlanCollection) asset;
} else {
throw new NotFoundException(ErrorCode.ASSET_NOT_FOUND_BY_QN, id, TYPE_NAME);
}
}
}
/**
* Restore the archived (soft-deleted) AtlanCollection to active.
*
* @param qualifiedName for the AtlanCollection
* @return true if the AtlanCollection 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) AtlanCollection to active.
*
* @param client connectivity to the Atlan tenant on which to restore the asset
* @param qualifiedName for the AtlanCollection
* @return true if the AtlanCollection 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);
}
/**
* Add the API token configured for the default client as an admin for this AtlanCollection.
* This is necessary to allow the API token to manage the collection itself or any queries within it.
*
* @param impersonationToken a bearer token for an actual user who is already an admin for the AtlanCollection, NOT an API token
* @throws AtlanException on any error during API invocation
*/
public AssetMutationResponse addApiTokenAsAdmin(final String impersonationToken) throws AtlanException {
return Asset.addApiTokenAsAdmin(getGuid(), impersonationToken);
}
/**
* Add the API token configured for the default client as a viewer for this AtlanCollection.
* This is necessary to allow the API token to view or run queries within the collection, but not make any
* changes to them.
*
* @param impersonationToken a bearer token for an actual user who is already an admin for the AtlanCollection, NOT an API token
* @throws AtlanException on any error during API invocation
*/
public AssetMutationResponse addApiTokenAsViewer(final String impersonationToken) throws AtlanException {
AtlanClient client = Atlan.getDefaultClient();
String token = client.users.getCurrentUser().getUsername();
String clientGuid = UUID.randomUUID().toString();
AtlanClient tmp = Atlan.getClient(client.getBaseUrl(), clientGuid);
tmp.setApiToken(impersonationToken);
// Look for the asset as the impersonated user, ensuring we include the viewer users
// in the results (so we avoid clobbering any existing viewer users)
Optional found = tmp.assets.select().where(GUID.eq(getGuid())).includeOnResults(VIEWER_USERS).stream().findFirst();
AssetMutationResponse response = null;
if (found.isPresent()) {
Asset asset = found.get();
Set existingViewers = asset.getViewerUsers();
response = asset.trimToRequired().viewerUsers(existingViewers).viewerUser(token).build().save(tmp);
} else {
throw new NotFoundException(ErrorCode.ASSET_NOT_FOUND_BY_GUID, getGuid());
}
Atlan.removeClient(client.getBaseUrl(), clientGuid);
return response;
}
/**
* Builds the minimal object necessary to create an AltanCollection.
*
* @param client connectivity to the Atlan tenant
* @param name of the AtlanCollection as the user who will own the AtlanCollection
* @return the minimal request necessary to create the AtlanCollection, as a builder
*/
public static AtlanCollectionBuilder creator(AtlanClient client, String name) {
return AtlanCollection._internal().guid("-" + ThreadLocalRandom.current().nextLong(0, Long.MAX_VALUE - 1)).name(name).qualifiedName(generateQualifiedName(client));
}
/**
* Generate a unique AltanCollection name.
*
* @param client connectivity to the Atlan tenant as the user who will own the AtlanCollection
* @return a unique name for the AltanCollection
*/
public static String generateQualifiedName(AtlanClient client) {
try {
String username = client.users.getCurrentUser().getUsername();
return "default/collection/" + username + "/" + UUID.randomUUID();
} catch (AtlanException e) {
log.error("Unable to determine the current user.", e);
}
return null;
}
/**
* If an asset with the same qualifiedName exists, updates the existing asset. Otherwise, creates the asset.
* No Atlan tags or custom metadata will be changed if updating an existing asset, irrespective of what
* is included in the asset itself when the method is called.
*
* @return details of the created or updated asset
* @throws AtlanException on any error during the API invocation
*/
@Override
public AsyncCreationResponse save() throws AtlanException {
return save(Atlan.getDefaultClient());
}
/**
* If an asset with the same qualifiedName exists, updates the existing asset. Otherwise, creates the asset.
* No Atlan tags or custom metadata will be changed if updating an existing asset, irrespective of what
* is included in the asset itself when the method is called.
*
* @param client connectivity to the Atlan tenant where this collection should be saved
* @return details of the created or updated asset
* @throws AtlanException on any error during the API invocation
*/
@Override
public AsyncCreationResponse save(AtlanClient client) throws AtlanException {
return client.assets.save(this, false);
}
/**
* If no asset exists, has the same behavior as the {@link #save()} method.
* If an asset does exist, optionally overwrites any Atlan tags. Custom metadata will always
* be entirely ignored using this method.
*
* @param replaceAtlanTags whether to replace Atlan tags during an update (true) or not (false)
* @return details of the created or updated asset
* @throws AtlanException on any error during the API invocation
*/
@Override
public AsyncCreationResponse save(boolean replaceAtlanTags) throws AtlanException {
return save(Atlan.getDefaultClient(), replaceAtlanTags);
}
/**
* If no asset exists, has the same behavior as the {@link #save()} method.
* If an asset does exist, optionally overwrites any Atlan tags. Custom metadata will always
* be entirely ignored using this method.
*
* @param client connectivity to the Atlan tenant where this collection should be saved
* @param replaceAtlanTags whether to replace Atlan tags during an update (true) or not (false)
* @return details of the created or updated asset
* @throws AtlanException on any error during the API invocation
*/
@Override
public AsyncCreationResponse save(AtlanClient client, boolean replaceAtlanTags) throws AtlanException {
return client.assets.save(this, replaceAtlanTags);
}
/**
* Builds the minimal object necessary to update a AtlanCollection.
*
* @param qualifiedName of the AtlanCollection
* @param name of the AtlanCollection
* @return the minimal request necessary to update the AtlanCollection, as a builder
*/
public static AtlanCollectionBuilder updater(String qualifiedName, String name) {
return AtlanCollection._internal().guid("-" + ThreadLocalRandom.current().nextLong(0, Long.MAX_VALUE - 1)).qualifiedName(qualifiedName).name(name);
}
/**
* Builds the minimal object necessary to apply an update to a AtlanCollection, from a potentially
* more-complete AtlanCollection object.
*
* @return the minimal object necessary to update the AtlanCollection, as a builder
* @throws InvalidRequestException if any of the minimal set of required properties for AtlanCollection are not found in the initial object
*/
@Override
public AtlanCollectionBuilder trimToRequired() throws InvalidRequestException {
validateRequired(TYPE_NAME, Map.of("qualifiedName", this.getQualifiedName(), "name", this.getName()));
return updater(this.getQualifiedName(), this.getName());
}
/**
* Find a collection by its human-readable name. Only the bare minimum set of attributes and no
* relationships will be retrieved for the collection, if found.
*
* @param name of the collection
* @return all collections with that name, if found
* @throws AtlanException on any API problems
* @throws NotFoundException if the collection does not exist
*/
public static List findByName(String name) throws AtlanException {
return findByName(name, (List) null);
}
/**
* Find a collection by its human-readable name.
*
* @param name of the collection
* @param attributes an optional collection of attributes (unchecked) to retrieve for the collection
* @return all collections with that name, if found
* @throws AtlanException on any API problems
* @throws NotFoundException if the collection does not exist
*/
public static List findByName(String name, Collection attributes) throws AtlanException {
return findByName(Atlan.getDefaultClient(), name, attributes);
}
/**
* Find a collection by its human-readable name.
*
* @param name of the collection
* @param attributes an optional collection of attributes (checked) to retrieve for the collection
* @return all collections with that name, if found
* @throws AtlanException on any API problems
* @throws NotFoundException if the collection does not exist
*/
public static List findByName(String name, List attributes) throws AtlanException {
return findByName(Atlan.getDefaultClient(), name, attributes);
}
/**
* Find a collection by its human-readable name. Only the bare minimum set of attributes and no
* relationships will be retrieved for the collection, if found.
*
* @param client connectivity to the Atlan tenant in which to search for the collection
* @param name of the collection
* @return all collections with that name, if found
* @throws AtlanException on any API problems
* @throws NotFoundException if the collection does not exist
*/
public static List findByName(AtlanClient client, String name) throws AtlanException {
return findByName(client, name, (List) null);
}
/**
* Find a collection by its human-readable name.
*
* @param client connectivity to the Atlan tenant in which to search for the collection
* @param name of the collection
* @param attributes an optional collection of attributes to retrieve for the collection
* @return all collections with that name, if found
* @throws AtlanException on any API problems
* @throws NotFoundException if the collection does not exist
*/
public static List findByName(AtlanClient client, String name, Collection attributes) throws AtlanException {
List results = new ArrayList<>();
AtlanCollection.select(client).where(NAME.eq(name))._includesOnResults(attributes == null ? Collections.emptyList() : attributes).stream().filter(a -> a instanceof AtlanCollection).forEach(c -> results.add((AtlanCollection) c));
if (results.isEmpty()) {
throw new NotFoundException(ErrorCode.COLLECTION_NOT_FOUND_BY_NAME, name);
}
return results;
}
/**
* Find a collection by its human-readable name.
*
* @param client connectivity to the Atlan tenant in which to search for the collection
* @param name of the collection
* @param attributes an optional collection of attributes (checked) to retrieve for the collection
* @return all collections with that name, if found
* @throws AtlanException on any API problems
* @throws NotFoundException if the collection does not exist
*/
public static List findByName(AtlanClient client, String name, List attributes) throws AtlanException {
List results = new ArrayList<>();
AtlanCollection.select(client).where(NAME.eq(name)).includesOnResults(attributes == null ? Collections.emptyList() : attributes).stream().filter(a -> a instanceof AtlanCollection).forEach(c -> results.add((AtlanCollection) c));
if (results.isEmpty()) {
throw new NotFoundException(ErrorCode.COLLECTION_NOT_FOUND_BY_NAME, name);
}
return results;
}
/**
* Remove the system description from a AtlanCollection.
*
* @param qualifiedName of the AtlanCollection
* @param name of the AtlanCollection
* @return the updated AtlanCollection, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static AtlanCollection removeDescription(String qualifiedName, String name) throws AtlanException {
return removeDescription(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the system description from a AtlanCollection.
*
* @param client connectivity to the Atlan tenant on which to remove the asset's description
* @param qualifiedName of the AtlanCollection
* @param name of the AtlanCollection
* @return the updated AtlanCollection, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static AtlanCollection removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (AtlanCollection) Asset.removeDescription(client, updater(qualifiedName, name));
}
/**
* Remove the user's description from a AtlanCollection.
*
* @param qualifiedName of the AtlanCollection
* @param name of the AtlanCollection
* @return the updated AtlanCollection, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static AtlanCollection removeUserDescription(String qualifiedName, String name) throws AtlanException {
return removeUserDescription(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the user's description from a AtlanCollection.
*
* @param client connectivity to the Atlan tenant on which to remove the asset's description
* @param qualifiedName of the AtlanCollection
* @param name of the AtlanCollection
* @return the updated AtlanCollection, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static AtlanCollection removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (AtlanCollection) Asset.removeUserDescription(client, updater(qualifiedName, name));
}
/**
* Remove the owners from a AtlanCollection.
*
* @param qualifiedName of the AtlanCollection
* @param name of the AtlanCollection
* @return the updated AtlanCollection, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static AtlanCollection removeOwners(String qualifiedName, String name) throws AtlanException {
return removeOwners(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the owners from a AtlanCollection.
*
* @param client connectivity to the Atlan tenant from which to remove the AtlanCollection's owners
* @param qualifiedName of the AtlanCollection
* @param name of the AtlanCollection
* @return the updated AtlanCollection, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static AtlanCollection removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (AtlanCollection) Asset.removeOwners(client, updater(qualifiedName, name));
}
/**
* Update the certificate on a AtlanCollection.
*
* @param qualifiedName of the AtlanCollection
* @param certificate to use
* @param message (optional) message, or null if no message
* @return the updated AtlanCollection, or null if the update failed
* @throws AtlanException on any API problems
*/
public static AtlanCollection updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException {
return updateCertificate(Atlan.getDefaultClient(), qualifiedName, certificate, message);
}
/**
* Update the certificate on a AtlanCollection.
*
* @param client connectivity to the Atlan tenant on which to update the AtlanCollection's certificate
* @param qualifiedName of the AtlanCollection
* @param certificate to use
* @param message (optional) message, or null if no message
* @return the updated AtlanCollection, or null if the update failed
* @throws AtlanException on any API problems
*/
public static AtlanCollection updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException {
return (AtlanCollection) Asset.updateCertificate(client, _internal(), TYPE_NAME, qualifiedName, certificate, message);
}
/**
* Remove the certificate from a AtlanCollection.
*
* @param qualifiedName of the AtlanCollection
* @param name of the AtlanCollection
* @return the updated AtlanCollection, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static AtlanCollection removeCertificate(String qualifiedName, String name) throws AtlanException {
return removeCertificate(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the certificate from a AtlanCollection.
*
* @param client connectivity to the Atlan tenant from which to remove the AtlanCollection's certificate
* @param qualifiedName of the AtlanCollection
* @param name of the AtlanCollection
* @return the updated AtlanCollection, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static AtlanCollection removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (AtlanCollection) Asset.removeCertificate(client, updater(qualifiedName, name));
}
/**
* Update the announcement on a AtlanCollection.
*
* @param qualifiedName of the AtlanCollection
* @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 AtlanCollection updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException {
return updateAnnouncement(Atlan.getDefaultClient(), qualifiedName, type, title, message);
}
/**
* Update the announcement on a AtlanCollection.
*
* @param client connectivity to the Atlan tenant on which to update the AtlanCollection's announcement
* @param qualifiedName of the AtlanCollection
* @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 AtlanCollection updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException {
return (AtlanCollection) Asset.updateAnnouncement(client, _internal(), TYPE_NAME, qualifiedName, type, title, message);
}
/**
* Remove the announcement from a AtlanCollection.
*
* @param qualifiedName of the AtlanCollection
* @param name of the AtlanCollection
* @return the updated AtlanCollection, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static AtlanCollection removeAnnouncement(String qualifiedName, String name) throws AtlanException {
return removeAnnouncement(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the announcement from a AtlanCollection.
*
* @param client connectivity to the Atlan client from which to remove the AtlanCollection's announcement
* @param qualifiedName of the AtlanCollection
* @param name of the AtlanCollection
* @return the updated AtlanCollection, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static AtlanCollection removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (AtlanCollection) Asset.removeAnnouncement(client, updater(qualifiedName, name));
}
/**
* Replace the terms linked to the AtlanCollection.
*
* @param qualifiedName for the AtlanCollection
* @param name human-readable name of the AtlanCollection
* @param terms the list of terms to replace on the AtlanCollection, or null to remove all terms from the AtlanCollection
* @return the AtlanCollection that was updated (note that it will NOT contain details of the replaced terms)
* @throws AtlanException on any API problems
*/
public static AtlanCollection replaceTerms(String qualifiedName, String name, List terms) throws AtlanException {
return replaceTerms(Atlan.getDefaultClient(), qualifiedName, name, terms);
}
/**
* Replace the terms linked to the AtlanCollection.
*
* @param client connectivity to the Atlan tenant on which to replace the AtlanCollection's assigned terms
* @param qualifiedName for the AtlanCollection
* @param name human-readable name of the AtlanCollection
* @param terms the list of terms to replace on the AtlanCollection, or null to remove all terms from the AtlanCollection
* @return the AtlanCollection that was updated (note that it will NOT contain details of the replaced terms)
* @throws AtlanException on any API problems
*/
public static AtlanCollection replaceTerms(AtlanClient client, String qualifiedName, String name, List terms) throws AtlanException {
return (AtlanCollection) Asset.replaceTerms(client, updater(qualifiedName, name), terms);
}
/**
* Link additional terms to the AtlanCollection, without replacing existing terms linked to the AtlanCollection.
* Note: this operation must make two API calls — one to retrieve the AtlanCollection's existing terms,
* and a second to append the new terms.
*
* @param qualifiedName for the AtlanCollection
* @param terms the list of terms to append to the AtlanCollection
* @return the AtlanCollection that was updated (note that it will NOT contain details of the appended terms)
* @throws AtlanException on any API problems
*/
public static AtlanCollection appendTerms(String qualifiedName, List terms) throws AtlanException {
return appendTerms(Atlan.getDefaultClient(), qualifiedName, terms);
}
/**
* Link additional terms to the AtlanCollection, without replacing existing terms linked to the AtlanCollection.
* Note: this operation must make two API calls — one to retrieve the AtlanCollection'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 AtlanCollection
* @param qualifiedName for the AtlanCollection
* @param terms the list of terms to append to the AtlanCollection
* @return the AtlanCollection that was updated (note that it will NOT contain details of the appended terms)
* @throws AtlanException on any API problems
*/
public static AtlanCollection appendTerms(AtlanClient client, String qualifiedName, List terms) throws AtlanException {
return (AtlanCollection) Asset.appendTerms(client, TYPE_NAME, qualifiedName, terms);
}
/**
* Remove terms from a AtlanCollection, without replacing all existing terms linked to the AtlanCollection.
* Note: this operation must make two API calls — one to retrieve the AtlanCollection's existing terms,
* and a second to remove the provided terms.
*
* @param qualifiedName for the AtlanCollection
* @param terms the list of terms to remove from the AtlanCollection, which must be referenced by GUID
* @return the AtlanCollection that was updated (note that it will NOT contain details of the resulting terms)
* @throws AtlanException on any API problems
*/
public static AtlanCollection removeTerms(String qualifiedName, List terms) throws AtlanException {
return removeTerms(Atlan.getDefaultClient(), qualifiedName, terms);
}
/**
* Remove terms from a AtlanCollection, without replacing all existing terms linked to the AtlanCollection.
* Note: this operation must make two API calls — one to retrieve the AtlanCollection'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 AtlanCollection
* @param qualifiedName for the AtlanCollection
* @param terms the list of terms to remove from the AtlanCollection, which must be referenced by GUID
* @return the AtlanCollection that was updated (note that it will NOT contain details of the resulting terms)
* @throws AtlanException on any API problems
*/
public static AtlanCollection removeTerms(AtlanClient client, String qualifiedName, List terms) throws AtlanException {
return (AtlanCollection) Asset.removeTerms(client, TYPE_NAME, qualifiedName, terms);
}
/**
* Add Atlan tags to a AtlanCollection, without replacing existing Atlan tags linked to the AtlanCollection.
* Note: this operation must make two API calls — one to retrieve the AtlanCollection's existing Atlan tags,
* and a second to append the new Atlan tags.
*
* @param qualifiedName of the AtlanCollection
* @param atlanTagNames human-readable names of the Atlan tags to add
* @throws AtlanException on any API problems
* @return the updated AtlanCollection
*/
public static AtlanCollection appendAtlanTags(String qualifiedName, List atlanTagNames) throws AtlanException {
return appendAtlanTags(Atlan.getDefaultClient(), qualifiedName, atlanTagNames);
}
/**
* Add Atlan tags to a AtlanCollection, without replacing existing Atlan tags linked to the AtlanCollection.
* Note: this operation must make two API calls — one to retrieve the AtlanCollection'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 AtlanCollection
* @param qualifiedName of the AtlanCollection
* @param atlanTagNames human-readable names of the Atlan tags to add
* @throws AtlanException on any API problems
* @return the updated AtlanCollection
*/
public static AtlanCollection appendAtlanTags(AtlanClient client, String qualifiedName, List atlanTagNames) throws AtlanException {
return (AtlanCollection) Asset.appendAtlanTags(client, TYPE_NAME, qualifiedName, atlanTagNames);
}
/**
* Add Atlan tags to a AtlanCollection, without replacing existing Atlan tags linked to the AtlanCollection.
* Note: this operation must make two API calls — one to retrieve the AtlanCollection's existing Atlan tags,
* and a second to append the new Atlan tags.
*
* @param qualifiedName of the AtlanCollection
* @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 AtlanCollection
*/
public static AtlanCollection 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 AtlanCollection, without replacing existing Atlan tags linked to the AtlanCollection.
* Note: this operation must make two API calls — one to retrieve the AtlanCollection'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 AtlanCollection
* @param qualifiedName of the AtlanCollection
* @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 AtlanCollection
*/
public static AtlanCollection appendAtlanTags(AtlanClient client, String qualifiedName, List atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException {
return (AtlanCollection) Asset.appendAtlanTags(client, TYPE_NAME, qualifiedName, atlanTagNames, propagate, removePropagationsOnDelete, restrictLineagePropagation);
}
/**
* Remove an Atlan tag from a AtlanCollection.
*
* @param qualifiedName of the AtlanCollection
* @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 AtlanCollection
*/
public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException {
removeAtlanTag(Atlan.getDefaultClient(), qualifiedName, atlanTagName);
}
/**
* Remove an Atlan tag from a AtlanCollection.
*
* @param client connectivity to the Atlan tenant from which to remove an Atlan tag from a AtlanCollection
* @param qualifiedName of the AtlanCollection
* @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 AtlanCollection
*/
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 AtlanCollectionBuilder> 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 java.util.ArrayList childrenFolders;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private java.util.ArrayList childrenQueries;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private String icon;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private IconType iconType;
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected B $fillValuesFrom(final C instance) {
super.$fillValuesFrom(instance);
AtlanCollection.AtlanCollectionBuilder.$fillValuesFromInstanceIntoBuilder(instance, this);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static void $fillValuesFromInstanceIntoBuilder(final AtlanCollection instance, final AtlanCollection.AtlanCollectionBuilder b) {
b.typeName(instance.typeName);
b.childrenFolders(instance.childrenFolders == null ? java.util.Collections.emptySortedSet() : instance.childrenFolders);
b.childrenQueries(instance.childrenQueries == null ? java.util.Collections.emptySortedSet() : instance.childrenQueries);
b.icon(instance.icon);
b.iconType(instance.iconType);
}
/**
* Fixed typeName for AtlanCollections.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B typeName(final String typeName) {
this.typeName$value = typeName;
typeName$set = true;
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B childrenFolder(final IFolder childrenFolder) {
if (this.childrenFolders == null) this.childrenFolders = new java.util.ArrayList();
this.childrenFolders.add(childrenFolder);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B childrenFolders(final java.util.Collection childrenFolders) {
if (childrenFolders == null) {
throw new java.lang.NullPointerException("childrenFolders cannot be null");
}
if (this.childrenFolders == null) this.childrenFolders = new java.util.ArrayList();
this.childrenFolders.addAll(childrenFolders);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B clearChildrenFolders() {
if (this.childrenFolders != null) this.childrenFolders.clear();
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B childrenQuery(final IAtlanQuery childrenQuery) {
if (this.childrenQueries == null) this.childrenQueries = new java.util.ArrayList();
this.childrenQueries.add(childrenQuery);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B childrenQueries(final java.util.Collection childrenQueries) {
if (childrenQueries == null) {
throw new java.lang.NullPointerException("childrenQueries cannot be null");
}
if (this.childrenQueries == null) this.childrenQueries = new java.util.ArrayList();
this.childrenQueries.addAll(childrenQueries);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B clearChildrenQueries() {
if (this.childrenQueries != null) this.childrenQueries.clear();
return self();
}
/**
* TBC
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B icon(final String icon) {
this.icon = icon;
return self();
}
/**
* TBC
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B iconType(final IconType iconType) {
this.iconType = iconType;
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 "AtlanCollection.AtlanCollectionBuilder(super=" + super.toString() + ", typeName$value=" + this.typeName$value + ", childrenFolders=" + this.childrenFolders + ", childrenQueries=" + this.childrenQueries + ", icon=" + this.icon + ", iconType=" + this.iconType + ")";
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static final class AtlanCollectionBuilderImpl extends AtlanCollection.AtlanCollectionBuilder {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private AtlanCollectionBuilderImpl() {
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected AtlanCollection.AtlanCollectionBuilderImpl self() {
return this;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public AtlanCollection build() {
return new AtlanCollection(this);
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected AtlanCollection(final AtlanCollection.AtlanCollectionBuilder b) {
super(b);
if (b.typeName$set) this.typeName = b.typeName$value;
else this.typeName = AtlanCollection.$default$typeName();
java.util.SortedSet childrenFolders = new java.util.TreeSet();
if (b.childrenFolders != null) childrenFolders.addAll(b.childrenFolders);
childrenFolders = java.util.Collections.unmodifiableSortedSet(childrenFolders);
this.childrenFolders = childrenFolders;
java.util.SortedSet childrenQueries = new java.util.TreeSet();
if (b.childrenQueries != null) childrenQueries.addAll(b.childrenQueries);
childrenQueries = java.util.Collections.unmodifiableSortedSet(childrenQueries);
this.childrenQueries = childrenQueries;
this.icon = b.icon;
this.iconType = b.iconType;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public static AtlanCollection.AtlanCollectionBuilder _internal() {
return new AtlanCollection.AtlanCollectionBuilderImpl();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public AtlanCollection.AtlanCollectionBuilder toBuilder() {
return new AtlanCollection.AtlanCollectionBuilderImpl().$fillValuesFrom(this);
}
/**
* TBC
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public SortedSet getChildrenFolders() {
return this.childrenFolders;
}
/**
* TBC
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public SortedSet getChildrenQueries() {
return this.childrenQueries;
}
/**
* TBC
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getIcon() {
return this.icon;
}
/**
* TBC
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public IconType getIconType() {
return this.iconType;
}
@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 AtlanCollection)) return false;
final AtlanCollection other = (AtlanCollection) o;
if (!other.canEqual((java.lang.Object) this)) return false;
if (!super.equals(o)) 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$childrenFolders = this.getChildrenFolders();
final java.lang.Object other$childrenFolders = other.getChildrenFolders();
if (this$childrenFolders == null ? other$childrenFolders != null : !this$childrenFolders.equals(other$childrenFolders)) return false;
final java.lang.Object this$childrenQueries = this.getChildrenQueries();
final java.lang.Object other$childrenQueries = other.getChildrenQueries();
if (this$childrenQueries == null ? other$childrenQueries != null : !this$childrenQueries.equals(other$childrenQueries)) return false;
final java.lang.Object this$icon = this.getIcon();
final java.lang.Object other$icon = other.getIcon();
if (this$icon == null ? other$icon != null : !this$icon.equals(other$icon)) return false;
final java.lang.Object this$iconType = this.getIconType();
final java.lang.Object other$iconType = other.getIconType();
if (this$iconType == null ? other$iconType != null : !this$iconType.equals(other$iconType)) return false;
return true;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected boolean canEqual(final java.lang.Object other) {
return other instanceof AtlanCollection;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public int hashCode() {
final int PRIME = 59;
int result = super.hashCode();
final java.lang.Object $typeName = this.getTypeName();
result = result * PRIME + ($typeName == null ? 43 : $typeName.hashCode());
final java.lang.Object $childrenFolders = this.getChildrenFolders();
result = result * PRIME + ($childrenFolders == null ? 43 : $childrenFolders.hashCode());
final java.lang.Object $childrenQueries = this.getChildrenQueries();
result = result * PRIME + ($childrenQueries == null ? 43 : $childrenQueries.hashCode());
final java.lang.Object $icon = this.getIcon();
result = result * PRIME + ($icon == null ? 43 : $icon.hashCode());
final java.lang.Object $iconType = this.getIconType();
result = result * PRIME + ($iconType == null ? 43 : $iconType.hashCode());
return result;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public java.lang.String toString() {
return "AtlanCollection(super=" + super.toString() + ", typeName=" + this.getTypeName() + ", childrenFolders=" + this.getChildrenFolders() + ", childrenQueries=" + this.getChildrenQueries() + ", icon=" + this.getIcon() + ", iconType=" + this.getIconType() + ")";
}
/**
* Fixed typeName for AtlanCollections.
*/
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getTypeName() {
return this.typeName;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy