com.atlan.model.assets.BusinessPolicyException 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.enums.AtlanAnnouncementType;
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 java.util.List;
import java.util.Map;
import java.util.SortedSet;
import java.util.concurrent.ThreadLocalRandom;
import javax.annotation.processing.Generated;
import lombok.*;
/**
* Exception to a business policy
*/
@Generated("com.atlan.generators.ModelGeneratorV2")
public class BusinessPolicyException extends Asset implements IBusinessPolicyException, IAsset, IReferenceable {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(BusinessPolicyException.class);
private static final long serialVersionUID = 2L;
public static final String TYPE_NAME = "BusinessPolicyException";
/**
* Fixed typeName for BusinessPolicyExceptions.
*/
String typeName;
/**
* Business Policy Exception Filter ES DSL to denote the associate asset/s involved.
*/
@Attribute
String businessPolicyExceptionFilterDSL;
/**
* List of groups who are part of this exception
*/
@Attribute
SortedSet businessPolicyExceptionGroups;
/**
* List of users who are part of this exception
*/
@Attribute
SortedSet businessPolicyExceptionUsers;
/**
* Business policies related to exception
*/
@Attribute
IBusinessPolicy businessPolicyForException;
/**
* Unique name of the business policy through which this asset is accessible.
*/
@Attribute
String businessPolicyQualifiedName;
/**
* Builds the minimal object necessary to create a relationship to a BusinessPolicyException, from a potentially
* more-complete BusinessPolicyException object.
*
* @return the minimal object necessary to relate to the BusinessPolicyException
* @throws InvalidRequestException if any of the minimal set of required properties for a BusinessPolicyException relationship are not found in the initial object
*/
@Override
public BusinessPolicyException 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 BusinessPolicyException 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) BusinessPolicyException assets will be included.
*
* @return a fluent search that includes all BusinessPolicyException assets
*/
public static FluentSearch.FluentSearchBuilder select() {
return select(Atlan.getDefaultClient());
}
/**
* Start a fluent search that will return all BusinessPolicyException 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) BusinessPolicyException assets will be included.
*
* @param client connectivity to the Atlan tenant from which to retrieve the assets
* @return a fluent search that includes all BusinessPolicyException assets
*/
public static FluentSearch.FluentSearchBuilder select(AtlanClient client) {
return select(client, false);
}
/**
* Start a fluent search that will return all BusinessPolicyException 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) BusinessPolicyExceptions will be included
* @return a fluent search that includes all BusinessPolicyException assets
*/
public static FluentSearch.FluentSearchBuilder select(boolean includeArchived) {
return select(Atlan.getDefaultClient(), includeArchived);
}
/**
* Start a fluent search that will return all BusinessPolicyException 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) BusinessPolicyExceptions will be included
* @return a fluent search that includes all BusinessPolicyException 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 BusinessPolicyException by GUID. Use this to create a relationship to this BusinessPolicyException,
* where the relationship should be replaced.
*
* @param guid the GUID of the BusinessPolicyException to reference
* @return reference to a BusinessPolicyException that can be used for defining a relationship to a BusinessPolicyException
*/
public static BusinessPolicyException refByGuid(String guid) {
return refByGuid(guid, Reference.SaveSemantic.REPLACE);
}
/**
* Reference to a BusinessPolicyException by GUID. Use this to create a relationship to this BusinessPolicyException,
* where you want to further control how that relationship should be updated (i.e. replaced,
* appended, or removed).
*
* @param guid the GUID of the BusinessPolicyException to reference
* @param semantic how to save this relationship (replace all with this, append it, or remove it)
* @return reference to a BusinessPolicyException that can be used for defining a relationship to a BusinessPolicyException
*/
public static BusinessPolicyException refByGuid(String guid, Reference.SaveSemantic semantic) {
return BusinessPolicyException._internal().guid(guid).semantic(semantic).build();
}
/**
* Reference to a BusinessPolicyException by qualifiedName. Use this to create a relationship to this BusinessPolicyException,
* where the relationship should be replaced.
*
* @param qualifiedName the qualifiedName of the BusinessPolicyException to reference
* @return reference to a BusinessPolicyException that can be used for defining a relationship to a BusinessPolicyException
*/
public static BusinessPolicyException refByQualifiedName(String qualifiedName) {
return refByQualifiedName(qualifiedName, Reference.SaveSemantic.REPLACE);
}
/**
* Reference to a BusinessPolicyException by qualifiedName. Use this to create a relationship to this BusinessPolicyException,
* where you want to further control how that relationship should be updated (i.e. replaced,
* appended, or removed).
*
* @param qualifiedName the qualifiedName of the BusinessPolicyException to reference
* @param semantic how to save this relationship (replace all with this, append it, or remove it)
* @return reference to a BusinessPolicyException that can be used for defining a relationship to a BusinessPolicyException
*/
public static BusinessPolicyException refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic) {
return BusinessPolicyException._internal().uniqueAttributes(UniqueAttributes.builder().qualifiedName(qualifiedName).build()).semantic(semantic).build();
}
/**
* Retrieves a BusinessPolicyException by one of its identifiers, complete with all of its relationships.
*
* @param id of the BusinessPolicyException to retrieve, either its GUID or its full qualifiedName
* @return the requested full BusinessPolicyException, complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the BusinessPolicyException does not exist or the provided GUID is not a BusinessPolicyException
*/
@JsonIgnore
public static BusinessPolicyException get(String id) throws AtlanException {
return get(Atlan.getDefaultClient(), id);
}
/**
* Retrieves a BusinessPolicyException 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 BusinessPolicyException to retrieve, either its GUID or its full qualifiedName
* @return the requested full BusinessPolicyException, complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the BusinessPolicyException does not exist or the provided GUID is not a BusinessPolicyException
*/
@JsonIgnore
public static BusinessPolicyException get(AtlanClient client, String id) throws AtlanException {
return get(client, id, true);
}
/**
* Retrieves a BusinessPolicyException 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 BusinessPolicyException 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 BusinessPolicyException, optionally complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the BusinessPolicyException does not exist or the provided GUID is not a BusinessPolicyException
*/
@JsonIgnore
public static BusinessPolicyException 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 BusinessPolicyException) {
return (BusinessPolicyException) 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 BusinessPolicyException) {
return (BusinessPolicyException) asset;
} else {
throw new NotFoundException(ErrorCode.ASSET_NOT_FOUND_BY_QN, id, TYPE_NAME);
}
}
}
/**
* Restore the archived (soft-deleted) BusinessPolicyException to active.
*
* @param qualifiedName for the BusinessPolicyException
* @return true if the BusinessPolicyException 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) BusinessPolicyException to active.
*
* @param client connectivity to the Atlan tenant on which to restore the asset
* @param qualifiedName for the BusinessPolicyException
* @return true if the BusinessPolicyException 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 update a BusinessPolicyException.
*
* @param qualifiedName of the BusinessPolicyException
* @param name of the BusinessPolicyException
* @return the minimal request necessary to update the BusinessPolicyException, as a builder
*/
public static BusinessPolicyExceptionBuilder updater(String qualifiedName, String name) {
return BusinessPolicyException._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 BusinessPolicyException, from a potentially
* more-complete BusinessPolicyException object.
*
* @return the minimal object necessary to update the BusinessPolicyException, as a builder
* @throws InvalidRequestException if any of the minimal set of required properties for BusinessPolicyException are not found in the initial object
*/
@Override
public BusinessPolicyExceptionBuilder trimToRequired() throws InvalidRequestException {
validateRequired(TYPE_NAME, Map.of("qualifiedName", this.getQualifiedName(), "name", this.getName()));
return updater(this.getQualifiedName(), this.getName());
}
/**
* Remove the system description from a BusinessPolicyException.
*
* @param qualifiedName of the BusinessPolicyException
* @param name of the BusinessPolicyException
* @return the updated BusinessPolicyException, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException removeDescription(String qualifiedName, String name) throws AtlanException {
return removeDescription(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the system description from a BusinessPolicyException.
*
* @param client connectivity to the Atlan tenant on which to remove the asset's description
* @param qualifiedName of the BusinessPolicyException
* @param name of the BusinessPolicyException
* @return the updated BusinessPolicyException, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (BusinessPolicyException) Asset.removeDescription(client, updater(qualifiedName, name));
}
/**
* Remove the user's description from a BusinessPolicyException.
*
* @param qualifiedName of the BusinessPolicyException
* @param name of the BusinessPolicyException
* @return the updated BusinessPolicyException, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException removeUserDescription(String qualifiedName, String name) throws AtlanException {
return removeUserDescription(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the user's description from a BusinessPolicyException.
*
* @param client connectivity to the Atlan tenant on which to remove the asset's description
* @param qualifiedName of the BusinessPolicyException
* @param name of the BusinessPolicyException
* @return the updated BusinessPolicyException, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (BusinessPolicyException) Asset.removeUserDescription(client, updater(qualifiedName, name));
}
/**
* Remove the owners from a BusinessPolicyException.
*
* @param qualifiedName of the BusinessPolicyException
* @param name of the BusinessPolicyException
* @return the updated BusinessPolicyException, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException removeOwners(String qualifiedName, String name) throws AtlanException {
return removeOwners(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the owners from a BusinessPolicyException.
*
* @param client connectivity to the Atlan tenant from which to remove the BusinessPolicyException's owners
* @param qualifiedName of the BusinessPolicyException
* @param name of the BusinessPolicyException
* @return the updated BusinessPolicyException, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (BusinessPolicyException) Asset.removeOwners(client, updater(qualifiedName, name));
}
/**
* Update the certificate on a BusinessPolicyException.
*
* @param qualifiedName of the BusinessPolicyException
* @param certificate to use
* @param message (optional) message, or null if no message
* @return the updated BusinessPolicyException, or null if the update failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException {
return updateCertificate(Atlan.getDefaultClient(), qualifiedName, certificate, message);
}
/**
* Update the certificate on a BusinessPolicyException.
*
* @param client connectivity to the Atlan tenant on which to update the BusinessPolicyException's certificate
* @param qualifiedName of the BusinessPolicyException
* @param certificate to use
* @param message (optional) message, or null if no message
* @return the updated BusinessPolicyException, or null if the update failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException {
return (BusinessPolicyException) Asset.updateCertificate(client, _internal(), TYPE_NAME, qualifiedName, certificate, message);
}
/**
* Remove the certificate from a BusinessPolicyException.
*
* @param qualifiedName of the BusinessPolicyException
* @param name of the BusinessPolicyException
* @return the updated BusinessPolicyException, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException removeCertificate(String qualifiedName, String name) throws AtlanException {
return removeCertificate(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the certificate from a BusinessPolicyException.
*
* @param client connectivity to the Atlan tenant from which to remove the BusinessPolicyException's certificate
* @param qualifiedName of the BusinessPolicyException
* @param name of the BusinessPolicyException
* @return the updated BusinessPolicyException, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (BusinessPolicyException) Asset.removeCertificate(client, updater(qualifiedName, name));
}
/**
* Update the announcement on a BusinessPolicyException.
*
* @param qualifiedName of the BusinessPolicyException
* @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 BusinessPolicyException updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException {
return updateAnnouncement(Atlan.getDefaultClient(), qualifiedName, type, title, message);
}
/**
* Update the announcement on a BusinessPolicyException.
*
* @param client connectivity to the Atlan tenant on which to update the BusinessPolicyException's announcement
* @param qualifiedName of the BusinessPolicyException
* @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 BusinessPolicyException updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException {
return (BusinessPolicyException) Asset.updateAnnouncement(client, _internal(), TYPE_NAME, qualifiedName, type, title, message);
}
/**
* Remove the announcement from a BusinessPolicyException.
*
* @param qualifiedName of the BusinessPolicyException
* @param name of the BusinessPolicyException
* @return the updated BusinessPolicyException, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException removeAnnouncement(String qualifiedName, String name) throws AtlanException {
return removeAnnouncement(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the announcement from a BusinessPolicyException.
*
* @param client connectivity to the Atlan client from which to remove the BusinessPolicyException's announcement
* @param qualifiedName of the BusinessPolicyException
* @param name of the BusinessPolicyException
* @return the updated BusinessPolicyException, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (BusinessPolicyException) Asset.removeAnnouncement(client, updater(qualifiedName, name));
}
/**
* Replace the terms linked to the BusinessPolicyException.
*
* @param qualifiedName for the BusinessPolicyException
* @param name human-readable name of the BusinessPolicyException
* @param terms the list of terms to replace on the BusinessPolicyException, or null to remove all terms from the BusinessPolicyException
* @return the BusinessPolicyException that was updated (note that it will NOT contain details of the replaced terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException replaceTerms(String qualifiedName, String name, List terms) throws AtlanException {
return replaceTerms(Atlan.getDefaultClient(), qualifiedName, name, terms);
}
/**
* Replace the terms linked to the BusinessPolicyException.
*
* @param client connectivity to the Atlan tenant on which to replace the BusinessPolicyException's assigned terms
* @param qualifiedName for the BusinessPolicyException
* @param name human-readable name of the BusinessPolicyException
* @param terms the list of terms to replace on the BusinessPolicyException, or null to remove all terms from the BusinessPolicyException
* @return the BusinessPolicyException that was updated (note that it will NOT contain details of the replaced terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException replaceTerms(AtlanClient client, String qualifiedName, String name, List terms) throws AtlanException {
return (BusinessPolicyException) Asset.replaceTerms(client, updater(qualifiedName, name), terms);
}
/**
* Link additional terms to the BusinessPolicyException, without replacing existing terms linked to the BusinessPolicyException.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyException's existing terms,
* and a second to append the new terms.
*
* @param qualifiedName for the BusinessPolicyException
* @param terms the list of terms to append to the BusinessPolicyException
* @return the BusinessPolicyException that was updated (note that it will NOT contain details of the appended terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException appendTerms(String qualifiedName, List terms) throws AtlanException {
return appendTerms(Atlan.getDefaultClient(), qualifiedName, terms);
}
/**
* Link additional terms to the BusinessPolicyException, without replacing existing terms linked to the BusinessPolicyException.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyException'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 BusinessPolicyException
* @param qualifiedName for the BusinessPolicyException
* @param terms the list of terms to append to the BusinessPolicyException
* @return the BusinessPolicyException that was updated (note that it will NOT contain details of the appended terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException appendTerms(AtlanClient client, String qualifiedName, List terms) throws AtlanException {
return (BusinessPolicyException) Asset.appendTerms(client, TYPE_NAME, qualifiedName, terms);
}
/**
* Remove terms from a BusinessPolicyException, without replacing all existing terms linked to the BusinessPolicyException.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyException's existing terms,
* and a second to remove the provided terms.
*
* @param qualifiedName for the BusinessPolicyException
* @param terms the list of terms to remove from the BusinessPolicyException, which must be referenced by GUID
* @return the BusinessPolicyException that was updated (note that it will NOT contain details of the resulting terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException removeTerms(String qualifiedName, List terms) throws AtlanException {
return removeTerms(Atlan.getDefaultClient(), qualifiedName, terms);
}
/**
* Remove terms from a BusinessPolicyException, without replacing all existing terms linked to the BusinessPolicyException.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyException'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 BusinessPolicyException
* @param qualifiedName for the BusinessPolicyException
* @param terms the list of terms to remove from the BusinessPolicyException, which must be referenced by GUID
* @return the BusinessPolicyException that was updated (note that it will NOT contain details of the resulting terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyException removeTerms(AtlanClient client, String qualifiedName, List terms) throws AtlanException {
return (BusinessPolicyException) Asset.removeTerms(client, TYPE_NAME, qualifiedName, terms);
}
/**
* Add Atlan tags to a BusinessPolicyException, without replacing existing Atlan tags linked to the BusinessPolicyException.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyException's existing Atlan tags,
* and a second to append the new Atlan tags.
*
* @param qualifiedName of the BusinessPolicyException
* @param atlanTagNames human-readable names of the Atlan tags to add
* @throws AtlanException on any API problems
* @return the updated BusinessPolicyException
*/
public static BusinessPolicyException appendAtlanTags(String qualifiedName, List atlanTagNames) throws AtlanException {
return appendAtlanTags(Atlan.getDefaultClient(), qualifiedName, atlanTagNames);
}
/**
* Add Atlan tags to a BusinessPolicyException, without replacing existing Atlan tags linked to the BusinessPolicyException.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyException'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 BusinessPolicyException
* @param qualifiedName of the BusinessPolicyException
* @param atlanTagNames human-readable names of the Atlan tags to add
* @throws AtlanException on any API problems
* @return the updated BusinessPolicyException
*/
public static BusinessPolicyException appendAtlanTags(AtlanClient client, String qualifiedName, List atlanTagNames) throws AtlanException {
return (BusinessPolicyException) Asset.appendAtlanTags(client, TYPE_NAME, qualifiedName, atlanTagNames);
}
/**
* Add Atlan tags to a BusinessPolicyException, without replacing existing Atlan tags linked to the BusinessPolicyException.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyException's existing Atlan tags,
* and a second to append the new Atlan tags.
*
* @param qualifiedName of the BusinessPolicyException
* @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 BusinessPolicyException
*/
public static BusinessPolicyException 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 BusinessPolicyException, without replacing existing Atlan tags linked to the BusinessPolicyException.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyException'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 BusinessPolicyException
* @param qualifiedName of the BusinessPolicyException
* @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 BusinessPolicyException
*/
public static BusinessPolicyException appendAtlanTags(AtlanClient client, String qualifiedName, List atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException {
return (BusinessPolicyException) Asset.appendAtlanTags(client, TYPE_NAME, qualifiedName, atlanTagNames, propagate, removePropagationsOnDelete, restrictLineagePropagation);
}
/**
* Remove an Atlan tag from a BusinessPolicyException.
*
* @param qualifiedName of the BusinessPolicyException
* @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 BusinessPolicyException
*/
public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException {
removeAtlanTag(Atlan.getDefaultClient(), qualifiedName, atlanTagName);
}
/**
* Remove an Atlan tag from a BusinessPolicyException.
*
* @param client connectivity to the Atlan tenant from which to remove an Atlan tag from a BusinessPolicyException
* @param qualifiedName of the BusinessPolicyException
* @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 BusinessPolicyException
*/
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 BusinessPolicyExceptionBuilder> 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 String businessPolicyExceptionFilterDSL;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private java.util.ArrayList businessPolicyExceptionGroups;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private java.util.ArrayList businessPolicyExceptionUsers;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private IBusinessPolicy businessPolicyForException;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private String businessPolicyQualifiedName;
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected B $fillValuesFrom(final C instance) {
super.$fillValuesFrom(instance);
BusinessPolicyException.BusinessPolicyExceptionBuilder.$fillValuesFromInstanceIntoBuilder(instance, this);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static void $fillValuesFromInstanceIntoBuilder(final BusinessPolicyException instance, final BusinessPolicyException.BusinessPolicyExceptionBuilder b) {
b.typeName(instance.typeName);
b.businessPolicyExceptionFilterDSL(instance.businessPolicyExceptionFilterDSL);
b.businessPolicyExceptionGroups(instance.businessPolicyExceptionGroups == null ? java.util.Collections.emptySortedSet() : instance.businessPolicyExceptionGroups);
b.businessPolicyExceptionUsers(instance.businessPolicyExceptionUsers == null ? java.util.Collections.emptySortedSet() : instance.businessPolicyExceptionUsers);
b.businessPolicyForException(instance.businessPolicyForException);
b.businessPolicyQualifiedName(instance.businessPolicyQualifiedName);
}
/**
* Fixed typeName for BusinessPolicyExceptions.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B typeName(final String typeName) {
this.typeName$value = typeName;
typeName$set = true;
return self();
}
/**
* Business Policy Exception Filter ES DSL to denote the associate asset/s involved.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B businessPolicyExceptionFilterDSL(final String businessPolicyExceptionFilterDSL) {
this.businessPolicyExceptionFilterDSL = businessPolicyExceptionFilterDSL;
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B businessPolicyExceptionGroup(final String businessPolicyExceptionGroup) {
if (this.businessPolicyExceptionGroups == null) this.businessPolicyExceptionGroups = new java.util.ArrayList();
this.businessPolicyExceptionGroups.add(businessPolicyExceptionGroup);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B businessPolicyExceptionGroups(final java.util.Collection businessPolicyExceptionGroups) {
if (businessPolicyExceptionGroups == null) {
throw new java.lang.NullPointerException("businessPolicyExceptionGroups cannot be null");
}
if (this.businessPolicyExceptionGroups == null) this.businessPolicyExceptionGroups = new java.util.ArrayList();
this.businessPolicyExceptionGroups.addAll(businessPolicyExceptionGroups);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B clearBusinessPolicyExceptionGroups() {
if (this.businessPolicyExceptionGroups != null) this.businessPolicyExceptionGroups.clear();
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B businessPolicyExceptionUser(final String businessPolicyExceptionUser) {
if (this.businessPolicyExceptionUsers == null) this.businessPolicyExceptionUsers = new java.util.ArrayList();
this.businessPolicyExceptionUsers.add(businessPolicyExceptionUser);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B businessPolicyExceptionUsers(final java.util.Collection businessPolicyExceptionUsers) {
if (businessPolicyExceptionUsers == null) {
throw new java.lang.NullPointerException("businessPolicyExceptionUsers cannot be null");
}
if (this.businessPolicyExceptionUsers == null) this.businessPolicyExceptionUsers = new java.util.ArrayList();
this.businessPolicyExceptionUsers.addAll(businessPolicyExceptionUsers);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B clearBusinessPolicyExceptionUsers() {
if (this.businessPolicyExceptionUsers != null) this.businessPolicyExceptionUsers.clear();
return self();
}
/**
* Business policies related to exception
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B businessPolicyForException(final IBusinessPolicy businessPolicyForException) {
this.businessPolicyForException = businessPolicyForException;
return self();
}
/**
* Unique name of the business policy through which this asset is accessible.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B businessPolicyQualifiedName(final String businessPolicyQualifiedName) {
this.businessPolicyQualifiedName = businessPolicyQualifiedName;
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 "BusinessPolicyException.BusinessPolicyExceptionBuilder(super=" + super.toString() + ", typeName$value=" + this.typeName$value + ", businessPolicyExceptionFilterDSL=" + this.businessPolicyExceptionFilterDSL + ", businessPolicyExceptionGroups=" + this.businessPolicyExceptionGroups + ", businessPolicyExceptionUsers=" + this.businessPolicyExceptionUsers + ", businessPolicyForException=" + this.businessPolicyForException + ", businessPolicyQualifiedName=" + this.businessPolicyQualifiedName + ")";
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static final class BusinessPolicyExceptionBuilderImpl extends BusinessPolicyException.BusinessPolicyExceptionBuilder {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private BusinessPolicyExceptionBuilderImpl() {
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected BusinessPolicyException.BusinessPolicyExceptionBuilderImpl self() {
return this;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public BusinessPolicyException build() {
return new BusinessPolicyException(this);
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected BusinessPolicyException(final BusinessPolicyException.BusinessPolicyExceptionBuilder b) {
super(b);
if (b.typeName$set) this.typeName = b.typeName$value;
else this.typeName = BusinessPolicyException.$default$typeName();
this.businessPolicyExceptionFilterDSL = b.businessPolicyExceptionFilterDSL;
java.util.SortedSet businessPolicyExceptionGroups = new java.util.TreeSet();
if (b.businessPolicyExceptionGroups != null) businessPolicyExceptionGroups.addAll(b.businessPolicyExceptionGroups);
businessPolicyExceptionGroups = java.util.Collections.unmodifiableSortedSet(businessPolicyExceptionGroups);
this.businessPolicyExceptionGroups = businessPolicyExceptionGroups;
java.util.SortedSet businessPolicyExceptionUsers = new java.util.TreeSet();
if (b.businessPolicyExceptionUsers != null) businessPolicyExceptionUsers.addAll(b.businessPolicyExceptionUsers);
businessPolicyExceptionUsers = java.util.Collections.unmodifiableSortedSet(businessPolicyExceptionUsers);
this.businessPolicyExceptionUsers = businessPolicyExceptionUsers;
this.businessPolicyForException = b.businessPolicyForException;
this.businessPolicyQualifiedName = b.businessPolicyQualifiedName;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public static BusinessPolicyException.BusinessPolicyExceptionBuilder _internal() {
return new BusinessPolicyException.BusinessPolicyExceptionBuilderImpl();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public BusinessPolicyException.BusinessPolicyExceptionBuilder toBuilder() {
return new BusinessPolicyException.BusinessPolicyExceptionBuilderImpl().$fillValuesFrom(this);
}
/**
* Business Policy Exception Filter ES DSL to denote the associate asset/s involved.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getBusinessPolicyExceptionFilterDSL() {
return this.businessPolicyExceptionFilterDSL;
}
/**
* List of groups who are part of this exception
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public SortedSet getBusinessPolicyExceptionGroups() {
return this.businessPolicyExceptionGroups;
}
/**
* List of users who are part of this exception
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public SortedSet getBusinessPolicyExceptionUsers() {
return this.businessPolicyExceptionUsers;
}
/**
* Business policies related to exception
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public IBusinessPolicy getBusinessPolicyForException() {
return this.businessPolicyForException;
}
/**
* Unique name of the business policy through which this asset is accessible.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getBusinessPolicyQualifiedName() {
return this.businessPolicyQualifiedName;
}
@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 BusinessPolicyException)) return false;
final BusinessPolicyException other = (BusinessPolicyException) 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$businessPolicyExceptionFilterDSL = this.getBusinessPolicyExceptionFilterDSL();
final java.lang.Object other$businessPolicyExceptionFilterDSL = other.getBusinessPolicyExceptionFilterDSL();
if (this$businessPolicyExceptionFilterDSL == null ? other$businessPolicyExceptionFilterDSL != null : !this$businessPolicyExceptionFilterDSL.equals(other$businessPolicyExceptionFilterDSL)) return false;
final java.lang.Object this$businessPolicyExceptionGroups = this.getBusinessPolicyExceptionGroups();
final java.lang.Object other$businessPolicyExceptionGroups = other.getBusinessPolicyExceptionGroups();
if (this$businessPolicyExceptionGroups == null ? other$businessPolicyExceptionGroups != null : !this$businessPolicyExceptionGroups.equals(other$businessPolicyExceptionGroups)) return false;
final java.lang.Object this$businessPolicyExceptionUsers = this.getBusinessPolicyExceptionUsers();
final java.lang.Object other$businessPolicyExceptionUsers = other.getBusinessPolicyExceptionUsers();
if (this$businessPolicyExceptionUsers == null ? other$businessPolicyExceptionUsers != null : !this$businessPolicyExceptionUsers.equals(other$businessPolicyExceptionUsers)) return false;
final java.lang.Object this$businessPolicyForException = this.getBusinessPolicyForException();
final java.lang.Object other$businessPolicyForException = other.getBusinessPolicyForException();
if (this$businessPolicyForException == null ? other$businessPolicyForException != null : !this$businessPolicyForException.equals(other$businessPolicyForException)) return false;
final java.lang.Object this$businessPolicyQualifiedName = this.getBusinessPolicyQualifiedName();
final java.lang.Object other$businessPolicyQualifiedName = other.getBusinessPolicyQualifiedName();
if (this$businessPolicyQualifiedName == null ? other$businessPolicyQualifiedName != null : !this$businessPolicyQualifiedName.equals(other$businessPolicyQualifiedName)) return false;
return true;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected boolean canEqual(final java.lang.Object other) {
return other instanceof BusinessPolicyException;
}
@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 $businessPolicyExceptionFilterDSL = this.getBusinessPolicyExceptionFilterDSL();
result = result * PRIME + ($businessPolicyExceptionFilterDSL == null ? 43 : $businessPolicyExceptionFilterDSL.hashCode());
final java.lang.Object $businessPolicyExceptionGroups = this.getBusinessPolicyExceptionGroups();
result = result * PRIME + ($businessPolicyExceptionGroups == null ? 43 : $businessPolicyExceptionGroups.hashCode());
final java.lang.Object $businessPolicyExceptionUsers = this.getBusinessPolicyExceptionUsers();
result = result * PRIME + ($businessPolicyExceptionUsers == null ? 43 : $businessPolicyExceptionUsers.hashCode());
final java.lang.Object $businessPolicyForException = this.getBusinessPolicyForException();
result = result * PRIME + ($businessPolicyForException == null ? 43 : $businessPolicyForException.hashCode());
final java.lang.Object $businessPolicyQualifiedName = this.getBusinessPolicyQualifiedName();
result = result * PRIME + ($businessPolicyQualifiedName == null ? 43 : $businessPolicyQualifiedName.hashCode());
return result;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public java.lang.String toString() {
return "BusinessPolicyException(super=" + super.toString() + ", typeName=" + this.getTypeName() + ", businessPolicyExceptionFilterDSL=" + this.getBusinessPolicyExceptionFilterDSL() + ", businessPolicyExceptionGroups=" + this.getBusinessPolicyExceptionGroups() + ", businessPolicyExceptionUsers=" + this.getBusinessPolicyExceptionUsers() + ", businessPolicyForException=" + this.getBusinessPolicyForException() + ", businessPolicyQualifiedName=" + this.getBusinessPolicyQualifiedName() + ")";
}
/**
* Fixed typeName for BusinessPolicyExceptions.
*/
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getTypeName() {
return this.typeName;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy