Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// Generated by delombok at Wed Oct 16 22:16:03 UTC 2024
/* SPDX-License-Identifier: Apache-2.0
Copyright 2022 Atlan Pte. Ltd. */
package com.atlan.model.assets;
import com.atlan.Atlan;
import com.atlan.AtlanClient;
import com.atlan.exception.AtlanException;
import com.atlan.exception.ErrorCode;
import com.atlan.exception.InvalidRequestException;
import com.atlan.exception.NotFoundException;
import com.atlan.model.enums.AtlanAnnouncementType;
import com.atlan.model.enums.CertificateStatus;
import com.atlan.model.enums.IncidentSeverity;
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.HashMap;
import java.util.List;
import java.util.Map;
import java.util.SortedSet;
import java.util.concurrent.ThreadLocalRandom;
import javax.annotation.processing.Generated;
import lombok.*;
/**
* Incident of business policy
*/
@Generated("com.atlan.generators.ModelGeneratorV2")
public class BusinessPolicyIncident extends Asset implements IBusinessPolicyIncident, IIncident, IAsset, IReferenceable {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(BusinessPolicyIncident.class);
private static final long serialVersionUID = 2L;
public static final String TYPE_NAME = "BusinessPolicyIncident";
/**
* Fixed typeName for BusinessPolicyIncidents.
*/
String typeName;
/**
* Filter ES DSL to denote the associate asset/s involved.
*/
@Attribute
String businessPolicyIncidentFilterDSL;
/**
* count of noncompliant assets in the incident
*/
@Attribute
Long businessPolicyIncidentNoncompliantCount;
/**
* policy ids related to this incident
*/
@Attribute
SortedSet businessPolicyIncidentRelatedPolicyGUIDs;
/**
* Status of this asset's severity.
*/
@Attribute
IncidentSeverity incidentSeverity;
/**
* Builds the minimal object necessary to create a relationship to a BusinessPolicyIncident, from a potentially
* more-complete BusinessPolicyIncident object.
*
* @return the minimal object necessary to relate to the BusinessPolicyIncident
* @throws InvalidRequestException if any of the minimal set of required properties for a BusinessPolicyIncident relationship are not found in the initial object
*/
@Override
public BusinessPolicyIncident 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 BusinessPolicyIncident 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) BusinessPolicyIncident assets will be included.
*
* @return a fluent search that includes all BusinessPolicyIncident assets
*/
public static FluentSearch.FluentSearchBuilder, ?> select() {
return select(Atlan.getDefaultClient());
}
/**
* Start a fluent search that will return all BusinessPolicyIncident 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) BusinessPolicyIncident assets will be included.
*
* @param client connectivity to the Atlan tenant from which to retrieve the assets
* @return a fluent search that includes all BusinessPolicyIncident assets
*/
public static FluentSearch.FluentSearchBuilder, ?> select(AtlanClient client) {
return select(client, false);
}
/**
* Start a fluent search that will return all BusinessPolicyIncident 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) BusinessPolicyIncidents will be included
* @return a fluent search that includes all BusinessPolicyIncident assets
*/
public static FluentSearch.FluentSearchBuilder, ?> select(boolean includeArchived) {
return select(Atlan.getDefaultClient(), includeArchived);
}
/**
* Start a fluent search that will return all BusinessPolicyIncident 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) BusinessPolicyIncidents will be included
* @return a fluent search that includes all BusinessPolicyIncident 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 BusinessPolicyIncident by GUID. Use this to create a relationship to this BusinessPolicyIncident,
* where the relationship should be replaced.
*
* @param guid the GUID of the BusinessPolicyIncident to reference
* @return reference to a BusinessPolicyIncident that can be used for defining a relationship to a BusinessPolicyIncident
*/
public static BusinessPolicyIncident refByGuid(String guid) {
return refByGuid(guid, Reference.SaveSemantic.REPLACE);
}
/**
* Reference to a BusinessPolicyIncident by GUID. Use this to create a relationship to this BusinessPolicyIncident,
* where you want to further control how that relationship should be updated (i.e. replaced,
* appended, or removed).
*
* @param guid the GUID of the BusinessPolicyIncident to reference
* @param semantic how to save this relationship (replace all with this, append it, or remove it)
* @return reference to a BusinessPolicyIncident that can be used for defining a relationship to a BusinessPolicyIncident
*/
public static BusinessPolicyIncident refByGuid(String guid, Reference.SaveSemantic semantic) {
return BusinessPolicyIncident._internal().guid(guid).semantic(semantic).build();
}
/**
* Reference to a BusinessPolicyIncident by qualifiedName. Use this to create a relationship to this BusinessPolicyIncident,
* where the relationship should be replaced.
*
* @param qualifiedName the qualifiedName of the BusinessPolicyIncident to reference
* @return reference to a BusinessPolicyIncident that can be used for defining a relationship to a BusinessPolicyIncident
*/
public static BusinessPolicyIncident refByQualifiedName(String qualifiedName) {
return refByQualifiedName(qualifiedName, Reference.SaveSemantic.REPLACE);
}
/**
* Reference to a BusinessPolicyIncident by qualifiedName. Use this to create a relationship to this BusinessPolicyIncident,
* where you want to further control how that relationship should be updated (i.e. replaced,
* appended, or removed).
*
* @param qualifiedName the qualifiedName of the BusinessPolicyIncident to reference
* @param semantic how to save this relationship (replace all with this, append it, or remove it)
* @return reference to a BusinessPolicyIncident that can be used for defining a relationship to a BusinessPolicyIncident
*/
public static BusinessPolicyIncident refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic) {
return BusinessPolicyIncident._internal().uniqueAttributes(UniqueAttributes.builder().qualifiedName(qualifiedName).build()).semantic(semantic).build();
}
/**
* Retrieves a BusinessPolicyIncident by one of its identifiers, complete with all of its relationships.
*
* @param id of the BusinessPolicyIncident to retrieve, either its GUID or its full qualifiedName
* @return the requested full BusinessPolicyIncident, complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the BusinessPolicyIncident does not exist or the provided GUID is not a BusinessPolicyIncident
*/
@JsonIgnore
public static BusinessPolicyIncident get(String id) throws AtlanException {
return get(Atlan.getDefaultClient(), id);
}
/**
* Retrieves a BusinessPolicyIncident 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 BusinessPolicyIncident to retrieve, either its GUID or its full qualifiedName
* @return the requested full BusinessPolicyIncident, complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the BusinessPolicyIncident does not exist or the provided GUID is not a BusinessPolicyIncident
*/
@JsonIgnore
public static BusinessPolicyIncident get(AtlanClient client, String id) throws AtlanException {
return get(client, id, true);
}
/**
* Retrieves a BusinessPolicyIncident 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 BusinessPolicyIncident 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 BusinessPolicyIncident, optionally complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the BusinessPolicyIncident does not exist or the provided GUID is not a BusinessPolicyIncident
*/
@JsonIgnore
public static BusinessPolicyIncident 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 BusinessPolicyIncident) {
return (BusinessPolicyIncident) 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 BusinessPolicyIncident) {
return (BusinessPolicyIncident) asset;
} else {
throw new NotFoundException(ErrorCode.ASSET_NOT_FOUND_BY_QN, id, TYPE_NAME);
}
}
}
/**
* Restore the archived (soft-deleted) BusinessPolicyIncident to active.
*
* @param qualifiedName for the BusinessPolicyIncident
* @return true if the BusinessPolicyIncident 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) BusinessPolicyIncident to active.
*
* @param client connectivity to the Atlan tenant on which to restore the asset
* @param qualifiedName for the BusinessPolicyIncident
* @return true if the BusinessPolicyIncident 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 BusinessPolicyIncident.
*
* @param qualifiedName of the BusinessPolicyIncident
* @param name of the BusinessPolicyIncident
* @return the minimal request necessary to update the BusinessPolicyIncident, as a builder
*/
public static BusinessPolicyIncidentBuilder, ?> updater(String qualifiedName, String name) {
return BusinessPolicyIncident._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 BusinessPolicyIncident, from a potentially
* more-complete BusinessPolicyIncident object.
*
* @return the minimal object necessary to update the BusinessPolicyIncident, as a builder
* @throws InvalidRequestException if any of the minimal set of required properties for BusinessPolicyIncident are not found in the initial object
*/
@Override
public BusinessPolicyIncidentBuilder, ?> trimToRequired() throws InvalidRequestException {
Map map = new HashMap<>();
map.put("qualifiedName", this.getQualifiedName());
map.put("name", this.getName());
validateRequired(TYPE_NAME, map);
return updater(this.getQualifiedName(), this.getName());
}
/**
* Remove the system description from a BusinessPolicyIncident.
*
* @param qualifiedName of the BusinessPolicyIncident
* @param name of the BusinessPolicyIncident
* @return the updated BusinessPolicyIncident, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident removeDescription(String qualifiedName, String name) throws AtlanException {
return removeDescription(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the system description from a BusinessPolicyIncident.
*
* @param client connectivity to the Atlan tenant on which to remove the asset's description
* @param qualifiedName of the BusinessPolicyIncident
* @param name of the BusinessPolicyIncident
* @return the updated BusinessPolicyIncident, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (BusinessPolicyIncident) Asset.removeDescription(client, updater(qualifiedName, name));
}
/**
* Remove the user's description from a BusinessPolicyIncident.
*
* @param qualifiedName of the BusinessPolicyIncident
* @param name of the BusinessPolicyIncident
* @return the updated BusinessPolicyIncident, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident removeUserDescription(String qualifiedName, String name) throws AtlanException {
return removeUserDescription(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the user's description from a BusinessPolicyIncident.
*
* @param client connectivity to the Atlan tenant on which to remove the asset's description
* @param qualifiedName of the BusinessPolicyIncident
* @param name of the BusinessPolicyIncident
* @return the updated BusinessPolicyIncident, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (BusinessPolicyIncident) Asset.removeUserDescription(client, updater(qualifiedName, name));
}
/**
* Remove the owners from a BusinessPolicyIncident.
*
* @param qualifiedName of the BusinessPolicyIncident
* @param name of the BusinessPolicyIncident
* @return the updated BusinessPolicyIncident, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident removeOwners(String qualifiedName, String name) throws AtlanException {
return removeOwners(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the owners from a BusinessPolicyIncident.
*
* @param client connectivity to the Atlan tenant from which to remove the BusinessPolicyIncident's owners
* @param qualifiedName of the BusinessPolicyIncident
* @param name of the BusinessPolicyIncident
* @return the updated BusinessPolicyIncident, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (BusinessPolicyIncident) Asset.removeOwners(client, updater(qualifiedName, name));
}
/**
* Update the certificate on a BusinessPolicyIncident.
*
* @param qualifiedName of the BusinessPolicyIncident
* @param certificate to use
* @param message (optional) message, or null if no message
* @return the updated BusinessPolicyIncident, or null if the update failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException {
return updateCertificate(Atlan.getDefaultClient(), qualifiedName, certificate, message);
}
/**
* Update the certificate on a BusinessPolicyIncident.
*
* @param client connectivity to the Atlan tenant on which to update the BusinessPolicyIncident's certificate
* @param qualifiedName of the BusinessPolicyIncident
* @param certificate to use
* @param message (optional) message, or null if no message
* @return the updated BusinessPolicyIncident, or null if the update failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException {
return (BusinessPolicyIncident) Asset.updateCertificate(client, _internal(), TYPE_NAME, qualifiedName, certificate, message);
}
/**
* Remove the certificate from a BusinessPolicyIncident.
*
* @param qualifiedName of the BusinessPolicyIncident
* @param name of the BusinessPolicyIncident
* @return the updated BusinessPolicyIncident, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident removeCertificate(String qualifiedName, String name) throws AtlanException {
return removeCertificate(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the certificate from a BusinessPolicyIncident.
*
* @param client connectivity to the Atlan tenant from which to remove the BusinessPolicyIncident's certificate
* @param qualifiedName of the BusinessPolicyIncident
* @param name of the BusinessPolicyIncident
* @return the updated BusinessPolicyIncident, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (BusinessPolicyIncident) Asset.removeCertificate(client, updater(qualifiedName, name));
}
/**
* Update the announcement on a BusinessPolicyIncident.
*
* @param qualifiedName of the BusinessPolicyIncident
* @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 BusinessPolicyIncident updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException {
return updateAnnouncement(Atlan.getDefaultClient(), qualifiedName, type, title, message);
}
/**
* Update the announcement on a BusinessPolicyIncident.
*
* @param client connectivity to the Atlan tenant on which to update the BusinessPolicyIncident's announcement
* @param qualifiedName of the BusinessPolicyIncident
* @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 BusinessPolicyIncident updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException {
return (BusinessPolicyIncident) Asset.updateAnnouncement(client, _internal(), TYPE_NAME, qualifiedName, type, title, message);
}
/**
* Remove the announcement from a BusinessPolicyIncident.
*
* @param qualifiedName of the BusinessPolicyIncident
* @param name of the BusinessPolicyIncident
* @return the updated BusinessPolicyIncident, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident removeAnnouncement(String qualifiedName, String name) throws AtlanException {
return removeAnnouncement(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the announcement from a BusinessPolicyIncident.
*
* @param client connectivity to the Atlan client from which to remove the BusinessPolicyIncident's announcement
* @param qualifiedName of the BusinessPolicyIncident
* @param name of the BusinessPolicyIncident
* @return the updated BusinessPolicyIncident, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (BusinessPolicyIncident) Asset.removeAnnouncement(client, updater(qualifiedName, name));
}
/**
* Replace the terms linked to the BusinessPolicyIncident.
*
* @param qualifiedName for the BusinessPolicyIncident
* @param name human-readable name of the BusinessPolicyIncident
* @param terms the list of terms to replace on the BusinessPolicyIncident, or null to remove all terms from the BusinessPolicyIncident
* @return the BusinessPolicyIncident that was updated (note that it will NOT contain details of the replaced terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident replaceTerms(String qualifiedName, String name, List terms) throws AtlanException {
return replaceTerms(Atlan.getDefaultClient(), qualifiedName, name, terms);
}
/**
* Replace the terms linked to the BusinessPolicyIncident.
*
* @param client connectivity to the Atlan tenant on which to replace the BusinessPolicyIncident's assigned terms
* @param qualifiedName for the BusinessPolicyIncident
* @param name human-readable name of the BusinessPolicyIncident
* @param terms the list of terms to replace on the BusinessPolicyIncident, or null to remove all terms from the BusinessPolicyIncident
* @return the BusinessPolicyIncident that was updated (note that it will NOT contain details of the replaced terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident replaceTerms(AtlanClient client, String qualifiedName, String name, List terms) throws AtlanException {
return (BusinessPolicyIncident) Asset.replaceTerms(client, updater(qualifiedName, name), terms);
}
/**
* Link additional terms to the BusinessPolicyIncident, without replacing existing terms linked to the BusinessPolicyIncident.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyIncident's existing terms,
* and a second to append the new terms.
*
* @param qualifiedName for the BusinessPolicyIncident
* @param terms the list of terms to append to the BusinessPolicyIncident
* @return the BusinessPolicyIncident that was updated (note that it will NOT contain details of the appended terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident appendTerms(String qualifiedName, List terms) throws AtlanException {
return appendTerms(Atlan.getDefaultClient(), qualifiedName, terms);
}
/**
* Link additional terms to the BusinessPolicyIncident, without replacing existing terms linked to the BusinessPolicyIncident.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyIncident'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 BusinessPolicyIncident
* @param qualifiedName for the BusinessPolicyIncident
* @param terms the list of terms to append to the BusinessPolicyIncident
* @return the BusinessPolicyIncident that was updated (note that it will NOT contain details of the appended terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident appendTerms(AtlanClient client, String qualifiedName, List terms) throws AtlanException {
return (BusinessPolicyIncident) Asset.appendTerms(client, TYPE_NAME, qualifiedName, terms);
}
/**
* Remove terms from a BusinessPolicyIncident, without replacing all existing terms linked to the BusinessPolicyIncident.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyIncident's existing terms,
* and a second to remove the provided terms.
*
* @param qualifiedName for the BusinessPolicyIncident
* @param terms the list of terms to remove from the BusinessPolicyIncident, which must be referenced by GUID
* @return the BusinessPolicyIncident that was updated (note that it will NOT contain details of the resulting terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident removeTerms(String qualifiedName, List terms) throws AtlanException {
return removeTerms(Atlan.getDefaultClient(), qualifiedName, terms);
}
/**
* Remove terms from a BusinessPolicyIncident, without replacing all existing terms linked to the BusinessPolicyIncident.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyIncident'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 BusinessPolicyIncident
* @param qualifiedName for the BusinessPolicyIncident
* @param terms the list of terms to remove from the BusinessPolicyIncident, which must be referenced by GUID
* @return the BusinessPolicyIncident that was updated (note that it will NOT contain details of the resulting terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyIncident removeTerms(AtlanClient client, String qualifiedName, List terms) throws AtlanException {
return (BusinessPolicyIncident) Asset.removeTerms(client, TYPE_NAME, qualifiedName, terms);
}
/**
* Add Atlan tags to a BusinessPolicyIncident, without replacing existing Atlan tags linked to the BusinessPolicyIncident.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyIncident's existing Atlan tags,
* and a second to append the new Atlan tags.
*
* @param qualifiedName of the BusinessPolicyIncident
* @param atlanTagNames human-readable names of the Atlan tags to add
* @throws AtlanException on any API problems
* @return the updated BusinessPolicyIncident
*/
public static BusinessPolicyIncident appendAtlanTags(String qualifiedName, List atlanTagNames) throws AtlanException {
return appendAtlanTags(Atlan.getDefaultClient(), qualifiedName, atlanTagNames);
}
/**
* Add Atlan tags to a BusinessPolicyIncident, without replacing existing Atlan tags linked to the BusinessPolicyIncident.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyIncident'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 BusinessPolicyIncident
* @param qualifiedName of the BusinessPolicyIncident
* @param atlanTagNames human-readable names of the Atlan tags to add
* @throws AtlanException on any API problems
* @return the updated BusinessPolicyIncident
*/
public static BusinessPolicyIncident appendAtlanTags(AtlanClient client, String qualifiedName, List atlanTagNames) throws AtlanException {
return (BusinessPolicyIncident) Asset.appendAtlanTags(client, TYPE_NAME, qualifiedName, atlanTagNames);
}
/**
* Add Atlan tags to a BusinessPolicyIncident, without replacing existing Atlan tags linked to the BusinessPolicyIncident.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyIncident's existing Atlan tags,
* and a second to append the new Atlan tags.
*
* @param qualifiedName of the BusinessPolicyIncident
* @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 BusinessPolicyIncident
*/
public static BusinessPolicyIncident 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 BusinessPolicyIncident, without replacing existing Atlan tags linked to the BusinessPolicyIncident.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyIncident'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 BusinessPolicyIncident
* @param qualifiedName of the BusinessPolicyIncident
* @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 BusinessPolicyIncident
*/
public static BusinessPolicyIncident appendAtlanTags(AtlanClient client, String qualifiedName, List atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException {
return (BusinessPolicyIncident) Asset.appendAtlanTags(client, TYPE_NAME, qualifiedName, atlanTagNames, propagate, removePropagationsOnDelete, restrictLineagePropagation);
}
/**
* Remove an Atlan tag from a BusinessPolicyIncident.
*
* @param qualifiedName of the BusinessPolicyIncident
* @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 BusinessPolicyIncident
*/
public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException {
removeAtlanTag(Atlan.getDefaultClient(), qualifiedName, atlanTagName);
}
/**
* Remove an Atlan tag from a BusinessPolicyIncident.
*
* @param client connectivity to the Atlan tenant from which to remove an Atlan tag from a BusinessPolicyIncident
* @param qualifiedName of the BusinessPolicyIncident
* @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 BusinessPolicyIncident
*/
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 BusinessPolicyIncidentBuilder> 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 businessPolicyIncidentFilterDSL;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private Long businessPolicyIncidentNoncompliantCount;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private java.util.ArrayList businessPolicyIncidentRelatedPolicyGUIDs;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private IncidentSeverity incidentSeverity;
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected B $fillValuesFrom(final C instance) {
super.$fillValuesFrom(instance);
BusinessPolicyIncident.BusinessPolicyIncidentBuilder.$fillValuesFromInstanceIntoBuilder(instance, this);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static void $fillValuesFromInstanceIntoBuilder(final BusinessPolicyIncident instance, final BusinessPolicyIncident.BusinessPolicyIncidentBuilder, ?> b) {
b.typeName(instance.typeName);
b.businessPolicyIncidentFilterDSL(instance.businessPolicyIncidentFilterDSL);
b.businessPolicyIncidentNoncompliantCount(instance.businessPolicyIncidentNoncompliantCount);
b.businessPolicyIncidentRelatedPolicyGUIDs(instance.businessPolicyIncidentRelatedPolicyGUIDs == null ? java.util.Collections.emptySortedSet() : instance.businessPolicyIncidentRelatedPolicyGUIDs);
b.incidentSeverity(instance.incidentSeverity);
}
/**
* Fixed typeName for BusinessPolicyIncidents.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B typeName(final String typeName) {
this.typeName$value = typeName;
typeName$set = true;
return self();
}
/**
* Filter ES DSL to denote the associate asset/s involved.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B businessPolicyIncidentFilterDSL(final String businessPolicyIncidentFilterDSL) {
this.businessPolicyIncidentFilterDSL = businessPolicyIncidentFilterDSL;
return self();
}
/**
* count of noncompliant assets in the incident
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B businessPolicyIncidentNoncompliantCount(final Long businessPolicyIncidentNoncompliantCount) {
this.businessPolicyIncidentNoncompliantCount = businessPolicyIncidentNoncompliantCount;
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B businessPolicyIncidentRelatedPolicyGUID(final String businessPolicyIncidentRelatedPolicyGUID) {
if (this.businessPolicyIncidentRelatedPolicyGUIDs == null) this.businessPolicyIncidentRelatedPolicyGUIDs = new java.util.ArrayList();
this.businessPolicyIncidentRelatedPolicyGUIDs.add(businessPolicyIncidentRelatedPolicyGUID);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B businessPolicyIncidentRelatedPolicyGUIDs(final java.util.Collection extends String> businessPolicyIncidentRelatedPolicyGUIDs) {
if (businessPolicyIncidentRelatedPolicyGUIDs == null) {
throw new java.lang.NullPointerException("businessPolicyIncidentRelatedPolicyGUIDs cannot be null");
}
if (this.businessPolicyIncidentRelatedPolicyGUIDs == null) this.businessPolicyIncidentRelatedPolicyGUIDs = new java.util.ArrayList();
this.businessPolicyIncidentRelatedPolicyGUIDs.addAll(businessPolicyIncidentRelatedPolicyGUIDs);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B clearBusinessPolicyIncidentRelatedPolicyGUIDs() {
if (this.businessPolicyIncidentRelatedPolicyGUIDs != null) this.businessPolicyIncidentRelatedPolicyGUIDs.clear();
return self();
}
/**
* Status of this asset's severity.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B incidentSeverity(final IncidentSeverity incidentSeverity) {
this.incidentSeverity = incidentSeverity;
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 "BusinessPolicyIncident.BusinessPolicyIncidentBuilder(super=" + super.toString() + ", typeName$value=" + this.typeName$value + ", businessPolicyIncidentFilterDSL=" + this.businessPolicyIncidentFilterDSL + ", businessPolicyIncidentNoncompliantCount=" + this.businessPolicyIncidentNoncompliantCount + ", businessPolicyIncidentRelatedPolicyGUIDs=" + this.businessPolicyIncidentRelatedPolicyGUIDs + ", incidentSeverity=" + this.incidentSeverity + ")";
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static final class BusinessPolicyIncidentBuilderImpl extends BusinessPolicyIncident.BusinessPolicyIncidentBuilder {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private BusinessPolicyIncidentBuilderImpl() {
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected BusinessPolicyIncident.BusinessPolicyIncidentBuilderImpl self() {
return this;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public BusinessPolicyIncident build() {
return new BusinessPolicyIncident(this);
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected BusinessPolicyIncident(final BusinessPolicyIncident.BusinessPolicyIncidentBuilder, ?> b) {
super(b);
if (b.typeName$set) this.typeName = b.typeName$value;
else this.typeName = BusinessPolicyIncident.$default$typeName();
this.businessPolicyIncidentFilterDSL = b.businessPolicyIncidentFilterDSL;
this.businessPolicyIncidentNoncompliantCount = b.businessPolicyIncidentNoncompliantCount;
java.util.SortedSet businessPolicyIncidentRelatedPolicyGUIDs = new java.util.TreeSet();
if (b.businessPolicyIncidentRelatedPolicyGUIDs != null) businessPolicyIncidentRelatedPolicyGUIDs.addAll(b.businessPolicyIncidentRelatedPolicyGUIDs);
businessPolicyIncidentRelatedPolicyGUIDs = java.util.Collections.unmodifiableSortedSet(businessPolicyIncidentRelatedPolicyGUIDs);
this.businessPolicyIncidentRelatedPolicyGUIDs = businessPolicyIncidentRelatedPolicyGUIDs;
this.incidentSeverity = b.incidentSeverity;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public static BusinessPolicyIncident.BusinessPolicyIncidentBuilder, ?> _internal() {
return new BusinessPolicyIncident.BusinessPolicyIncidentBuilderImpl();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public BusinessPolicyIncident.BusinessPolicyIncidentBuilder, ?> toBuilder() {
return new BusinessPolicyIncident.BusinessPolicyIncidentBuilderImpl().$fillValuesFrom(this);
}
/**
* Filter ES DSL to denote the associate asset/s involved.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getBusinessPolicyIncidentFilterDSL() {
return this.businessPolicyIncidentFilterDSL;
}
/**
* count of noncompliant assets in the incident
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getBusinessPolicyIncidentNoncompliantCount() {
return this.businessPolicyIncidentNoncompliantCount;
}
/**
* policy ids related to this incident
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public SortedSet getBusinessPolicyIncidentRelatedPolicyGUIDs() {
return this.businessPolicyIncidentRelatedPolicyGUIDs;
}
/**
* Status of this asset's severity.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public IncidentSeverity getIncidentSeverity() {
return this.incidentSeverity;
}
@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 BusinessPolicyIncident)) return false;
final BusinessPolicyIncident other = (BusinessPolicyIncident) o;
if (!other.canEqual((java.lang.Object) this)) return false;
if (!super.equals(o)) return false;
final java.lang.Object this$businessPolicyIncidentNoncompliantCount = this.getBusinessPolicyIncidentNoncompliantCount();
final java.lang.Object other$businessPolicyIncidentNoncompliantCount = other.getBusinessPolicyIncidentNoncompliantCount();
if (this$businessPolicyIncidentNoncompliantCount == null ? other$businessPolicyIncidentNoncompliantCount != null : !this$businessPolicyIncidentNoncompliantCount.equals(other$businessPolicyIncidentNoncompliantCount)) 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$businessPolicyIncidentFilterDSL = this.getBusinessPolicyIncidentFilterDSL();
final java.lang.Object other$businessPolicyIncidentFilterDSL = other.getBusinessPolicyIncidentFilterDSL();
if (this$businessPolicyIncidentFilterDSL == null ? other$businessPolicyIncidentFilterDSL != null : !this$businessPolicyIncidentFilterDSL.equals(other$businessPolicyIncidentFilterDSL)) return false;
final java.lang.Object this$businessPolicyIncidentRelatedPolicyGUIDs = this.getBusinessPolicyIncidentRelatedPolicyGUIDs();
final java.lang.Object other$businessPolicyIncidentRelatedPolicyGUIDs = other.getBusinessPolicyIncidentRelatedPolicyGUIDs();
if (this$businessPolicyIncidentRelatedPolicyGUIDs == null ? other$businessPolicyIncidentRelatedPolicyGUIDs != null : !this$businessPolicyIncidentRelatedPolicyGUIDs.equals(other$businessPolicyIncidentRelatedPolicyGUIDs)) return false;
final java.lang.Object this$incidentSeverity = this.getIncidentSeverity();
final java.lang.Object other$incidentSeverity = other.getIncidentSeverity();
if (this$incidentSeverity == null ? other$incidentSeverity != null : !this$incidentSeverity.equals(other$incidentSeverity)) return false;
return true;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected boolean canEqual(final java.lang.Object other) {
return other instanceof BusinessPolicyIncident;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public int hashCode() {
final int PRIME = 59;
int result = super.hashCode();
final java.lang.Object $businessPolicyIncidentNoncompliantCount = this.getBusinessPolicyIncidentNoncompliantCount();
result = result * PRIME + ($businessPolicyIncidentNoncompliantCount == null ? 43 : $businessPolicyIncidentNoncompliantCount.hashCode());
final java.lang.Object $typeName = this.getTypeName();
result = result * PRIME + ($typeName == null ? 43 : $typeName.hashCode());
final java.lang.Object $businessPolicyIncidentFilterDSL = this.getBusinessPolicyIncidentFilterDSL();
result = result * PRIME + ($businessPolicyIncidentFilterDSL == null ? 43 : $businessPolicyIncidentFilterDSL.hashCode());
final java.lang.Object $businessPolicyIncidentRelatedPolicyGUIDs = this.getBusinessPolicyIncidentRelatedPolicyGUIDs();
result = result * PRIME + ($businessPolicyIncidentRelatedPolicyGUIDs == null ? 43 : $businessPolicyIncidentRelatedPolicyGUIDs.hashCode());
final java.lang.Object $incidentSeverity = this.getIncidentSeverity();
result = result * PRIME + ($incidentSeverity == null ? 43 : $incidentSeverity.hashCode());
return result;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public java.lang.String toString() {
return "BusinessPolicyIncident(super=" + super.toString() + ", typeName=" + this.getTypeName() + ", businessPolicyIncidentFilterDSL=" + this.getBusinessPolicyIncidentFilterDSL() + ", businessPolicyIncidentNoncompliantCount=" + this.getBusinessPolicyIncidentNoncompliantCount() + ", businessPolicyIncidentRelatedPolicyGUIDs=" + this.getBusinessPolicyIncidentRelatedPolicyGUIDs() + ", incidentSeverity=" + this.getIncidentSeverity() + ")";
}
/**
* Fixed typeName for BusinessPolicyIncidents.
*/
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getTypeName() {
return this.typeName;
}
}