com.atlan.model.assets.SigmaWorkbook

All Implemented Interfaces:: IAsset, IBI, ICatalog, IReferenceable, ISigma, ISigmaWorkbook, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class SigmaWorkbook extends Asset implements ISigmaWorkbook, ISigma, IBI, ICatalog, IAsset, IReferenceable

Instance of a Sigma workbook in Atlan.

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

SigmaWorkbook.SigmaWorkbookBuilder<C extends SigmaWorkbook,B extends SigmaWorkbook.SigmaWorkbookBuilder<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_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_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_ICON, 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_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_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.ICatalog
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

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.ISigma
SIGMA_DATA_ELEMENT_NAME, SIGMA_DATA_ELEMENT_QUALIFIED_NAME, SIGMA_PAGE_NAME, SIGMA_PAGE_QUALIFIED_NAME, SIGMA_WORKBOOK_NAME, SIGMA_WORKBOOK_QUALIFIED_NAME

Fields inherited from interface com.atlan.model.assets.ISigmaWorkbook
SIGMA_PAGE_COUNT, SIGMA_PAGES
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

SigmaWorkbook(SigmaWorkbook.SigmaWorkbookBuilder<?,?> b)
Method Summary

Modifier and Type

Method

Description

static SigmaWorkbook.SigmaWorkbookBuilder<?,?>

_internal()

static SigmaWorkbook

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

Deprecated.
see Asset.AssetBuilder.appendAtlanTags(List)

static SigmaWorkbook

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

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

static SigmaWorkbook

appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms)

Deprecated.
see Asset.AssetBuilder.appendAssignedTerm(GlossaryTerm)

protected boolean

canEqual(Object other)

boolean

equals(Object o)

static SigmaWorkbook

get(AtlanClient client, String id)

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

static SigmaWorkbook

get(AtlanClient client, String id, boolean includeAllRelationships)

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

static SigmaWorkbook

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

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

static SigmaWorkbook

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

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

SortedSet<IAirflowTask>

getInputToAirflowTasks()

Tasks to which this asset provides input.

SortedSet<ILineageProcess>

getInputToProcesses()

Processes to which this asset provides input.

SortedSet<ISparkJob>

getInputToSparkJobs()

TBC

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

String

getSigmaDataElementName()

Simple name of the data element in which this asset exists.

String

getSigmaDataElementQualifiedName()

Unique name of the data element in which this asset exists.

Long

getSigmaPageCount()

Number of pages in this workbook.

String

getSigmaPageName()

Simple name of the page on which this asset exists.

String

getSigmaPageQualifiedName()

Unique name of the page on which this asset exists.

SortedSet<ISigmaPage>

getSigmaPages()

Pages that exist in this workbook.

String

getSigmaWorkbookName()

Simple name of the workbook in which this asset exists.

String

getSigmaWorkbookQualifiedName()

Unique name of the workbook in which this asset exists.

String

getTypeName()

Fixed typeName for SigmaWorkbooks.

int

hashCode()

static SigmaWorkbook

refByGuid(String guid)

Reference to a SigmaWorkbook by GUID.

static SigmaWorkbook

refByGuid(String guid, Reference.SaveSemantic semantic)

Reference to a SigmaWorkbook by GUID.

static SigmaWorkbook

refByQualifiedName(String qualifiedName)

Reference to a SigmaWorkbook by qualifiedName.

static SigmaWorkbook

refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)

Reference to a SigmaWorkbook by qualifiedName.

static SigmaWorkbook

removeAnnouncement(AtlanClient client, String qualifiedName, String name)

Remove the announcement from a SigmaWorkbook.

static void

removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName)

Deprecated.
see Asset.AssetBuilder.removeAtlanTag(String)

static SigmaWorkbook

removeCertificate(AtlanClient client, String qualifiedName, String name)

Remove the certificate from a SigmaWorkbook.

static SigmaWorkbook

removeDescription(AtlanClient client, String qualifiedName, String name)

Remove the system description from a SigmaWorkbook.

static SigmaWorkbook

removeOwners(AtlanClient client, String qualifiedName, String name)

Remove the owners from a SigmaWorkbook.

static SigmaWorkbook

removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms)

Deprecated.
see Asset.AssetBuilder.removeAssignedTerm(GlossaryTerm)

static SigmaWorkbook

removeUserDescription(AtlanClient client, String qualifiedName, String name)

Remove the user's description from a SigmaWorkbook.

static SigmaWorkbook

replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms)

Replace the terms linked to the SigmaWorkbook.

static boolean

restore(AtlanClient client, String qualifiedName)

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

static FluentSearch.FluentSearchBuilder<?,?>

select(AtlanClient client)

Start a fluent search that will return all SigmaWorkbook assets.

static FluentSearch.FluentSearchBuilder<?,?>

select(AtlanClient client, boolean includeArchived)

Start a fluent search that will return all SigmaWorkbook assets.

SigmaWorkbook.SigmaWorkbookBuilder<?,?>

toBuilder()

String

toString()

SigmaWorkbook

trimToReference()

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

SigmaWorkbook.SigmaWorkbookBuilder<?,?>

trimToRequired()

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

static SigmaWorkbook

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

Update the announcement on a SigmaWorkbook.

static SigmaWorkbook

updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message)

Update the certificate on a SigmaWorkbook.

static SigmaWorkbook.SigmaWorkbookBuilder<?,?>

updater(String qualifiedName, String name)

Builds the minimal object necessary to update a SigmaWorkbook.

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, 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, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, 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, 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, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, 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.IBI
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, 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, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, 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, 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, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, 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.ISigma
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, 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, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, 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.ISigmaWorkbook
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, 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, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, 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
- SigmaWorkbook
  
  protected SigmaWorkbook(SigmaWorkbook.SigmaWorkbookBuilder<?,?> b)
Method Details
- trimToReference
  
  public SigmaWorkbook trimToReference() throws InvalidRequestException
  
  Builds the minimal object necessary to create a relationship to a SigmaWorkbook, from a potentially more-complete SigmaWorkbook object.
  
  Overrides:
  
  trimToReference in class Asset
  
  Returns:
  
  the minimal object necessary to relate to the SigmaWorkbook
  
  Throws:
  
  InvalidRequestException - if any of the minimal set of required properties for a SigmaWorkbook relationship are not found in the initial object
- select
  
  public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
  
  Start a fluent search that will return all SigmaWorkbook 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) SigmaWorkbook assets will be included.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to retrieve the assets
  
  Returns:
  
  a fluent search that includes all SigmaWorkbook assets
- select
  
  public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
  
  Start a fluent search that will return all SigmaWorkbook 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) SigmaWorkbooks will be included
  
  Returns:
  
  a fluent search that includes all SigmaWorkbook assets
- refByGuid
  
  public static SigmaWorkbook refByGuid(String guid)
  
  Reference to a SigmaWorkbook by GUID. Use this to create a relationship to this SigmaWorkbook, where the relationship should be replaced.
  
  Parameters:
  
  guid - the GUID of the SigmaWorkbook to reference
  
  Returns:
  
  reference to a SigmaWorkbook that can be used for defining a relationship to a SigmaWorkbook
- refByGuid
  
  public static SigmaWorkbook refByGuid(String guid, Reference.SaveSemantic semantic)
  
  Reference to a SigmaWorkbook by GUID. Use this to create a relationship to this SigmaWorkbook, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
  
  Parameters:
  
  guid - the GUID of the SigmaWorkbook to reference
  
  semantic - how to save this relationship (replace all with this, append it, or remove it)
  
  Returns:
  
  reference to a SigmaWorkbook that can be used for defining a relationship to a SigmaWorkbook
- refByQualifiedName
  
  public static SigmaWorkbook refByQualifiedName(String qualifiedName)
  
  Reference to a SigmaWorkbook by qualifiedName. Use this to create a relationship to this SigmaWorkbook, where the relationship should be replaced.
  
  Parameters:
  
  qualifiedName - the qualifiedName of the SigmaWorkbook to reference
  
  Returns:
  
  reference to a SigmaWorkbook that can be used for defining a relationship to a SigmaWorkbook
- refByQualifiedName
  
  public static SigmaWorkbook refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)
  
  Reference to a SigmaWorkbook by qualifiedName. Use this to create a relationship to this SigmaWorkbook, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
  
  Parameters:
  
  qualifiedName - the qualifiedName of the SigmaWorkbook to reference
  
  semantic - how to save this relationship (replace all with this, append it, or remove it)
  
  Returns:
  
  reference to a SigmaWorkbook that can be used for defining a relationship to a SigmaWorkbook
- get
  
  public static SigmaWorkbook get(AtlanClient client, String id) throws AtlanException
  
  Retrieves a SigmaWorkbook 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 SigmaWorkbook to retrieve, either its GUID or its full qualifiedName
  
  Returns:
  
  the requested full SigmaWorkbook, complete with all of its relationships
  
  Throws:
  
  AtlanException - on any error during the API invocation, such as the NotFoundException if the SigmaWorkbook does not exist or the provided GUID is not a SigmaWorkbook
- get
  
  public static SigmaWorkbook get(AtlanClient client, String id, boolean includeAllRelationships) throws AtlanException
  
  Retrieves a SigmaWorkbook 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 SigmaWorkbook 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 SigmaWorkbook, optionally complete with all of its relationships
  
  Throws:
  
  AtlanException - on any error during the API invocation, such as the NotFoundException if the SigmaWorkbook does not exist or the provided GUID is not a SigmaWorkbook
- get
  
  public static SigmaWorkbook get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException
  
  Retrieves a SigmaWorkbook 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 SigmaWorkbook to retrieve, either its GUID or its full qualifiedName
  
  attributes - to retrieve for the SigmaWorkbook, including any relationships
  
  Returns:
  
  the requested SigmaWorkbook, 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 SigmaWorkbook does not exist or the provided GUID is not a SigmaWorkbook
- get
  
  public static SigmaWorkbook get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException
  
  Retrieves a SigmaWorkbook 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 SigmaWorkbook to retrieve, either its GUID or its full qualifiedName
  
  attributes - to retrieve for the SigmaWorkbook, including any relationships
  
  attributesOnRelated - to retrieve on each relationship retrieved for the SigmaWorkbook
  
  Returns:
  
  the requested SigmaWorkbook, 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 SigmaWorkbook does not exist or the provided GUID is not a SigmaWorkbook
- restore
  
  public static boolean restore(AtlanClient client, String qualifiedName) throws AtlanException
  
  Restore the archived (soft-deleted) SigmaWorkbook to active.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to restore the asset
  
  qualifiedName - for the SigmaWorkbook
  
  Returns:
  
  true if the SigmaWorkbook is now active, and false otherwise
  
  Throws:
  
  AtlanException - on any API problems
- updater
  
  public static SigmaWorkbook.SigmaWorkbookBuilder<?,?> updater(String qualifiedName, String name)
  
  Builds the minimal object necessary to update a SigmaWorkbook.
  
  Parameters:
  
  qualifiedName - of the SigmaWorkbook
  
  name - of the SigmaWorkbook
  
  Returns:
  
  the minimal request necessary to update the SigmaWorkbook, as a builder
- trimToRequired
  
  public SigmaWorkbook.SigmaWorkbookBuilder<?,?> trimToRequired() throws InvalidRequestException
  
  Builds the minimal object necessary to apply an update to a SigmaWorkbook, from a potentially more-complete SigmaWorkbook object.
  
  Overrides:
  
  trimToRequired in class Asset
  
  Returns:
  
  the minimal object necessary to update the SigmaWorkbook, as a builder
  
  Throws:
  
  InvalidRequestException - if any of the minimal set of required properties for SigmaWorkbook are not found in the initial object
- removeDescription
  
  public static SigmaWorkbook removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the system description from a SigmaWorkbook.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to remove the asset's description
  
  qualifiedName - of the SigmaWorkbook
  
  name - of the SigmaWorkbook
  
  Returns:
  
  the updated SigmaWorkbook, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- removeUserDescription
  
  public static SigmaWorkbook removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the user's description from a SigmaWorkbook.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to remove the asset's description
  
  qualifiedName - of the SigmaWorkbook
  
  name - of the SigmaWorkbook
  
  Returns:
  
  the updated SigmaWorkbook, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- removeOwners
  
  public static SigmaWorkbook removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the owners from a SigmaWorkbook.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to remove the SigmaWorkbook's owners
  
  qualifiedName - of the SigmaWorkbook
  
  name - of the SigmaWorkbook
  
  Returns:
  
  the updated SigmaWorkbook, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- updateCertificate
  
  public static SigmaWorkbook updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
  
  Update the certificate on a SigmaWorkbook.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to update the SigmaWorkbook's certificate
  
  qualifiedName - of the SigmaWorkbook
  
  certificate - to use
  
  message - (optional) message, or null if no message
  
  Returns:
  
  the updated SigmaWorkbook, or null if the update failed
  
  Throws:
  
  AtlanException - on any API problems
- removeCertificate
  
  public static SigmaWorkbook removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the certificate from a SigmaWorkbook.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to remove the SigmaWorkbook's certificate
  
  qualifiedName - of the SigmaWorkbook
  
  name - of the SigmaWorkbook
  
  Returns:
  
  the updated SigmaWorkbook, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- updateAnnouncement
  
  public static SigmaWorkbook updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
  
  Update the announcement on a SigmaWorkbook.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to update the SigmaWorkbook's announcement
  
  qualifiedName - of the SigmaWorkbook
  
  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 result of the update, or null if the update failed
  
  Throws:
  
  AtlanException - on any API problems
- removeAnnouncement
  
  public static SigmaWorkbook removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the announcement from a SigmaWorkbook.
  
  Parameters:
  
  client - connectivity to the Atlan client from which to remove the SigmaWorkbook's announcement
  
  qualifiedName - of the SigmaWorkbook
  
  name - of the SigmaWorkbook
  
  Returns:
  
  the updated SigmaWorkbook, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- replaceTerms
  
  public static SigmaWorkbook replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
  
  Replace the terms linked to the SigmaWorkbook.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to replace the SigmaWorkbook's assigned terms
  
  qualifiedName - for the SigmaWorkbook
  
  name - human-readable name of the SigmaWorkbook
  
  terms - the list of terms to replace on the SigmaWorkbook, or null to remove all terms from the SigmaWorkbook
  
  Returns:
  
  the SigmaWorkbook that was updated (note that it will NOT contain details of the replaced terms)
  
  Throws:
  
  AtlanException - on any API problems
- appendTerms
  
  @Deprecated public static SigmaWorkbook appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
  
  Deprecated.
  see Asset.AssetBuilder.appendAssignedTerm(GlossaryTerm)
  
  Link additional terms to the SigmaWorkbook, without replacing existing terms linked to the SigmaWorkbook. Note: this operation must make two API calls — one to retrieve the SigmaWorkbook'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 SigmaWorkbook
  
  qualifiedName - for the SigmaWorkbook
  
  terms - the list of terms to append to the SigmaWorkbook
  
  Returns:
  
  the SigmaWorkbook that was updated (note that it will NOT contain details of the appended terms)
  
  Throws:
  
  AtlanException - on any API problems
- removeTerms
  
  @Deprecated public static SigmaWorkbook removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
  
  Deprecated.
  see Asset.AssetBuilder.removeAssignedTerm(GlossaryTerm)
  
  Remove terms from a SigmaWorkbook, without replacing all existing terms linked to the SigmaWorkbook. Note: this operation must make two API calls — one to retrieve the SigmaWorkbook'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 SigmaWorkbook
  
  qualifiedName - for the SigmaWorkbook
  
  terms - the list of terms to remove from the SigmaWorkbook, which must be referenced by GUID
  
  Returns:
  
  the SigmaWorkbook that was updated (note that it will NOT contain details of the resulting terms)
  
  Throws:
  
  AtlanException - on any API problems
- appendAtlanTags
  
  @Deprecated public static SigmaWorkbook appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
  
  Deprecated.
  see Asset.AssetBuilder.appendAtlanTags(List)
  
  Add Atlan tags to a SigmaWorkbook, without replacing existing Atlan tags linked to the SigmaWorkbook. Note: this operation must make two API calls — one to retrieve the SigmaWorkbook'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 SigmaWorkbook
  
  qualifiedName - of the SigmaWorkbook
  
  atlanTagNames - human-readable names of the Atlan tags to add
  
  Returns:
  
  the updated SigmaWorkbook
  
  Throws:
  
  AtlanException - on any API problems
- appendAtlanTags
  
  @Deprecated public static SigmaWorkbook 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 SigmaWorkbook, without replacing existing Atlan tags linked to the SigmaWorkbook. Note: this operation must make two API calls — one to retrieve the SigmaWorkbook'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 SigmaWorkbook
  
  qualifiedName - of the SigmaWorkbook
  
  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 SigmaWorkbook
  
  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 SigmaWorkbook.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to remove an Atlan tag from a SigmaWorkbook
  
  qualifiedName - of the SigmaWorkbook
  
  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 SigmaWorkbook
- _internal
  
  public static SigmaWorkbook.SigmaWorkbookBuilder<?,?> _internal()
- toBuilder
  
  public SigmaWorkbook.SigmaWorkbookBuilder<?,?> toBuilder()
  
  Overrides:
  
  toBuilder in class Reference
- getInputToAirflowTasks
  
  public SortedSet<IAirflowTask> getInputToAirflowTasks()
  
  Tasks to which this asset provides input.
  
  Specified by:
  
  getInputToAirflowTasks in interface IBI
  
  Specified by:
  
  getInputToAirflowTasks in interface ICatalog
  
  Specified by:
  
  getInputToAirflowTasks in interface ISigma
  
  Specified by:
  
  getInputToAirflowTasks in interface ISigmaWorkbook
- getInputToProcesses
  
  public SortedSet<ILineageProcess> getInputToProcesses()
  
  Processes to which this asset provides input.
  
  Specified by:
  
  getInputToProcesses in interface IBI
  
  Specified by:
  
  getInputToProcesses in interface ICatalog
  
  Specified by:
  
  getInputToProcesses in interface ISigma
  
  Specified by:
  
  getInputToProcesses in interface ISigmaWorkbook
- getInputToSparkJobs
  
  public SortedSet<ISparkJob> getInputToSparkJobs()
  
  TBC
  
  Specified by:
  
  getInputToSparkJobs in interface IBI
  
  Specified by:
  
  getInputToSparkJobs in interface ICatalog
  
  Specified by:
  
  getInputToSparkJobs in interface ISigma
  
  Specified by:
  
  getInputToSparkJobs in interface ISigmaWorkbook
- getModelImplementedAttributes
  
  public SortedSet<IModelAttribute> getModelImplementedAttributes()
  
  Attributes implemented by this asset.
  
  Specified by:
  
  getModelImplementedAttributes in interface IBI
  
  Specified by:
  
  getModelImplementedAttributes in interface ICatalog
  
  Specified by:
  
  getModelImplementedAttributes in interface ISigma
  
  Specified by:
  
  getModelImplementedAttributes in interface ISigmaWorkbook
- getModelImplementedEntities
  
  public SortedSet<IModelEntity> getModelImplementedEntities()
  
  Entities implemented by this asset.
  
  Specified by:
  
  getModelImplementedEntities in interface IBI
  
  Specified by:
  
  getModelImplementedEntities in interface ICatalog
  
  Specified by:
  
  getModelImplementedEntities in interface ISigma
  
  Specified by:
  
  getModelImplementedEntities in interface ISigmaWorkbook
- getOutputFromAirflowTasks
  
  public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
  
  Tasks from which this asset is output.
  
  Specified by:
  
  getOutputFromAirflowTasks in interface IBI
  
  Specified by:
  
  getOutputFromAirflowTasks in interface ICatalog
  
  Specified by:
  
  getOutputFromAirflowTasks in interface ISigma
  
  Specified by:
  
  getOutputFromAirflowTasks in interface ISigmaWorkbook
- getOutputFromProcesses
  
  public SortedSet<ILineageProcess> getOutputFromProcesses()
  
  Processes from which this asset is produced as output.
  
  Specified by:
  
  getOutputFromProcesses in interface IBI
  
  Specified by:
  
  getOutputFromProcesses in interface ICatalog
  
  Specified by:
  
  getOutputFromProcesses in interface ISigma
  
  Specified by:
  
  getOutputFromProcesses in interface ISigmaWorkbook
- getOutputFromSparkJobs
  
  public SortedSet<ISparkJob> getOutputFromSparkJobs()
  
  TBC
  
  Specified by:
  
  getOutputFromSparkJobs in interface IBI
  
  Specified by:
  
  getOutputFromSparkJobs in interface ICatalog
  
  Specified by:
  
  getOutputFromSparkJobs in interface ISigma
  
  Specified by:
  
  getOutputFromSparkJobs in interface ISigmaWorkbook
- getSigmaDataElementName
  
  public String getSigmaDataElementName()
  
  Simple name of the data element in which this asset exists.
  
  Specified by:
  
  getSigmaDataElementName in interface ISigma
  
  Specified by:
  
  getSigmaDataElementName in interface ISigmaWorkbook
- getSigmaDataElementQualifiedName
  
  public String getSigmaDataElementQualifiedName()
  
  Unique name of the data element in which this asset exists.
  
  Specified by:
  
  getSigmaDataElementQualifiedName in interface ISigma
  
  Specified by:
  
  getSigmaDataElementQualifiedName in interface ISigmaWorkbook
- getSigmaPageCount
  
  public Long getSigmaPageCount()
  
  Number of pages in this workbook.
  
  Specified by:
  
  getSigmaPageCount in interface ISigmaWorkbook
- getSigmaPageName
  
  public String getSigmaPageName()
  
  Simple name of the page on which this asset exists.
  
  Specified by:
  
  getSigmaPageName in interface ISigma
  
  Specified by:
  
  getSigmaPageName in interface ISigmaWorkbook
- getSigmaPageQualifiedName
  
  public String getSigmaPageQualifiedName()
  
  Unique name of the page on which this asset exists.
  
  Specified by:
  
  getSigmaPageQualifiedName in interface ISigma
  
  Specified by:
  
  getSigmaPageQualifiedName in interface ISigmaWorkbook
- getSigmaPages
  
  public SortedSet<ISigmaPage> getSigmaPages()
  
  Pages that exist in this workbook.
  
  Specified by:
  
  getSigmaPages in interface ISigmaWorkbook
- getSigmaWorkbookName
  
  public String getSigmaWorkbookName()
  
  Simple name of the workbook in which this asset exists.
  
  Specified by:
  
  getSigmaWorkbookName in interface ISigma
  
  Specified by:
  
  getSigmaWorkbookName in interface ISigmaWorkbook
- getSigmaWorkbookQualifiedName
  
  public String getSigmaWorkbookQualifiedName()
  
  Unique name of the workbook in which this asset exists.
  
  Specified by:
  
  getSigmaWorkbookQualifiedName in interface ISigma
  
  Specified by:
  
  getSigmaWorkbookQualifiedName in interface ISigmaWorkbook
- 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 SigmaWorkbooks.
  
  Specified by:
  
  getTypeName in interface AuditDetail
  
  Specified by:
  
  getTypeName in interface IAsset
  
  Specified by:
  
  getTypeName in interface IBI
  
  Specified by:
  
  getTypeName in interface ICatalog
  
  Specified by:
  
  getTypeName in interface IReferenceable
  
  Specified by:
  
  getTypeName in interface ISigma
  
  Specified by:
  
  getTypeName in interface ISigmaWorkbook
  
  Overrides:
  
  getTypeName in class Reference

Class SigmaWorkbook

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.ICatalog

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

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

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

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.IBI

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.ISigma

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

Field Details

TYPE_NAME

Constructor Details

SigmaWorkbook

Method Details

trimToReference

select

select

refByGuid

refByGuid

refByQualifiedName

refByQualifiedName

get

get

get

get

restore

updater

trimToRequired

removeDescription

removeUserDescription

removeOwners

updateCertificate

removeCertificate

updateAnnouncement

removeAnnouncement

replaceTerms

appendTerms

removeTerms

appendAtlanTags

appendAtlanTags

removeAtlanTag

_internal

toBuilder

getInputToAirflowTasks

getInputToProcesses

getInputToSparkJobs

getModelImplementedAttributes

getModelImplementedEntities

getOutputFromAirflowTasks

getOutputFromProcesses

getOutputFromSparkJobs

getSigmaDataElementName

getSigmaDataElementQualifiedName

getSigmaPageCount

getSigmaPageName

getSigmaPageQualifiedName

getSigmaPages

getSigmaWorkbookName

getSigmaWorkbookQualifiedName

equals

canEqual

hashCode

toString

getTypeName