com.atlan.model.assets.IAtlanQuery Maven / Gradle / Ivy
/* SPDX-License-Identifier: Apache-2.0
Copyright 2023 Atlan Pte. Ltd. */
package com.atlan.model.assets;
import com.atlan.model.enums.AtlanAnnouncementType;
import com.atlan.model.enums.AtlanConnectorType;
import com.atlan.model.enums.AtlanIcon;
import com.atlan.model.enums.AtlanStatus;
import com.atlan.model.enums.CertificateStatus;
import com.atlan.model.enums.SourceCostUnitType;
import com.atlan.model.fields.BooleanField;
import com.atlan.model.fields.KeywordTextField;
import com.atlan.model.fields.RelationField;
import com.atlan.model.fields.TextField;
import com.atlan.model.relations.RelationshipAttributes;
import com.atlan.model.relations.UniqueAttributes;
import com.atlan.model.structs.PopularityInsights;
import com.atlan.model.structs.StarredDetails;
import com.atlan.serde.AssetDeserializer;
import com.atlan.serde.AssetSerializer;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import java.util.List;
import java.util.Map;
import java.util.SortedSet;
import javax.annotation.processing.Generated;
/**
* Instance of a query in Atlan.
*/
@Generated(value = "com.atlan.generators.ModelGeneratorV2")
@JsonSerialize(using = AssetSerializer.class)
@JsonDeserialize(using = AssetDeserializer.class)
public interface IAtlanQuery {
public static final String TYPE_NAME = "Query";
/** TBC */
KeywordTextField COLLECTION_QUALIFIED_NAME =
new KeywordTextField("collectionQualifiedName", "collectionQualifiedName", "collectionQualifiedName.text");
/** TBC */
RelationField COLUMNS = new RelationField("columns");
/** TBC */
KeywordTextField DEFAULT_DATABASE_QUALIFIED_NAME = new KeywordTextField(
"defaultDatabaseQualifiedName", "defaultDatabaseQualifiedName", "defaultDatabaseQualifiedName.text");
/** TBC */
KeywordTextField DEFAULT_SCHEMA_QUALIFIED_NAME = new KeywordTextField(
"defaultSchemaQualifiedName", "defaultSchemaQualifiedName", "defaultSchemaQualifiedName.text");
/** TBC */
BooleanField IS_PRIVATE = new BooleanField("isPrivate", "isPrivate");
/** TBC */
BooleanField IS_SQL_SNIPPET = new BooleanField("isSqlSnippet", "isSqlSnippet");
/** TBC */
BooleanField IS_VISUAL_QUERY = new BooleanField("isVisualQuery", "isVisualQuery");
/** TBC */
TextField LONG_RAW_QUERY = new TextField("longRawQuery", "longRawQuery");
/** TBC */
RelationField PARENT = new RelationField("parent");
/** TBC */
KeywordTextField PARENT_QUALIFIED_NAME =
new KeywordTextField("parentQualifiedName", "parentQualifiedName", "parentQualifiedName.text");
/** TBC */
TextField RAW_QUERY = new TextField("rawQuery", "rawQuery");
/** TBC */
RelationField TABLES = new RelationField("tables");
/** TBC */
TextField VARIABLES_SCHEMA_BASE64 = new TextField("variablesSchemaBase64", "variablesSchemaBase64");
/** TBC */
RelationField VIEWS = new RelationField("views");
/** TBC */
TextField VISUAL_BUILDER_SCHEMA_BASE64 = new TextField("visualBuilderSchemaBase64", "visualBuilderSchemaBase64");
/** TBC */
SortedSet getAdminGroups();
/** TBC */
SortedSet getAdminRoles();
/** TBC */
SortedSet getAdminUsers();
/** TBC */
String getAnnouncementMessage();
/** TBC */
String getAnnouncementTitle();
/** TBC */
AtlanAnnouncementType getAnnouncementType();
/** TBC */
Long getAnnouncementUpdatedAt();
/** TBC */
String getAnnouncementUpdatedBy();
/** TBC */
SortedSet getAnomaloChecks();
/** TBC */
SortedSet getAssetAnomaloAppliedCheckTypes();
/** TBC */
Long getAssetAnomaloCheckCount();
/** TBC */
String getAssetAnomaloCheckStatuses();
/** TBC */
String getAssetAnomaloDQStatus();
/** TBC */
Long getAssetAnomaloFailedCheckCount();
/** TBC */
SortedSet getAssetAnomaloFailedCheckTypes();
/** TBC */
Long getAssetAnomaloLastCheckRunAt();
/** TBC */
String getAssetAnomaloSourceUrl();
/** TBC */
String getAssetCoverImage();
/** TBC */
String getAssetDbtAccountName();
/** TBC */
String getAssetDbtAlias();
/** TBC */
String getAssetDbtEnvironmentDbtVersion();
/** TBC */
String getAssetDbtEnvironmentName();
/** TBC */
Long getAssetDbtJobLastRun();
/** TBC */
String getAssetDbtJobLastRunArtifactS3Path();
/** TBC */
Boolean getAssetDbtJobLastRunArtifactsSaved();
/** TBC */
Long getAssetDbtJobLastRunCreatedAt();
/** TBC */
Long getAssetDbtJobLastRunDequedAt();
/** TBC */
String getAssetDbtJobLastRunExecutedByThreadId();
/** TBC */
String getAssetDbtJobLastRunGitBranch();
/** TBC */
String getAssetDbtJobLastRunGitSha();
/** TBC */
Boolean getAssetDbtJobLastRunHasDocsGenerated();
/** TBC */
Boolean getAssetDbtJobLastRunHasSourcesGenerated();
/** TBC */
Boolean getAssetDbtJobLastRunNotificationsSent();
/** TBC */
String getAssetDbtJobLastRunOwnerThreadId();
/** TBC */
String getAssetDbtJobLastRunQueuedDuration();
/** TBC */
String getAssetDbtJobLastRunQueuedDurationHumanized();
/** TBC */
String getAssetDbtJobLastRunRunDuration();
/** TBC */
String getAssetDbtJobLastRunRunDurationHumanized();
/** TBC */
Long getAssetDbtJobLastRunStartedAt();
/** TBC */
String getAssetDbtJobLastRunStatusMessage();
/** TBC */
String getAssetDbtJobLastRunTotalDuration();
/** TBC */
String getAssetDbtJobLastRunTotalDurationHumanized();
/** TBC */
Long getAssetDbtJobLastRunUpdatedAt();
/** TBC */
String getAssetDbtJobLastRunUrl();
/** TBC */
String getAssetDbtJobName();
/** TBC */
Long getAssetDbtJobNextRun();
/** TBC */
String getAssetDbtJobNextRunHumanized();
/** TBC */
String getAssetDbtJobSchedule();
/** TBC */
String getAssetDbtJobScheduleCronHumanized();
/** TBC */
String getAssetDbtJobStatus();
/** TBC */
String getAssetDbtMeta();
/** TBC */
String getAssetDbtPackageName();
/** TBC */
String getAssetDbtProjectName();
/** TBC */
String getAssetDbtSemanticLayerProxyUrl();
/** TBC */
String getAssetDbtSourceFreshnessCriteria();
/** TBC */
SortedSet getAssetDbtTags();
/** TBC */
String getAssetDbtTestStatus();
/** TBC */
String getAssetDbtUniqueId();
/** TBC */
String getAssetDbtWorkflowLastUpdated();
/** TBC */
AtlanIcon getAssetIcon();
/** TBC */
SortedSet getAssetMcAlertQualifiedNames();
/** TBC */
SortedSet getAssetMcIncidentNames();
/** TBC */
SortedSet getAssetMcIncidentPriorities();
/** TBC */
SortedSet getAssetMcIncidentQualifiedNames();
/** TBC */
SortedSet getAssetMcIncidentSeverities();
/** TBC */
SortedSet getAssetMcIncidentStates();
/** TBC */
SortedSet getAssetMcIncidentSubTypes();
/** TBC */
SortedSet getAssetMcIncidentTypes();
/** TBC */
Long getAssetMcLastSyncRunAt();
/** TBC */
SortedSet getAssetMcMonitorNames();
/** TBC */
SortedSet getAssetMcMonitorQualifiedNames();
/** TBC */
SortedSet getAssetMcMonitorScheduleTypes();
/** TBC */
SortedSet getAssetMcMonitorStatuses();
/** TBC */
SortedSet getAssetMcMonitorTypes();
/** TBC */
Long getAssetPoliciesCount();
/** TBC */
SortedSet getAssetPolicyGUIDs();
/** TBC */
Long getAssetSodaCheckCount();
/** TBC */
String getAssetSodaCheckStatuses();
/** TBC */
String getAssetSodaDQStatus();
/** TBC */
Long getAssetSodaLastScanAt();
/** TBC */
Long getAssetSodaLastSyncRunAt();
/** TBC */
String getAssetSodaSourceURL();
/** TBC */
SortedSet getAssetTags();
/** TBC */
String getAssetThemeHex();
/** TBC */
SortedSet getAssignedTerms();
/** TBC */
String getCalculationViewName();
/** TBC */
String getCalculationViewQualifiedName();
/** TBC */
CertificateStatus getCertificateStatus();
/** TBC */
String getCertificateStatusMessage();
/** TBC */
Long getCertificateUpdatedAt();
/** TBC */
String getCertificateUpdatedBy();
/** TBC */
String getCollectionQualifiedName();
/** TBC */
SortedSet getColumns();
/** TBC */
String getConnectionName();
/** TBC */
String getConnectionQualifiedName();
/** TBC */
AtlanConnectorType getConnectorType();
/** TBC */
IDataContract getDataContractLatest();
/** TBC */
IDataContract getDataContractLatestCertified();
/** TBC */
String getDatabaseName();
/** TBC */
String getDatabaseQualifiedName();
/** TBC */
SortedSet getDbtModels();
/** TBC */
String getDbtQualifiedName();
/** TBC */
SortedSet getDbtSources();
/** TBC */
SortedSet getDbtTests();
/** TBC */
String getDefaultDatabaseQualifiedName();
/** TBC */
String getDefaultSchemaQualifiedName();
/** TBC */
String getDescription();
/** TBC */
String getDisplayName();
/** TBC */
SortedSet getDomainGUIDs();
/** TBC */
SortedSet getFiles();
/** TBC */
Boolean getHasContract();
/** TBC */
Boolean getHasLineage();
/** TBC */
SortedSet getInputPortDataProducts();
/** TBC */
SortedSet getInputToAirflowTasks();
/** TBC */
SortedSet getInputToProcesses();
/** TBC */
SortedSet getInputToSparkJobs();
/** TBC */
Boolean getIsAIGenerated();
/** TBC */
Boolean getIsDiscoverable();
/** TBC */
Boolean getIsEditable();
/** TBC */
Boolean getIsPartial();
/** TBC */
Boolean getIsPrivate();
/** TBC */
Boolean getIsProfiled();
/** TBC */
Boolean getIsSqlSnippet();
/** TBC */
Boolean getIsVisualQuery();
/** TBC */
Long getLastProfiledAt();
/** TBC */
Long getLastRowChangedAt();
/** TBC */
String getLastSyncRun();
/** TBC */
Long getLastSyncRunAt();
/** TBC */
String getLastSyncWorkflowName();
/** TBC */
String getLexicographicalSortOrder();
/** TBC */
SortedSet getLinks();
/** TBC */
String getLongRawQuery();
/** TBC */
SortedSet getMcIncidents();
/** TBC */
SortedSet getMcMonitors();
/** TBC */
SortedSet getMetrics();
/** TBC */
String getName();
/** TBC */
SortedSet getNonCompliantAssetPolicyGUIDs();
/** TBC */
SortedSet getOutputFromAirflowTasks();
/** TBC */
SortedSet getOutputFromProcesses();
/** TBC */
SortedSet getOutputFromSparkJobs();
/** TBC */
SortedSet getOutputPortDataProducts();
/** TBC */
SortedSet getOwnerGroups();
/** TBC */
SortedSet getOwnerUsers();
/** TBC */
INamespace getParent();
/** TBC */
String getParentQualifiedName();
/** TBC */
Double getPopularityScore();
/** TBC */
String getQualifiedName();
/** TBC */
Long getQueryCount();
/** TBC */
Long getQueryCountUpdatedAt();
/** TBC */
Long getQueryUserCount();
/** TBC */
Map getQueryUserMap();
/** TBC */
String getRawQuery();
/** TBC */
String getRawQueryText();
/** TBC */
IReadme getReadme();
/** TBC */
String getSampleDataUrl();
/** TBC */
String getSchemaName();
/** TBC */
String getSchemaQualifiedName();
/** TBC */
SortedSet getSchemaRegistrySubjects();
/** TBC */
SortedSet getSodaChecks();
/** TBC */
SourceCostUnitType getSourceCostUnit();
/** TBC */
Long getSourceCreatedAt();
/** TBC */
String getSourceCreatedBy();
/** TBC */
String getSourceEmbedURL();
/** TBC */
Long getSourceLastReadAt();
/** TBC */
String getSourceOwners();
/** TBC */
List getSourceQueryComputeCostRecords();
/** TBC */
SortedSet getSourceQueryComputeCosts();
/** TBC */
Long getSourceReadCount();
/** TBC */
List getSourceReadExpensiveQueryRecords();
/** TBC */
List getSourceReadPopularQueryRecords();
/** TBC */
Double getSourceReadQueryCost();
/** TBC */
List getSourceReadRecentUserRecords();
/** TBC */
SortedSet getSourceReadRecentUsers();
/** TBC */
List getSourceReadSlowQueryRecords();
/** TBC */
List getSourceReadTopUserRecords();
/** TBC */
SortedSet getSourceReadTopUsers();
/** TBC */
Long getSourceReadUserCount();
/** TBC */
Double getSourceTotalCost();
/** TBC */
String getSourceURL();
/** TBC */
Long getSourceUpdatedAt();
/** TBC */
String getSourceUpdatedBy();
/** TBC */
SortedSet getSqlDBTSources();
/** TBC */
SortedSet getSqlDbtModels();
/** TBC */
SortedSet getStarredBy();
/** TBC */
Integer getStarredCount();
/** TBC */
List getStarredDetails();
/** TBC */
String getSubType();
/** TBC */
String getTableName();
/** TBC */
String getTableQualifiedName();
/** TBC */
SortedSet getTables();
/** TBC */
String getTenantId();
/** TBC */
SortedSet getUserDefRelationshipFroms();
/** TBC */
SortedSet getUserDefRelationshipTos();
/** TBC */
String getUserDescription();
/** TBC */
String getVariablesSchemaBase64();
/** TBC */
String getViewName();
/** TBC */
String getViewQualifiedName();
/** TBC */
Double getViewScore();
/** TBC */
SortedSet getViewerGroups();
/** TBC */
SortedSet getViewerUsers();
/** TBC */
SortedSet getViews();
/** TBC */
String getVisualBuilderSchemaBase64();
/** Name of the type that defines the asset. */
String getTypeName();
/** Globally-unique identifier for the asset. */
String getGuid();
/** Human-readable name of the asset. */
String getDisplayText();
/** Status of the asset (if this is a related asset). */
String getEntityStatus();
/** Type of the relationship (if this is a related asset). */
String getRelationshipType();
/** Unique identifier of the relationship (when this is a related asset). */
String getRelationshipGuid();
/** Status of the relationship (when this is a related asset). */
AtlanStatus getRelationshipStatus();
/** Attributes specific to the relationship (unused). */
RelationshipAttributes getRelationshipAttributes();
/**
* Attribute(s) that uniquely identify the asset (when this is a related asset).
* If the guid is not provided, these must be provided.
*/
UniqueAttributes getUniqueAttributes();
/**
* When true, indicates that this object represents a complete view of the entity.
* When false, this object is only a reference or some partial view of the entity.
*/
boolean isComplete();
/**
* Indicates whether this object can be used as a valid reference by GUID.
* @return true if it is a valid GUID reference, false otherwise
*/
boolean isValidReferenceByGuid();
/**
* Indicates whether this object can be used as a valid reference by qualifiedName.
* @return true if it is a valid qualifiedName reference, false otherwise
*/
boolean isValidReferenceByQualifiedName();
}