com.atlan.model.assets.APIObject Maven / Gradle / Ivy
// Generated by delombok at Tue Nov 26 17:04:59 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.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.*;
/**
* Instances of APIObject in Atlan.
*/
@Generated("com.atlan.generators.ModelGeneratorV2")
@SuppressWarnings("cast")
public class APIObject extends Asset implements IAPIObject, IAPI, ICatalog, IAsset, IReferenceable {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(APIObject.class);
private static final long serialVersionUID = 2L;
public static final String TYPE_NAME = "APIObject";
/**
* Fixed typeName for APIObjects.
*/
String typeName;
/**
* External documentation of the API.
*/
@Attribute
Map apiExternalDocs;
/**
* Count of the APIField of this object.
*/
@Attribute
Long apiFieldCount;
/**
* APIField assets contained within this APIObject.
*/
@Attribute
SortedSet apiFields;
/**
* Whether authentication is optional (true) or required (false).
*/
@Attribute
Boolean apiIsAuthOptional;
/**
* If this asset refers to an APIObject
*/
@Attribute
Boolean apiIsObjectReference;
/**
* Qualified name of the APIObject that is referred to by this asset. When apiIsObjectReference is true.
*/
@Attribute
String apiObjectQualifiedName;
/**
* Simple name of the API spec, if this asset is contained in an API spec.
*/
@Attribute
String apiSpecName;
/**
* Unique name of the API spec, if this asset is contained in an API spec.
*/
@Attribute
String apiSpecQualifiedName;
/**
* Type of API, for example: OpenAPI, GraphQL, etc.
*/
@Attribute
String apiSpecType;
/**
* Version of the API specification.
*/
@Attribute
String apiSpecVersion;
/**
* Tasks to which this asset provides input.
*/
@Attribute
SortedSet inputToAirflowTasks;
/**
* Processes to which this asset provides input.
*/
@Attribute
SortedSet inputToProcesses;
/**
* TBC
*/
@Attribute
SortedSet inputToSparkJobs;
/**
* Attributes implemented by this asset.
*/
@Attribute
SortedSet modelImplementedAttributes;
/**
* Entities implemented by this asset.
*/
@Attribute
SortedSet modelImplementedEntities;
/**
* Tasks from which this asset is output.
*/
@Attribute
SortedSet outputFromAirflowTasks;
/**
* Processes from which this asset is produced as output.
*/
@Attribute
SortedSet outputFromProcesses;
/**
* TBC
*/
@Attribute
SortedSet outputFromSparkJobs;
/**
* Builds the minimal object necessary to create a relationship to a APIObject, from a potentially
* more-complete APIObject object.
*
* @return the minimal object necessary to relate to the APIObject
* @throws InvalidRequestException if any of the minimal set of required properties for a APIObject relationship are not found in the initial object
*/
@Override
public APIObject 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 APIObject 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) APIObject assets will be included.
*
* @return a fluent search that includes all APIObject assets
*/
public static FluentSearch.FluentSearchBuilder select() {
return select(Atlan.getDefaultClient());
}
/**
* Start a fluent search that will return all APIObject 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) APIObject assets will be included.
*
* @param client connectivity to the Atlan tenant from which to retrieve the assets
* @return a fluent search that includes all APIObject assets
*/
public static FluentSearch.FluentSearchBuilder select(AtlanClient client) {
return select(client, false);
}
/**
* Start a fluent search that will return all APIObject 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) APIObjects will be included
* @return a fluent search that includes all APIObject assets
*/
public static FluentSearch.FluentSearchBuilder select(boolean includeArchived) {
return select(Atlan.getDefaultClient(), includeArchived);
}
/**
* Start a fluent search that will return all APIObject 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) APIObjects will be included
* @return a fluent search that includes all APIObject 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 APIObject by GUID. Use this to create a relationship to this APIObject,
* where the relationship should be replaced.
*
* @param guid the GUID of the APIObject to reference
* @return reference to a APIObject that can be used for defining a relationship to a APIObject
*/
public static APIObject refByGuid(String guid) {
return refByGuid(guid, Reference.SaveSemantic.REPLACE);
}
/**
* Reference to a APIObject by GUID. Use this to create a relationship to this APIObject,
* where you want to further control how that relationship should be updated (i.e. replaced,
* appended, or removed).
*
* @param guid the GUID of the APIObject to reference
* @param semantic how to save this relationship (replace all with this, append it, or remove it)
* @return reference to a APIObject that can be used for defining a relationship to a APIObject
*/
public static APIObject refByGuid(String guid, Reference.SaveSemantic semantic) {
return APIObject._internal().guid(guid).semantic(semantic).build();
}
/**
* Reference to a APIObject by qualifiedName. Use this to create a relationship to this APIObject,
* where the relationship should be replaced.
*
* @param qualifiedName the qualifiedName of the APIObject to reference
* @return reference to a APIObject that can be used for defining a relationship to a APIObject
*/
public static APIObject refByQualifiedName(String qualifiedName) {
return refByQualifiedName(qualifiedName, Reference.SaveSemantic.REPLACE);
}
/**
* Reference to a APIObject by qualifiedName. Use this to create a relationship to this APIObject,
* where you want to further control how that relationship should be updated (i.e. replaced,
* appended, or removed).
*
* @param qualifiedName the qualifiedName of the APIObject to reference
* @param semantic how to save this relationship (replace all with this, append it, or remove it)
* @return reference to a APIObject that can be used for defining a relationship to a APIObject
*/
public static APIObject refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic) {
return APIObject._internal().uniqueAttributes(UniqueAttributes.builder().qualifiedName(qualifiedName).build()).semantic(semantic).build();
}
/**
* Retrieves a APIObject by one of its identifiers, complete with all of its relationships.
*
* @param id of the APIObject to retrieve, either its GUID or its full qualifiedName
* @return the requested full APIObject, complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the APIObject does not exist or the provided GUID is not a APIObject
*/
@JsonIgnore
public static APIObject get(String id) throws AtlanException {
return get(Atlan.getDefaultClient(), id);
}
/**
* Retrieves a APIObject 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 APIObject to retrieve, either its GUID or its full qualifiedName
* @return the requested full APIObject, complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the APIObject does not exist or the provided GUID is not a APIObject
*/
@JsonIgnore
public static APIObject get(AtlanClient client, String id) throws AtlanException {
return get(client, id, true);
}
/**
* Retrieves a APIObject 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 APIObject 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 APIObject, optionally complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the APIObject does not exist or the provided GUID is not a APIObject
*/
@JsonIgnore
public static APIObject 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 APIObject) {
return (APIObject) 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 APIObject) {
return (APIObject) asset;
} else {
throw new NotFoundException(ErrorCode.ASSET_NOT_FOUND_BY_QN, id, TYPE_NAME);
}
}
}
/**
* Restore the archived (soft-deleted) APIObject to active.
*
* @param qualifiedName for the APIObject
* @return true if the APIObject 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) APIObject to active.
*
* @param client connectivity to the Atlan tenant on which to restore the asset
* @param qualifiedName for the APIObject
* @return true if the APIObject 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 APIObject.
*
* @param qualifiedName of the APIObject
* @param name of the APIObject
* @return the minimal request necessary to update the APIObject, as a builder
*/
public static APIObjectBuilder updater(String qualifiedName, String name) {
return APIObject._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 APIObject, from a potentially
* more-complete APIObject object.
*
* @return the minimal object necessary to update the APIObject, as a builder
* @throws InvalidRequestException if any of the minimal set of required properties for APIObject are not found in the initial object
*/
@Override
public APIObjectBuilder 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 APIObject.
*
* @param qualifiedName of the APIObject
* @param name of the APIObject
* @return the updated APIObject, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static APIObject removeDescription(String qualifiedName, String name) throws AtlanException {
return removeDescription(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the system description from a APIObject.
*
* @param client connectivity to the Atlan tenant on which to remove the asset's description
* @param qualifiedName of the APIObject
* @param name of the APIObject
* @return the updated APIObject, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static APIObject removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (APIObject) Asset.removeDescription(client, updater(qualifiedName, name));
}
/**
* Remove the user's description from a APIObject.
*
* @param qualifiedName of the APIObject
* @param name of the APIObject
* @return the updated APIObject, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static APIObject removeUserDescription(String qualifiedName, String name) throws AtlanException {
return removeUserDescription(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the user's description from a APIObject.
*
* @param client connectivity to the Atlan tenant on which to remove the asset's description
* @param qualifiedName of the APIObject
* @param name of the APIObject
* @return the updated APIObject, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static APIObject removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (APIObject) Asset.removeUserDescription(client, updater(qualifiedName, name));
}
/**
* Remove the owners from a APIObject.
*
* @param qualifiedName of the APIObject
* @param name of the APIObject
* @return the updated APIObject, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static APIObject removeOwners(String qualifiedName, String name) throws AtlanException {
return removeOwners(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the owners from a APIObject.
*
* @param client connectivity to the Atlan tenant from which to remove the APIObject's owners
* @param qualifiedName of the APIObject
* @param name of the APIObject
* @return the updated APIObject, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static APIObject removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (APIObject) Asset.removeOwners(client, updater(qualifiedName, name));
}
/**
* Update the certificate on a APIObject.
*
* @param qualifiedName of the APIObject
* @param certificate to use
* @param message (optional) message, or null if no message
* @return the updated APIObject, or null if the update failed
* @throws AtlanException on any API problems
*/
public static APIObject updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException {
return updateCertificate(Atlan.getDefaultClient(), qualifiedName, certificate, message);
}
/**
* Update the certificate on a APIObject.
*
* @param client connectivity to the Atlan tenant on which to update the APIObject's certificate
* @param qualifiedName of the APIObject
* @param certificate to use
* @param message (optional) message, or null if no message
* @return the updated APIObject, or null if the update failed
* @throws AtlanException on any API problems
*/
public static APIObject updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException {
return (APIObject) Asset.updateCertificate(client, _internal(), TYPE_NAME, qualifiedName, certificate, message);
}
/**
* Remove the certificate from a APIObject.
*
* @param qualifiedName of the APIObject
* @param name of the APIObject
* @return the updated APIObject, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static APIObject removeCertificate(String qualifiedName, String name) throws AtlanException {
return removeCertificate(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the certificate from a APIObject.
*
* @param client connectivity to the Atlan tenant from which to remove the APIObject's certificate
* @param qualifiedName of the APIObject
* @param name of the APIObject
* @return the updated APIObject, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static APIObject removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (APIObject) Asset.removeCertificate(client, updater(qualifiedName, name));
}
/**
* Update the announcement on a APIObject.
*
* @param qualifiedName of the APIObject
* @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 APIObject updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException {
return updateAnnouncement(Atlan.getDefaultClient(), qualifiedName, type, title, message);
}
/**
* Update the announcement on a APIObject.
*
* @param client connectivity to the Atlan tenant on which to update the APIObject's announcement
* @param qualifiedName of the APIObject
* @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 APIObject updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException {
return (APIObject) Asset.updateAnnouncement(client, _internal(), TYPE_NAME, qualifiedName, type, title, message);
}
/**
* Remove the announcement from a APIObject.
*
* @param qualifiedName of the APIObject
* @param name of the APIObject
* @return the updated APIObject, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static APIObject removeAnnouncement(String qualifiedName, String name) throws AtlanException {
return removeAnnouncement(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the announcement from a APIObject.
*
* @param client connectivity to the Atlan client from which to remove the APIObject's announcement
* @param qualifiedName of the APIObject
* @param name of the APIObject
* @return the updated APIObject, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static APIObject removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (APIObject) Asset.removeAnnouncement(client, updater(qualifiedName, name));
}
/**
* Replace the terms linked to the APIObject.
*
* @param qualifiedName for the APIObject
* @param name human-readable name of the APIObject
* @param terms the list of terms to replace on the APIObject, or null to remove all terms from the APIObject
* @return the APIObject that was updated (note that it will NOT contain details of the replaced terms)
* @throws AtlanException on any API problems
*/
public static APIObject replaceTerms(String qualifiedName, String name, List terms) throws AtlanException {
return replaceTerms(Atlan.getDefaultClient(), qualifiedName, name, terms);
}
/**
* Replace the terms linked to the APIObject.
*
* @param client connectivity to the Atlan tenant on which to replace the APIObject's assigned terms
* @param qualifiedName for the APIObject
* @param name human-readable name of the APIObject
* @param terms the list of terms to replace on the APIObject, or null to remove all terms from the APIObject
* @return the APIObject that was updated (note that it will NOT contain details of the replaced terms)
* @throws AtlanException on any API problems
*/
public static APIObject replaceTerms(AtlanClient client, String qualifiedName, String name, List terms) throws AtlanException {
return (APIObject) Asset.replaceTerms(client, updater(qualifiedName, name), terms);
}
/**
* Link additional terms to the APIObject, without replacing existing terms linked to the APIObject.
* Note: this operation must make two API calls — one to retrieve the APIObject's existing terms,
* and a second to append the new terms.
*
* @param qualifiedName for the APIObject
* @param terms the list of terms to append to the APIObject
* @return the APIObject that was updated (note that it will NOT contain details of the appended terms)
* @throws AtlanException on any API problems
*/
public static APIObject appendTerms(String qualifiedName, List terms) throws AtlanException {
return appendTerms(Atlan.getDefaultClient(), qualifiedName, terms);
}
/**
* Link additional terms to the APIObject, without replacing existing terms linked to the APIObject.
* Note: this operation must make two API calls — one to retrieve the APIObject'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 APIObject
* @param qualifiedName for the APIObject
* @param terms the list of terms to append to the APIObject
* @return the APIObject that was updated (note that it will NOT contain details of the appended terms)
* @throws AtlanException on any API problems
*/
public static APIObject appendTerms(AtlanClient client, String qualifiedName, List terms) throws AtlanException {
return (APIObject) Asset.appendTerms(client, TYPE_NAME, qualifiedName, terms);
}
/**
* Remove terms from a APIObject, without replacing all existing terms linked to the APIObject.
* Note: this operation must make two API calls — one to retrieve the APIObject's existing terms,
* and a second to remove the provided terms.
*
* @param qualifiedName for the APIObject
* @param terms the list of terms to remove from the APIObject, which must be referenced by GUID
* @return the APIObject that was updated (note that it will NOT contain details of the resulting terms)
* @throws AtlanException on any API problems
*/
public static APIObject removeTerms(String qualifiedName, List terms) throws AtlanException {
return removeTerms(Atlan.getDefaultClient(), qualifiedName, terms);
}
/**
* Remove terms from a APIObject, without replacing all existing terms linked to the APIObject.
* Note: this operation must make two API calls — one to retrieve the APIObject'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 APIObject
* @param qualifiedName for the APIObject
* @param terms the list of terms to remove from the APIObject, which must be referenced by GUID
* @return the APIObject that was updated (note that it will NOT contain details of the resulting terms)
* @throws AtlanException on any API problems
*/
public static APIObject removeTerms(AtlanClient client, String qualifiedName, List terms) throws AtlanException {
return (APIObject) Asset.removeTerms(client, TYPE_NAME, qualifiedName, terms);
}
/**
* Add Atlan tags to a APIObject, without replacing existing Atlan tags linked to the APIObject.
* Note: this operation must make two API calls — one to retrieve the APIObject's existing Atlan tags,
* and a second to append the new Atlan tags.
*
* @param qualifiedName of the APIObject
* @param atlanTagNames human-readable names of the Atlan tags to add
* @throws AtlanException on any API problems
* @return the updated APIObject
*/
public static APIObject appendAtlanTags(String qualifiedName, List atlanTagNames) throws AtlanException {
return appendAtlanTags(Atlan.getDefaultClient(), qualifiedName, atlanTagNames);
}
/**
* Add Atlan tags to a APIObject, without replacing existing Atlan tags linked to the APIObject.
* Note: this operation must make two API calls — one to retrieve the APIObject'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 APIObject
* @param qualifiedName of the APIObject
* @param atlanTagNames human-readable names of the Atlan tags to add
* @throws AtlanException on any API problems
* @return the updated APIObject
*/
public static APIObject appendAtlanTags(AtlanClient client, String qualifiedName, List atlanTagNames) throws AtlanException {
return (APIObject) Asset.appendAtlanTags(client, TYPE_NAME, qualifiedName, atlanTagNames);
}
/**
* Add Atlan tags to a APIObject, without replacing existing Atlan tags linked to the APIObject.
* Note: this operation must make two API calls — one to retrieve the APIObject's existing Atlan tags,
* and a second to append the new Atlan tags.
*
* @param qualifiedName of the APIObject
* @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 APIObject
*/
public static APIObject 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 APIObject, without replacing existing Atlan tags linked to the APIObject.
* Note: this operation must make two API calls — one to retrieve the APIObject'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 APIObject
* @param qualifiedName of the APIObject
* @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 APIObject
*/
public static APIObject appendAtlanTags(AtlanClient client, String qualifiedName, List atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException {
return (APIObject) Asset.appendAtlanTags(client, TYPE_NAME, qualifiedName, atlanTagNames, propagate, removePropagationsOnDelete, restrictLineagePropagation);
}
/**
* Remove an Atlan tag from a APIObject.
*
* @param qualifiedName of the APIObject
* @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 APIObject
*/
public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException {
removeAtlanTag(Atlan.getDefaultClient(), qualifiedName, atlanTagName);
}
/**
* Remove an Atlan tag from a APIObject.
*
* @param client connectivity to the Atlan tenant from which to remove an Atlan tag from a APIObject
* @param qualifiedName of the APIObject
* @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 APIObject
*/
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 APIObjectBuilder> extends Asset.AssetBuilder {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private boolean typeName$set;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private String typeName$value;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private java.util.ArrayList apiExternalDocs$key;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private java.util.ArrayList apiExternalDocs$value;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private Long apiFieldCount;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private java.util.ArrayList apiFields;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private Boolean apiIsAuthOptional;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private Boolean apiIsObjectReference;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private String apiObjectQualifiedName;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private String apiSpecName;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private String apiSpecQualifiedName;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private String apiSpecType;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private String apiSpecVersion;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private java.util.ArrayList inputToAirflowTasks;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private java.util.ArrayList inputToProcesses;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private java.util.ArrayList inputToSparkJobs;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private java.util.ArrayList modelImplementedAttributes;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private java.util.ArrayList modelImplementedEntities;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private java.util.ArrayList outputFromAirflowTasks;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private java.util.ArrayList outputFromProcesses;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private java.util.ArrayList outputFromSparkJobs;
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected B $fillValuesFrom(final C instance) {
super.$fillValuesFrom(instance);
APIObject.APIObjectBuilder.$fillValuesFromInstanceIntoBuilder(instance, this);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static void $fillValuesFromInstanceIntoBuilder(final APIObject instance, final APIObject.APIObjectBuilder b) {
b.typeName(instance.typeName);
b.apiExternalDocs(instance.apiExternalDocs == null ? java.util.Collections.emptyMap() : instance.apiExternalDocs);
b.apiFieldCount(instance.apiFieldCount);
b.apiFields(instance.apiFields == null ? java.util.Collections.emptySortedSet() : instance.apiFields);
b.apiIsAuthOptional(instance.apiIsAuthOptional);
b.apiIsObjectReference(instance.apiIsObjectReference);
b.apiObjectQualifiedName(instance.apiObjectQualifiedName);
b.apiSpecName(instance.apiSpecName);
b.apiSpecQualifiedName(instance.apiSpecQualifiedName);
b.apiSpecType(instance.apiSpecType);
b.apiSpecVersion(instance.apiSpecVersion);
b.inputToAirflowTasks(instance.inputToAirflowTasks == null ? java.util.Collections.emptySortedSet() : instance.inputToAirflowTasks);
b.inputToProcesses(instance.inputToProcesses == null ? java.util.Collections.emptySortedSet() : instance.inputToProcesses);
b.inputToSparkJobs(instance.inputToSparkJobs == null ? java.util.Collections.emptySortedSet() : instance.inputToSparkJobs);
b.modelImplementedAttributes(instance.modelImplementedAttributes == null ? java.util.Collections.emptySortedSet() : instance.modelImplementedAttributes);
b.modelImplementedEntities(instance.modelImplementedEntities == null ? java.util.Collections.emptySortedSet() : instance.modelImplementedEntities);
b.outputFromAirflowTasks(instance.outputFromAirflowTasks == null ? java.util.Collections.emptySortedSet() : instance.outputFromAirflowTasks);
b.outputFromProcesses(instance.outputFromProcesses == null ? java.util.Collections.emptySortedSet() : instance.outputFromProcesses);
b.outputFromSparkJobs(instance.outputFromSparkJobs == null ? java.util.Collections.emptySortedSet() : instance.outputFromSparkJobs);
}
/**
* Fixed typeName for APIObjects.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B typeName(final String typeName) {
this.typeName$value = typeName;
typeName$set = true;
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B apiExternalDoc(final String apiExternalDocKey, final String apiExternalDocValue) {
if (this.apiExternalDocs$key == null) {
this.apiExternalDocs$key = new java.util.ArrayList();
this.apiExternalDocs$value = new java.util.ArrayList();
}
this.apiExternalDocs$key.add(apiExternalDocKey);
this.apiExternalDocs$value.add(apiExternalDocValue);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B apiExternalDocs(final java.util.Map apiExternalDocs) {
if (apiExternalDocs == null) {
throw new java.lang.NullPointerException("apiExternalDocs cannot be null");
}
if (this.apiExternalDocs$key == null) {
this.apiExternalDocs$key = new java.util.ArrayList();
this.apiExternalDocs$value = new java.util.ArrayList();
}
for (final java.util.Map.Entry $lombokEntry : apiExternalDocs.entrySet()) {
this.apiExternalDocs$key.add($lombokEntry.getKey());
this.apiExternalDocs$value.add($lombokEntry.getValue());
}
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B clearApiExternalDocs() {
if (this.apiExternalDocs$key != null) {
this.apiExternalDocs$key.clear();
this.apiExternalDocs$value.clear();
}
return self();
}
/**
* Count of the APIField of this object.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B apiFieldCount(final Long apiFieldCount) {
this.apiFieldCount = apiFieldCount;
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B apiField(final IAPIField apiField) {
if (this.apiFields == null) this.apiFields = new java.util.ArrayList();
this.apiFields.add(apiField);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B apiFields(final java.util.Collection apiFields) {
if (apiFields == null) {
throw new java.lang.NullPointerException("apiFields cannot be null");
}
if (this.apiFields == null) this.apiFields = new java.util.ArrayList();
this.apiFields.addAll(apiFields);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B clearApiFields() {
if (this.apiFields != null) this.apiFields.clear();
return self();
}
/**
* Whether authentication is optional (true) or required (false).
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B apiIsAuthOptional(final Boolean apiIsAuthOptional) {
this.apiIsAuthOptional = apiIsAuthOptional;
return self();
}
/**
* If this asset refers to an APIObject
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B apiIsObjectReference(final Boolean apiIsObjectReference) {
this.apiIsObjectReference = apiIsObjectReference;
return self();
}
/**
* Qualified name of the APIObject that is referred to by this asset. When apiIsObjectReference is true.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B apiObjectQualifiedName(final String apiObjectQualifiedName) {
this.apiObjectQualifiedName = apiObjectQualifiedName;
return self();
}
/**
* Simple name of the API spec, if this asset is contained in an API spec.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B apiSpecName(final String apiSpecName) {
this.apiSpecName = apiSpecName;
return self();
}
/**
* Unique name of the API spec, if this asset is contained in an API spec.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B apiSpecQualifiedName(final String apiSpecQualifiedName) {
this.apiSpecQualifiedName = apiSpecQualifiedName;
return self();
}
/**
* Type of API, for example: OpenAPI, GraphQL, etc.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B apiSpecType(final String apiSpecType) {
this.apiSpecType = apiSpecType;
return self();
}
/**
* Version of the API specification.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B apiSpecVersion(final String apiSpecVersion) {
this.apiSpecVersion = apiSpecVersion;
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B inputToAirflowTask(final IAirflowTask inputToAirflowTask) {
if (this.inputToAirflowTasks == null) this.inputToAirflowTasks = new java.util.ArrayList();
this.inputToAirflowTasks.add(inputToAirflowTask);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B inputToAirflowTasks(final java.util.Collection inputToAirflowTasks) {
if (inputToAirflowTasks == null) {
throw new java.lang.NullPointerException("inputToAirflowTasks cannot be null");
}
if (this.inputToAirflowTasks == null) this.inputToAirflowTasks = new java.util.ArrayList();
this.inputToAirflowTasks.addAll(inputToAirflowTasks);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B clearInputToAirflowTasks() {
if (this.inputToAirflowTasks != null) this.inputToAirflowTasks.clear();
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B inputToProcess(final ILineageProcess inputToProcess) {
if (this.inputToProcesses == null) this.inputToProcesses = new java.util.ArrayList();
this.inputToProcesses.add(inputToProcess);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B inputToProcesses(final java.util.Collection inputToProcesses) {
if (inputToProcesses == null) {
throw new java.lang.NullPointerException("inputToProcesses cannot be null");
}
if (this.inputToProcesses == null) this.inputToProcesses = new java.util.ArrayList();
this.inputToProcesses.addAll(inputToProcesses);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B clearInputToProcesses() {
if (this.inputToProcesses != null) this.inputToProcesses.clear();
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B inputToSparkJob(final ISparkJob inputToSparkJob) {
if (this.inputToSparkJobs == null) this.inputToSparkJobs = new java.util.ArrayList();
this.inputToSparkJobs.add(inputToSparkJob);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B inputToSparkJobs(final java.util.Collection inputToSparkJobs) {
if (inputToSparkJobs == null) {
throw new java.lang.NullPointerException("inputToSparkJobs cannot be null");
}
if (this.inputToSparkJobs == null) this.inputToSparkJobs = new java.util.ArrayList();
this.inputToSparkJobs.addAll(inputToSparkJobs);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B clearInputToSparkJobs() {
if (this.inputToSparkJobs != null) this.inputToSparkJobs.clear();
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B modelImplementedAttribute(final IModelAttribute modelImplementedAttribute) {
if (this.modelImplementedAttributes == null) this.modelImplementedAttributes = new java.util.ArrayList();
this.modelImplementedAttributes.add(modelImplementedAttribute);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B modelImplementedAttributes(final java.util.Collection modelImplementedAttributes) {
if (modelImplementedAttributes == null) {
throw new java.lang.NullPointerException("modelImplementedAttributes cannot be null");
}
if (this.modelImplementedAttributes == null) this.modelImplementedAttributes = new java.util.ArrayList();
this.modelImplementedAttributes.addAll(modelImplementedAttributes);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B clearModelImplementedAttributes() {
if (this.modelImplementedAttributes != null) this.modelImplementedAttributes.clear();
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B modelImplementedEntity(final IModelEntity modelImplementedEntity) {
if (this.modelImplementedEntities == null) this.modelImplementedEntities = new java.util.ArrayList();
this.modelImplementedEntities.add(modelImplementedEntity);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B modelImplementedEntities(final java.util.Collection modelImplementedEntities) {
if (modelImplementedEntities == null) {
throw new java.lang.NullPointerException("modelImplementedEntities cannot be null");
}
if (this.modelImplementedEntities == null) this.modelImplementedEntities = new java.util.ArrayList();
this.modelImplementedEntities.addAll(modelImplementedEntities);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B clearModelImplementedEntities() {
if (this.modelImplementedEntities != null) this.modelImplementedEntities.clear();
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B outputFromAirflowTask(final IAirflowTask outputFromAirflowTask) {
if (this.outputFromAirflowTasks == null) this.outputFromAirflowTasks = new java.util.ArrayList();
this.outputFromAirflowTasks.add(outputFromAirflowTask);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B outputFromAirflowTasks(final java.util.Collection outputFromAirflowTasks) {
if (outputFromAirflowTasks == null) {
throw new java.lang.NullPointerException("outputFromAirflowTasks cannot be null");
}
if (this.outputFromAirflowTasks == null) this.outputFromAirflowTasks = new java.util.ArrayList();
this.outputFromAirflowTasks.addAll(outputFromAirflowTasks);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B clearOutputFromAirflowTasks() {
if (this.outputFromAirflowTasks != null) this.outputFromAirflowTasks.clear();
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B outputFromProcess(final ILineageProcess outputFromProcess) {
if (this.outputFromProcesses == null) this.outputFromProcesses = new java.util.ArrayList();
this.outputFromProcesses.add(outputFromProcess);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B outputFromProcesses(final java.util.Collection outputFromProcesses) {
if (outputFromProcesses == null) {
throw new java.lang.NullPointerException("outputFromProcesses cannot be null");
}
if (this.outputFromProcesses == null) this.outputFromProcesses = new java.util.ArrayList();
this.outputFromProcesses.addAll(outputFromProcesses);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B clearOutputFromProcesses() {
if (this.outputFromProcesses != null) this.outputFromProcesses.clear();
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B outputFromSparkJob(final ISparkJob outputFromSparkJob) {
if (this.outputFromSparkJobs == null) this.outputFromSparkJobs = new java.util.ArrayList();
this.outputFromSparkJobs.add(outputFromSparkJob);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B outputFromSparkJobs(final java.util.Collection outputFromSparkJobs) {
if (outputFromSparkJobs == null) {
throw new java.lang.NullPointerException("outputFromSparkJobs cannot be null");
}
if (this.outputFromSparkJobs == null) this.outputFromSparkJobs = new java.util.ArrayList();
this.outputFromSparkJobs.addAll(outputFromSparkJobs);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B clearOutputFromSparkJobs() {
if (this.outputFromSparkJobs != null) this.outputFromSparkJobs.clear();
return self();
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected abstract B self();
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public abstract C build();
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public java.lang.String toString() {
return "APIObject.APIObjectBuilder(super=" + super.toString() + ", typeName$value=" + this.typeName$value + ", apiExternalDocs$key=" + this.apiExternalDocs$key + ", apiExternalDocs$value=" + this.apiExternalDocs$value + ", apiFieldCount=" + this.apiFieldCount + ", apiFields=" + this.apiFields + ", apiIsAuthOptional=" + this.apiIsAuthOptional + ", apiIsObjectReference=" + this.apiIsObjectReference + ", apiObjectQualifiedName=" + this.apiObjectQualifiedName + ", apiSpecName=" + this.apiSpecName + ", apiSpecQualifiedName=" + this.apiSpecQualifiedName + ", apiSpecType=" + this.apiSpecType + ", apiSpecVersion=" + this.apiSpecVersion + ", inputToAirflowTasks=" + this.inputToAirflowTasks + ", inputToProcesses=" + this.inputToProcesses + ", inputToSparkJobs=" + this.inputToSparkJobs + ", modelImplementedAttributes=" + this.modelImplementedAttributes + ", modelImplementedEntities=" + this.modelImplementedEntities + ", outputFromAirflowTasks=" + this.outputFromAirflowTasks + ", outputFromProcesses=" + this.outputFromProcesses + ", outputFromSparkJobs=" + this.outputFromSparkJobs + ")";
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static final class APIObjectBuilderImpl extends APIObject.APIObjectBuilder {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private APIObjectBuilderImpl() {
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected APIObject.APIObjectBuilderImpl self() {
return this;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public APIObject build() {
return new APIObject(this);
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected APIObject(final APIObject.APIObjectBuilder b) {
super(b);
if (b.typeName$set) this.typeName = b.typeName$value;
else this.typeName = APIObject.$default$typeName();
java.util.Map apiExternalDocs;
switch (b.apiExternalDocs$key == null ? 0 : b.apiExternalDocs$key.size()) {
case 0:
apiExternalDocs = java.util.Collections.emptyMap();
break;
case 1:
apiExternalDocs = java.util.Collections.singletonMap(b.apiExternalDocs$key.get(0), b.apiExternalDocs$value.get(0));
break;
default:
apiExternalDocs = new java.util.LinkedHashMap(b.apiExternalDocs$key.size() < 1073741824 ? 1 + b.apiExternalDocs$key.size() + (b.apiExternalDocs$key.size() - 3) / 3 : java.lang.Integer.MAX_VALUE);
for (int $i = 0; $i < b.apiExternalDocs$key.size(); $i++) apiExternalDocs.put(b.apiExternalDocs$key.get($i), (String) b.apiExternalDocs$value.get($i));
apiExternalDocs = java.util.Collections.unmodifiableMap(apiExternalDocs);
}
this.apiExternalDocs = apiExternalDocs;
this.apiFieldCount = b.apiFieldCount;
java.util.SortedSet apiFields = new java.util.TreeSet();
if (b.apiFields != null) apiFields.addAll(b.apiFields);
apiFields = java.util.Collections.unmodifiableSortedSet(apiFields);
this.apiFields = apiFields;
this.apiIsAuthOptional = b.apiIsAuthOptional;
this.apiIsObjectReference = b.apiIsObjectReference;
this.apiObjectQualifiedName = b.apiObjectQualifiedName;
this.apiSpecName = b.apiSpecName;
this.apiSpecQualifiedName = b.apiSpecQualifiedName;
this.apiSpecType = b.apiSpecType;
this.apiSpecVersion = b.apiSpecVersion;
java.util.SortedSet inputToAirflowTasks = new java.util.TreeSet();
if (b.inputToAirflowTasks != null) inputToAirflowTasks.addAll(b.inputToAirflowTasks);
inputToAirflowTasks = java.util.Collections.unmodifiableSortedSet(inputToAirflowTasks);
this.inputToAirflowTasks = inputToAirflowTasks;
java.util.SortedSet inputToProcesses = new java.util.TreeSet();
if (b.inputToProcesses != null) inputToProcesses.addAll(b.inputToProcesses);
inputToProcesses = java.util.Collections.unmodifiableSortedSet(inputToProcesses);
this.inputToProcesses = inputToProcesses;
java.util.SortedSet inputToSparkJobs = new java.util.TreeSet();
if (b.inputToSparkJobs != null) inputToSparkJobs.addAll(b.inputToSparkJobs);
inputToSparkJobs = java.util.Collections.unmodifiableSortedSet(inputToSparkJobs);
this.inputToSparkJobs = inputToSparkJobs;
java.util.SortedSet modelImplementedAttributes = new java.util.TreeSet();
if (b.modelImplementedAttributes != null) modelImplementedAttributes.addAll(b.modelImplementedAttributes);
modelImplementedAttributes = java.util.Collections.unmodifiableSortedSet(modelImplementedAttributes);
this.modelImplementedAttributes = modelImplementedAttributes;
java.util.SortedSet modelImplementedEntities = new java.util.TreeSet();
if (b.modelImplementedEntities != null) modelImplementedEntities.addAll(b.modelImplementedEntities);
modelImplementedEntities = java.util.Collections.unmodifiableSortedSet(modelImplementedEntities);
this.modelImplementedEntities = modelImplementedEntities;
java.util.SortedSet outputFromAirflowTasks = new java.util.TreeSet();
if (b.outputFromAirflowTasks != null) outputFromAirflowTasks.addAll(b.outputFromAirflowTasks);
outputFromAirflowTasks = java.util.Collections.unmodifiableSortedSet(outputFromAirflowTasks);
this.outputFromAirflowTasks = outputFromAirflowTasks;
java.util.SortedSet outputFromProcesses = new java.util.TreeSet();
if (b.outputFromProcesses != null) outputFromProcesses.addAll(b.outputFromProcesses);
outputFromProcesses = java.util.Collections.unmodifiableSortedSet(outputFromProcesses);
this.outputFromProcesses = outputFromProcesses;
java.util.SortedSet outputFromSparkJobs = new java.util.TreeSet();
if (b.outputFromSparkJobs != null) outputFromSparkJobs.addAll(b.outputFromSparkJobs);
outputFromSparkJobs = java.util.Collections.unmodifiableSortedSet(outputFromSparkJobs);
this.outputFromSparkJobs = outputFromSparkJobs;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public static APIObject.APIObjectBuilder _internal() {
return new APIObject.APIObjectBuilderImpl();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public APIObject.APIObjectBuilder toBuilder() {
return new APIObject.APIObjectBuilderImpl().$fillValuesFrom(this);
}
/**
* External documentation of the API.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getApiExternalDocs() {
return this.apiExternalDocs;
}
/**
* Count of the APIField of this object.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getApiFieldCount() {
return this.apiFieldCount;
}
/**
* APIField assets contained within this APIObject.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public SortedSet getApiFields() {
return this.apiFields;
}
/**
* Whether authentication is optional (true) or required (false).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Boolean getApiIsAuthOptional() {
return this.apiIsAuthOptional;
}
/**
* If this asset refers to an APIObject
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Boolean getApiIsObjectReference() {
return this.apiIsObjectReference;
}
/**
* Qualified name of the APIObject that is referred to by this asset. When apiIsObjectReference is true.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getApiObjectQualifiedName() {
return this.apiObjectQualifiedName;
}
/**
* Simple name of the API spec, if this asset is contained in an API spec.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getApiSpecName() {
return this.apiSpecName;
}
/**
* Unique name of the API spec, if this asset is contained in an API spec.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getApiSpecQualifiedName() {
return this.apiSpecQualifiedName;
}
/**
* Type of API, for example: OpenAPI, GraphQL, etc.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getApiSpecType() {
return this.apiSpecType;
}
/**
* Version of the API specification.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getApiSpecVersion() {
return this.apiSpecVersion;
}
/**
* Tasks to which this asset provides input.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public SortedSet getInputToAirflowTasks() {
return this.inputToAirflowTasks;
}
/**
* Processes to which this asset provides input.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public SortedSet getInputToProcesses() {
return this.inputToProcesses;
}
/**
* TBC
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public SortedSet getInputToSparkJobs() {
return this.inputToSparkJobs;
}
/**
* Attributes implemented by this asset.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public SortedSet getModelImplementedAttributes() {
return this.modelImplementedAttributes;
}
/**
* Entities implemented by this asset.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public SortedSet getModelImplementedEntities() {
return this.modelImplementedEntities;
}
/**
* Tasks from which this asset is output.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public SortedSet getOutputFromAirflowTasks() {
return this.outputFromAirflowTasks;
}
/**
* Processes from which this asset is produced as output.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public SortedSet getOutputFromProcesses() {
return this.outputFromProcesses;
}
/**
* TBC
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public SortedSet getOutputFromSparkJobs() {
return this.outputFromSparkJobs;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public boolean equals(final java.lang.Object o) {
if (o == this) return true;
if (!(o instanceof APIObject)) return false;
final APIObject other = (APIObject) o;
if (!other.canEqual((java.lang.Object) this)) return false;
if (!super.equals(o)) return false;
final java.lang.Object this$apiFieldCount = this.getApiFieldCount();
final java.lang.Object other$apiFieldCount = other.getApiFieldCount();
if (this$apiFieldCount == null ? other$apiFieldCount != null : !this$apiFieldCount.equals(other$apiFieldCount)) return false;
final java.lang.Object this$apiIsAuthOptional = this.getApiIsAuthOptional();
final java.lang.Object other$apiIsAuthOptional = other.getApiIsAuthOptional();
if (this$apiIsAuthOptional == null ? other$apiIsAuthOptional != null : !this$apiIsAuthOptional.equals(other$apiIsAuthOptional)) return false;
final java.lang.Object this$apiIsObjectReference = this.getApiIsObjectReference();
final java.lang.Object other$apiIsObjectReference = other.getApiIsObjectReference();
if (this$apiIsObjectReference == null ? other$apiIsObjectReference != null : !this$apiIsObjectReference.equals(other$apiIsObjectReference)) 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$apiExternalDocs = this.getApiExternalDocs();
final java.lang.Object other$apiExternalDocs = other.getApiExternalDocs();
if (this$apiExternalDocs == null ? other$apiExternalDocs != null : !this$apiExternalDocs.equals(other$apiExternalDocs)) return false;
final java.lang.Object this$apiFields = this.getApiFields();
final java.lang.Object other$apiFields = other.getApiFields();
if (this$apiFields == null ? other$apiFields != null : !this$apiFields.equals(other$apiFields)) return false;
final java.lang.Object this$apiObjectQualifiedName = this.getApiObjectQualifiedName();
final java.lang.Object other$apiObjectQualifiedName = other.getApiObjectQualifiedName();
if (this$apiObjectQualifiedName == null ? other$apiObjectQualifiedName != null : !this$apiObjectQualifiedName.equals(other$apiObjectQualifiedName)) return false;
final java.lang.Object this$apiSpecName = this.getApiSpecName();
final java.lang.Object other$apiSpecName = other.getApiSpecName();
if (this$apiSpecName == null ? other$apiSpecName != null : !this$apiSpecName.equals(other$apiSpecName)) return false;
final java.lang.Object this$apiSpecQualifiedName = this.getApiSpecQualifiedName();
final java.lang.Object other$apiSpecQualifiedName = other.getApiSpecQualifiedName();
if (this$apiSpecQualifiedName == null ? other$apiSpecQualifiedName != null : !this$apiSpecQualifiedName.equals(other$apiSpecQualifiedName)) return false;
final java.lang.Object this$apiSpecType = this.getApiSpecType();
final java.lang.Object other$apiSpecType = other.getApiSpecType();
if (this$apiSpecType == null ? other$apiSpecType != null : !this$apiSpecType.equals(other$apiSpecType)) return false;
final java.lang.Object this$apiSpecVersion = this.getApiSpecVersion();
final java.lang.Object other$apiSpecVersion = other.getApiSpecVersion();
if (this$apiSpecVersion == null ? other$apiSpecVersion != null : !this$apiSpecVersion.equals(other$apiSpecVersion)) return false;
final java.lang.Object this$inputToAirflowTasks = this.getInputToAirflowTasks();
final java.lang.Object other$inputToAirflowTasks = other.getInputToAirflowTasks();
if (this$inputToAirflowTasks == null ? other$inputToAirflowTasks != null : !this$inputToAirflowTasks.equals(other$inputToAirflowTasks)) return false;
final java.lang.Object this$inputToProcesses = this.getInputToProcesses();
final java.lang.Object other$inputToProcesses = other.getInputToProcesses();
if (this$inputToProcesses == null ? other$inputToProcesses != null : !this$inputToProcesses.equals(other$inputToProcesses)) return false;
final java.lang.Object this$inputToSparkJobs = this.getInputToSparkJobs();
final java.lang.Object other$inputToSparkJobs = other.getInputToSparkJobs();
if (this$inputToSparkJobs == null ? other$inputToSparkJobs != null : !this$inputToSparkJobs.equals(other$inputToSparkJobs)) return false;
final java.lang.Object this$modelImplementedAttributes = this.getModelImplementedAttributes();
final java.lang.Object other$modelImplementedAttributes = other.getModelImplementedAttributes();
if (this$modelImplementedAttributes == null ? other$modelImplementedAttributes != null : !this$modelImplementedAttributes.equals(other$modelImplementedAttributes)) return false;
final java.lang.Object this$modelImplementedEntities = this.getModelImplementedEntities();
final java.lang.Object other$modelImplementedEntities = other.getModelImplementedEntities();
if (this$modelImplementedEntities == null ? other$modelImplementedEntities != null : !this$modelImplementedEntities.equals(other$modelImplementedEntities)) return false;
final java.lang.Object this$outputFromAirflowTasks = this.getOutputFromAirflowTasks();
final java.lang.Object other$outputFromAirflowTasks = other.getOutputFromAirflowTasks();
if (this$outputFromAirflowTasks == null ? other$outputFromAirflowTasks != null : !this$outputFromAirflowTasks.equals(other$outputFromAirflowTasks)) return false;
final java.lang.Object this$outputFromProcesses = this.getOutputFromProcesses();
final java.lang.Object other$outputFromProcesses = other.getOutputFromProcesses();
if (this$outputFromProcesses == null ? other$outputFromProcesses != null : !this$outputFromProcesses.equals(other$outputFromProcesses)) return false;
final java.lang.Object this$outputFromSparkJobs = this.getOutputFromSparkJobs();
final java.lang.Object other$outputFromSparkJobs = other.getOutputFromSparkJobs();
if (this$outputFromSparkJobs == null ? other$outputFromSparkJobs != null : !this$outputFromSparkJobs.equals(other$outputFromSparkJobs)) return false;
return true;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected boolean canEqual(final java.lang.Object other) {
return other instanceof APIObject;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public int hashCode() {
final int PRIME = 59;
int result = super.hashCode();
final java.lang.Object $apiFieldCount = this.getApiFieldCount();
result = result * PRIME + ($apiFieldCount == null ? 43 : $apiFieldCount.hashCode());
final java.lang.Object $apiIsAuthOptional = this.getApiIsAuthOptional();
result = result * PRIME + ($apiIsAuthOptional == null ? 43 : $apiIsAuthOptional.hashCode());
final java.lang.Object $apiIsObjectReference = this.getApiIsObjectReference();
result = result * PRIME + ($apiIsObjectReference == null ? 43 : $apiIsObjectReference.hashCode());
final java.lang.Object $typeName = this.getTypeName();
result = result * PRIME + ($typeName == null ? 43 : $typeName.hashCode());
final java.lang.Object $apiExternalDocs = this.getApiExternalDocs();
result = result * PRIME + ($apiExternalDocs == null ? 43 : $apiExternalDocs.hashCode());
final java.lang.Object $apiFields = this.getApiFields();
result = result * PRIME + ($apiFields == null ? 43 : $apiFields.hashCode());
final java.lang.Object $apiObjectQualifiedName = this.getApiObjectQualifiedName();
result = result * PRIME + ($apiObjectQualifiedName == null ? 43 : $apiObjectQualifiedName.hashCode());
final java.lang.Object $apiSpecName = this.getApiSpecName();
result = result * PRIME + ($apiSpecName == null ? 43 : $apiSpecName.hashCode());
final java.lang.Object $apiSpecQualifiedName = this.getApiSpecQualifiedName();
result = result * PRIME + ($apiSpecQualifiedName == null ? 43 : $apiSpecQualifiedName.hashCode());
final java.lang.Object $apiSpecType = this.getApiSpecType();
result = result * PRIME + ($apiSpecType == null ? 43 : $apiSpecType.hashCode());
final java.lang.Object $apiSpecVersion = this.getApiSpecVersion();
result = result * PRIME + ($apiSpecVersion == null ? 43 : $apiSpecVersion.hashCode());
final java.lang.Object $inputToAirflowTasks = this.getInputToAirflowTasks();
result = result * PRIME + ($inputToAirflowTasks == null ? 43 : $inputToAirflowTasks.hashCode());
final java.lang.Object $inputToProcesses = this.getInputToProcesses();
result = result * PRIME + ($inputToProcesses == null ? 43 : $inputToProcesses.hashCode());
final java.lang.Object $inputToSparkJobs = this.getInputToSparkJobs();
result = result * PRIME + ($inputToSparkJobs == null ? 43 : $inputToSparkJobs.hashCode());
final java.lang.Object $modelImplementedAttributes = this.getModelImplementedAttributes();
result = result * PRIME + ($modelImplementedAttributes == null ? 43 : $modelImplementedAttributes.hashCode());
final java.lang.Object $modelImplementedEntities = this.getModelImplementedEntities();
result = result * PRIME + ($modelImplementedEntities == null ? 43 : $modelImplementedEntities.hashCode());
final java.lang.Object $outputFromAirflowTasks = this.getOutputFromAirflowTasks();
result = result * PRIME + ($outputFromAirflowTasks == null ? 43 : $outputFromAirflowTasks.hashCode());
final java.lang.Object $outputFromProcesses = this.getOutputFromProcesses();
result = result * PRIME + ($outputFromProcesses == null ? 43 : $outputFromProcesses.hashCode());
final java.lang.Object $outputFromSparkJobs = this.getOutputFromSparkJobs();
result = result * PRIME + ($outputFromSparkJobs == null ? 43 : $outputFromSparkJobs.hashCode());
return result;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public java.lang.String toString() {
return "APIObject(super=" + super.toString() + ", typeName=" + this.getTypeName() + ", apiExternalDocs=" + this.getApiExternalDocs() + ", apiFieldCount=" + this.getApiFieldCount() + ", apiFields=" + this.getApiFields() + ", apiIsAuthOptional=" + this.getApiIsAuthOptional() + ", apiIsObjectReference=" + this.getApiIsObjectReference() + ", apiObjectQualifiedName=" + this.getApiObjectQualifiedName() + ", apiSpecName=" + this.getApiSpecName() + ", apiSpecQualifiedName=" + this.getApiSpecQualifiedName() + ", apiSpecType=" + this.getApiSpecType() + ", apiSpecVersion=" + this.getApiSpecVersion() + ", inputToAirflowTasks=" + this.getInputToAirflowTasks() + ", inputToProcesses=" + this.getInputToProcesses() + ", inputToSparkJobs=" + this.getInputToSparkJobs() + ", modelImplementedAttributes=" + this.getModelImplementedAttributes() + ", modelImplementedEntities=" + this.getModelImplementedEntities() + ", outputFromAirflowTasks=" + this.getOutputFromAirflowTasks() + ", outputFromProcesses=" + this.getOutputFromProcesses() + ", outputFromSparkJobs=" + this.getOutputFromSparkJobs() + ")";
}
/**
* Fixed typeName for APIObjects.
*/
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getTypeName() {
return this.typeName;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy