Package com.atlan.model.assets
Class View
java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.View
- All Implemented Interfaces:
IAsset
,ICatalog
,IReferenceable
,ISQL
,IView
,AuditDetail
,Serializable
,Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2")
public class View
extends Asset
implements IView, ISQL, ICatalog, IAsset, IReferenceable
Instance of a database view in Atlan.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
View.ViewBuilder<C extends View,
B extends View.ViewBuilder<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 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, 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_ICON, 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_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_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_TAGS, ASSET_THEME_HEX, CERTIFICATE_STATUS, CERTIFICATE_STATUS_MESSAGE, CERTIFICATE_UPDATED_AT, CERTIFICATE_UPDATED_BY, CONNECTION_NAME, CONNECTION_QUALIFIED_NAME, CONNECTOR_TYPE, DATA_CONTRACT_LATEST, DATA_CONTRACT_LATEST_CERTIFIED, DBT_QUALIFIED_NAME, DESCRIPTION, DISPLAY_NAME, DOMAIN_GUIDS, 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, OWNER_GROUPS, OWNER_USERS, POPULARITY_SCORE, 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.ICatalog
APPLICATION_CONTAINER, ASSET_APPLICATION_QUALIFIED_NAME, INPUT_TO_AIRFLOW_TASKS, INPUT_TO_PROCESSES, INPUT_TO_SPARK_JOBS, MODEL_IMPLEMENTED_ENTITIES, OUTPUT_FROM_AIRFLOW_TASKS, OUTPUT_FROM_PROCESSES, OUTPUT_FROM_SPARK_JOBS
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_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_DBT_MODELS, SQL_DBT_SOURCES, TABLE_NAME, TABLE_QUALIFIED_NAME, VIEW_NAME, VIEW_QUALIFIED_NAME
Fields inherited from interface com.atlan.model.assets.IView
ALIAS, COLUMN_COUNT, COLUMNS, DEFINITION, IS_QUERY_PREVIEW, IS_TEMPORARY, QUERIES, QUERY_PREVIEW_CONFIG, ROW_COUNT, SCHEMA, SIZE_BYTES
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic View.ViewBuilder<?,
?> static View
appendAtlanTags
(AtlanClient client, String qualifiedName, List<String> atlanTagNames) Add Atlan tags to a View, without replacing existing Atlan tags linked to the View.static View
appendAtlanTags
(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) Add Atlan tags to a View, without replacing existing Atlan tags linked to the View.static View
appendAtlanTags
(String qualifiedName, List<String> atlanTagNames) Add Atlan tags to a View, without replacing existing Atlan tags linked to the View.static View
appendAtlanTags
(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) Add Atlan tags to a View, without replacing existing Atlan tags linked to the View.static View
appendTerms
(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Link additional terms to the View, without replacing existing terms linked to the View.static View
appendTerms
(String qualifiedName, List<IGlossaryTerm> terms) Link additional terms to the View, without replacing existing terms linked to the View.protected boolean
static View.ViewBuilder<?,
?> Builds the minimal object necessary to create a view.static View.ViewBuilder<?,
?> Builds the minimal object necessary to create a view.static View.ViewBuilder<?,
?> creator
(String name, String connectionQualifiedName, String databaseName, String databaseQualifiedName, String schemaName, String schemaQualifiedName) Builds the minimal object necessary to create a view.boolean
static String
generateQualifiedName
(String name, String schemaQualifiedName) Generate a unique view name.static View
get
(AtlanClient client, String id) Retrieves a View by one of its identifiers, complete with all of its relationships.static View
get
(AtlanClient client, String id, boolean includeRelationships) Retrieves a View by one of its identifiers, optionally complete with all of its relationships.static View
Retrieves a View by one of its identifiers, complete with all of its relationships.getAlias()
Alias for this view.ApplicationContainer asset containing this Catalog asset.Qualified name of the Application Container that contains this asset.Simple name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.Unique name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.Number of columns in this view.Columns that exist within this view.Simple name of the database in which this SQL asset exists, or empty if it does not exist within a database.Unique name of the database in which this SQL asset exists, or empty if it does not exist within a database.TBCTBCTBCSQL definition of this view.Tasks to which this asset provides input.Processes to which this asset provides input.TBCWhether this asset has been profiled (true) or not (false).Whether preview queries are allowed on this view (true) or not (false).Whether this view is temporary (true) or not (false).Time (epoch) at which this asset was last profiled, in milliseconds.Entities implemented by this asset.Tasks from which this asset is output.Processes from which this asset is produced as output.TBCQueries that access this view.Number of times this asset has been queried.Time (epoch) at which the query count was last updated, in milliseconds.Configuration for preview queries on this view.Number of unique users who have queried this asset.Map of unique users who have queried this asset to the number of times they have queried it.Number of rows in this view.Schema in which this view exists.Simple name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.Unique name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.Size of this view, in bytes.TBCTBCSimple name of the table in which this SQL asset exists, or empty if it does not exist within a table.Unique name of the table in which this SQL asset exists, or empty if it does not exist within a table.Fixed typeName for Views.Simple name of the view in which this SQL asset exists, or empty if it does not exist within a view.Unique name of the view in which this SQL asset exists, or empty if it does not exist within a view.int
hashCode()
static View
Reference to a View by GUID.static View
refByGuid
(String guid, Reference.SaveSemantic semantic) Reference to a View by GUID.static View
refByQualifiedName
(String qualifiedName) Reference to a View by qualifiedName.static View
refByQualifiedName
(String qualifiedName, Reference.SaveSemantic semantic) Reference to a View by qualifiedName.static View
removeAnnouncement
(AtlanClient client, String qualifiedName, String name) Remove the announcement from a View.static View
removeAnnouncement
(String qualifiedName, String name) Remove the announcement from a View.static void
removeAtlanTag
(AtlanClient client, String qualifiedName, String atlanTagName) Remove an Atlan tag from a View.static void
removeAtlanTag
(String qualifiedName, String atlanTagName) Remove an Atlan tag from a View.static View
removeCertificate
(AtlanClient client, String qualifiedName, String name) Remove the certificate from a View.static View
removeCertificate
(String qualifiedName, String name) Remove the certificate from a View.static View
removeDescription
(AtlanClient client, String qualifiedName, String name) Remove the system description from a View.static View
removeDescription
(String qualifiedName, String name) Remove the system description from a View.static View
removeOwners
(AtlanClient client, String qualifiedName, String name) Remove the owners from a View.static View
removeOwners
(String qualifiedName, String name) Remove the owners from a View.static View
removeTerms
(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Remove terms from a View, without replacing all existing terms linked to the View.static View
removeTerms
(String qualifiedName, List<IGlossaryTerm> terms) Remove terms from a View, without replacing all existing terms linked to the View.static View
removeUserDescription
(AtlanClient client, String qualifiedName, String name) Remove the user's description from a View.static View
removeUserDescription
(String qualifiedName, String name) Remove the user's description from a View.static View
replaceTerms
(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the View.static View
replaceTerms
(String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the View.static boolean
restore
(AtlanClient client, String qualifiedName) Restore the archived (soft-deleted) View to active.static boolean
Restore the archived (soft-deleted) View to active.static FluentSearch.FluentSearchBuilder<?,
?> select()
Start a fluent search that will return all View assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(boolean includeArchived) Start a fluent search that will return all View assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(AtlanClient client) Start a fluent search that will return all View assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(AtlanClient client, boolean includeArchived) Start a fluent search that will return all View assets.View.ViewBuilder<?,
?> toString()
Builds the minimal object necessary to create a relationship to a View, from a potentially more-complete View object.View.ViewBuilder<?,
?> Builds the minimal object necessary to apply an update to a View, from a potentially more-complete View object.static View
updateAnnouncement
(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a View.static View
updateAnnouncement
(String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a View.static View
updateCertificate
(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a View.static View
updateCertificate
(String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a View.static View.ViewBuilder<?,
?> Builds the minimal object necessary to update a View.Methods inherited from class com.atlan.model.assets.Asset
addApiTokenAsAdmin, appendAtlanTags, appendAtlanTags, appendTerms, delete, delete, get, getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, 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, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getAtlanTagNames, getAtlanTags, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getCreatedBy, getCreateTime, getCustomMetadata, getCustomMetadataSets, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDeleteHandler, getDepth, getDescription, getDisplayName, getDomainGUIDs, getFiles, getHasContract, getHasLineage, getImmediateDownstream, getImmediateUpstream, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsIncomplete, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMeaningNames, getMeanings, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getNullFields, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPendingTasks, getPopularityScore, 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, lineage, lineage, purge, purge, removeAnnouncement, removeAtlanTag, removeCertificate, removeCustomMetadata, removeCustomMetadata, removeDescription, removeOwners, removeTerms, removeUserDescription, replaceCustomMetadata, replaceCustomMetadata, replaceTerms, requestLineage, requestLineage, restore, save, save, save, save, saveMergingCM, saveMergingCM, saveReplacingCM, saveReplacingCM, updateAnnouncement, updateAnnouncement, updateCertificate, updateCertificate, updateCustomMetadataAttributes, updateCustomMetadataAttributes, updateMergingCM, updateMergingCM, updateReplacingCM, updateReplacingCM
Methods inherited from class com.atlan.model.relations.Reference
builder, by, compareTo, getCompleteObject, getCustomAttributes, getDisplayText, getEntityStatus, getGuid, getLabels, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, 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, 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, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPopularityScore, 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, 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, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPopularityScore, 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, 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, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPopularityScore, 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.IView
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, 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, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPopularityScore, 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
- See Also:
-
-
Constructor Details
-
View
-
-
Method Details
-
trimToReference
Builds the minimal object necessary to create a relationship to a View, from a potentially more-complete View object.- Overrides:
trimToReference
in classAsset
- Returns:
- the minimal object necessary to relate to the View
- Throws:
InvalidRequestException
- if any of the minimal set of required properties for a View relationship are not found in the initial object
-
select
Start a fluent search that will return all View 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) View assets will be included.- Returns:
- a fluent search that includes all View assets
-
select
Start a fluent search that will return all View 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) View assets will be included.- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assets- Returns:
- a fluent search that includes all View assets
-
select
Start a fluent search that will return all View 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:
includeArchived
- when true, archived (soft-deleted) Views will be included- Returns:
- a fluent search that includes all View assets
-
select
public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived) Start a fluent search that will return all View 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 assetsincludeArchived
- when true, archived (soft-deleted) Views will be included- Returns:
- a fluent search that includes all View assets
-
refByGuid
Reference to a View by GUID. Use this to create a relationship to this View, where the relationship should be replaced.- Parameters:
guid
- the GUID of the View to reference- Returns:
- reference to a View that can be used for defining a relationship to a View
-
refByGuid
Reference to a View by GUID. Use this to create a relationship to this View, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
guid
- the GUID of the View to referencesemantic
- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a View that can be used for defining a relationship to a View
-
refByQualifiedName
Reference to a View by qualifiedName. Use this to create a relationship to this View, where the relationship should be replaced.- Parameters:
qualifiedName
- the qualifiedName of the View to reference- Returns:
- reference to a View that can be used for defining a relationship to a View
-
refByQualifiedName
Reference to a View by qualifiedName. Use this to create a relationship to this View, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
qualifiedName
- the qualifiedName of the View to referencesemantic
- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a View that can be used for defining a relationship to a View
-
get
Retrieves a View by one of its identifiers, complete with all of its relationships.- Parameters:
id
- of the View to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full View, complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the View does not exist or the provided GUID is not a View
-
get
Retrieves a View by one of its identifiers, complete with all of its relationships.- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assetid
- of the View to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full View, complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the View does not exist or the provided GUID is not a View
-
get
public static View get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException Retrieves a View by one of its identifiers, optionally complete with all of its relationships.- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assetid
- of the View to retrieve, either its GUID or its full qualifiedNameincludeRelationships
- if true, all of the asset's relationships will also be retrieved; if false, no relationships will be retrieved- Returns:
- the requested full View, optionally complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the View does not exist or the provided GUID is not a View
-
restore
Restore the archived (soft-deleted) View to active.- Parameters:
qualifiedName
- for the View- Returns:
- true if the View is now active, and false otherwise
- Throws:
AtlanException
- on any API problems
-
restore
Restore the archived (soft-deleted) View to active.- Parameters:
client
- connectivity to the Atlan tenant on which to restore the assetqualifiedName
- for the View- Returns:
- true if the View is now active, and false otherwise
- Throws:
AtlanException
- on any API problems
-
creator
public static View.ViewBuilder<?,?> creator(String name, Schema schema) throws InvalidRequestException Builds the minimal object necessary to create a view.- Parameters:
name
- of the viewschema
- in which the view should be created, which must have at least a qualifiedName- Returns:
- the minimal request necessary to create the view, as a builder
- Throws:
InvalidRequestException
- if the schema provided is without a qualifiedName
-
creator
Builds the minimal object necessary to create a view.- Parameters:
name
- of the viewschemaQualifiedName
- unique name of the schema in which this view exists- Returns:
- the minimal request necessary to create the view, as a builder
-
creator
public static View.ViewBuilder<?,?> creator(String name, String connectionQualifiedName, String databaseName, String databaseQualifiedName, String schemaName, String schemaQualifiedName) Builds the minimal object necessary to create a view.- Parameters:
name
- of the viewconnectionQualifiedName
- unique name of the connection in which to create the ViewdatabaseName
- simple name of the Database in which to create the ViewdatabaseQualifiedName
- unique name of the Database in which to create the ViewschemaName
- simple name of the Schema in which to create the ViewschemaQualifiedName
- unique name of the Schema in which to create the View- Returns:
- the minimal request necessary to create the view, as a builder
-
generateQualifiedName
Generate a unique view name.- Parameters:
name
- of the viewschemaQualifiedName
- unique name of the schema in which this view exists- Returns:
- a unique name for the view
-
updater
Builds the minimal object necessary to update a View.- Parameters:
qualifiedName
- of the Viewname
- of the View- Returns:
- the minimal request necessary to update the View, as a builder
-
trimToRequired
Builds the minimal object necessary to apply an update to a View, from a potentially more-complete View object.- Overrides:
trimToRequired
in classAsset
- Returns:
- the minimal object necessary to update the View, as a builder
- Throws:
InvalidRequestException
- if any of the minimal set of required properties for View are not found in the initial object
-
removeDescription
Remove the system description from a View.- Parameters:
qualifiedName
- of the Viewname
- of the View- Returns:
- the updated View, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeDescription
public static View removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the system description from a View.- Parameters:
client
- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName
- of the Viewname
- of the View- Returns:
- the updated View, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeUserDescription
Remove the user's description from a View.- Parameters:
qualifiedName
- of the Viewname
- of the View- Returns:
- the updated View, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeUserDescription
public static View removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the user's description from a View.- Parameters:
client
- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName
- of the Viewname
- of the View- Returns:
- the updated View, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeOwners
Remove the owners from a View.- Parameters:
qualifiedName
- of the Viewname
- of the View- Returns:
- the updated View, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeOwners
public static View removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the owners from a View.- Parameters:
client
- connectivity to the Atlan tenant from which to remove the View's ownersqualifiedName
- of the Viewname
- of the View- Returns:
- the updated View, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
updateCertificate
public static View updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a View.- Parameters:
qualifiedName
- of the Viewcertificate
- to usemessage
- (optional) message, or null if no message- Returns:
- the updated View, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
updateCertificate
public static View updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a View.- Parameters:
client
- connectivity to the Atlan tenant on which to update the View's certificatequalifiedName
- of the Viewcertificate
- to usemessage
- (optional) message, or null if no message- Returns:
- the updated View, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
removeCertificate
Remove the certificate from a View.- Parameters:
qualifiedName
- of the Viewname
- of the View- Returns:
- the updated View, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeCertificate
public static View removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the certificate from a View.- Parameters:
client
- connectivity to the Atlan tenant from which to remove the View's certificatequalifiedName
- of the Viewname
- of the View- Returns:
- the updated View, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
updateAnnouncement
public static View updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a View.- Parameters:
qualifiedName
- of the Viewtype
- type of announcement to settitle
- (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 result of the update, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
updateAnnouncement
public static View updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a View.- Parameters:
client
- connectivity to the Atlan tenant on which to update the View's announcementqualifiedName
- of the Viewtype
- type of announcement to settitle
- (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 result of the update, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
removeAnnouncement
Remove the announcement from a View.- Parameters:
qualifiedName
- of the Viewname
- of the View- Returns:
- the updated View, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeAnnouncement
public static View removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the announcement from a View.- Parameters:
client
- connectivity to the Atlan client from which to remove the View's announcementqualifiedName
- of the Viewname
- of the View- Returns:
- the updated View, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
replaceTerms
public static View replaceTerms(String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the View.- Parameters:
qualifiedName
- for the Viewname
- human-readable name of the Viewterms
- the list of terms to replace on the View, or null to remove all terms from the View- Returns:
- the View that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException
- on any API problems
-
replaceTerms
public static View replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the View.- Parameters:
client
- connectivity to the Atlan tenant on which to replace the View's assigned termsqualifiedName
- for the Viewname
- human-readable name of the Viewterms
- the list of terms to replace on the View, or null to remove all terms from the View- Returns:
- the View that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException
- on any API problems
-
appendTerms
public static View appendTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Link additional terms to the View, without replacing existing terms linked to the View. Note: this operation must make two API calls — one to retrieve the View's existing terms, and a second to append the new terms.- Parameters:
qualifiedName
- for the Viewterms
- the list of terms to append to the View- Returns:
- the View that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException
- on any API problems
-
appendTerms
public static View appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Link additional terms to the View, without replacing existing terms linked to the View. Note: this operation must make two API calls — one to retrieve the View's existing terms, and a second to append the new terms.- Parameters:
client
- connectivity to the Atlan tenant on which to append terms to the ViewqualifiedName
- for the Viewterms
- the list of terms to append to the View- Returns:
- the View that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException
- on any API problems
-
removeTerms
public static View removeTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Remove terms from a View, without replacing all existing terms linked to the View. Note: this operation must make two API calls — one to retrieve the View's existing terms, and a second to remove the provided terms.- Parameters:
qualifiedName
- for the Viewterms
- the list of terms to remove from the View, which must be referenced by GUID- Returns:
- the View that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException
- on any API problems
-
removeTerms
public static View removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Remove terms from a View, without replacing all existing terms linked to the View. Note: this operation must make two API calls — one to retrieve the View's existing terms, and a second to remove the provided terms.- Parameters:
client
- connectivity to the Atlan tenant from which to remove terms from the ViewqualifiedName
- for the Viewterms
- the list of terms to remove from the View, which must be referenced by GUID- Returns:
- the View that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static View appendAtlanTags(String qualifiedName, List<String> atlanTagNames) throws AtlanException Add Atlan tags to a View, without replacing existing Atlan tags linked to the View. Note: this operation must make two API calls — one to retrieve the View's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
qualifiedName
- of the ViewatlanTagNames
- human-readable names of the Atlan tags to add- Returns:
- the updated View
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static View appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException Add Atlan tags to a View, without replacing existing Atlan tags linked to the View. Note: this operation must make two API calls — one to retrieve the View'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 ViewqualifiedName
- of the ViewatlanTagNames
- human-readable names of the Atlan tags to add- Returns:
- the updated View
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static View appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a View, without replacing existing Atlan tags linked to the View. Note: this operation must make two API calls — one to retrieve the View's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
qualifiedName
- of the ViewatlanTagNames
- human-readable names of the Atlan tags to addpropagate
- 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 View
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static View appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a View, without replacing existing Atlan tags linked to the View. Note: this operation must make two API calls — one to retrieve the View'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 ViewqualifiedName
- of the ViewatlanTagNames
- human-readable names of the Atlan tags to addpropagate
- 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 View
- Throws:
AtlanException
- on any API problems
-
removeAtlanTag
Remove an Atlan tag from a View.- Parameters:
qualifiedName
- of the ViewatlanTagName
- 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 View
-
removeAtlanTag
public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException Remove an Atlan tag from a View.- Parameters:
client
- connectivity to the Atlan tenant from which to remove an Atlan tag from a ViewqualifiedName
- of the ViewatlanTagName
- 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 View
-
_internal
-
toBuilder
-
getAlias
Alias for this view. -
getApplicationContainer
ApplicationContainer asset containing this Catalog asset.- Specified by:
getApplicationContainer
in interfaceICatalog
- Specified by:
getApplicationContainer
in interfaceISQL
- Specified by:
getApplicationContainer
in interfaceIView
-
getAssetApplicationQualifiedName
Qualified name of the Application Container that contains this asset.- Specified by:
getAssetApplicationQualifiedName
in interfaceICatalog
- Specified by:
getAssetApplicationQualifiedName
in interfaceISQL
- Specified by:
getAssetApplicationQualifiedName
in interfaceIView
-
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 interfaceISQL
- Specified by:
getCalculationViewName
in interfaceIView
-
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 interfaceISQL
- Specified by:
getCalculationViewQualifiedName
in interfaceIView
-
getColumnCount
Number of columns in this view.- Specified by:
getColumnCount
in interfaceIView
-
getColumns
Columns that exist within this view.- Specified by:
getColumns
in interfaceIView
-
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 interfaceISQL
- Specified by:
getDatabaseName
in interfaceIView
-
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 interfaceISQL
- Specified by:
getDatabaseQualifiedName
in interfaceIView
-
getDbtModels
TBC- Specified by:
getDbtModels
in interfaceISQL
- Specified by:
getDbtModels
in interfaceIView
-
getDbtSources
TBC- Specified by:
getDbtSources
in interfaceISQL
- Specified by:
getDbtSources
in interfaceIView
-
getDbtTests
TBC- Specified by:
getDbtTests
in interfaceISQL
- Specified by:
getDbtTests
in interfaceIView
-
getDefinition
SQL definition of this view.- Specified by:
getDefinition
in interfaceIView
-
getInputToAirflowTasks
Tasks to which this asset provides input.- Specified by:
getInputToAirflowTasks
in interfaceICatalog
- Specified by:
getInputToAirflowTasks
in interfaceISQL
- Specified by:
getInputToAirflowTasks
in interfaceIView
-
getInputToProcesses
Processes to which this asset provides input.- Specified by:
getInputToProcesses
in interfaceICatalog
- Specified by:
getInputToProcesses
in interfaceISQL
- Specified by:
getInputToProcesses
in interfaceIView
-
getInputToSparkJobs
TBC- Specified by:
getInputToSparkJobs
in interfaceICatalog
- Specified by:
getInputToSparkJobs
in interfaceISQL
- Specified by:
getInputToSparkJobs
in interfaceIView
-
getIsProfiled
Whether this asset has been profiled (true) or not (false).- Specified by:
getIsProfiled
in interfaceISQL
- Specified by:
getIsProfiled
in interfaceIView
-
getIsQueryPreview
Whether preview queries are allowed on this view (true) or not (false).- Specified by:
getIsQueryPreview
in interfaceIView
-
getIsTemporary
Whether this view is temporary (true) or not (false).- Specified by:
getIsTemporary
in interfaceIView
-
getLastProfiledAt
Time (epoch) at which this asset was last profiled, in milliseconds.- Specified by:
getLastProfiledAt
in interfaceISQL
- Specified by:
getLastProfiledAt
in interfaceIView
-
getModelImplementedEntities
Entities implemented by this asset.- Specified by:
getModelImplementedEntities
in interfaceICatalog
- Specified by:
getModelImplementedEntities
in interfaceISQL
- Specified by:
getModelImplementedEntities
in interfaceIView
-
getOutputFromAirflowTasks
Tasks from which this asset is output.- Specified by:
getOutputFromAirflowTasks
in interfaceICatalog
- Specified by:
getOutputFromAirflowTasks
in interfaceISQL
- Specified by:
getOutputFromAirflowTasks
in interfaceIView
-
getOutputFromProcesses
Processes from which this asset is produced as output.- Specified by:
getOutputFromProcesses
in interfaceICatalog
- Specified by:
getOutputFromProcesses
in interfaceISQL
- Specified by:
getOutputFromProcesses
in interfaceIView
-
getOutputFromSparkJobs
TBC- Specified by:
getOutputFromSparkJobs
in interfaceICatalog
- Specified by:
getOutputFromSparkJobs
in interfaceISQL
- Specified by:
getOutputFromSparkJobs
in interfaceIView
-
getQueries
Queries that access this view.- Specified by:
getQueries
in interfaceIView
-
getQueryCount
Number of times this asset has been queried.- Specified by:
getQueryCount
in interfaceISQL
- Specified by:
getQueryCount
in interfaceIView
-
getQueryCountUpdatedAt
Time (epoch) at which the query count was last updated, in milliseconds.- Specified by:
getQueryCountUpdatedAt
in interfaceISQL
- Specified by:
getQueryCountUpdatedAt
in interfaceIView
-
getQueryPreviewConfig
Configuration for preview queries on this view.- Specified by:
getQueryPreviewConfig
in interfaceIView
-
getQueryUserCount
Number of unique users who have queried this asset.- Specified by:
getQueryUserCount
in interfaceISQL
- Specified by:
getQueryUserCount
in interfaceIView
-
getQueryUserMap
Map of unique users who have queried this asset to the number of times they have queried it.- Specified by:
getQueryUserMap
in interfaceISQL
- Specified by:
getQueryUserMap
in interfaceIView
-
getRowCount
Number of rows in this view.- Specified by:
getRowCount
in interfaceIView
-
getSchema
Schema in which this view exists. -
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 interfaceISQL
- Specified by:
getSchemaName
in interfaceIView
-
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 interfaceISQL
- Specified by:
getSchemaQualifiedName
in interfaceIView
-
getSizeBytes
Size of this view, in bytes.- Specified by:
getSizeBytes
in interfaceIView
-
getSqlDBTSources
TBC- Specified by:
getSqlDBTSources
in interfaceISQL
- Specified by:
getSqlDBTSources
in interfaceIView
-
getSqlDbtModels
TBC- Specified by:
getSqlDbtModels
in interfaceISQL
- Specified by:
getSqlDbtModels
in interfaceIView
-
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 interfaceISQL
- Specified by:
getTableName
in interfaceIView
-
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 interfaceISQL
- Specified by:
getTableQualifiedName
in interfaceIView
-
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 interfaceISQL
- Specified by:
getViewName
in interfaceIView
-
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 interfaceISQL
- Specified by:
getViewQualifiedName
in interfaceIView
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
Description copied from class:AtlanObject
-
getTypeName
Fixed typeName for Views.- Specified by:
getTypeName
in interfaceAuditDetail
- Specified by:
getTypeName
in interfaceIAsset
- Specified by:
getTypeName
in interfaceICatalog
- Specified by:
getTypeName
in interfaceIReferenceable
- Specified by:
getTypeName
in interfaceISQL
- Specified by:
getTypeName
in interfaceIView
- Overrides:
getTypeName
in classReference
-