com.atlan.model.assets.AtlanQuery

All Implemented Interfaces:: IAsset, IAtlanQuery, ICatalog, IReferenceable, ISQL, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class AtlanQuery extends Asset implements IAtlanQuery, ISQL, ICatalog, IAsset, IReferenceable

Instance of a query in Atlan.

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

AtlanQuery.AtlanQueryBuilder<C extends AtlanQuery,B extends AtlanQuery.AtlanQueryBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.assets.Asset
Asset.AssetBuilder<C extends Asset,B extends Asset.AssetBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.relations.Reference
Reference.ReferenceBuilder<C extends Reference,B extends Reference.ReferenceBuilder<C,B>>, Reference.SaveSemantic

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject
AtlanObject.AtlanObjectBuilder<C extends AtlanObject,B extends AtlanObject.AtlanObjectBuilder<C,B>>
Field Summary

Fields

Modifier and Type

Field

Description

static final String

TYPE_NAME

Fields inherited from class com.atlan.model.core.AtlanObject
rawJsonObject

Fields inherited from interface com.atlan.model.assets.IAsset
ADMIN_GROUPS, ADMIN_ROLES, ADMIN_USERS, ANNOUNCEMENT_MESSAGE, ANNOUNCEMENT_TITLE, ANNOUNCEMENT_TYPE, ANNOUNCEMENT_UPDATED_AT, ANNOUNCEMENT_UPDATED_BY, ANOMALO_CHECKS, APPLICATION, APPLICATION_FIELD, APPLICATION_FIELD_QUALIFIED_NAME, APPLICATION_QUALIFIED_NAME, ASSET_AI_ALIAS, ASSET_AI_GENERATED_DESCRIPTION, ASSET_AI_GENERATED_DESCRIPTION_CONFIDENCE, ASSET_AI_GENERATED_DESCRIPTION_REASONING, ASSET_ANNOUNCEMENT_EXPIRED_AT, ASSET_ANOMALO_APPLIED_CHECK_TYPES, ASSET_ANOMALO_CHECK_COUNT, ASSET_ANOMALO_CHECK_STATUSES, ASSET_ANOMALO_DQ_STATUS, ASSET_ANOMALO_FAILED_CHECK_COUNT, ASSET_ANOMALO_FAILED_CHECK_TYPES, ASSET_ANOMALO_LAST_CHECK_RUN_AT, ASSET_ANOMALO_SOURCE_URL, ASSET_COVER_IMAGE, ASSET_DBT_ACCOUNT_NAME, ASSET_DBT_ALIAS, ASSET_DBT_ENVIRONMENT_DBT_VERSION, ASSET_DBT_ENVIRONMENT_NAME, ASSET_DBT_JOB_LAST_RUN, ASSET_DBT_JOB_LAST_RUN_ARTIFACT_S3PATH, ASSET_DBT_JOB_LAST_RUN_ARTIFACTS_SAVED, ASSET_DBT_JOB_LAST_RUN_CREATED_AT, ASSET_DBT_JOB_LAST_RUN_DEQUED_AT, ASSET_DBT_JOB_LAST_RUN_EXECUTED_BY_THREAD_ID, ASSET_DBT_JOB_LAST_RUN_GIT_BRANCH, ASSET_DBT_JOB_LAST_RUN_GIT_SHA, ASSET_DBT_JOB_LAST_RUN_HAS_DOCS_GENERATED, ASSET_DBT_JOB_LAST_RUN_HAS_SOURCES_GENERATED, ASSET_DBT_JOB_LAST_RUN_NOTIFICATIONS_SENT, ASSET_DBT_JOB_LAST_RUN_OWNER_THREAD_ID, ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION, ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_RUN_DURATION, ASSET_DBT_JOB_LAST_RUN_RUN_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_STARTED_AT, ASSET_DBT_JOB_LAST_RUN_STATUS_MESSAGE, ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION, ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_UPDATED_AT, ASSET_DBT_JOB_LAST_RUN_URL, ASSET_DBT_JOB_NAME, ASSET_DBT_JOB_NEXT_RUN, ASSET_DBT_JOB_NEXT_RUN_HUMANIZED, ASSET_DBT_JOB_SCHEDULE, ASSET_DBT_JOB_SCHEDULE_CRON_HUMANIZED, ASSET_DBT_JOB_STATUS, ASSET_DBT_META, ASSET_DBT_PACKAGE_NAME, ASSET_DBT_PROJECT_NAME, ASSET_DBT_SEMANTIC_LAYER_PROXY_URL, ASSET_DBT_SOURCE_FRESHNESS_CRITERIA, ASSET_DBT_TAGS, ASSET_DBT_TEST_STATUS, ASSET_DBT_UNIQUE_ID, ASSET_DBT_WORKFLOW_LAST_UPDATED, ASSET_DQ_FRESHNESS_EXPECTATION, ASSET_DQ_FRESHNESS_VALUE, ASSET_DQ_MANUAL_RUN_STATUS, ASSET_DQ_RESULT, ASSET_DQ_ROW_SCOPE_FILTER_COLUMN_QUALIFIED_NAME, ASSET_DQ_RULE_ATTACHED_DIMENSIONS, ASSET_DQ_RULE_ATTACHED_RULE_TYPES, ASSET_DQ_RULE_FAILED_COUNT, ASSET_DQ_RULE_FAILED_DIMENSIONS, ASSET_DQ_RULE_FAILED_RULE_TYPES, ASSET_DQ_RULE_LAST_RUN_AT, ASSET_DQ_RULE_PASSED_COUNT, ASSET_DQ_RULE_PASSED_DIMENSIONS, ASSET_DQ_RULE_PASSED_RULE_TYPES, ASSET_DQ_RULE_RESULT_TAGS, ASSET_DQ_RULE_TOTAL_COUNT, ASSET_DQ_SCHEDULE_CRONTAB, ASSET_DQ_SCHEDULE_SOURCE_SYNC_ERROR_CODE, ASSET_DQ_SCHEDULE_SOURCE_SYNC_ERROR_MESSAGE, ASSET_DQ_SCHEDULE_SOURCE_SYNC_RAW_ERROR, ASSET_DQ_SCHEDULE_SOURCE_SYNC_STATUS, ASSET_DQ_SCHEDULE_SOURCE_SYNCED_AT, ASSET_DQ_SCHEDULE_TIME_ZONE, ASSET_DQ_SCHEDULE_TYPE, ASSET_EXTERNAL_DQ_METADATA_DETAILS, ASSET_EXTERNAL_DQ_SCORE_VALUE, ASSET_EXTERNAL_DQ_TEST_AVG_SCORES, ASSET_EXTERNAL_DQ_TEST_ENTITIES, ASSET_EXTERNAL_DQ_TEST_LATEST_SCORES, ASSET_EXTERNAL_DQ_TEST_MIN_SCORES, ASSET_GCP_DATAPLEX_ASPECT_FIELD_LIST, ASSET_GCP_DATAPLEX_ASPECT_LIST, ASSET_GCP_DATAPLEX_METADATA_DETAILS, ASSET_HAS_AI_README, ASSET_ICON, ASSET_IMMUTA_REQUEST_TYPE, ASSET_IMMUTA_REQUEST_URL, ASSET_INTERNAL_POPULARITY_SCORE, ASSET_MC_ALERT_QUALIFIED_NAMES, ASSET_MC_INCIDENT_NAMES, ASSET_MC_INCIDENT_PRIORITIES, ASSET_MC_INCIDENT_QUALIFIED_NAMES, ASSET_MC_INCIDENT_SEVERITIES, ASSET_MC_INCIDENT_STATES, ASSET_MC_INCIDENT_SUB_TYPES, ASSET_MC_INCIDENT_TYPES, ASSET_MC_IS_MONITORED, ASSET_MC_LAST_SYNC_RUN_AT, ASSET_MC_MONITOR_NAMES, ASSET_MC_MONITOR_QUALIFIED_NAMES, ASSET_MC_MONITOR_SCHEDULE_TYPES, ASSET_MC_MONITOR_STATUSES, ASSET_MC_MONITOR_TYPES, ASSET_POLICIES_COUNT, ASSET_POLICY_GUIDS, ASSET_REDIRECT_GUIDS, ASSET_SMUS_METADATA_FORM_DETAILS, ASSET_SMUS_METADATA_FORM_KEY_VALUE_DETAILS, ASSET_SMUS_METADATA_FORM_NAMES, ASSET_SODA_CHECK_COUNT, ASSET_SODA_CHECK_STATUSES, ASSET_SODA_DQ_STATUS, ASSET_SODA_LAST_SCAN_AT, ASSET_SODA_LAST_SYNC_RUN_AT, ASSET_SODA_SOURCE_URL, ASSET_SOURCE_ID, ASSET_SOURCE_README, ASSET_SPACE_NAME, ASSET_SPACE_QUALIFIED_NAME, ASSET_TAGS, ASSET_THEME_HEX, ASSET_USER_DEFINED_TYPE, CERTIFICATE_STATUS, CERTIFICATE_STATUS_MESSAGE, CERTIFICATE_UPDATED_AT, CERTIFICATE_UPDATED_BY, CONNECTION_NAME, CONNECTION_QUALIFIED_NAME, CONNECTOR_NAME, CONNECTOR_TYPE, CUSTOM_CONNECTOR_TYPE, DATA_CONTRACT_LATEST, DATA_CONTRACT_LATEST_CERTIFIED, DBT_QUALIFIED_NAME, DESCRIPTION, DISPLAY_NAME, DOMAIN_GUIDS, DQ_BASE_DATASET_RULES, DQ_REFERENCE_DATASET_RULES, FILES, HAS_CONTRACT, HAS_LINEAGE, INPUT_PORT_DATA_PRODUCTS, IS_AI_GENERATED, IS_DISCOVERABLE, IS_EDITABLE, IS_PARTIAL, LAST_ROW_CHANGED_AT, LAST_SYNC_RUN, LAST_SYNC_RUN_AT, LAST_SYNC_WORKFLOW_NAME, LEXICOGRAPHICAL_SORT_ORDER, LINKS, MC_INCIDENTS, MC_MONITORS, METRICS, NAME, NON_COMPLIANT_ASSET_POLICY_GUIDS, OUTPUT_PORT_DATA_PRODUCTS, OUTPUT_PRODUCT_GUIDS, OWNER_GROUPS, OWNER_USERS, POPULARITY_SCORE, PRODUCT_GUIDS, QUALIFIED_NAME, README, SAMPLE_DATA_URL, SCHEMA_REGISTRY_SUBJECTS, SODA_CHECKS, SOURCE_COST_UNIT, SOURCE_CREATED_AT, SOURCE_CREATED_BY, SOURCE_EMBED_URL, SOURCE_LAST_READ_AT, SOURCE_OWNERS, SOURCE_QUERY_COMPUTE_COST_RECORDS, SOURCE_QUERY_COMPUTE_COSTS, SOURCE_READ_COUNT, SOURCE_READ_EXPENSIVE_QUERY_RECORDS, SOURCE_READ_POPULAR_QUERY_RECORDS, SOURCE_READ_QUERY_COST, SOURCE_READ_RECENT_USER_RECORDS, SOURCE_READ_RECENT_USERS, SOURCE_READ_SLOW_QUERY_RECORDS, SOURCE_READ_TOP_USER_RECORDS, SOURCE_READ_TOP_USERS, SOURCE_READ_USER_COUNT, SOURCE_TOTAL_COST, SOURCE_UPDATED_AT, SOURCE_UPDATED_BY, SOURCE_URL, STARRED_BY, STARRED_COUNT, STARRED_DETAILS, SUB_TYPE, TENANT_ID, USER_DEF_RELATIONSHIP_FROMS, USER_DEF_RELATIONSHIP_TOS, USER_DESCRIPTION, VIEW_SCORE, VIEWER_GROUPS, VIEWER_USERS

Fields inherited from interface com.atlan.model.assets.IAtlanQuery
COLLECTION_QUALIFIED_NAME, COLUMNS, DEFAULT_DATABASE_QUALIFIED_NAME, DEFAULT_SCHEMA_QUALIFIED_NAME, IS_PRIVATE, IS_SQL_SNIPPET, IS_VISUAL_QUERY, LONG_RAW_QUERY, PARENT, PARENT_QUALIFIED_NAME, RAW_QUERY, RAW_QUERY_TEXT, TABLES, VARIABLES_SCHEMA_BASE64, VIEWS, VISUAL_BUILDER_SCHEMA_BASE64

Fields inherited from interface com.atlan.model.assets.ICatalog
CATALOG_DATASET_GUID, INPUT_TO_AIRFLOW_TASKS, INPUT_TO_PROCESSES, INPUT_TO_SPARK_JOBS, MODEL_IMPLEMENTED_ATTRIBUTES, MODEL_IMPLEMENTED_ENTITIES, OUTPUT_FROM_AIRFLOW_TASKS, OUTPUT_FROM_PROCESSES, OUTPUT_FROM_SPARK_JOBS, PARTIAL_CHILD_FIELDS, PARTIAL_CHILD_OBJECTS

Fields inherited from interface com.atlan.model.assets.IReferenceable
ASSIGNED_TERMS, ATLAN_TAGS, CREATE_TIME, CREATED_BY, CUSTOM_ATTRIBUTES, GUID, PROPAGATED_ATLAN_TAGS, STATUS, SUPER_TYPE_NAMES, UPDATE_TIME, UPDATED_BY

Fields inherited from interface com.atlan.model.assets.ISQL
CALCULATION_VIEW_NAME, CALCULATION_VIEW_QUALIFIED_NAME, DATABASE_NAME, DATABASE_QUALIFIED_NAME, DBT_MODELS, DBT_SEED_ASSETS, DBT_SOURCES, DBT_TESTS, IS_PROFILED, LAST_PROFILED_AT, QUERY_COUNT, QUERY_COUNT_UPDATED_AT, QUERY_USER_COUNT, QUERY_USER_MAP, SCHEMA_NAME, SCHEMA_QUALIFIED_NAME, SQL_AI_INSIGHTS_LAST_ANALYZED_AT, SQL_AI_INSIGHTS_POPULAR_BUSINESS_QUESTION_COUNT, SQL_AI_INSIGHTS_POPULAR_FILTER_COUNT, SQL_AI_INSIGHTS_POPULAR_JOIN_COUNT, SQL_AI_INSIGHTS_RELATIONSHIP_COUNT, SQL_AI_MODEL_CONTEXT_QUALIFIED_NAME, SQL_COALESCE_ENVIRONMENT_ID, SQL_COALESCE_ENVIRONMENT_NAME, SQL_COALESCE_LAST_RUN_AT, SQL_COALESCE_LAST_RUN_STATUS, SQL_COALESCE_NODE_STATUS, SQL_COALESCE_NODE_TYPE, SQL_COALESCE_PROJECT_ID, SQL_COALESCE_PROJECT_NAME, SQL_DBT_MODELS, SQL_DBT_SOURCES, SQL_HAS_AI_INSIGHTS, SQL_IS_SECURE, TABLE_NAME, TABLE_QUALIFIED_NAME, VIEW_NAME, VIEW_QUALIFIED_NAME
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

AtlanQuery(AtlanQuery.AtlanQueryBuilder<?,?> b)
Method Summary

Modifier and Type

Method

Description

static AtlanQuery.AtlanQueryBuilder<?,?>

_internal()

static AtlanQuery

appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames)

Deprecated.
see Asset.AssetBuilder.appendAtlanTags(List)

static AtlanQuery

appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation)

Deprecated.
see Asset.AssetBuilder.appendAtlanTags(List, boolean, boolean, boolean, boolean)

protected boolean

canEqual(Object other)

static AtlanQuery.AtlanQueryBuilder<?,?>

creator(String name, AtlanCollection collection)

Builds the minimal object necessary to create a Query.

static AtlanQuery.AtlanQueryBuilder<?,?>

creator(String name, Folder parentFolder)

Builds the minimal object necessary to create a Query.

static AtlanQuery.AtlanQueryBuilder<?,?>

creator(String name, String collectionQualifiedName, String parentFolderQualifiedName)

Builds the minimal object necessary to create a Query.

boolean

equals(Object o)

static String

generateQualifiedName(String name, String parentQualifiedName)

Generate a unique Query.

static AtlanQuery

get(AtlanClient client, String id)

Retrieves a AtlanQuery by one of its identifiers, complete with all of its relationships.

static AtlanQuery

get(AtlanClient client, String id, boolean includeAllRelationships)

Retrieves a AtlanQuery by one of its identifiers, optionally complete with all of its relationships.

static AtlanQuery

get(AtlanClient client, String id, Collection<AtlanField> attributes)

Retrieves a AtlanQuery by one of its identifiers, with only the requested attributes (and relationships).

static AtlanQuery

get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated)

Retrieves a AtlanQuery by one of its identifiers, with only the requested attributes (and relationships).

String

getCalculationViewName()

Simple name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.

String

getCalculationViewQualifiedName()

Unique name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.

String

getCatalogDatasetGuid()

Unique identifier of the dataset this asset belongs to.

String

getCollectionQualifiedName()

Unique name of the collection in which this query exists.

SortedSet<IColumn>

getColumns()

Columns this query accesses.

String

getDatabaseName()

Simple name of the database in which this SQL asset exists, or empty if it does not exist within a database.

String

getDatabaseQualifiedName()

Unique name of the database in which this SQL asset exists, or empty if it does not exist within a database.

SortedSet<IDbtModel>

getDbtModels()

(Deprecated) Model containing the assets.

SortedSet<IDbtSeed>

getDbtSeedAssets()

DBT seeds that materialize the SQL asset.

SortedSet<IDbtSource>

getDbtSources()

Source containing the assets.

SortedSet<IDbtTest>

getDbtTests()

Tests related to this asset.

String

getDefaultDatabaseQualifiedName()

Unique name of the default database to use for this query.

String

getDefaultSchemaQualifiedName()

Unique name of the default schema to use for this query.

SortedSet<IAirflowTask>

getInputToAirflowTasks()

Tasks to which this asset provides input.

SortedSet<ILineageProcess>

getInputToProcesses()

Processes to which this asset provides input.

SortedSet<ISparkJob>

getInputToSparkJobs()

TBC

Boolean

getIsPrivate()

Whether this query is private (true) or shared (false).

Boolean

getIsProfiled()

Whether this asset has been profiled (true) or not (false).

Boolean

getIsSqlSnippet()

Whether this query is a SQL snippet (true) or not (false).

Boolean

getIsVisualQuery()

Whether this query is a visual query (true) or not (false).

Long

getLastProfiledAt()

Time (epoch) at which this asset was last profiled, in milliseconds.

String

getLongRawQuery()

Raw SQL query string.

SortedSet<IModelAttribute>

getModelImplementedAttributes()

Attributes implemented by this asset.

SortedSet<IModelEntity>

getModelImplementedEntities()

Entities implemented by this asset.

SortedSet<IAirflowTask>

getOutputFromAirflowTasks()

Tasks from which this asset is output.

SortedSet<ILineageProcess>

getOutputFromProcesses()

Processes from which this asset is produced as output.

SortedSet<ISparkJob>

getOutputFromSparkJobs()

TBC

INamespace

getParent()

Namespace in which this query exists.

String

getParentQualifiedName()

Unique name of the parent collection or folder in which this query exists.

SortedSet<IPartialField>

getPartialChildFields()

Partial fields contained in the asset.

SortedSet<IPartialObject>

getPartialChildObjects()

Partial objects contained in the asset.

Long

getQueryCount()

Number of times this asset has been queried.

Long

getQueryCountUpdatedAt()

Time (epoch) at which the query count was last updated, in milliseconds.

Long

getQueryUserCount()

Number of unique users who have queried this asset.

Map<String,Long>

getQueryUserMap()

Map of unique users who have queried this asset to the number of times they have queried it.

String

getRawQuery()

Deprecated.

String

getRawQueryText()

TBC

String

getSchemaName()

Simple name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.

String

getSchemaQualifiedName()

Unique name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.

SortedSet<ISnowflakeSemanticLogicalTable>

getSnowflakeSemanticLogicalTables()

Semantic logical tables that reference this physical table or view.

Long

getSqlAiInsightsLastAnalyzedAt()

Time (epoch) at which this asset was last analyzed for AI insights, in milliseconds.

Integer

getSqlAiInsightsPopularBusinessQuestionCount()

Number of popular business questions associated with this asset.

Integer

getSqlAiInsightsPopularFilterCount()

Number of popular filter patterns associated with this asset.

Integer

getSqlAiInsightsPopularJoinCount()

Number of popular join patterns associated with this asset.

Integer

getSqlAiInsightsRelationshipCount()

Number of relationship insights associated with this asset.

String

getSqlAIModelContextQualifiedName()

Unique name of the context in which the model versions exist, or empty if it does not exist within an AI model context.

String

getSqlCoalesceEnvironmentId()

Identifier of the Coalesce environment.

String

getSqlCoalesceEnvironmentName()

Name of the Coalesce environment.

Long

getSqlCoalesceLastRunAt()

Time (epoch) at which the Coalesce node that materialized this asset last ran, in milliseconds.

String

getSqlCoalesceLastRunStatus()

Status of the Coalesce run.

String

getSqlCoalesceNodeStatus()

Status of the Coalesce node for a given run.

String

getSqlCoalesceNodeType()

Type of the Coalesce node.

String

getSqlCoalesceProjectId()

Identifier of the Coalesce project.

String

getSqlCoalesceProjectName()

Name of the Coalesce project.

SortedSet<IDbtModel>

getSqlDbtModels()

Assets related to the model.

SortedSet<IDbtSource>

getSqlDBTSources()

Sources related to this asset.

Boolean

getSqlHasAiInsights()

Whether this asset has any AI insights data available.

SortedSet<ISqlInsightBusinessQuestion>

getSqlInsightBusinessQuestions()

Business question insights for this SQL asset.

SortedSet<ISqlInsightJoin>

getSqlInsightIncomingJoins()

Join insights where this asset is the joined dataset.

SortedSet<ISqlInsightJoin>

getSqlInsightOutgoingJoins()

Join insights where this asset is the source dataset.

Boolean

getSqlIsSecure()

Whether this asset is secure (true) or not (false).

String

getTableName()

Simple name of the table in which this SQL asset exists, or empty if it does not exist within a table.

String

getTableQualifiedName()

Unique name of the table in which this SQL asset exists, or empty if it does not exist within a table.

SortedSet<ITable>

getTables()

Tables this query accesses.

String

getTypeName()

Fixed typeName for AtlanQuerys.

String

getVariablesSchemaBase64()

Base64-encoded string of the variables to use in this query.

String

getViewName()

Simple name of the view in which this SQL asset exists, or empty if it does not exist within a view.

String

getViewQualifiedName()

Unique name of the view in which this SQL asset exists, or empty if it does not exist within a view.

SortedSet<IView>

getViews()

Views this query accesses.

String

getVisualBuilderSchemaBase64()

Base64-encoded string for the visual query builder.

int

hashCode()

static AtlanQuery

refByGuid(String guid)

Reference to a AtlanQuery by GUID.

static AtlanQuery

refByGuid(String guid, Reference.SaveSemantic semantic)

Reference to a AtlanQuery by GUID.

static AtlanQuery

refByQualifiedName(String qualifiedName)

Reference to a AtlanQuery by qualifiedName.

static AtlanQuery

refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)

Reference to a AtlanQuery by qualifiedName.

static AtlanQuery

removeAnnouncement(AtlanClient client, String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName)

Remove the announcement from a AtlanQuery.

static void

removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName)

Deprecated.
see Asset.AssetBuilder.removeAtlanTag(String)

static AtlanQuery

removeCertificate(AtlanClient client, String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName)

Remove the certificate from a AtlanQuery.

static boolean

restore(AtlanClient client, String qualifiedName)

Restore the archived (soft-deleted) AtlanQuery to active.

static FluentSearch.FluentSearchBuilder<?,?>

select(AtlanClient client)

Start a fluent search that will return all AtlanQuery assets.

static FluentSearch.FluentSearchBuilder<?,?>

select(AtlanClient client, boolean includeArchived)

Start a fluent search that will return all AtlanQuery assets.

AtlanQuery.AtlanQueryBuilder<?,?>

toBuilder()

String

toString()

AtlanQuery

trimToReference()

Builds the minimal object necessary to create a relationship to a AtlanQuery, from a potentially more-complete AtlanQuery object.

AtlanQuery.AtlanQueryBuilder<?,?>

trimToRequired()

Builds the minimal object necessary to apply an update to a AtlanQuery, from a potentially more-complete AtlanQuery object.

static AtlanQuery

updateAnnouncement(AtlanClient client, String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName, AtlanAnnouncementType type, String title, String message)

Update the announcement on a AtlanQuery.

static AtlanQuery

updateCertificate(AtlanClient client, String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName, CertificateStatus certificate, String message)

Update the certificate on a AtlanQuery.

static AtlanQuery.AtlanQueryBuilder<?,?>

updater(String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName)

Builds the minimal object necessary to update a AtlanQuery.

Methods inherited from class com.atlan.model.assets.Asset
addApiTokenAsAdmin, appendAtlanTags, appendAtlanTags, appendTerms, delete, get, getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiAlias, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetExternalDQScoreValue, getAssetExternalDQTestAvgScores, getAssetExternalDQTestEntities, getAssetExternalDQTestLatestScores, getAssetExternalDQTestMinScores, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetHasAiReadme, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getAtlanTagNames, getAtlanTags, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCreatedBy, getCreateTime, getCustomConnectorType, getCustomMetadata, getCustomMetadataSets, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDeleteHandler, getDepth, getDescription, getDisplayName, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getFiles, getHasContract, getHasLineage, getIconUrl, getImmediateDownstream, getImmediateUpstream, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsIncomplete, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMeaningNames, getMeanings, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getNullFields, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPendingTasks, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getStatus, getSubType, getTenantId, getUpdatedBy, getUpdateTime, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, lineage, lineage, purge, removeAnnouncement, removeAtlanTag, removeCertificate, removeCustomMetadata, removeDescription, removeOwners, removeTerms, removeUserDescription, replaceCustomMetadata, replaceTerms, requestLineage, restore, save, save, saveMergingCM, saveMergingCM, saveReplacingCM, saveReplacingCM, updateAnnouncement, updateAnnouncement, updateCertificate, updateCertificate, updateCustomMetadataAttributes, updateMergingCM, updateMergingCM, updateReplacingCM, updateReplacingCM

Methods inherited from class com.atlan.model.relations.Reference
builder, by, compareTo, getAddedRelationshipAttributes, getCompleteObject, getCustomAttributes, getDisplayText, getDocId, getEntityStatus, getGuid, getLabels, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getRemovedRelationshipAttributes, getSemantic, getUniqueAttributes, isComplete, isValidReference, isValidReferenceByGuid, isValidReferenceByQualifiedName, setCompleteObject, to, validateRelationship, validateRequired

Methods inherited from class com.atlan.model.core.AtlanObject
getRawJsonObject, setRawJsonObject, toJson

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlan.model.search.AuditDetail
getRawJsonObject, setRawJsonObject

Methods inherited from interface com.atlan.model.assets.IAsset
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiAlias, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetExternalDQScoreValue, getAssetExternalDQTestAvgScores, getAssetExternalDQTestEntities, getAssetExternalDQTestLatestScores, getAssetExternalDQTestMinScores, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetHasAiReadme, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.IAtlanQuery
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiAlias, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetExternalDQScoreValue, getAssetExternalDQTestAvgScores, getAssetExternalDQTestEntities, getAssetExternalDQTestLatestScores, getAssetExternalDQTestMinScores, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetHasAiReadme, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.ICatalog
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiAlias, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetExternalDQScoreValue, getAssetExternalDQTestAvgScores, getAssetExternalDQTestEntities, getAssetExternalDQTestLatestScores, getAssetExternalDQTestMinScores, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetHasAiReadme, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.IReferenceable
getAtlanTagNames, getAtlanTags, getCreatedBy, getCreateTime, getCustomMetadataSets, getDeleteHandler, getGuid, getIsIncomplete, getMeaningNames, getMeanings, getPendingTasks, getQualifiedName, getStatus, getUpdatedBy, getUpdateTime

Methods inherited from interface com.atlan.model.assets.ISQL
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiAlias, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetExternalDQScoreValue, getAssetExternalDQTestAvgScores, getAssetExternalDQTestEntities, getAssetExternalDQTestLatestScores, getAssetExternalDQTestMinScores, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetHasAiReadme, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Field Details
- TYPE_NAME
  
  public static final String TYPE_NAME
  See Also:
  
  Constant Field Values
Constructor Details
- AtlanQuery
  
  protected AtlanQuery(AtlanQuery.AtlanQueryBuilder<?,?> b)
Method Details
- trimToReference
  
  public AtlanQuery trimToReference() throws InvalidRequestException
  
  Builds the minimal object necessary to create a relationship to a AtlanQuery, from a potentially more-complete AtlanQuery object.
  
  Overrides:
  
  trimToReference in class Asset
  
  Returns:
  
  the minimal object necessary to relate to the AtlanQuery
  
  Throws:
  
  InvalidRequestException - if any of the minimal set of required properties for a AtlanQuery relationship are not found in the initial object
- select
  
  public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
  
  Start a fluent search that will return all AtlanQuery 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) AtlanQuery assets will be included.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to retrieve the assets
  
  Returns:
  
  a fluent search that includes all AtlanQuery assets
- select
  
  public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
  
  Start a fluent search that will return all AtlanQuery 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.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to retrieve the assets
  
  includeArchived - when true, archived (soft-deleted) AtlanQuerys will be included
  
  Returns:
  
  a fluent search that includes all AtlanQuery assets
- refByGuid
  
  public static AtlanQuery refByGuid(String guid)
  
  Reference to a AtlanQuery by GUID. Use this to create a relationship to this AtlanQuery, where the relationship should be replaced.
  
  Parameters:
  
  guid - the GUID of the AtlanQuery to reference
  
  Returns:
  
  reference to a AtlanQuery that can be used for defining a relationship to a AtlanQuery
- refByGuid
  
  public static AtlanQuery refByGuid(String guid, Reference.SaveSemantic semantic)
  
  Reference to a AtlanQuery by GUID. Use this to create a relationship to this AtlanQuery, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
  
  Parameters:
  
  guid - the GUID of the AtlanQuery to reference
  
  semantic - how to save this relationship (replace all with this, append it, or remove it)
  
  Returns:
  
  reference to a AtlanQuery that can be used for defining a relationship to a AtlanQuery
- refByQualifiedName
  
  public static AtlanQuery refByQualifiedName(String qualifiedName)
  
  Reference to a AtlanQuery by qualifiedName. Use this to create a relationship to this AtlanQuery, where the relationship should be replaced.
  
  Parameters:
  
  qualifiedName - the qualifiedName of the AtlanQuery to reference
  
  Returns:
  
  reference to a AtlanQuery that can be used for defining a relationship to a AtlanQuery
- refByQualifiedName
  
  public static AtlanQuery refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)
  
  Reference to a AtlanQuery by qualifiedName. Use this to create a relationship to this AtlanQuery, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
  
  Parameters:
  
  qualifiedName - the qualifiedName of the AtlanQuery to reference
  
  semantic - how to save this relationship (replace all with this, append it, or remove it)
  
  Returns:
  
  reference to a AtlanQuery that can be used for defining a relationship to a AtlanQuery
- get
  
  public static AtlanQuery get(AtlanClient client, String id) throws AtlanException
  
  Retrieves a AtlanQuery by one of its identifiers, complete with all of its relationships.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to retrieve the asset
  
  id - of the AtlanQuery to retrieve, either its GUID or its full qualifiedName
  
  Returns:
  
  the requested full AtlanQuery, complete with all of its relationships
  
  Throws:
  
  AtlanException - on any error during the API invocation, such as the NotFoundException if the AtlanQuery does not exist or the provided GUID is not a AtlanQuery
- get
  
  public static AtlanQuery get(AtlanClient client, String id, boolean includeAllRelationships) throws AtlanException
  
  Retrieves a AtlanQuery by one of its identifiers, optionally complete with all of its relationships.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to retrieve the asset
  
  id - of the AtlanQuery to retrieve, either its GUID or its full qualifiedName
  
  includeAllRelationships - if true, all the asset's relationships will also be retrieved; if false, no relationships will be retrieved
  
  Returns:
  
  the requested full AtlanQuery, optionally complete with all of its relationships
  
  Throws:
  
  AtlanException - on any error during the API invocation, such as the NotFoundException if the AtlanQuery does not exist or the provided GUID is not a AtlanQuery
- get
  
  public static AtlanQuery get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException
  
  Retrieves a AtlanQuery by one of its identifiers, with only the requested attributes (and relationships).
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to retrieve the asset
  
  id - of the AtlanQuery to retrieve, either its GUID or its full qualifiedName
  
  attributes - to retrieve for the AtlanQuery, including any relationships
  
  Returns:
  
  the requested AtlanQuery, with only its minimal information and the requested attributes (and relationships)
  
  Throws:
  
  AtlanException - on any error during the API invocation, such as the NotFoundException if the AtlanQuery does not exist or the provided GUID is not a AtlanQuery
- get
  
  public static AtlanQuery get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException
  
  Retrieves a AtlanQuery by one of its identifiers, with only the requested attributes (and relationships).
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to retrieve the asset
  
  id - of the AtlanQuery to retrieve, either its GUID or its full qualifiedName
  
  attributes - to retrieve for the AtlanQuery, including any relationships
  
  attributesOnRelated - to retrieve on each relationship retrieved for the AtlanQuery
  
  Returns:
  
  the requested AtlanQuery, with only its minimal information and the requested attributes (and relationships)
  
  Throws:
  
  AtlanException - on any error during the API invocation, such as the NotFoundException if the AtlanQuery does not exist or the provided GUID is not a AtlanQuery
- restore
  
  public static boolean restore(AtlanClient client, String qualifiedName) throws AtlanException
  
  Restore the archived (soft-deleted) AtlanQuery to active.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to restore the asset
  
  qualifiedName - for the AtlanQuery
  
  Returns:
  
  true if the AtlanQuery is now active, and false otherwise
  
  Throws:
  
  AtlanException - on any API problems
- creator
  
  public static AtlanQuery.AtlanQueryBuilder<?,?> creator(String name, Folder parentFolder) throws InvalidRequestException
  
  Builds the minimal object necessary to create a Query.
  
  Parameters:
  
  name - of the Query
  
  parentFolder - in which the Query should be created, which must have at least a qualifiedName
  
  Returns:
  
  the minimal request necessary to create the Query, as a builder
  
  Throws:
  
  InvalidRequestException - if the parentFolder provided is without a qualifiedName
- creator
  
  public static AtlanQuery.AtlanQueryBuilder<?,?> creator(String name, AtlanCollection collection) throws InvalidRequestException
  
  Builds the minimal object necessary to create a Query.
  
  Parameters:
  
  name - of the Query
  
  collection - in which the Query should be created, which must have at least a qualifiedName
  
  Returns:
  
  the minimal request necessary to create the Query, as a builder
  
  Throws:
  
  InvalidRequestException - if the collection provided is without a qualifiedName
- creator
  
  public static AtlanQuery.AtlanQueryBuilder<?,?> creator(String name, String collectionQualifiedName, String parentFolderQualifiedName)
  
  Builds the minimal object necessary to create a Query.
  
  Parameters:
  
  name - of the Query
  
  collectionQualifiedName - unique name of the AtlanCollection in which the Query should be created
  
  parentFolderQualifiedName - unique name of the Folder in which this Query should be created, or null if it should be created directly in the collection
  
  Returns:
  
  the minimal request necessary to create the Query, as a builder
- generateQualifiedName
  
  public static String generateQualifiedName(String name, String parentQualifiedName)
  
  Generate a unique Query.
  
  Parameters:
  
  name - of the Query
  
  parentQualifiedName - unique name of the collection or folder in which this Query exists
  
  Returns:
  
  a unique name for the Query
- updater
  
  public static AtlanQuery.AtlanQueryBuilder<?,?> updater(String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName)
  
  Builds the minimal object necessary to update a AtlanQuery.
  
  Parameters:
  
  qualifiedName - of the AtlanQuery
  
  name - of the AtlanQuery
  
  collectionQualifiedName - qualifiedName of the parent collection the query is contained within
  
  parentQualifiedName - qualifiedName of the parent collection or folder the query is contained within
  
  Returns:
  
  the minimal request necessary to update the AtlanQuery, as a builder
- trimToRequired
  
  public AtlanQuery.AtlanQueryBuilder<?,?> trimToRequired() throws InvalidRequestException
  
  Builds the minimal object necessary to apply an update to a AtlanQuery, from a potentially more-complete AtlanQuery object.
  
  Overrides:
  
  trimToRequired in class Asset
  
  Returns:
  
  the minimal object necessary to update the AtlanQuery, as a builder
  
  Throws:
  
  InvalidRequestException - if any of the minimal set of required properties for AtlanQuery are not found in the initial object
- updateCertificate
  
  public static AtlanQuery updateCertificate(AtlanClient client, String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName, CertificateStatus certificate, String message) throws AtlanException
  
  Update the certificate on a AtlanQuery.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to update the AtlanQuery's certificate
  
  qualifiedName - of the AtlanQuery
  
  name - of the AtlanQuery
  
  collectionQualifiedName - qualifiedName of the AtlanQuery's collection
  
  parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
  
  certificate - to use
  
  message - (optional) message, or null if no message
  
  Returns:
  
  the updated AtlanQuery, or null if the update failed
  
  Throws:
  
  AtlanException - on any API problems
- removeCertificate
  
  public static AtlanQuery removeCertificate(AtlanClient client, String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName) throws AtlanException
  
  Remove the certificate from a AtlanQuery.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to remove the AtlanQuery's certificate
  
  qualifiedName - of the AtlanQuery
  
  name - of the AtlanQuery
  
  collectionQualifiedName - qualifiedName of the AtlanQuery's collection
  
  parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
  
  Returns:
  
  the updated AtlanQuery, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- updateAnnouncement
  
  public static AtlanQuery updateAnnouncement(AtlanClient client, String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
  
  Update the announcement on a AtlanQuery.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to update the AtlanQuery's announcement
  
  qualifiedName - of the AtlanQuery
  
  name - of the AtlanQuery
  
  collectionQualifiedName - qualifiedName of the AtlanQuery's collection
  
  parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
  
  type - type of announcement to set
  
  title - (optional) title of the announcement to set (or null for no title)
  
  message - (optional) message of the announcement to set (or null for no message)
  
  Returns:
  
  the updated AtlanQuery, or null if the update failed
  
  Throws:
  
  AtlanException - on any API problems
- removeAnnouncement
  
  public static AtlanQuery removeAnnouncement(AtlanClient client, String qualifiedName, String name, String collectionQualifiedName, String parentQualifiedName) throws AtlanException
  
  Remove the announcement from a AtlanQuery.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to remove the AtlanQuery's announcement
  
  qualifiedName - of the AtlanQuery
  
  name - of the AtlanQuery
  
  collectionQualifiedName - qualifiedName of the AtlanQuery's collection
  
  parentQualifiedName - qualifiedName of the AtlanQuery's parent namespace
  
  Returns:
  
  the updated AtlanQuery, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- appendAtlanTags
  
  @Deprecated public static AtlanQuery appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
  
  Deprecated.
  see Asset.AssetBuilder.appendAtlanTags(List)
  
  Add Atlan tags to a AtlanQuery, without replacing existing Atlan tags linked to the AtlanQuery. Note: this operation must make two API calls — one to retrieve the AtlanQuery's existing Atlan tags, and a second to append the new Atlan tags.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to append Atlan tags to the AtlanQuery
  
  qualifiedName - of the AtlanQuery
  
  atlanTagNames - human-readable names of the Atlan tags to add
  
  Returns:
  
  the updated AtlanQuery
  
  Throws:
  
  AtlanException - on any API problems
- appendAtlanTags
  
  @Deprecated public static AtlanQuery appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
  
  Deprecated.
  see Asset.AssetBuilder.appendAtlanTags(List, boolean, boolean, boolean, boolean)
  
  Add Atlan tags to a AtlanQuery, without replacing existing Atlan tags linked to the AtlanQuery. Note: this operation must make two API calls — one to retrieve the AtlanQuery's existing Atlan tags, and a second to append the new Atlan tags.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to append Atlan tags to the AtlanQuery
  
  qualifiedName - of the AtlanQuery
  
  atlanTagNames - human-readable names of the Atlan tags to add
  
  propagate - whether to propagate the Atlan tag (true) or not (false)
  
  removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
  
  restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
  
  Returns:
  
  the updated AtlanQuery
  
  Throws:
  
  AtlanException - on any API problems
- removeAtlanTag
  
  @Deprecated public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
  
  Deprecated.
  see Asset.AssetBuilder.removeAtlanTag(String)
  
  Remove an Atlan tag from a AtlanQuery.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to remove an Atlan tag from a AtlanQuery
  
  qualifiedName - of the AtlanQuery
  
  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 AtlanQuery
- _internal
  
  public static AtlanQuery.AtlanQueryBuilder<?,?> _internal()
- toBuilder
  
  public AtlanQuery.AtlanQueryBuilder<?,?> toBuilder()
  
  Overrides:
  
  toBuilder in class Reference
- getCalculationViewName
  
  public String getCalculationViewName()
  
  Simple name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.
  
  Specified by:
  
  getCalculationViewName in interface IAtlanQuery
  
  Specified by:
  
  getCalculationViewName in interface ISQL
- getCalculationViewQualifiedName
  
  public String getCalculationViewQualifiedName()
  
  Unique name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.
  
  Specified by:
  
  getCalculationViewQualifiedName in interface IAtlanQuery
  
  Specified by:
  
  getCalculationViewQualifiedName in interface ISQL
- getCatalogDatasetGuid
  
  public String getCatalogDatasetGuid()
  
  Unique identifier of the dataset this asset belongs to.
  
  Specified by:
  
  getCatalogDatasetGuid in interface IAtlanQuery
  
  Specified by:
  
  getCatalogDatasetGuid in interface ICatalog
  
  Specified by:
  
  getCatalogDatasetGuid in interface ISQL
- getCollectionQualifiedName
  
  public String getCollectionQualifiedName()
  
  Unique name of the collection in which this query exists.
  
  Specified by:
  
  getCollectionQualifiedName in interface IAtlanQuery
- getColumns
  
  public SortedSet<IColumn> getColumns()
  
  Columns this query accesses.
  
  Specified by:
  
  getColumns in interface IAtlanQuery
- getDatabaseName
  
  public String getDatabaseName()
  
  Simple name of the database in which this SQL asset exists, or empty if it does not exist within a database.
  
  Specified by:
  
  getDatabaseName in interface IAtlanQuery
  
  Specified by:
  
  getDatabaseName in interface ISQL
- getDatabaseQualifiedName
  
  public String getDatabaseQualifiedName()
  
  Unique name of the database in which this SQL asset exists, or empty if it does not exist within a database.
  
  Specified by:
  
  getDatabaseQualifiedName in interface IAtlanQuery
  
  Specified by:
  
  getDatabaseQualifiedName in interface ISQL
- getDbtModels
  
  public SortedSet<IDbtModel> getDbtModels()
  
  (Deprecated) Model containing the assets.
  
  Specified by:
  
  getDbtModels in interface IAtlanQuery
  
  Specified by:
  
  getDbtModels in interface ISQL
- getDbtSeedAssets
  
  public SortedSet<IDbtSeed> getDbtSeedAssets()
  
  DBT seeds that materialize the SQL asset.
  
  Specified by:
  
  getDbtSeedAssets in interface IAtlanQuery
  
  Specified by:
  
  getDbtSeedAssets in interface ISQL
- getDbtSources
  
  public SortedSet<IDbtSource> getDbtSources()
  
  Source containing the assets.
  
  Specified by:
  
  getDbtSources in interface IAtlanQuery
  
  Specified by:
  
  getDbtSources in interface ISQL
- getDbtTests
  
  public SortedSet<IDbtTest> getDbtTests()
  
  Tests related to this asset.
  
  Specified by:
  
  getDbtTests in interface IAtlanQuery
  
  Specified by:
  
  getDbtTests in interface ISQL
- getDefaultDatabaseQualifiedName
  
  public String getDefaultDatabaseQualifiedName()
  
  Unique name of the default database to use for this query.
  
  Specified by:
  
  getDefaultDatabaseQualifiedName in interface IAtlanQuery
- getDefaultSchemaQualifiedName
  
  public String getDefaultSchemaQualifiedName()
  
  Unique name of the default schema to use for this query.
  
  Specified by:
  
  getDefaultSchemaQualifiedName in interface IAtlanQuery
- getInputToAirflowTasks
  
  public SortedSet<IAirflowTask> getInputToAirflowTasks()
  
  Tasks to which this asset provides input.
  
  Specified by:
  
  getInputToAirflowTasks in interface IAtlanQuery
  
  Specified by:
  
  getInputToAirflowTasks in interface ICatalog
  
  Specified by:
  
  getInputToAirflowTasks in interface ISQL
- getInputToProcesses
  
  public SortedSet<ILineageProcess> getInputToProcesses()
  
  Processes to which this asset provides input.
  
  Specified by:
  
  getInputToProcesses in interface IAtlanQuery
  
  Specified by:
  
  getInputToProcesses in interface ICatalog
  
  Specified by:
  
  getInputToProcesses in interface ISQL
- getInputToSparkJobs
  
  public SortedSet<ISparkJob> getInputToSparkJobs()
  
  TBC
  
  Specified by:
  
  getInputToSparkJobs in interface IAtlanQuery
  
  Specified by:
  
  getInputToSparkJobs in interface ICatalog
  
  Specified by:
  
  getInputToSparkJobs in interface ISQL
- getIsPrivate
  
  public Boolean getIsPrivate()
  
  Whether this query is private (true) or shared (false).
  
  Specified by:
  
  getIsPrivate in interface IAtlanQuery
- getIsProfiled
  
  public Boolean getIsProfiled()
  
  Whether this asset has been profiled (true) or not (false).
  
  Specified by:
  
  getIsProfiled in interface IAtlanQuery
  
  Specified by:
  
  getIsProfiled in interface ISQL
- getIsSqlSnippet
  
  public Boolean getIsSqlSnippet()
  
  Whether this query is a SQL snippet (true) or not (false).
  
  Specified by:
  
  getIsSqlSnippet in interface IAtlanQuery
- getIsVisualQuery
  
  public Boolean getIsVisualQuery()
  
  Whether this query is a visual query (true) or not (false).
  
  Specified by:
  
  getIsVisualQuery in interface IAtlanQuery
- getLastProfiledAt
  
  public Long getLastProfiledAt()
  
  Time (epoch) at which this asset was last profiled, in milliseconds.
  
  Specified by:
  
  getLastProfiledAt in interface IAtlanQuery
  
  Specified by:
  
  getLastProfiledAt in interface ISQL
- getLongRawQuery
  
  public String getLongRawQuery()
  
  Raw SQL query string.
  
  Specified by:
  
  getLongRawQuery in interface IAtlanQuery
- getModelImplementedAttributes
  
  public SortedSet<IModelAttribute> getModelImplementedAttributes()
  
  Attributes implemented by this asset.
  
  Specified by:
  
  getModelImplementedAttributes in interface IAtlanQuery
  
  Specified by:
  
  getModelImplementedAttributes in interface ICatalog
  
  Specified by:
  
  getModelImplementedAttributes in interface ISQL
- getModelImplementedEntities
  
  public SortedSet<IModelEntity> getModelImplementedEntities()
  
  Entities implemented by this asset.
  
  Specified by:
  
  getModelImplementedEntities in interface IAtlanQuery
  
  Specified by:
  
  getModelImplementedEntities in interface ICatalog
  
  Specified by:
  
  getModelImplementedEntities in interface ISQL
- getOutputFromAirflowTasks
  
  public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
  
  Tasks from which this asset is output.
  
  Specified by:
  
  getOutputFromAirflowTasks in interface IAtlanQuery
  
  Specified by:
  
  getOutputFromAirflowTasks in interface ICatalog
  
  Specified by:
  
  getOutputFromAirflowTasks in interface ISQL
- getOutputFromProcesses
  
  public SortedSet<ILineageProcess> getOutputFromProcesses()
  
  Processes from which this asset is produced as output.
  
  Specified by:
  
  getOutputFromProcesses in interface IAtlanQuery
  
  Specified by:
  
  getOutputFromProcesses in interface ICatalog
  
  Specified by:
  
  getOutputFromProcesses in interface ISQL
- getOutputFromSparkJobs
  
  public SortedSet<ISparkJob> getOutputFromSparkJobs()
  
  TBC
  
  Specified by:
  
  getOutputFromSparkJobs in interface IAtlanQuery
  
  Specified by:
  
  getOutputFromSparkJobs in interface ICatalog
  
  Specified by:
  
  getOutputFromSparkJobs in interface ISQL
- getParent
  
  public INamespace getParent()
  
  Namespace in which this query exists.
  
  Specified by:
  
  getParent in interface IAtlanQuery
- getParentQualifiedName
  
  public String getParentQualifiedName()
  
  Unique name of the parent collection or folder in which this query exists.
  
  Specified by:
  
  getParentQualifiedName in interface IAtlanQuery
- getPartialChildFields
  
  public SortedSet<IPartialField> getPartialChildFields()
  
  Partial fields contained in the asset.
  
  Specified by:
  
  getPartialChildFields in interface IAtlanQuery
  
  Specified by:
  
  getPartialChildFields in interface ICatalog
  
  Specified by:
  
  getPartialChildFields in interface ISQL
- getPartialChildObjects
  
  public SortedSet<IPartialObject> getPartialChildObjects()
  
  Partial objects contained in the asset.
  
  Specified by:
  
  getPartialChildObjects in interface IAtlanQuery
  
  Specified by:
  
  getPartialChildObjects in interface ICatalog
  
  Specified by:
  
  getPartialChildObjects in interface ISQL
- getQueryCount
  
  public Long getQueryCount()
  
  Number of times this asset has been queried.
  
  Specified by:
  
  getQueryCount in interface IAtlanQuery
  
  Specified by:
  
  getQueryCount in interface ISQL
- getQueryCountUpdatedAt
  
  public Long getQueryCountUpdatedAt()
  
  Time (epoch) at which the query count was last updated, in milliseconds.
  
  Specified by:
  
  getQueryCountUpdatedAt in interface IAtlanQuery
  
  Specified by:
  
  getQueryCountUpdatedAt in interface ISQL
- getQueryUserCount
  
  public Long getQueryUserCount()
  
  Number of unique users who have queried this asset.
  
  Specified by:
  
  getQueryUserCount in interface IAtlanQuery
  
  Specified by:
  
  getQueryUserCount in interface ISQL
- getQueryUserMap
  
  public Map<String,Long> getQueryUserMap()
  
  Map of unique users who have queried this asset to the number of times they have queried it.
  
  Specified by:
  
  getQueryUserMap in interface IAtlanQuery
  
  Specified by:
  
  getQueryUserMap in interface ISQL
- getRawQuery
  
  public String getRawQuery()
  
  Deprecated. See 'longRawQuery' instead.
  
  Specified by:
  
  getRawQuery in interface IAtlanQuery
- getRawQueryText
  
  public String getRawQueryText()
  
  TBC
  
  Specified by:
  
  getRawQueryText in interface IAtlanQuery
- getSchemaName
  
  public String getSchemaName()
  
  Simple name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.
  
  Specified by:
  
  getSchemaName in interface IAtlanQuery
  
  Specified by:
  
  getSchemaName in interface ISQL
- getSchemaQualifiedName
  
  public String getSchemaQualifiedName()
  
  Unique name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.
  
  Specified by:
  
  getSchemaQualifiedName in interface IAtlanQuery
  
  Specified by:
  
  getSchemaQualifiedName in interface ISQL
- getSnowflakeSemanticLogicalTables
  
  public SortedSet<ISnowflakeSemanticLogicalTable> getSnowflakeSemanticLogicalTables()
  
  Semantic logical tables that reference this physical table or view.
- getSqlAIModelContextQualifiedName
  
  public String getSqlAIModelContextQualifiedName()
  
  Unique name of the context in which the model versions exist, or empty if it does not exist within an AI model context.
  
  Specified by:
  
  getSqlAIModelContextQualifiedName in interface IAtlanQuery
  
  Specified by:
  
  getSqlAIModelContextQualifiedName in interface ISQL
- getSqlAiInsightsLastAnalyzedAt
  
  public Long getSqlAiInsightsLastAnalyzedAt()
  
  Time (epoch) at which this asset was last analyzed for AI insights, in milliseconds.
  
  Specified by:
  
  getSqlAiInsightsLastAnalyzedAt in interface IAtlanQuery
  
  Specified by:
  
  getSqlAiInsightsLastAnalyzedAt in interface ISQL
- getSqlAiInsightsPopularBusinessQuestionCount
  
  public Integer getSqlAiInsightsPopularBusinessQuestionCount()
  
  Number of popular business questions associated with this asset.
  
  Specified by:
  
  getSqlAiInsightsPopularBusinessQuestionCount in interface IAtlanQuery
  
  Specified by:
  
  getSqlAiInsightsPopularBusinessQuestionCount in interface ISQL
- getSqlAiInsightsPopularFilterCount
  
  public Integer getSqlAiInsightsPopularFilterCount()
  
  Number of popular filter patterns associated with this asset.
  
  Specified by:
  
  getSqlAiInsightsPopularFilterCount in interface IAtlanQuery
  
  Specified by:
  
  getSqlAiInsightsPopularFilterCount in interface ISQL
- getSqlAiInsightsPopularJoinCount
  
  public Integer getSqlAiInsightsPopularJoinCount()
  
  Number of popular join patterns associated with this asset.
  
  Specified by:
  
  getSqlAiInsightsPopularJoinCount in interface IAtlanQuery
  
  Specified by:
  
  getSqlAiInsightsPopularJoinCount in interface ISQL
- getSqlAiInsightsRelationshipCount
  
  public Integer getSqlAiInsightsRelationshipCount()
  
  Number of relationship insights associated with this asset.
  
  Specified by:
  
  getSqlAiInsightsRelationshipCount in interface IAtlanQuery
  
  Specified by:
  
  getSqlAiInsightsRelationshipCount in interface ISQL
- getSqlCoalesceEnvironmentId
  
  public String getSqlCoalesceEnvironmentId()
  
  Identifier of the Coalesce environment.
  
  Specified by:
  
  getSqlCoalesceEnvironmentId in interface IAtlanQuery
  
  Specified by:
  
  getSqlCoalesceEnvironmentId in interface ISQL
- getSqlCoalesceEnvironmentName
  
  public String getSqlCoalesceEnvironmentName()
  
  Name of the Coalesce environment.
  
  Specified by:
  
  getSqlCoalesceEnvironmentName in interface IAtlanQuery
  
  Specified by:
  
  getSqlCoalesceEnvironmentName in interface ISQL
- getSqlCoalesceLastRunAt
  
  public Long getSqlCoalesceLastRunAt()
  
  Time (epoch) at which the Coalesce node that materialized this asset last ran, in milliseconds.
  
  Specified by:
  
  getSqlCoalesceLastRunAt in interface IAtlanQuery
  
  Specified by:
  
  getSqlCoalesceLastRunAt in interface ISQL
- getSqlCoalesceLastRunStatus
  
  public String getSqlCoalesceLastRunStatus()
  
  Status of the Coalesce run. One of: success, failure, cancelled, or skipped.
  
  Specified by:
  
  getSqlCoalesceLastRunStatus in interface IAtlanQuery
  
  Specified by:
  
  getSqlCoalesceLastRunStatus in interface ISQL
- getSqlCoalesceNodeStatus
  
  public String getSqlCoalesceNodeStatus()
  
  Status of the Coalesce node for a given run.
  
  Specified by:
  
  getSqlCoalesceNodeStatus in interface IAtlanQuery
  
  Specified by:
  
  getSqlCoalesceNodeStatus in interface ISQL
- getSqlCoalesceNodeType
  
  public String getSqlCoalesceNodeType()
  
  Type of the Coalesce node.
  
  Specified by:
  
  getSqlCoalesceNodeType in interface IAtlanQuery
  
  Specified by:
  
  getSqlCoalesceNodeType in interface ISQL
- getSqlCoalesceProjectId
  
  public String getSqlCoalesceProjectId()
  
  Identifier of the Coalesce project.
  
  Specified by:
  
  getSqlCoalesceProjectId in interface IAtlanQuery
  
  Specified by:
  
  getSqlCoalesceProjectId in interface ISQL
- getSqlCoalesceProjectName
  
  public String getSqlCoalesceProjectName()
  
  Name of the Coalesce project.
  
  Specified by:
  
  getSqlCoalesceProjectName in interface IAtlanQuery
  
  Specified by:
  
  getSqlCoalesceProjectName in interface ISQL
- getSqlDBTSources
  
  public SortedSet<IDbtSource> getSqlDBTSources()
  
  Sources related to this asset.
  
  Specified by:
  
  getSqlDBTSources in interface IAtlanQuery
  
  Specified by:
  
  getSqlDBTSources in interface ISQL
- getSqlDbtModels
  
  public SortedSet<IDbtModel> getSqlDbtModels()
  
  Assets related to the model.
  
  Specified by:
  
  getSqlDbtModels in interface IAtlanQuery
  
  Specified by:
  
  getSqlDbtModels in interface ISQL
- getSqlHasAiInsights
  
  public Boolean getSqlHasAiInsights()
  
  Whether this asset has any AI insights data available.
  
  Specified by:
  
  getSqlHasAiInsights in interface IAtlanQuery
  
  Specified by:
  
  getSqlHasAiInsights in interface ISQL
- getSqlInsightBusinessQuestions
  
  public SortedSet<ISqlInsightBusinessQuestion> getSqlInsightBusinessQuestions()
  
  Business question insights for this SQL asset.
- getSqlInsightIncomingJoins
  
  public SortedSet<ISqlInsightJoin> getSqlInsightIncomingJoins()
  
  Join insights where this asset is the joined dataset.
- getSqlInsightOutgoingJoins
  
  public SortedSet<ISqlInsightJoin> getSqlInsightOutgoingJoins()
  
  Join insights where this asset is the source dataset.
- getSqlIsSecure
  
  public Boolean getSqlIsSecure()
  
  Whether this asset is secure (true) or not (false).
  
  Specified by:
  
  getSqlIsSecure in interface IAtlanQuery
  
  Specified by:
  
  getSqlIsSecure in interface ISQL
- getTableName
  
  public String getTableName()
  
  Simple name of the table in which this SQL asset exists, or empty if it does not exist within a table.
  
  Specified by:
  
  getTableName in interface IAtlanQuery
  
  Specified by:
  
  getTableName in interface ISQL
- getTableQualifiedName
  
  public String getTableQualifiedName()
  
  Unique name of the table in which this SQL asset exists, or empty if it does not exist within a table.
  
  Specified by:
  
  getTableQualifiedName in interface IAtlanQuery
  
  Specified by:
  
  getTableQualifiedName in interface ISQL
- getTables
  
  public SortedSet<ITable> getTables()
  
  Tables this query accesses.
  
  Specified by:
  
  getTables in interface IAtlanQuery
- getVariablesSchemaBase64
  
  public String getVariablesSchemaBase64()
  
  Base64-encoded string of the variables to use in this query.
  
  Specified by:
  
  getVariablesSchemaBase64 in interface IAtlanQuery
- getViewName
  
  public String getViewName()
  
  Simple name of the view in which this SQL asset exists, or empty if it does not exist within a view.
  
  Specified by:
  
  getViewName in interface IAtlanQuery
  
  Specified by:
  
  getViewName in interface ISQL
- getViewQualifiedName
  
  public String getViewQualifiedName()
  
  Unique name of the view in which this SQL asset exists, or empty if it does not exist within a view.
  
  Specified by:
  
  getViewQualifiedName in interface IAtlanQuery
  
  Specified by:
  
  getViewQualifiedName in interface ISQL
- getViews
  
  public SortedSet<IView> getViews()
  
  Views this query accesses.
  
  Specified by:
  
  getViews in interface IAtlanQuery
- getVisualBuilderSchemaBase64
  
  public String getVisualBuilderSchemaBase64()
  
  Base64-encoded string for the visual query builder.
  
  Specified by:
  
  getVisualBuilderSchemaBase64 in interface IAtlanQuery
- equals
  
  public boolean equals(Object o)
  
  Overrides:
  
  equals in class Asset
- canEqual
  
  protected boolean canEqual(Object other)
  
  Overrides:
  
  canEqual in class Asset
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Asset
- toString
  
  public String toString()
  
  Description copied from class: AtlanObject
  
  Overrides:
  
  toString in class Asset
- getTypeName
  
  public String getTypeName()
  
  Fixed typeName for AtlanQuerys.
  
  Specified by:
  
  getTypeName in interface AuditDetail
  
  Specified by:
  
  getTypeName in interface IAsset
  
  Specified by:
  
  getTypeName in interface IAtlanQuery
  
  Specified by:
  
  getTypeName in interface ICatalog
  
  Specified by:
  
  getTypeName in interface IReferenceable
  
  Specified by:
  
  getTypeName in interface ISQL
  
  Overrides:
  
  getTypeName in class Reference

Class AtlanQuery

Nested Class Summary

Nested classes/interfaces inherited from class com.atlan.model.assets.Asset

Nested classes/interfaces inherited from class com.atlan.model.relations.Reference

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject

Field Summary

Fields inherited from class com.atlan.model.core.AtlanObject

Fields inherited from interface com.atlan.model.assets.IAsset

Fields inherited from interface com.atlan.model.assets.IAtlanQuery

Fields inherited from interface com.atlan.model.assets.ICatalog

Fields inherited from interface com.atlan.model.assets.IReferenceable

Fields inherited from interface com.atlan.model.assets.ISQL

Constructor Summary

Method Summary

Methods inherited from class com.atlan.model.assets.Asset

Methods inherited from class com.atlan.model.relations.Reference

Methods inherited from class com.atlan.model.core.AtlanObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlan.model.search.AuditDetail

Methods inherited from interface com.atlan.model.assets.IAsset

Methods inherited from interface com.atlan.model.assets.IAtlanQuery

Methods inherited from interface com.atlan.model.assets.ICatalog

Methods inherited from interface com.atlan.model.assets.IReferenceable

Methods inherited from interface com.atlan.model.assets.ISQL

Field Details

TYPE_NAME

Constructor Details

AtlanQuery

Method Details

trimToReference

select

select

refByGuid

refByGuid

refByQualifiedName

refByQualifiedName

get

get

get

get

restore

creator

creator

creator

generateQualifiedName

updater

trimToRequired

updateCertificate

removeCertificate

updateAnnouncement

removeAnnouncement

appendAtlanTags

appendAtlanTags

removeAtlanTag

_internal

toBuilder

getCalculationViewName

getCalculationViewQualifiedName

getCatalogDatasetGuid

getCollectionQualifiedName

getColumns

getDatabaseName

getDatabaseQualifiedName

getDbtModels

getDbtSeedAssets

getDbtSources

getDbtTests

getDefaultDatabaseQualifiedName

getDefaultSchemaQualifiedName

getInputToAirflowTasks

getInputToProcesses

getInputToSparkJobs

getIsPrivate

getIsProfiled

getIsSqlSnippet

getIsVisualQuery

getLastProfiledAt

getLongRawQuery

getModelImplementedAttributes

getModelImplementedEntities