Package com.atlan.model.assets

Class Procedure

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.relations.Reference

com.atlan.model.assets.Asset

com.atlan.model.assets.Procedure

All Implemented Interfaces:

IAsset, ICatalog, IProcedure, IReferenceable, ISQL, AuditDetail, Serializable, Comparable<Reference>

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

Instance of a stored procedure (routine) in Atlan.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Procedure.ProcedureBuilder<C extends Procedure,B extends Procedure.ProcedureBuilder<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_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_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_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_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

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

DEFINITION, SCHEMA

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Procedure(Procedure.ProcedureBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static Procedure.ProcedureBuilder<?,?>	_internal()
static Procedure	appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames)	Add Atlan tags to a Procedure, without replacing existing Atlan tags linked to the Procedure.
static Procedure	appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation)	Add Atlan tags to a Procedure, without replacing existing Atlan tags linked to the Procedure.
static Procedure	appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms)	Link additional terms to the Procedure, without replacing existing terms linked to the Procedure.
protected boolean	canEqual(Object other)
static Procedure.ProcedureBuilder<?,?>	creator(String name, String definition, Schema schema)	Builds the minimal object necessary to create a procedure.
static Procedure.ProcedureBuilder<?,?>	creator(String name, String definition, String schemaQualifiedName)	Builds the minimal object necessary to create a procedure.
static Procedure.ProcedureBuilder<?,?>	creator(String name, String definition, String connectionQualifiedName, String databaseName, String databaseQualifiedName, String schemaName, String schemaQualifiedName)	Builds the minimal object necessary to create a procedure.
boolean	equals(Object o)
static String	generateQualifiedName(String name, String schemaQualifiedName)	Generate a unique table name.
static Procedure	get(AtlanClient client, String id)	Retrieves a Procedure by one of its identifiers, complete with all of its relationships.
static Procedure	get(AtlanClient client, String id, boolean includeAllRelationships)	Retrieves a Procedure by one of its identifiers, optionally complete with all of its relationships.
static Procedure	get(AtlanClient client, String id, Collection<AtlanField> attributes)	Retrieves a Procedure by one of its identifiers, with only the requested attributes (and relationships).
static Procedure	get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated)	Retrieves a Procedure by one of its identifiers, with only the requested attributes (and relationships).
String	getCalculationViewName()	Simple name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.
String	getCalculationViewQualifiedName()	Unique name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.
String	getDatabaseName()	Simple name of the database in which this SQL asset exists, or empty if it does not exist within a database.
String	getDatabaseQualifiedName()	Unique name of the database in which this SQL asset exists, or empty if it does not exist within a database.
SortedSet<IDbtModel>	getDbtModels()	TBC
SortedSet<IDbtSource>	getDbtSources()	TBC
SortedSet<IDbtTest>	getDbtTests()	TBC
String	getDefinition()	SQL definition of the procedure.
SortedSet<IAirflowTask>	getInputToAirflowTasks()	Tasks to which this asset provides input.
SortedSet<ILineageProcess>	getInputToProcesses()	Processes to which this asset provides input.
SortedSet<ISparkJob>	getInputToSparkJobs()	TBC
Boolean	getIsProfiled()	Whether this asset has been profiled (true) or not (false).
Long	getLastProfiledAt()	Time (epoch) at which this asset was last profiled, in milliseconds.
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
Long	getQueryCount()	Number of times this asset has been queried.
Long	getQueryCountUpdatedAt()	Time (epoch) at which the query count was last updated, in milliseconds.
Long	getQueryUserCount()	Number of unique users who have queried this asset.
Map<String,Long>	getQueryUserMap()	Map of unique users who have queried this asset to the number of times they have queried it.
ISchema	getSchema()	Schema in which this stored procedure exists.
String	getSchemaName()	Simple name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.
String	getSchemaQualifiedName()	Unique name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.
SortedSet<IDbtModel>	getSqlDbtModels()	TBC
SortedSet<IDbtSource>	getSqlDBTSources()	TBC
String	getTableName()	Simple name of the table in which this SQL asset exists, or empty if it does not exist within a table.
String	getTableQualifiedName()	Unique name of the table in which this SQL asset exists, or empty if it does not exist within a table.
String	getTypeName()	Fixed typeName for Procedures.
String	getViewName()	Simple name of the view in which this SQL asset exists, or empty if it does not exist within a view.
String	getViewQualifiedName()	Unique name of the view in which this SQL asset exists, or empty if it does not exist within a view.
int	hashCode()
static Procedure	refByGuid(String guid)	Reference to a Procedure by GUID.
static Procedure	refByGuid(String guid, Reference.SaveSemantic semantic)	Reference to a Procedure by GUID.
static Procedure	refByQualifiedName(String qualifiedName)	Reference to a Procedure by qualifiedName.
static Procedure	refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)	Reference to a Procedure by qualifiedName.
static Procedure	removeAnnouncement(AtlanClient client, String qualifiedName, String name)	Remove the announcement from a Procedure.
static void	removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName)	Remove an Atlan tag from a Procedure.
static Procedure	removeCertificate(AtlanClient client, String qualifiedName, String name)	Remove the certificate from a Procedure.
static Procedure	removeDescription(AtlanClient client, String qualifiedName, String name)	Remove the system description from a Procedure.
static Procedure	removeOwners(AtlanClient client, String qualifiedName, String name)	Remove the owners from a Procedure.
static Procedure	removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms)	Remove terms from a Procedure, without replacing all existing terms linked to the Procedure.
static Procedure	removeUserDescription(AtlanClient client, String qualifiedName, String name)	Remove the user's description from a Procedure.
static Procedure	replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms)	Replace the terms linked to the Procedure.
static boolean	restore(AtlanClient client, String qualifiedName)	Restore the archived (soft-deleted) Procedure to active.
static FluentSearch.FluentSearchBuilder<?,?>	select(AtlanClient client)	Start a fluent search that will return all Procedure assets.
static FluentSearch.FluentSearchBuilder<?,?>	select(AtlanClient client, boolean includeArchived)	Start a fluent search that will return all Procedure assets.
Procedure.ProcedureBuilder<?,?>	toBuilder()
String	toString()
Procedure	trimToReference()	Builds the minimal object necessary to create a relationship to a Procedure, from a potentially more-complete Procedure object.
Procedure.ProcedureBuilder<?,?>	trimToRequired()	Builds the minimal object necessary to apply an update to a Procedure, from a potentially more-complete Procedure object.
static Procedure	updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message)	Update the announcement on a Procedure.
static Procedure	updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message)	Update the certificate on a Procedure.
static Procedure.ProcedureBuilder<?,?>	updater(String qualifiedName, String name)	Builds the minimal object necessary to update a Procedure.

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, 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, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, 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, purge, removeAnnouncement, removeAtlanTag, removeCertificate, removeCustomMetadata, removeDescription, removeOwners, removeTerms, removeUserDescription, replaceCustomMetadata, replaceTerms, requestLineage, restore, save, save, saveMergingCM, saveReplacingCM, updateAnnouncement, updateAnnouncement, updateCertificate, updateCertificate, updateCustomMetadataAttributes, updateMergingCM, 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, getApplication, 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, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, 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, getApplication, 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, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, 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.IProcedure

getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, 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, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, 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, getApplication, 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, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, 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

public static final String TYPE_NAME

See Also:

• Constant Field Values

Constructor Details

Procedure

protected Procedure(Procedure.ProcedureBuilder<?,?> b)

Method Details

trimToReference

public Procedure trimToReference()
                          throws InvalidRequestException

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

Overrides:

trimToReference in class Asset

Returns:

the minimal object necessary to relate to the Procedure

Throws:

InvalidRequestException - if any of the minimal set of required properties for a Procedure relationship are not found in the initial object

select

public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)

Start a fluent search that will return all Procedure 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) Procedure assets will be included.

Parameters:

client - connectivity to the Atlan tenant from which to retrieve the assets

Returns:

a fluent search that includes all Procedure assets

select

public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client,
 boolean includeArchived)

Start a fluent search that will return all Procedure 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) Procedures will be included

Returns:

a fluent search that includes all Procedure assets

refByGuid

public static Procedure refByGuid(String guid)

Reference to a Procedure by GUID. Use this to create a relationship to this Procedure, where the relationship should be replaced.

Parameters:

guid - the GUID of the Procedure to reference

Returns:

reference to a Procedure that can be used for defining a relationship to a Procedure

refByGuid

public static Procedure refByGuid(String guid,
 Reference.SaveSemantic semantic)

Reference to a Procedure by GUID. Use this to create a relationship to this Procedure, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).

Parameters:

guid - the GUID of the Procedure to reference

semantic - how to save this relationship (replace all with this, append it, or remove it)

Returns:

reference to a Procedure that can be used for defining a relationship to a Procedure

refByQualifiedName

public static Procedure refByQualifiedName(String qualifiedName)

Reference to a Procedure by qualifiedName. Use this to create a relationship to this Procedure, where the relationship should be replaced.

Parameters:

qualifiedName - the qualifiedName of the Procedure to reference

Returns:

reference to a Procedure that can be used for defining a relationship to a Procedure

refByQualifiedName

public static Procedure refByQualifiedName(String qualifiedName,
 Reference.SaveSemantic semantic)

Reference to a Procedure by qualifiedName. Use this to create a relationship to this Procedure, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).

Parameters:

qualifiedName - the qualifiedName of the Procedure to reference

semantic - how to save this relationship (replace all with this, append it, or remove it)

Returns:

reference to a Procedure that can be used for defining a relationship to a Procedure

get

public static Procedure get(AtlanClient client,
 String id)
                     throws AtlanException

Retrieves a Procedure 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 Procedure to retrieve, either its GUID or its full qualifiedName

Returns:

the requested full Procedure, complete with all of its relationships

Throws:

AtlanException - on any error during the API invocation, such as the NotFoundException if the Procedure does not exist or the provided GUID is not a Procedure

get

public static Procedure get(AtlanClient client,
 String id,
 boolean includeAllRelationships)
                     throws AtlanException

Retrieves a Procedure 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 Procedure 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 Procedure, optionally complete with all of its relationships

Throws:

AtlanException - on any error during the API invocation, such as the NotFoundException if the Procedure does not exist or the provided GUID is not a Procedure

get

public static Procedure get(AtlanClient client,
 String id,
 Collection<AtlanField> attributes)
                     throws AtlanException

Retrieves a Procedure 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 Procedure to retrieve, either its GUID or its full qualifiedName

attributes - to retrieve for the Procedure, including any relationships

Returns:

the requested Procedure, 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 Procedure does not exist or the provided GUID is not a Procedure

get

public static Procedure get(AtlanClient client,
 String id,
 Collection<AtlanField> attributes,
 Collection<AtlanField> attributesOnRelated)
                     throws AtlanException

Retrieves a Procedure 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 Procedure to retrieve, either its GUID or its full qualifiedName

attributes - to retrieve for the Procedure, including any relationships

attributesOnRelated - to retrieve on each relationship retrieved for the Procedure

Returns:

the requested Procedure, 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 Procedure does not exist or the provided GUID is not a Procedure

restore

public static boolean restore(AtlanClient client,
 String qualifiedName)
                       throws AtlanException

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

Parameters:

client - connectivity to the Atlan tenant on which to restore the asset

qualifiedName - for the Procedure

Returns:

true if the Procedure is now active, and false otherwise

Throws:

AtlanException - on any API problems

creator

public static Procedure.ProcedureBuilder<?,?> creator(String name,
 String definition,
 Schema schema)
                                               throws InvalidRequestException

Builds the minimal object necessary to create a procedure.

Parameters:

name - of the procedure

definition - of the procedure

schema - in which the table should be created, which must have at least a qualifiedName

Returns:

the minimal request necessary to create the table, as a builder

Throws:

InvalidRequestException - if the schema provided is without a qualifiedName

creator

public static Procedure.ProcedureBuilder<?,?> creator(String name,
 String definition,
 String schemaQualifiedName)

Builds the minimal object necessary to create a procedure.

Parameters:

name - of the procedure

definition - of the procedure

schemaQualifiedName - unique name of the schema in which this table exists

Returns:

the minimal request necessary to create the table, as a builder

creator

public static Procedure.ProcedureBuilder<?,?> creator(String name,
 String definition,
 String connectionQualifiedName,
 String databaseName,
 String databaseQualifiedName,
 String schemaName,
 String schemaQualifiedName)

Builds the minimal object necessary to create a procedure.

Parameters:

name - of the procedure

definition - of the procedure

connectionQualifiedName - unique name of the connection in which to create the Table

databaseName - simple name of the Database in which to create the Table

databaseQualifiedName - unique name of the Database in which to create the Table

schemaName - simple name of the Schema in which to create the Table

schemaQualifiedName - unique name of the Schema in which to create the Table

Returns:

the minimal request necessary to create the table, as a builder

updater

public static Procedure.ProcedureBuilder<?,?> updater(String qualifiedName,
 String name)

Builds the minimal object necessary to update a Procedure.

Parameters:

qualifiedName - of the Procedure

name - of the Procedure

Returns:

the minimal request necessary to update the Procedure, as a builder

generateQualifiedName

public static String generateQualifiedName(String name,
 String schemaQualifiedName)

Generate a unique table name.

Parameters:

name - of the table

schemaQualifiedName - unique name of the schema in which this table exists

Returns:

a unique name for the table

trimToRequired

public Procedure.ProcedureBuilder<?,?> trimToRequired()
                                               throws InvalidRequestException

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

Overrides:

trimToRequired in class Asset

Returns:

the minimal object necessary to update the Procedure, as a builder

Throws:

InvalidRequestException - if any of the minimal set of required properties for Procedure are not found in the initial object

removeDescription

public static Procedure removeDescription(AtlanClient client,
 String qualifiedName,
 String name)
                                   throws AtlanException

Remove the system description from a Procedure.

Parameters:

client - connectivity to the Atlan tenant on which to remove the asset's description

qualifiedName - of the Procedure

name - of the Procedure

Returns:

the updated Procedure, or null if the removal failed

Throws:

AtlanException - on any API problems

removeUserDescription

public static Procedure removeUserDescription(AtlanClient client,
 String qualifiedName,
 String name)
                                       throws AtlanException

Remove the user's description from a Procedure.

Parameters:

client - connectivity to the Atlan tenant on which to remove the asset's description

qualifiedName - of the Procedure

name - of the Procedure

Returns:

the updated Procedure, or null if the removal failed

Throws:

AtlanException - on any API problems

removeOwners

public static Procedure removeOwners(AtlanClient client,
 String qualifiedName,
 String name)
                              throws AtlanException

Remove the owners from a Procedure.

Parameters:

client - connectivity to the Atlan tenant from which to remove the Procedure's owners

qualifiedName - of the Procedure

name - of the Procedure

Returns:

the updated Procedure, or null if the removal failed

Throws:

AtlanException - on any API problems

updateCertificate

public static Procedure updateCertificate(AtlanClient client,
 String qualifiedName,
 CertificateStatus certificate,
 String message)
                                   throws AtlanException

Update the certificate on a Procedure.

Parameters:

client - connectivity to the Atlan tenant on which to update the Procedure's certificate

qualifiedName - of the Procedure

certificate - to use

message - (optional) message, or null if no message

Returns:

the updated Procedure, or null if the update failed

Throws:

AtlanException - on any API problems

removeCertificate

public static Procedure removeCertificate(AtlanClient client,
 String qualifiedName,
 String name)
                                   throws AtlanException

Remove the certificate from a Procedure.

Parameters:

client - connectivity to the Atlan tenant from which to remove the Procedure's certificate

qualifiedName - of the Procedure

name - of the Procedure

Returns:

the updated Procedure, or null if the removal failed

Throws:

AtlanException - on any API problems

updateAnnouncement

public static Procedure updateAnnouncement(AtlanClient client,
 String qualifiedName,
 AtlanAnnouncementType type,
 String title,
 String message)
                                    throws AtlanException

Update the announcement on a Procedure.

Parameters:

client - connectivity to the Atlan tenant on which to update the Procedure's announcement

qualifiedName - of the Procedure

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 Procedure removeAnnouncement(AtlanClient client,
 String qualifiedName,
 String name)
                                    throws AtlanException

Remove the announcement from a Procedure.

Parameters:

client - connectivity to the Atlan client from which to remove the Procedure's announcement

qualifiedName - of the Procedure

name - of the Procedure

Returns:

the updated Procedure, or null if the removal failed

Throws:

AtlanException - on any API problems

replaceTerms

public static Procedure replaceTerms(AtlanClient client,
 String qualifiedName,
 String name,
 List<IGlossaryTerm> terms)
                              throws AtlanException

Replace the terms linked to the Procedure.

Parameters:

client - connectivity to the Atlan tenant on which to replace the Procedure's assigned terms

qualifiedName - for the Procedure

name - human-readable name of the Procedure

terms - the list of terms to replace on the Procedure, or null to remove all terms from the Procedure

Returns:

the Procedure that was updated (note that it will NOT contain details of the replaced terms)

Throws:

AtlanException - on any API problems

appendTerms

public static Procedure appendTerms(AtlanClient client,
 String qualifiedName,
 List<IGlossaryTerm> terms)
                             throws AtlanException

Link additional terms to the Procedure, without replacing existing terms linked to the Procedure. Note: this operation must make two API calls — one to retrieve the Procedure'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 Procedure

qualifiedName - for the Procedure

terms - the list of terms to append to the Procedure

Returns:

the Procedure that was updated (note that it will NOT contain details of the appended terms)

Throws:

AtlanException - on any API problems

removeTerms

public static Procedure removeTerms(AtlanClient client,
 String qualifiedName,
 List<IGlossaryTerm> terms)
                             throws AtlanException

Remove terms from a Procedure, without replacing all existing terms linked to the Procedure. Note: this operation must make two API calls — one to retrieve the Procedure'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 Procedure

qualifiedName - for the Procedure

terms - the list of terms to remove from the Procedure, which must be referenced by GUID

Returns:

the Procedure that was updated (note that it will NOT contain details of the resulting terms)

Throws:

AtlanException - on any API problems

appendAtlanTags

public static Procedure appendAtlanTags(AtlanClient client,
 String qualifiedName,
 List<String> atlanTagNames)
                                 throws AtlanException

Add Atlan tags to a Procedure, without replacing existing Atlan tags linked to the Procedure. Note: this operation must make two API calls — one to retrieve the Procedure'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 Procedure

qualifiedName - of the Procedure

atlanTagNames - human-readable names of the Atlan tags to add

Returns:

the updated Procedure

Throws:

AtlanException - on any API problems

appendAtlanTags

public static Procedure appendAtlanTags(AtlanClient client,
 String qualifiedName,
 List<String> atlanTagNames,
 boolean propagate,
 boolean removePropagationsOnDelete,
 boolean restrictLineagePropagation)
                                 throws AtlanException

Add Atlan tags to a Procedure, without replacing existing Atlan tags linked to the Procedure. Note: this operation must make two API calls — one to retrieve the Procedure'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 Procedure

qualifiedName - of the Procedure

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 Procedure

Throws:

AtlanException - on any API problems

removeAtlanTag

public static void removeAtlanTag(AtlanClient client,
 String qualifiedName,
 String atlanTagName)
                           throws AtlanException

Remove an Atlan tag from a Procedure.

Parameters:

client - connectivity to the Atlan tenant from which to remove an Atlan tag from a Procedure

qualifiedName - of the Procedure

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 Procedure

_internal

public static Procedure.ProcedureBuilder<?,?> _internal()

toBuilder

public Procedure.ProcedureBuilder<?,?> toBuilder()

Overrides:

toBuilder in class Reference

getCalculationViewName

public String getCalculationViewName()

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

Specified by:

getCalculationViewName in interface IProcedure

Specified by:

getCalculationViewName in interface ISQL

getCalculationViewQualifiedName

public String getCalculationViewQualifiedName()

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

Specified by:

getCalculationViewQualifiedName in interface IProcedure

Specified by:

getCalculationViewQualifiedName in interface ISQL

getDatabaseName

public String getDatabaseName()

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

Specified by:

getDatabaseName in interface IProcedure

Specified by:

getDatabaseName in interface ISQL

getDatabaseQualifiedName

public String getDatabaseQualifiedName()

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

Specified by:

getDatabaseQualifiedName in interface IProcedure

Specified by:

getDatabaseQualifiedName in interface ISQL

getDbtModels

public SortedSet<IDbtModel> getDbtModels()

TBC

Specified by:

getDbtModels in interface IProcedure

Specified by:

getDbtModels in interface ISQL

getDbtSources

public SortedSet<IDbtSource> getDbtSources()

TBC

Specified by:

getDbtSources in interface IProcedure

Specified by:

getDbtSources in interface ISQL

getDbtTests

public SortedSet<IDbtTest> getDbtTests()

TBC

Specified by:

getDbtTests in interface IProcedure

Specified by:

getDbtTests in interface ISQL

getDefinition

public String getDefinition()

SQL definition of the procedure.

Specified by:

getDefinition in interface IProcedure

getInputToAirflowTasks

public SortedSet<IAirflowTask> getInputToAirflowTasks()

Tasks to which this asset provides input.

Specified by:

getInputToAirflowTasks in interface ICatalog

Specified by:

getInputToAirflowTasks in interface IProcedure

Specified by:

getInputToAirflowTasks in interface ISQL

getInputToProcesses

public SortedSet<ILineageProcess> getInputToProcesses()

Processes to which this asset provides input.

Specified by:

getInputToProcesses in interface ICatalog

Specified by:

getInputToProcesses in interface IProcedure

Specified by:

getInputToProcesses in interface ISQL

getInputToSparkJobs

public SortedSet<ISparkJob> getInputToSparkJobs()

TBC

Specified by:

getInputToSparkJobs in interface ICatalog

Specified by:

getInputToSparkJobs in interface IProcedure

Specified by:

getInputToSparkJobs in interface ISQL

getIsProfiled

public Boolean getIsProfiled()

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

Specified by:

getIsProfiled in interface IProcedure

Specified by:

getIsProfiled in interface ISQL

getLastProfiledAt

public Long getLastProfiledAt()

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

Specified by:

getLastProfiledAt in interface IProcedure

Specified by:

getLastProfiledAt in interface ISQL

getModelImplementedAttributes

public SortedSet<IModelAttribute> getModelImplementedAttributes()

Attributes implemented by this asset.

Specified by:

getModelImplementedAttributes in interface ICatalog

Specified by:

getModelImplementedAttributes in interface IProcedure

Specified by:

getModelImplementedAttributes in interface ISQL

getModelImplementedEntities

public SortedSet<IModelEntity> getModelImplementedEntities()

Entities implemented by this asset.

Specified by:

getModelImplementedEntities in interface ICatalog

Specified by:

getModelImplementedEntities in interface IProcedure

Specified by:

getModelImplementedEntities in interface ISQL

getOutputFromAirflowTasks

public SortedSet<IAirflowTask> getOutputFromAirflowTasks()

Tasks from which this asset is output.

Specified by:

getOutputFromAirflowTasks in interface ICatalog

Specified by:

getOutputFromAirflowTasks in interface IProcedure

Specified by:

getOutputFromAirflowTasks in interface ISQL

getOutputFromProcesses

public SortedSet<ILineageProcess> getOutputFromProcesses()

Processes from which this asset is produced as output.

Specified by:

getOutputFromProcesses in interface ICatalog

Specified by:

getOutputFromProcesses in interface IProcedure

Specified by:

getOutputFromProcesses in interface ISQL

getOutputFromSparkJobs

public SortedSet<ISparkJob> getOutputFromSparkJobs()

TBC

Specified by:

getOutputFromSparkJobs in interface ICatalog

Specified by:

getOutputFromSparkJobs in interface IProcedure

Specified by:

getOutputFromSparkJobs in interface ISQL

getQueryCount

public Long getQueryCount()

Number of times this asset has been queried.

Specified by:

getQueryCount in interface IProcedure

Specified by:

getQueryCount in interface ISQL

getQueryCountUpdatedAt

public Long getQueryCountUpdatedAt()

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

Specified by:

getQueryCountUpdatedAt in interface IProcedure

Specified by:

getQueryCountUpdatedAt in interface ISQL

getQueryUserCount

public Long getQueryUserCount()

Number of unique users who have queried this asset.

Specified by:

getQueryUserCount in interface IProcedure

Specified by:

getQueryUserCount in interface ISQL

getQueryUserMap

public Map<String,Long> getQueryUserMap()

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

Specified by:

getQueryUserMap in interface IProcedure

Specified by:

getQueryUserMap in interface ISQL

getSchema

public ISchema getSchema()

Schema in which this stored procedure exists.

Specified by:

getSchema in interface IProcedure

getSchemaName

public String getSchemaName()

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

Specified by:

getSchemaName in interface IProcedure

Specified by:

getSchemaName in interface ISQL

getSchemaQualifiedName

public String getSchemaQualifiedName()

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

Specified by:

getSchemaQualifiedName in interface IProcedure

Specified by:

getSchemaQualifiedName in interface ISQL

getSqlDBTSources

public SortedSet<IDbtSource> getSqlDBTSources()

TBC

Specified by:

getSqlDBTSources in interface IProcedure

Specified by:

getSqlDBTSources in interface ISQL

getSqlDbtModels

public SortedSet<IDbtModel> getSqlDbtModels()

TBC

Specified by:

getSqlDbtModels in interface IProcedure

Specified by:

getSqlDbtModels in interface ISQL

getTableName

public String getTableName()

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

Specified by:

getTableName in interface IProcedure

Specified by:

getTableName in interface ISQL

getTableQualifiedName

public String getTableQualifiedName()

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

Specified by:

getTableQualifiedName in interface IProcedure

Specified by:

getTableQualifiedName in interface ISQL

getViewName

public String getViewName()

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

Specified by:

getViewName in interface IProcedure

Specified by:

getViewName in interface ISQL

getViewQualifiedName

public String getViewQualifiedName()

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

Specified by:

getViewQualifiedName in interface IProcedure

Specified by:

getViewQualifiedName in interface ISQL

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

Specified by:

getTypeName in interface AuditDetail

Specified by:

getTypeName in interface IAsset

Specified by:

getTypeName in interface ICatalog

Specified by:

getTypeName in interface IProcedure

Specified by:

getTypeName in interface IReferenceable

Specified by:

getTypeName in interface ISQL

Overrides:

getTypeName in class Reference