Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// Generated by delombok at Thu Oct 10 18:56:33 UTC 2024
/* SPDX-License-Identifier: Apache-2.0
Copyright 2022 Atlan Pte. Ltd. */
package com.atlan.model.assets;
import com.atlan.Atlan;
import com.atlan.AtlanClient;
import com.atlan.exception.AtlanException;
import com.atlan.exception.ErrorCode;
import com.atlan.exception.InvalidRequestException;
import com.atlan.exception.NotFoundException;
import com.atlan.model.enums.AtlanAnnouncementType;
import com.atlan.model.enums.CertificateStatus;
import com.atlan.model.relations.Reference;
import com.atlan.model.relations.UniqueAttributes;
import com.atlan.model.search.FluentSearch;
import com.atlan.util.StringUtils;
import com.fasterxml.jackson.annotation.JsonIgnore;
import java.util.List;
import java.util.Map;
import java.util.SortedSet;
import java.util.concurrent.ThreadLocalRandom;
import javax.annotation.processing.Generated;
import lombok.*;
/**
* Instance of a Cognite file in Atlan.
*/
@Generated("com.atlan.generators.ModelGeneratorV2")
public class CogniteFile extends Asset implements ICogniteFile, ICognite, ISaaS, ICatalog, IAsset, IReferenceable {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(CogniteFile.class);
private static final long serialVersionUID = 2L;
public static final String TYPE_NAME = "CogniteFile";
/**
* Fixed typeName for CogniteFiles.
*/
String typeName;
/**
* Asset in which this file exists.
*/
@Attribute
ICogniteAsset cogniteAsset;
/**
* Tasks to which this asset provides input.
*/
@Attribute
SortedSet inputToAirflowTasks;
/**
* Processes to which this asset provides input.
*/
@Attribute
SortedSet inputToProcesses;
/**
* TBC
*/
@Attribute
SortedSet inputToSparkJobs;
/**
* 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 CogniteFile, from a potentially
* more-complete CogniteFile object.
*
* @return the minimal object necessary to relate to the CogniteFile
* @throws InvalidRequestException if any of the minimal set of required properties for a CogniteFile relationship are not found in the initial object
*/
@Override
public CogniteFile 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 CogniteFile 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) CogniteFile assets will be included.
*
* @return a fluent search that includes all CogniteFile assets
*/
public static FluentSearch.FluentSearchBuilder select() {
return select(Atlan.getDefaultClient());
}
/**
* Start a fluent search that will return all CogniteFile 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) CogniteFile assets will be included.
*
* @param client connectivity to the Atlan tenant from which to retrieve the assets
* @return a fluent search that includes all CogniteFile assets
*/
public static FluentSearch.FluentSearchBuilder select(AtlanClient client) {
return select(client, false);
}
/**
* Start a fluent search that will return all CogniteFile 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) CogniteFiles will be included
* @return a fluent search that includes all CogniteFile assets
*/
public static FluentSearch.FluentSearchBuilder select(boolean includeArchived) {
return select(Atlan.getDefaultClient(), includeArchived);
}
/**
* Start a fluent search that will return all CogniteFile 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) CogniteFiles will be included
* @return a fluent search that includes all CogniteFile 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 CogniteFile by GUID. Use this to create a relationship to this CogniteFile,
* where the relationship should be replaced.
*
* @param guid the GUID of the CogniteFile to reference
* @return reference to a CogniteFile that can be used for defining a relationship to a CogniteFile
*/
public static CogniteFile refByGuid(String guid) {
return refByGuid(guid, Reference.SaveSemantic.REPLACE);
}
/**
* Reference to a CogniteFile by GUID. Use this to create a relationship to this CogniteFile,
* where you want to further control how that relationship should be updated (i.e. replaced,
* appended, or removed).
*
* @param guid the GUID of the CogniteFile to reference
* @param semantic how to save this relationship (replace all with this, append it, or remove it)
* @return reference to a CogniteFile that can be used for defining a relationship to a CogniteFile
*/
public static CogniteFile refByGuid(String guid, Reference.SaveSemantic semantic) {
return CogniteFile._internal().guid(guid).semantic(semantic).build();
}
/**
* Reference to a CogniteFile by qualifiedName. Use this to create a relationship to this CogniteFile,
* where the relationship should be replaced.
*
* @param qualifiedName the qualifiedName of the CogniteFile to reference
* @return reference to a CogniteFile that can be used for defining a relationship to a CogniteFile
*/
public static CogniteFile refByQualifiedName(String qualifiedName) {
return refByQualifiedName(qualifiedName, Reference.SaveSemantic.REPLACE);
}
/**
* Reference to a CogniteFile by qualifiedName. Use this to create a relationship to this CogniteFile,
* where you want to further control how that relationship should be updated (i.e. replaced,
* appended, or removed).
*
* @param qualifiedName the qualifiedName of the CogniteFile to reference
* @param semantic how to save this relationship (replace all with this, append it, or remove it)
* @return reference to a CogniteFile that can be used for defining a relationship to a CogniteFile
*/
public static CogniteFile refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic) {
return CogniteFile._internal().uniqueAttributes(UniqueAttributes.builder().qualifiedName(qualifiedName).build()).semantic(semantic).build();
}
/**
* Retrieves a CogniteFile by one of its identifiers, complete with all of its relationships.
*
* @param id of the CogniteFile to retrieve, either its GUID or its full qualifiedName
* @return the requested full CogniteFile, complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the CogniteFile does not exist or the provided GUID is not a CogniteFile
*/
@JsonIgnore
public static CogniteFile get(String id) throws AtlanException {
return get(Atlan.getDefaultClient(), id);
}
/**
* Retrieves a CogniteFile 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 CogniteFile to retrieve, either its GUID or its full qualifiedName
* @return the requested full CogniteFile, complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the CogniteFile does not exist or the provided GUID is not a CogniteFile
*/
@JsonIgnore
public static CogniteFile get(AtlanClient client, String id) throws AtlanException {
return get(client, id, true);
}
/**
* Retrieves a CogniteFile 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 CogniteFile 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 CogniteFile, optionally complete with all of its relationships
* @throws AtlanException on any error during the API invocation, such as the {@link NotFoundException} if the CogniteFile does not exist or the provided GUID is not a CogniteFile
*/
@JsonIgnore
public static CogniteFile 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 CogniteFile) {
return (CogniteFile) 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 CogniteFile) {
return (CogniteFile) asset;
} else {
throw new NotFoundException(ErrorCode.ASSET_NOT_FOUND_BY_QN, id, TYPE_NAME);
}
}
}
/**
* Restore the archived (soft-deleted) CogniteFile to active.
*
* @param qualifiedName for the CogniteFile
* @return true if the CogniteFile 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) CogniteFile to active.
*
* @param client connectivity to the Atlan tenant on which to restore the asset
* @param qualifiedName for the CogniteFile
* @return true if the CogniteFile 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 CogniteFile.
*
* @param qualifiedName of the CogniteFile
* @param name of the CogniteFile
* @return the minimal request necessary to update the CogniteFile, as a builder
*/
public static CogniteFileBuilder updater(String qualifiedName, String name) {
return CogniteFile._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 CogniteFile, from a potentially
* more-complete CogniteFile object.
*
* @return the minimal object necessary to update the CogniteFile, as a builder
* @throws InvalidRequestException if any of the minimal set of required properties for CogniteFile are not found in the initial object
*/
@Override
public CogniteFileBuilder 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 CogniteFile.
*
* @param qualifiedName of the CogniteFile
* @param name of the CogniteFile
* @return the updated CogniteFile, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static CogniteFile removeDescription(String qualifiedName, String name) throws AtlanException {
return removeDescription(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the system description from a CogniteFile.
*
* @param client connectivity to the Atlan tenant on which to remove the asset's description
* @param qualifiedName of the CogniteFile
* @param name of the CogniteFile
* @return the updated CogniteFile, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static CogniteFile removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (CogniteFile) Asset.removeDescription(client, updater(qualifiedName, name));
}
/**
* Remove the user's description from a CogniteFile.
*
* @param qualifiedName of the CogniteFile
* @param name of the CogniteFile
* @return the updated CogniteFile, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static CogniteFile removeUserDescription(String qualifiedName, String name) throws AtlanException {
return removeUserDescription(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the user's description from a CogniteFile.
*
* @param client connectivity to the Atlan tenant on which to remove the asset's description
* @param qualifiedName of the CogniteFile
* @param name of the CogniteFile
* @return the updated CogniteFile, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static CogniteFile removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (CogniteFile) Asset.removeUserDescription(client, updater(qualifiedName, name));
}
/**
* Remove the owners from a CogniteFile.
*
* @param qualifiedName of the CogniteFile
* @param name of the CogniteFile
* @return the updated CogniteFile, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static CogniteFile removeOwners(String qualifiedName, String name) throws AtlanException {
return removeOwners(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the owners from a CogniteFile.
*
* @param client connectivity to the Atlan tenant from which to remove the CogniteFile's owners
* @param qualifiedName of the CogniteFile
* @param name of the CogniteFile
* @return the updated CogniteFile, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static CogniteFile removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (CogniteFile) Asset.removeOwners(client, updater(qualifiedName, name));
}
/**
* Update the certificate on a CogniteFile.
*
* @param qualifiedName of the CogniteFile
* @param certificate to use
* @param message (optional) message, or null if no message
* @return the updated CogniteFile, or null if the update failed
* @throws AtlanException on any API problems
*/
public static CogniteFile updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException {
return updateCertificate(Atlan.getDefaultClient(), qualifiedName, certificate, message);
}
/**
* Update the certificate on a CogniteFile.
*
* @param client connectivity to the Atlan tenant on which to update the CogniteFile's certificate
* @param qualifiedName of the CogniteFile
* @param certificate to use
* @param message (optional) message, or null if no message
* @return the updated CogniteFile, or null if the update failed
* @throws AtlanException on any API problems
*/
public static CogniteFile updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException {
return (CogniteFile) Asset.updateCertificate(client, _internal(), TYPE_NAME, qualifiedName, certificate, message);
}
/**
* Remove the certificate from a CogniteFile.
*
* @param qualifiedName of the CogniteFile
* @param name of the CogniteFile
* @return the updated CogniteFile, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static CogniteFile removeCertificate(String qualifiedName, String name) throws AtlanException {
return removeCertificate(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the certificate from a CogniteFile.
*
* @param client connectivity to the Atlan tenant from which to remove the CogniteFile's certificate
* @param qualifiedName of the CogniteFile
* @param name of the CogniteFile
* @return the updated CogniteFile, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static CogniteFile removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (CogniteFile) Asset.removeCertificate(client, updater(qualifiedName, name));
}
/**
* Update the announcement on a CogniteFile.
*
* @param qualifiedName of the CogniteFile
* @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 CogniteFile updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException {
return updateAnnouncement(Atlan.getDefaultClient(), qualifiedName, type, title, message);
}
/**
* Update the announcement on a CogniteFile.
*
* @param client connectivity to the Atlan tenant on which to update the CogniteFile's announcement
* @param qualifiedName of the CogniteFile
* @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 CogniteFile updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException {
return (CogniteFile) Asset.updateAnnouncement(client, _internal(), TYPE_NAME, qualifiedName, type, title, message);
}
/**
* Remove the announcement from a CogniteFile.
*
* @param qualifiedName of the CogniteFile
* @param name of the CogniteFile
* @return the updated CogniteFile, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static CogniteFile removeAnnouncement(String qualifiedName, String name) throws AtlanException {
return removeAnnouncement(Atlan.getDefaultClient(), qualifiedName, name);
}
/**
* Remove the announcement from a CogniteFile.
*
* @param client connectivity to the Atlan client from which to remove the CogniteFile's announcement
* @param qualifiedName of the CogniteFile
* @param name of the CogniteFile
* @return the updated CogniteFile, or null if the removal failed
* @throws AtlanException on any API problems
*/
public static CogniteFile removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException {
return (CogniteFile) Asset.removeAnnouncement(client, updater(qualifiedName, name));
}
/**
* Replace the terms linked to the CogniteFile.
*
* @param qualifiedName for the CogniteFile
* @param name human-readable name of the CogniteFile
* @param terms the list of terms to replace on the CogniteFile, or null to remove all terms from the CogniteFile
* @return the CogniteFile that was updated (note that it will NOT contain details of the replaced terms)
* @throws AtlanException on any API problems
*/
public static CogniteFile replaceTerms(String qualifiedName, String name, List terms) throws AtlanException {
return replaceTerms(Atlan.getDefaultClient(), qualifiedName, name, terms);
}
/**
* Replace the terms linked to the CogniteFile.
*
* @param client connectivity to the Atlan tenant on which to replace the CogniteFile's assigned terms
* @param qualifiedName for the CogniteFile
* @param name human-readable name of the CogniteFile
* @param terms the list of terms to replace on the CogniteFile, or null to remove all terms from the CogniteFile
* @return the CogniteFile that was updated (note that it will NOT contain details of the replaced terms)
* @throws AtlanException on any API problems
*/
public static CogniteFile replaceTerms(AtlanClient client, String qualifiedName, String name, List terms) throws AtlanException {
return (CogniteFile) Asset.replaceTerms(client, updater(qualifiedName, name), terms);
}
/**
* Link additional terms to the CogniteFile, without replacing existing terms linked to the CogniteFile.
* Note: this operation must make two API calls — one to retrieve the CogniteFile's existing terms,
* and a second to append the new terms.
*
* @param qualifiedName for the CogniteFile
* @param terms the list of terms to append to the CogniteFile
* @return the CogniteFile that was updated (note that it will NOT contain details of the appended terms)
* @throws AtlanException on any API problems
*/
public static CogniteFile appendTerms(String qualifiedName, List terms) throws AtlanException {
return appendTerms(Atlan.getDefaultClient(), qualifiedName, terms);
}
/**
* Link additional terms to the CogniteFile, without replacing existing terms linked to the CogniteFile.
* Note: this operation must make two API calls — one to retrieve the CogniteFile'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 CogniteFile
* @param qualifiedName for the CogniteFile
* @param terms the list of terms to append to the CogniteFile
* @return the CogniteFile that was updated (note that it will NOT contain details of the appended terms)
* @throws AtlanException on any API problems
*/
public static CogniteFile appendTerms(AtlanClient client, String qualifiedName, List terms) throws AtlanException {
return (CogniteFile) Asset.appendTerms(client, TYPE_NAME, qualifiedName, terms);
}
/**
* Remove terms from a CogniteFile, without replacing all existing terms linked to the CogniteFile.
* Note: this operation must make two API calls — one to retrieve the CogniteFile's existing terms,
* and a second to remove the provided terms.
*
* @param qualifiedName for the CogniteFile
* @param terms the list of terms to remove from the CogniteFile, which must be referenced by GUID
* @return the CogniteFile that was updated (note that it will NOT contain details of the resulting terms)
* @throws AtlanException on any API problems
*/
public static CogniteFile removeTerms(String qualifiedName, List terms) throws AtlanException {
return removeTerms(Atlan.getDefaultClient(), qualifiedName, terms);
}
/**
* Remove terms from a CogniteFile, without replacing all existing terms linked to the CogniteFile.
* Note: this operation must make two API calls — one to retrieve the CogniteFile'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 CogniteFile
* @param qualifiedName for the CogniteFile
* @param terms the list of terms to remove from the CogniteFile, which must be referenced by GUID
* @return the CogniteFile that was updated (note that it will NOT contain details of the resulting terms)
* @throws AtlanException on any API problems
*/
public static CogniteFile removeTerms(AtlanClient client, String qualifiedName, List terms) throws AtlanException {
return (CogniteFile) Asset.removeTerms(client, TYPE_NAME, qualifiedName, terms);
}
/**
* Add Atlan tags to a CogniteFile, without replacing existing Atlan tags linked to the CogniteFile.
* Note: this operation must make two API calls — one to retrieve the CogniteFile's existing Atlan tags,
* and a second to append the new Atlan tags.
*
* @param qualifiedName of the CogniteFile
* @param atlanTagNames human-readable names of the Atlan tags to add
* @throws AtlanException on any API problems
* @return the updated CogniteFile
*/
public static CogniteFile appendAtlanTags(String qualifiedName, List atlanTagNames) throws AtlanException {
return appendAtlanTags(Atlan.getDefaultClient(), qualifiedName, atlanTagNames);
}
/**
* Add Atlan tags to a CogniteFile, without replacing existing Atlan tags linked to the CogniteFile.
* Note: this operation must make two API calls — one to retrieve the CogniteFile'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 CogniteFile
* @param qualifiedName of the CogniteFile
* @param atlanTagNames human-readable names of the Atlan tags to add
* @throws AtlanException on any API problems
* @return the updated CogniteFile
*/
public static CogniteFile appendAtlanTags(AtlanClient client, String qualifiedName, List atlanTagNames) throws AtlanException {
return (CogniteFile) Asset.appendAtlanTags(client, TYPE_NAME, qualifiedName, atlanTagNames);
}
/**
* Add Atlan tags to a CogniteFile, without replacing existing Atlan tags linked to the CogniteFile.
* Note: this operation must make two API calls — one to retrieve the CogniteFile's existing Atlan tags,
* and a second to append the new Atlan tags.
*
* @param qualifiedName of the CogniteFile
* @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 CogniteFile
*/
public static CogniteFile 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 CogniteFile, without replacing existing Atlan tags linked to the CogniteFile.
* Note: this operation must make two API calls — one to retrieve the CogniteFile'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 CogniteFile
* @param qualifiedName of the CogniteFile
* @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 CogniteFile
*/
public static CogniteFile appendAtlanTags(AtlanClient client, String qualifiedName, List atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException {
return (CogniteFile) Asset.appendAtlanTags(client, TYPE_NAME, qualifiedName, atlanTagNames, propagate, removePropagationsOnDelete, restrictLineagePropagation);
}
/**
* Remove an Atlan tag from a CogniteFile.
*
* @param qualifiedName of the CogniteFile
* @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 CogniteFile
*/
public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException {
removeAtlanTag(Atlan.getDefaultClient(), qualifiedName, atlanTagName);
}
/**
* Remove an Atlan tag from a CogniteFile.
*
* @param client connectivity to the Atlan tenant from which to remove an Atlan tag from a CogniteFile
* @param qualifiedName of the CogniteFile
* @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 CogniteFile
*/
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 CogniteFileBuilder> 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 ICogniteAsset cogniteAsset;
@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 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);
CogniteFile.CogniteFileBuilder.$fillValuesFromInstanceIntoBuilder(instance, this);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static void $fillValuesFromInstanceIntoBuilder(final CogniteFile instance, final CogniteFile.CogniteFileBuilder b) {
b.typeName(instance.typeName);
b.cogniteAsset(instance.cogniteAsset);
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.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 CogniteFiles.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B typeName(final String typeName) {
this.typeName$value = typeName;
typeName$set = true;
return self();
}
/**
* Asset in which this file exists.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B cogniteAsset(final ICogniteAsset cogniteAsset) {
this.cogniteAsset = cogniteAsset;
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 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 "CogniteFile.CogniteFileBuilder(super=" + super.toString() + ", typeName$value=" + this.typeName$value + ", cogniteAsset=" + this.cogniteAsset + ", inputToAirflowTasks=" + this.inputToAirflowTasks + ", inputToProcesses=" + this.inputToProcesses + ", inputToSparkJobs=" + this.inputToSparkJobs + ", outputFromAirflowTasks=" + this.outputFromAirflowTasks + ", outputFromProcesses=" + this.outputFromProcesses + ", outputFromSparkJobs=" + this.outputFromSparkJobs + ")";
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static final class CogniteFileBuilderImpl extends CogniteFile.CogniteFileBuilder {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private CogniteFileBuilderImpl() {
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected CogniteFile.CogniteFileBuilderImpl self() {
return this;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public CogniteFile build() {
return new CogniteFile(this);
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected CogniteFile(final CogniteFile.CogniteFileBuilder b) {
super(b);
if (b.typeName$set) this.typeName = b.typeName$value;
else this.typeName = CogniteFile.$default$typeName();
this.cogniteAsset = b.cogniteAsset;
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 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 CogniteFile.CogniteFileBuilder _internal() {
return new CogniteFile.CogniteFileBuilderImpl();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public CogniteFile.CogniteFileBuilder toBuilder() {
return new CogniteFile.CogniteFileBuilderImpl().$fillValuesFrom(this);
}
/**
* Asset in which this file exists.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public ICogniteAsset getCogniteAsset() {
return this.cogniteAsset;
}
/**
* 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;
}
/**
* 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 CogniteFile)) return false;
final CogniteFile other = (CogniteFile) o;
if (!other.canEqual((java.lang.Object) this)) return false;
if (!super.equals(o)) return false;
final java.lang.Object this$typeName = this.getTypeName();
final java.lang.Object other$typeName = other.getTypeName();
if (this$typeName == null ? other$typeName != null : !this$typeName.equals(other$typeName)) return false;
final java.lang.Object this$cogniteAsset = this.getCogniteAsset();
final java.lang.Object other$cogniteAsset = other.getCogniteAsset();
if (this$cogniteAsset == null ? other$cogniteAsset != null : !this$cogniteAsset.equals(other$cogniteAsset)) 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$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 CogniteFile;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public int hashCode() {
final int PRIME = 59;
int result = super.hashCode();
final java.lang.Object $typeName = this.getTypeName();
result = result * PRIME + ($typeName == null ? 43 : $typeName.hashCode());
final java.lang.Object $cogniteAsset = this.getCogniteAsset();
result = result * PRIME + ($cogniteAsset == null ? 43 : $cogniteAsset.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 $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 "CogniteFile(super=" + super.toString() + ", typeName=" + this.getTypeName() + ", cogniteAsset=" + this.getCogniteAsset() + ", inputToAirflowTasks=" + this.getInputToAirflowTasks() + ", inputToProcesses=" + this.getInputToProcesses() + ", inputToSparkJobs=" + this.getInputToSparkJobs() + ", outputFromAirflowTasks=" + this.getOutputFromAirflowTasks() + ", outputFromProcesses=" + this.getOutputFromProcesses() + ", outputFromSparkJobs=" + this.getOutputFromSparkJobs() + ")";
}
/**
* Fixed typeName for CogniteFiles.
*/
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getTypeName() {
return this.typeName;
}
}
