com.atlan.model.assets.BusinessPolicyLog 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.concurrent.ThreadLocalRandom;
import javax.annotation.processing.Generated;
import lombok.*;
/**
* Instance of a business policy log in Atlan.
*/
@Generated("com.atlan.generators.ModelGeneratorV2")
public class BusinessPolicyLog extends Asset implements IBusinessPolicyLog, IAsset, IReferenceable {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(BusinessPolicyLog.class);
private static final long serialVersionUID = 2L;
public static final String TYPE_NAME = "BusinessPolicyLog";
/**
* Fixed typeName for BusinessPolicyLogs.
*/
String typeName;
/**
* business policy guid for which log are created
*/
@Attribute
String businessPolicyId;
/**
* business policy type for which log are created
*/
@Attribute
String businessPolicyLogPolicyType;
/**
* number of compliant assets in the policy
*/
@Attribute
Long compliantAssetsCount;
/**
* number of governed assets in the policy
*/
@Attribute
Long governedAssetsCount;
/**
* number of non compliant assets in the policy
*/
@Attribute
Long nonCompliantAssetsCount;
/**
* number of non governed assets in the policy
*/
@Attribute
Long nonGovernedAssetsCount;
/**
* Builds the minimal object necessary to create a relationship to a BusinessPolicyLog, from a potentially
* more-complete BusinessPolicyLog object.
*
* @return the minimal object necessary to relate to the BusinessPolicyLog
* @throws InvalidRequestException if any of the minimal set of required properties for a BusinessPolicyLog relationship are not found in the initial object
*/
@Override
public BusinessPolicyLog 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 BusinessPolicyLog 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) BusinessPolicyLog assets will be included.
*
* @return a fluent search that includes all BusinessPolicyLog assets
*/
public static FluentSearch.FluentSearchBuilder select() {
return select(Atlan.getDefaultClient());
}
/**
* Start a fluent search that will return all BusinessPolicyLog 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) BusinessPolicyLog assets will be included.
*
* @param client connectivity to the Atlan tenant from which to retrieve the assets
* @return a fluent search that includes all BusinessPolicyLog assets
*/
public static FluentSearch.FluentSearchBuilder select(AtlanClient client) {
return select(client, false);
}
/**
* Start a fluent search that will return all BusinessPolicyLog 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) BusinessPolicyLogs will be included
* @return a fluent search that includes all BusinessPolicyLog assets
*/
public static FluentSearch.FluentSearchBuilder select(boolean includeArchived) {
return select(Atlan.getDefaultClient(), includeArchived);
}
/**
* Start a fluent search that will return all BusinessPolicyLog 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) BusinessPolicyLogs will be included
* @return a fluent search that includes all BusinessPolicyLog 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 BusinessPolicyLog by GUID. Use this to create a relationship to this BusinessPolicyLog,
* where the relationship should be replaced.
*
* @param guid the GUID of the BusinessPolicyLog to reference
* @return reference to a BusinessPolicyLog that can be used for defining a relationship to a BusinessPolicyLog
*/
public static BusinessPolicyLog refByGuid(String guid) {
return refByGuid(guid, Reference.SaveSemantic.REPLACE);
}
/**
* Reference to a BusinessPolicyLog by GUID. Use this to create a relationship to this BusinessPolicyLog,
* where you want to further control how that relationship should be updated (i.e. replaced,
* appended, or removed).
*
* @param guid the GUID of the BusinessPolicyLog to reference
* @param semantic how to save this relationship (replace all with this, append it, or remove it)
* @return reference to a BusinessPolicyLog that can be used for defining a relationship to a BusinessPolicyLog
*/
public static BusinessPolicyLog refByGuid(String guid, Reference.SaveSemantic semantic) {
return BusinessPolicyLog._internal().guid(guid).semantic(semantic).build();
}
/**
* Reference to a BusinessPolicyLog by qualifiedName. Use this to create a relationship to this BusinessPolicyLog,
* where the relationship should be replaced.
*
* @param qualifiedName the qualifiedName of the BusinessPolicyLog to reference
* @return reference to a BusinessPolicyLog that can be used for defining a relationship to a BusinessPolicyLog
*/
public static BusinessPolicyLog refByQualifiedName(String qualifiedName) {
return refByQualifiedName(qualifiedName, Reference.SaveSemantic.REPLACE);
}
/**
* Reference to a BusinessPolicyLog by qualifiedName. Use this to create a relationship to this BusinessPolicyLog,
* where you want to further control how that relationship should be updated (i.e. replaced,
* appended, or removed).
*
* @param qualifiedName the qualifiedName of the BusinessPolicyLog to reference
* @param semantic how to save this relationship (replace all with this, append it, or remove it)
* @return reference to a BusinessPolicyLog that can be used for defining a relationship to a BusinessPolicyLog
*/
public static BusinessPolicyLog refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic) {
return BusinessPolicyLog._internal().uniqueAttributes(UniqueAttributes.builder().qualifiedName(qualifiedName).build()).semantic(semantic).build();
}
/**
* Retrieves a BusinessPolicyLog by one of its identifiers, complete with all of its relationships.
*
* @param id of the BusinessPolicyLog to retrieve, either its GUID or its full qualifiedName
* @return the requested full BusinessPolicyLog, complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the BusinessPolicyLog does not exist or the provided GUID is not a BusinessPolicyLog
*/
@JsonIgnore
public static BusinessPolicyLog get(String id) throws AtlanException {
return get(Atlan.getDefaultClient(), id);
}
/**
* Retrieves a BusinessPolicyLog 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 BusinessPolicyLog to retrieve, either its GUID or its full qualifiedName
* @return the requested full BusinessPolicyLog, complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the BusinessPolicyLog does not exist or the provided GUID is not a BusinessPolicyLog
*/
@JsonIgnore
public static BusinessPolicyLog get(AtlanClient client, String id) throws AtlanException {
return get(client, id, true);
}
/**
* Retrieves a BusinessPolicyLog 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 BusinessPolicyLog 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 BusinessPolicyLog, optionally complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the BusinessPolicyLog does not exist or the provided GUID is not a BusinessPolicyLog
*/
@JsonIgnore
public static BusinessPolicyLog 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 BusinessPolicyLog) {
return (BusinessPolicyLog) 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 BusinessPolicyLog) {
return (BusinessPolicyLog) asset;
} else {
throw new NotFoundException(ErrorCode.ASSET_NOT_FOUND_BY_QN, id, TYPE_NAME);
}
}
}
/**
* Restore the archived (soft-deleted) BusinessPolicyLog to active.
*
* @param qualifiedName for the BusinessPolicyLog
* @return true if the BusinessPolicyLog 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) BusinessPolicyLog to active.
*
* @param client connectivity to the Atlan tenant on which to restore the asset
* @param qualifiedName for the BusinessPolicyLog
* @return true if the BusinessPolicyLog 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 BusinessPolicyLog.
*
* @param qualifiedName of the BusinessPolicyLog
* @param name of the BusinessPolicyLog
* @return the minimal request necessary to update the BusinessPolicyLog, as a builder
*/
public static BusinessPolicyLogBuilder updater(String qualifiedName, String name) {
return BusinessPolicyLog._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 BusinessPolicyLog, from a potentially
* more-complete BusinessPolicyLog object.
*
* @return the minimal object necessary to update the BusinessPolicyLog, as a builder
* @throws InvalidRequestException if any of the minimal set of required properties for BusinessPolicyLog are not found in the initial object
*/
@Override
public BusinessPolicyLogBuilder 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 BusinessPolicyLog.
*
* @param qualifiedName of the BusinessPolicyLog
* @param name of the BusinessPolicyLog
* @return the updated BusinessPolicyLog, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog removeDescription(String qualifiedName, String name) throws AtlanException {
return removeDescription(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the system description from a BusinessPolicyLog.
*
* @param client connectivity to the Atlan tenant on which to remove the asset's description
* @param qualifiedName of the BusinessPolicyLog
* @param name of the BusinessPolicyLog
* @return the updated BusinessPolicyLog, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (BusinessPolicyLog) Asset.removeDescription(client, updater(qualifiedName, name));
}
/**
* Remove the user's description from a BusinessPolicyLog.
*
* @param qualifiedName of the BusinessPolicyLog
* @param name of the BusinessPolicyLog
* @return the updated BusinessPolicyLog, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog removeUserDescription(String qualifiedName, String name) throws AtlanException {
return removeUserDescription(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the user's description from a BusinessPolicyLog.
*
* @param client connectivity to the Atlan tenant on which to remove the asset's description
* @param qualifiedName of the BusinessPolicyLog
* @param name of the BusinessPolicyLog
* @return the updated BusinessPolicyLog, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (BusinessPolicyLog) Asset.removeUserDescription(client, updater(qualifiedName, name));
}
/**
* Remove the owners from a BusinessPolicyLog.
*
* @param qualifiedName of the BusinessPolicyLog
* @param name of the BusinessPolicyLog
* @return the updated BusinessPolicyLog, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog removeOwners(String qualifiedName, String name) throws AtlanException {
return removeOwners(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the owners from a BusinessPolicyLog.
*
* @param client connectivity to the Atlan tenant from which to remove the BusinessPolicyLog's owners
* @param qualifiedName of the BusinessPolicyLog
* @param name of the BusinessPolicyLog
* @return the updated BusinessPolicyLog, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (BusinessPolicyLog) Asset.removeOwners(client, updater(qualifiedName, name));
}
/**
* Update the certificate on a BusinessPolicyLog.
*
* @param qualifiedName of the BusinessPolicyLog
* @param certificate to use
* @param message (optional) message, or null if no message
* @return the updated BusinessPolicyLog, or null if the update failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException {
return updateCertificate(Atlan.getDefaultClient(), qualifiedName, certificate, message);
}
/**
* Update the certificate on a BusinessPolicyLog.
*
* @param client connectivity to the Atlan tenant on which to update the BusinessPolicyLog's certificate
* @param qualifiedName of the BusinessPolicyLog
* @param certificate to use
* @param message (optional) message, or null if no message
* @return the updated BusinessPolicyLog, or null if the update failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException {
return (BusinessPolicyLog) Asset.updateCertificate(client, _internal(), TYPE_NAME, qualifiedName, certificate, message);
}
/**
* Remove the certificate from a BusinessPolicyLog.
*
* @param qualifiedName of the BusinessPolicyLog
* @param name of the BusinessPolicyLog
* @return the updated BusinessPolicyLog, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog removeCertificate(String qualifiedName, String name) throws AtlanException {
return removeCertificate(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the certificate from a BusinessPolicyLog.
*
* @param client connectivity to the Atlan tenant from which to remove the BusinessPolicyLog's certificate
* @param qualifiedName of the BusinessPolicyLog
* @param name of the BusinessPolicyLog
* @return the updated BusinessPolicyLog, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (BusinessPolicyLog) Asset.removeCertificate(client, updater(qualifiedName, name));
}
/**
* Update the announcement on a BusinessPolicyLog.
*
* @param qualifiedName of the BusinessPolicyLog
* @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 BusinessPolicyLog updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException {
return updateAnnouncement(Atlan.getDefaultClient(), qualifiedName, type, title, message);
}
/**
* Update the announcement on a BusinessPolicyLog.
*
* @param client connectivity to the Atlan tenant on which to update the BusinessPolicyLog's announcement
* @param qualifiedName of the BusinessPolicyLog
* @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 BusinessPolicyLog updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException {
return (BusinessPolicyLog) Asset.updateAnnouncement(client, _internal(), TYPE_NAME, qualifiedName, type, title, message);
}
/**
* Remove the announcement from a BusinessPolicyLog.
*
* @param qualifiedName of the BusinessPolicyLog
* @param name of the BusinessPolicyLog
* @return the updated BusinessPolicyLog, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog removeAnnouncement(String qualifiedName, String name) throws AtlanException {
return removeAnnouncement(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the announcement from a BusinessPolicyLog.
*
* @param client connectivity to the Atlan client from which to remove the BusinessPolicyLog's announcement
* @param qualifiedName of the BusinessPolicyLog
* @param name of the BusinessPolicyLog
* @return the updated BusinessPolicyLog, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (BusinessPolicyLog) Asset.removeAnnouncement(client, updater(qualifiedName, name));
}
/**
* Replace the terms linked to the BusinessPolicyLog.
*
* @param qualifiedName for the BusinessPolicyLog
* @param name human-readable name of the BusinessPolicyLog
* @param terms the list of terms to replace on the BusinessPolicyLog, or null to remove all terms from the BusinessPolicyLog
* @return the BusinessPolicyLog that was updated (note that it will NOT contain details of the replaced terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog replaceTerms(String qualifiedName, String name, List terms) throws AtlanException {
return replaceTerms(Atlan.getDefaultClient(), qualifiedName, name, terms);
}
/**
* Replace the terms linked to the BusinessPolicyLog.
*
* @param client connectivity to the Atlan tenant on which to replace the BusinessPolicyLog's assigned terms
* @param qualifiedName for the BusinessPolicyLog
* @param name human-readable name of the BusinessPolicyLog
* @param terms the list of terms to replace on the BusinessPolicyLog, or null to remove all terms from the BusinessPolicyLog
* @return the BusinessPolicyLog that was updated (note that it will NOT contain details of the replaced terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog replaceTerms(AtlanClient client, String qualifiedName, String name, List terms) throws AtlanException {
return (BusinessPolicyLog) Asset.replaceTerms(client, updater(qualifiedName, name), terms);
}
/**
* Link additional terms to the BusinessPolicyLog, without replacing existing terms linked to the BusinessPolicyLog.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyLog's existing terms,
* and a second to append the new terms.
*
* @param qualifiedName for the BusinessPolicyLog
* @param terms the list of terms to append to the BusinessPolicyLog
* @return the BusinessPolicyLog that was updated (note that it will NOT contain details of the appended terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog appendTerms(String qualifiedName, List terms) throws AtlanException {
return appendTerms(Atlan.getDefaultClient(), qualifiedName, terms);
}
/**
* Link additional terms to the BusinessPolicyLog, without replacing existing terms linked to the BusinessPolicyLog.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyLog'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 BusinessPolicyLog
* @param qualifiedName for the BusinessPolicyLog
* @param terms the list of terms to append to the BusinessPolicyLog
* @return the BusinessPolicyLog that was updated (note that it will NOT contain details of the appended terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog appendTerms(AtlanClient client, String qualifiedName, List terms) throws AtlanException {
return (BusinessPolicyLog) Asset.appendTerms(client, TYPE_NAME, qualifiedName, terms);
}
/**
* Remove terms from a BusinessPolicyLog, without replacing all existing terms linked to the BusinessPolicyLog.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyLog's existing terms,
* and a second to remove the provided terms.
*
* @param qualifiedName for the BusinessPolicyLog
* @param terms the list of terms to remove from the BusinessPolicyLog, which must be referenced by GUID
* @return the BusinessPolicyLog that was updated (note that it will NOT contain details of the resulting terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog removeTerms(String qualifiedName, List terms) throws AtlanException {
return removeTerms(Atlan.getDefaultClient(), qualifiedName, terms);
}
/**
* Remove terms from a BusinessPolicyLog, without replacing all existing terms linked to the BusinessPolicyLog.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyLog'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 BusinessPolicyLog
* @param qualifiedName for the BusinessPolicyLog
* @param terms the list of terms to remove from the BusinessPolicyLog, which must be referenced by GUID
* @return the BusinessPolicyLog that was updated (note that it will NOT contain details of the resulting terms)
* @throws AtlanException on any API problems
*/
public static BusinessPolicyLog removeTerms(AtlanClient client, String qualifiedName, List terms) throws AtlanException {
return (BusinessPolicyLog) Asset.removeTerms(client, TYPE_NAME, qualifiedName, terms);
}
/**
* Add Atlan tags to a BusinessPolicyLog, without replacing existing Atlan tags linked to the BusinessPolicyLog.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyLog's existing Atlan tags,
* and a second to append the new Atlan tags.
*
* @param qualifiedName of the BusinessPolicyLog
* @param atlanTagNames human-readable names of the Atlan tags to add
* @throws AtlanException on any API problems
* @return the updated BusinessPolicyLog
*/
public static BusinessPolicyLog appendAtlanTags(String qualifiedName, List atlanTagNames) throws AtlanException {
return appendAtlanTags(Atlan.getDefaultClient(), qualifiedName, atlanTagNames);
}
/**
* Add Atlan tags to a BusinessPolicyLog, without replacing existing Atlan tags linked to the BusinessPolicyLog.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyLog'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 BusinessPolicyLog
* @param qualifiedName of the BusinessPolicyLog
* @param atlanTagNames human-readable names of the Atlan tags to add
* @throws AtlanException on any API problems
* @return the updated BusinessPolicyLog
*/
public static BusinessPolicyLog appendAtlanTags(AtlanClient client, String qualifiedName, List atlanTagNames) throws AtlanException {
return (BusinessPolicyLog) Asset.appendAtlanTags(client, TYPE_NAME, qualifiedName, atlanTagNames);
}
/**
* Add Atlan tags to a BusinessPolicyLog, without replacing existing Atlan tags linked to the BusinessPolicyLog.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyLog's existing Atlan tags,
* and a second to append the new Atlan tags.
*
* @param qualifiedName of the BusinessPolicyLog
* @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 BusinessPolicyLog
*/
public static BusinessPolicyLog 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 BusinessPolicyLog, without replacing existing Atlan tags linked to the BusinessPolicyLog.
* Note: this operation must make two API calls — one to retrieve the BusinessPolicyLog'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 BusinessPolicyLog
* @param qualifiedName of the BusinessPolicyLog
* @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 BusinessPolicyLog
*/
public static BusinessPolicyLog appendAtlanTags(AtlanClient client, String qualifiedName, List atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException {
return (BusinessPolicyLog) Asset.appendAtlanTags(client, TYPE_NAME, qualifiedName, atlanTagNames, propagate, removePropagationsOnDelete, restrictLineagePropagation);
}
/**
* Remove an Atlan tag from a BusinessPolicyLog.
*
* @param qualifiedName of the BusinessPolicyLog
* @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 BusinessPolicyLog
*/
public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException {
removeAtlanTag(Atlan.getDefaultClient(), qualifiedName, atlanTagName);
}
/**
* Remove an Atlan tag from a BusinessPolicyLog.
*
* @param client connectivity to the Atlan tenant from which to remove an Atlan tag from a BusinessPolicyLog
* @param qualifiedName of the BusinessPolicyLog
* @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 BusinessPolicyLog
*/
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 BusinessPolicyLogBuilder> 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 businessPolicyId;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private String businessPolicyLogPolicyType;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private Long compliantAssetsCount;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private Long governedAssetsCount;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private Long nonCompliantAssetsCount;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private Long nonGovernedAssetsCount;
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected B $fillValuesFrom(final C instance) {
super.$fillValuesFrom(instance);
BusinessPolicyLog.BusinessPolicyLogBuilder.$fillValuesFromInstanceIntoBuilder(instance, this);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static void $fillValuesFromInstanceIntoBuilder(final BusinessPolicyLog instance, final BusinessPolicyLog.BusinessPolicyLogBuilder b) {
b.typeName(instance.typeName);
b.businessPolicyId(instance.businessPolicyId);
b.businessPolicyLogPolicyType(instance.businessPolicyLogPolicyType);
b.compliantAssetsCount(instance.compliantAssetsCount);
b.governedAssetsCount(instance.governedAssetsCount);
b.nonCompliantAssetsCount(instance.nonCompliantAssetsCount);
b.nonGovernedAssetsCount(instance.nonGovernedAssetsCount);
}
/**
* Fixed typeName for BusinessPolicyLogs.
* @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 guid for which log are created
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B businessPolicyId(final String businessPolicyId) {
this.businessPolicyId = businessPolicyId;
return self();
}
/**
* business policy type for which log are created
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B businessPolicyLogPolicyType(final String businessPolicyLogPolicyType) {
this.businessPolicyLogPolicyType = businessPolicyLogPolicyType;
return self();
}
/**
* number of compliant assets in the policy
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B compliantAssetsCount(final Long compliantAssetsCount) {
this.compliantAssetsCount = compliantAssetsCount;
return self();
}
/**
* number of governed assets in the policy
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B governedAssetsCount(final Long governedAssetsCount) {
this.governedAssetsCount = governedAssetsCount;
return self();
}
/**
* number of non compliant assets in the policy
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B nonCompliantAssetsCount(final Long nonCompliantAssetsCount) {
this.nonCompliantAssetsCount = nonCompliantAssetsCount;
return self();
}
/**
* number of non governed assets in the policy
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B nonGovernedAssetsCount(final Long nonGovernedAssetsCount) {
this.nonGovernedAssetsCount = nonGovernedAssetsCount;
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 "BusinessPolicyLog.BusinessPolicyLogBuilder(super=" + super.toString() + ", typeName$value=" + this.typeName$value + ", businessPolicyId=" + this.businessPolicyId + ", businessPolicyLogPolicyType=" + this.businessPolicyLogPolicyType + ", compliantAssetsCount=" + this.compliantAssetsCount + ", governedAssetsCount=" + this.governedAssetsCount + ", nonCompliantAssetsCount=" + this.nonCompliantAssetsCount + ", nonGovernedAssetsCount=" + this.nonGovernedAssetsCount + ")";
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static final class BusinessPolicyLogBuilderImpl extends BusinessPolicyLog.BusinessPolicyLogBuilder {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private BusinessPolicyLogBuilderImpl() {
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected BusinessPolicyLog.BusinessPolicyLogBuilderImpl self() {
return this;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public BusinessPolicyLog build() {
return new BusinessPolicyLog(this);
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected BusinessPolicyLog(final BusinessPolicyLog.BusinessPolicyLogBuilder b) {
super(b);
if (b.typeName$set) this.typeName = b.typeName$value;
else this.typeName = BusinessPolicyLog.$default$typeName();
this.businessPolicyId = b.businessPolicyId;
this.businessPolicyLogPolicyType = b.businessPolicyLogPolicyType;
this.compliantAssetsCount = b.compliantAssetsCount;
this.governedAssetsCount = b.governedAssetsCount;
this.nonCompliantAssetsCount = b.nonCompliantAssetsCount;
this.nonGovernedAssetsCount = b.nonGovernedAssetsCount;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public static BusinessPolicyLog.BusinessPolicyLogBuilder _internal() {
return new BusinessPolicyLog.BusinessPolicyLogBuilderImpl();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public BusinessPolicyLog.BusinessPolicyLogBuilder toBuilder() {
return new BusinessPolicyLog.BusinessPolicyLogBuilderImpl().$fillValuesFrom(this);
}
/**
* business policy guid for which log are created
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getBusinessPolicyId() {
return this.businessPolicyId;
}
/**
* business policy type for which log are created
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getBusinessPolicyLogPolicyType() {
return this.businessPolicyLogPolicyType;
}
/**
* number of compliant assets in the policy
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getCompliantAssetsCount() {
return this.compliantAssetsCount;
}
/**
* number of governed assets in the policy
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getGovernedAssetsCount() {
return this.governedAssetsCount;
}
/**
* number of non compliant assets in the policy
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getNonCompliantAssetsCount() {
return this.nonCompliantAssetsCount;
}
/**
* number of non governed assets in the policy
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getNonGovernedAssetsCount() {
return this.nonGovernedAssetsCount;
}
@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 BusinessPolicyLog)) return false;
final BusinessPolicyLog other = (BusinessPolicyLog) o;
if (!other.canEqual((java.lang.Object) this)) return false;
if (!super.equals(o)) return false;
final java.lang.Object this$compliantAssetsCount = this.getCompliantAssetsCount();
final java.lang.Object other$compliantAssetsCount = other.getCompliantAssetsCount();
if (this$compliantAssetsCount == null ? other$compliantAssetsCount != null : !this$compliantAssetsCount.equals(other$compliantAssetsCount)) return false;
final java.lang.Object this$governedAssetsCount = this.getGovernedAssetsCount();
final java.lang.Object other$governedAssetsCount = other.getGovernedAssetsCount();
if (this$governedAssetsCount == null ? other$governedAssetsCount != null : !this$governedAssetsCount.equals(other$governedAssetsCount)) return false;
final java.lang.Object this$nonCompliantAssetsCount = this.getNonCompliantAssetsCount();
final java.lang.Object other$nonCompliantAssetsCount = other.getNonCompliantAssetsCount();
if (this$nonCompliantAssetsCount == null ? other$nonCompliantAssetsCount != null : !this$nonCompliantAssetsCount.equals(other$nonCompliantAssetsCount)) return false;
final java.lang.Object this$nonGovernedAssetsCount = this.getNonGovernedAssetsCount();
final java.lang.Object other$nonGovernedAssetsCount = other.getNonGovernedAssetsCount();
if (this$nonGovernedAssetsCount == null ? other$nonGovernedAssetsCount != null : !this$nonGovernedAssetsCount.equals(other$nonGovernedAssetsCount)) 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$businessPolicyId = this.getBusinessPolicyId();
final java.lang.Object other$businessPolicyId = other.getBusinessPolicyId();
if (this$businessPolicyId == null ? other$businessPolicyId != null : !this$businessPolicyId.equals(other$businessPolicyId)) return false;
final java.lang.Object this$businessPolicyLogPolicyType = this.getBusinessPolicyLogPolicyType();
final java.lang.Object other$businessPolicyLogPolicyType = other.getBusinessPolicyLogPolicyType();
if (this$businessPolicyLogPolicyType == null ? other$businessPolicyLogPolicyType != null : !this$businessPolicyLogPolicyType.equals(other$businessPolicyLogPolicyType)) return false;
return true;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected boolean canEqual(final java.lang.Object other) {
return other instanceof BusinessPolicyLog;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public int hashCode() {
final int PRIME = 59;
int result = super.hashCode();
final java.lang.Object $compliantAssetsCount = this.getCompliantAssetsCount();
result = result * PRIME + ($compliantAssetsCount == null ? 43 : $compliantAssetsCount.hashCode());
final java.lang.Object $governedAssetsCount = this.getGovernedAssetsCount();
result = result * PRIME + ($governedAssetsCount == null ? 43 : $governedAssetsCount.hashCode());
final java.lang.Object $nonCompliantAssetsCount = this.getNonCompliantAssetsCount();
result = result * PRIME + ($nonCompliantAssetsCount == null ? 43 : $nonCompliantAssetsCount.hashCode());
final java.lang.Object $nonGovernedAssetsCount = this.getNonGovernedAssetsCount();
result = result * PRIME + ($nonGovernedAssetsCount == null ? 43 : $nonGovernedAssetsCount.hashCode());
final java.lang.Object $typeName = this.getTypeName();
result = result * PRIME + ($typeName == null ? 43 : $typeName.hashCode());
final java.lang.Object $businessPolicyId = this.getBusinessPolicyId();
result = result * PRIME + ($businessPolicyId == null ? 43 : $businessPolicyId.hashCode());
final java.lang.Object $businessPolicyLogPolicyType = this.getBusinessPolicyLogPolicyType();
result = result * PRIME + ($businessPolicyLogPolicyType == null ? 43 : $businessPolicyLogPolicyType.hashCode());
return result;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public java.lang.String toString() {
return "BusinessPolicyLog(super=" + super.toString() + ", typeName=" + this.getTypeName() + ", businessPolicyId=" + this.getBusinessPolicyId() + ", businessPolicyLogPolicyType=" + this.getBusinessPolicyLogPolicyType() + ", compliantAssetsCount=" + this.getCompliantAssetsCount() + ", governedAssetsCount=" + this.getGovernedAssetsCount() + ", nonCompliantAssetsCount=" + this.getNonCompliantAssetsCount() + ", nonGovernedAssetsCount=" + this.getNonGovernedAssetsCount() + ")";
}
/**
* Fixed typeName for BusinessPolicyLogs.
*/
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getTypeName() {
return this.typeName;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy