Package com.atlan.model.assets
Class Stakeholder
java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.Stakeholder
- All Implemented Interfaces:
IAccessControl
,IAsset
,IPersona
,IReferenceable
,IStakeholder
,AuditDetail
,Serializable
,Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2")
public class Stakeholder
extends Asset
implements IStakeholder, IPersona, IAccessControl, IAsset, IReferenceable
Atlan Type representing Stakeholders
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Stakeholder.StakeholderBuilder<C extends Stakeholder,
B extends Stakeholder.StakeholderBuilder<C, B>> Nested classes/interfaces inherited from class com.atlan.model.assets.Asset
Asset.AssetBuilder<C extends Asset,
B extends Asset.AssetBuilder<C, B>> Nested classes/interfaces inherited from class com.atlan.model.relations.Reference
Reference.ReferenceBuilder<C extends Reference,
B extends Reference.ReferenceBuilder<C, B>>, Reference.SaveSemantic Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject
AtlanObject.AtlanObjectBuilder<C extends AtlanObject,
B extends AtlanObject.AtlanObjectBuilder<C, B>> -
Field Summary
Fields inherited from class com.atlan.model.core.AtlanObject
rawJsonObject
Fields inherited from interface com.atlan.model.assets.IAccessControl
CHANNEL_LINK, DEFAULT_NAVIGATION, DENY_ASSET_FILTERS, DENY_ASSET_TABS, DENY_ASSET_TYPES, DENY_CUSTOM_METADATA_GUIDS, DENY_NAVIGATION_PAGES, DISPLAY_PREFERENCES, IS_ACCESS_CONTROL_ENABLED, POLICIES
Fields inherited from interface com.atlan.model.assets.IAsset
ADMIN_GROUPS, ADMIN_ROLES, ADMIN_USERS, ANNOUNCEMENT_MESSAGE, ANNOUNCEMENT_TITLE, ANNOUNCEMENT_TYPE, ANNOUNCEMENT_UPDATED_AT, ANNOUNCEMENT_UPDATED_BY, ANOMALO_CHECKS, ASSET_ANOMALO_APPLIED_CHECK_TYPES, ASSET_ANOMALO_CHECK_COUNT, ASSET_ANOMALO_CHECK_STATUSES, ASSET_ANOMALO_DQ_STATUS, ASSET_ANOMALO_FAILED_CHECK_COUNT, ASSET_ANOMALO_FAILED_CHECK_TYPES, ASSET_ANOMALO_LAST_CHECK_RUN_AT, ASSET_ANOMALO_SOURCE_URL, ASSET_COVER_IMAGE, ASSET_DBT_ACCOUNT_NAME, ASSET_DBT_ALIAS, ASSET_DBT_ENVIRONMENT_DBT_VERSION, ASSET_DBT_ENVIRONMENT_NAME, ASSET_DBT_JOB_LAST_RUN, ASSET_DBT_JOB_LAST_RUN_ARTIFACT_S3PATH, ASSET_DBT_JOB_LAST_RUN_ARTIFACTS_SAVED, ASSET_DBT_JOB_LAST_RUN_CREATED_AT, ASSET_DBT_JOB_LAST_RUN_DEQUED_AT, ASSET_DBT_JOB_LAST_RUN_EXECUTED_BY_THREAD_ID, ASSET_DBT_JOB_LAST_RUN_GIT_BRANCH, ASSET_DBT_JOB_LAST_RUN_GIT_SHA, ASSET_DBT_JOB_LAST_RUN_HAS_DOCS_GENERATED, ASSET_DBT_JOB_LAST_RUN_HAS_SOURCES_GENERATED, ASSET_DBT_JOB_LAST_RUN_NOTIFICATIONS_SENT, ASSET_DBT_JOB_LAST_RUN_OWNER_THREAD_ID, ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION, ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_RUN_DURATION, ASSET_DBT_JOB_LAST_RUN_RUN_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_STARTED_AT, ASSET_DBT_JOB_LAST_RUN_STATUS_MESSAGE, ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION, ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_UPDATED_AT, ASSET_DBT_JOB_LAST_RUN_URL, ASSET_DBT_JOB_NAME, ASSET_DBT_JOB_NEXT_RUN, ASSET_DBT_JOB_NEXT_RUN_HUMANIZED, ASSET_DBT_JOB_SCHEDULE, ASSET_DBT_JOB_SCHEDULE_CRON_HUMANIZED, ASSET_DBT_JOB_STATUS, ASSET_DBT_META, ASSET_DBT_PACKAGE_NAME, ASSET_DBT_PROJECT_NAME, ASSET_DBT_SEMANTIC_LAYER_PROXY_URL, ASSET_DBT_SOURCE_FRESHNESS_CRITERIA, ASSET_DBT_TAGS, ASSET_DBT_TEST_STATUS, ASSET_DBT_UNIQUE_ID, ASSET_DBT_WORKFLOW_LAST_UPDATED, ASSET_ICON, ASSET_MC_ALERT_QUALIFIED_NAMES, ASSET_MC_INCIDENT_NAMES, ASSET_MC_INCIDENT_PRIORITIES, ASSET_MC_INCIDENT_QUALIFIED_NAMES, ASSET_MC_INCIDENT_SEVERITIES, ASSET_MC_INCIDENT_STATES, ASSET_MC_INCIDENT_SUB_TYPES, ASSET_MC_INCIDENT_TYPES, ASSET_MC_LAST_SYNC_RUN_AT, ASSET_MC_MONITOR_NAMES, ASSET_MC_MONITOR_QUALIFIED_NAMES, ASSET_MC_MONITOR_SCHEDULE_TYPES, ASSET_MC_MONITOR_STATUSES, ASSET_MC_MONITOR_TYPES, ASSET_POLICIES_COUNT, ASSET_POLICY_GUIDS, ASSET_SODA_CHECK_COUNT, ASSET_SODA_CHECK_STATUSES, ASSET_SODA_DQ_STATUS, ASSET_SODA_LAST_SCAN_AT, ASSET_SODA_LAST_SYNC_RUN_AT, ASSET_SODA_SOURCE_URL, ASSET_TAGS, ASSET_THEME_HEX, CERTIFICATE_STATUS, CERTIFICATE_STATUS_MESSAGE, CERTIFICATE_UPDATED_AT, CERTIFICATE_UPDATED_BY, CONNECTION_NAME, CONNECTION_QUALIFIED_NAME, CONNECTOR_TYPE, DATA_CONTRACT_LATEST, DATA_CONTRACT_LATEST_CERTIFIED, DBT_QUALIFIED_NAME, DESCRIPTION, DISPLAY_NAME, DOMAIN_GUIDS, FILES, HAS_CONTRACT, HAS_LINEAGE, INPUT_PORT_DATA_PRODUCTS, IS_AI_GENERATED, IS_DISCOVERABLE, IS_EDITABLE, IS_PARTIAL, LAST_ROW_CHANGED_AT, LAST_SYNC_RUN, LAST_SYNC_RUN_AT, LAST_SYNC_WORKFLOW_NAME, LEXICOGRAPHICAL_SORT_ORDER, LINKS, MC_INCIDENTS, MC_MONITORS, METRICS, NAME, NON_COMPLIANT_ASSET_POLICY_GUIDS, OUTPUT_PORT_DATA_PRODUCTS, OWNER_GROUPS, OWNER_USERS, POPULARITY_SCORE, QUALIFIED_NAME, README, SAMPLE_DATA_URL, SCHEMA_REGISTRY_SUBJECTS, SODA_CHECKS, SOURCE_COST_UNIT, SOURCE_CREATED_AT, SOURCE_CREATED_BY, SOURCE_EMBED_URL, SOURCE_LAST_READ_AT, SOURCE_OWNERS, SOURCE_QUERY_COMPUTE_COST_RECORDS, SOURCE_QUERY_COMPUTE_COSTS, SOURCE_READ_COUNT, SOURCE_READ_EXPENSIVE_QUERY_RECORDS, SOURCE_READ_POPULAR_QUERY_RECORDS, SOURCE_READ_QUERY_COST, SOURCE_READ_RECENT_USER_RECORDS, SOURCE_READ_RECENT_USERS, SOURCE_READ_SLOW_QUERY_RECORDS, SOURCE_READ_TOP_USER_RECORDS, SOURCE_READ_TOP_USERS, SOURCE_READ_USER_COUNT, SOURCE_TOTAL_COST, SOURCE_UPDATED_AT, SOURCE_UPDATED_BY, SOURCE_URL, STARRED_BY, STARRED_COUNT, STARRED_DETAILS, SUB_TYPE, TENANT_ID, USER_DEF_RELATIONSHIP_FROMS, USER_DEF_RELATIONSHIP_TOS, USER_DESCRIPTION, VIEW_SCORE, VIEWER_GROUPS, VIEWER_USERS
Fields inherited from interface com.atlan.model.assets.IPersona
PERSONA_GROUPS, PERSONA_USERS, ROLE_ID
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.IStakeholder
STAKEHOLDER_DATA_DOMAIN, STAKEHOLDER_DOMAIN_QUALIFIED_NAME, STAKEHOLDER_TITLE, STAKEHOLDER_TITLE_GUID
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Stakeholder.StakeholderBuilder<?,
?> static Stakeholder
appendAtlanTags
(AtlanClient client, String qualifiedName, List<String> atlanTagNames) Add Atlan tags to a Stakeholder, without replacing existing Atlan tags linked to the Stakeholder.static Stakeholder
appendAtlanTags
(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) Add Atlan tags to a Stakeholder, without replacing existing Atlan tags linked to the Stakeholder.static Stakeholder
appendAtlanTags
(String qualifiedName, List<String> atlanTagNames) Add Atlan tags to a Stakeholder, without replacing existing Atlan tags linked to the Stakeholder.static Stakeholder
appendAtlanTags
(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) Add Atlan tags to a Stakeholder, without replacing existing Atlan tags linked to the Stakeholder.static Stakeholder
appendTerms
(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Link additional terms to the Stakeholder, without replacing existing terms linked to the Stakeholder.static Stakeholder
appendTerms
(String qualifiedName, List<IGlossaryTerm> terms) Link additional terms to the Stakeholder, without replacing existing terms linked to the Stakeholder.protected boolean
boolean
static Stakeholder
get
(AtlanClient client, String id) Retrieves a Stakeholder by one of its identifiers, complete with all of its relationships.static Stakeholder
get
(AtlanClient client, String id, boolean includeRelationships) Retrieves a Stakeholder by one of its identifiers, optionally complete with all of its relationships.static Stakeholder
Retrieves a Stakeholder by one of its identifiers, complete with all of its relationships.TBCTBCTBCTBCTBCTBCTBCTBCTBCTBCTBCTBCTBCDomain assigned to the StakeholderTBCStakeholder-title assigned for this Stakeholder-PersonaTBCFixed typeName for Stakeholders.int
hashCode()
static Stakeholder
Reference to a Stakeholder by GUID.static Stakeholder
refByGuid
(String guid, Reference.SaveSemantic semantic) Reference to a Stakeholder by GUID.static Stakeholder
refByQualifiedName
(String qualifiedName) Reference to a Stakeholder by qualifiedName.static Stakeholder
refByQualifiedName
(String qualifiedName, Reference.SaveSemantic semantic) Reference to a Stakeholder by qualifiedName.static Stakeholder
removeAnnouncement
(AtlanClient client, String qualifiedName, String name) Remove the announcement from a Stakeholder.static Stakeholder
removeAnnouncement
(String qualifiedName, String name) Remove the announcement from a Stakeholder.static void
removeAtlanTag
(AtlanClient client, String qualifiedName, String atlanTagName) Remove an Atlan tag from a Stakeholder.static void
removeAtlanTag
(String qualifiedName, String atlanTagName) Remove an Atlan tag from a Stakeholder.static Stakeholder
removeCertificate
(AtlanClient client, String qualifiedName, String name) Remove the certificate from a Stakeholder.static Stakeholder
removeCertificate
(String qualifiedName, String name) Remove the certificate from a Stakeholder.static Stakeholder
removeDescription
(AtlanClient client, String qualifiedName, String name) Remove the system description from a Stakeholder.static Stakeholder
removeDescription
(String qualifiedName, String name) Remove the system description from a Stakeholder.static Stakeholder
removeOwners
(AtlanClient client, String qualifiedName, String name) Remove the owners from a Stakeholder.static Stakeholder
removeOwners
(String qualifiedName, String name) Remove the owners from a Stakeholder.static Stakeholder
removeTerms
(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Remove terms from a Stakeholder, without replacing all existing terms linked to the Stakeholder.static Stakeholder
removeTerms
(String qualifiedName, List<IGlossaryTerm> terms) Remove terms from a Stakeholder, without replacing all existing terms linked to the Stakeholder.static Stakeholder
removeUserDescription
(AtlanClient client, String qualifiedName, String name) Remove the user's description from a Stakeholder.static Stakeholder
removeUserDescription
(String qualifiedName, String name) Remove the user's description from a Stakeholder.static Stakeholder
replaceTerms
(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the Stakeholder.static Stakeholder
replaceTerms
(String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the Stakeholder.static boolean
restore
(AtlanClient client, String qualifiedName) Restore the archived (soft-deleted) Stakeholder to active.static boolean
Restore the archived (soft-deleted) Stakeholder to active.static FluentSearch.FluentSearchBuilder<?,
?> select()
Start a fluent search that will return all Stakeholder assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(boolean includeArchived) Start a fluent search that will return all Stakeholder assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(AtlanClient client) Start a fluent search that will return all Stakeholder assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(AtlanClient client, boolean includeArchived) Start a fluent search that will return all Stakeholder assets.toString()
Builds the minimal object necessary to create a relationship to a Stakeholder, from a potentially more-complete Stakeholder object.Builds the minimal object necessary to apply an update to a Stakeholder, from a potentially more-complete Stakeholder object.static Stakeholder
updateAnnouncement
(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a Stakeholder.static Stakeholder
updateAnnouncement
(String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a Stakeholder.static Stakeholder
updateCertificate
(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a Stakeholder.static Stakeholder
updateCertificate
(String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a Stakeholder.static Stakeholder.StakeholderBuilder<?,
?> Builds the minimal object necessary to update a Stakeholder.Methods inherited from class com.atlan.model.assets.Asset
addApiTokenAsAdmin, appendAtlanTags, appendAtlanTags, appendTerms, delete, delete, get, getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getAtlanTagNames, getAtlanTags, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getCreatedBy, getCreateTime, getCustomMetadata, getCustomMetadataSets, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDeleteHandler, getDepth, getDescription, getDisplayName, getDomainGUIDs, getFiles, getHasContract, getHasLineage, getImmediateDownstream, getImmediateUpstream, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsIncomplete, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMeaningNames, getMeanings, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getNullFields, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPendingTasks, getPopularityScore, getQualifiedName, getReadme, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getStatus, getSubType, getTenantId, getUpdatedBy, getUpdateTime, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, lineage, lineage, lineage, lineage, purge, purge, removeAnnouncement, removeAtlanTag, removeCertificate, removeCustomMetadata, removeCustomMetadata, removeDescription, removeOwners, removeTerms, removeUserDescription, replaceCustomMetadata, replaceCustomMetadata, replaceTerms, requestLineage, requestLineage, restore, save, save, save, save, saveMergingCM, saveMergingCM, saveReplacingCM, saveReplacingCM, updateAnnouncement, updateAnnouncement, updateCertificate, updateCertificate, updateCustomMetadataAttributes, updateCustomMetadataAttributes, updateMergingCM, updateMergingCM, updateReplacingCM, updateReplacingCM
Methods inherited from class com.atlan.model.relations.Reference
builder, by, compareTo, getCompleteObject, getCustomAttributes, getDisplayText, getEntityStatus, getGuid, getLabels, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSemantic, getUniqueAttributes, isComplete, isValidReference, isValidReferenceByGuid, isValidReferenceByQualifiedName, setCompleteObject, to, validateRelationship, validateRequired
Methods inherited from class com.atlan.model.core.AtlanObject
getRawJsonObject, setRawJsonObject, toJson
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.atlan.model.search.AuditDetail
getRawJsonObject, setRawJsonObject
Methods inherited from interface com.atlan.model.assets.IAccessControl
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPopularityScore, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName
Methods inherited from interface com.atlan.model.assets.IAsset
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPopularityScore, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName
Methods inherited from interface com.atlan.model.assets.IPersona
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPopularityScore, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName
Methods inherited from interface com.atlan.model.assets.IReferenceable
getAtlanTagNames, getAtlanTags, getCreatedBy, getCreateTime, getCustomMetadataSets, getDeleteHandler, getGuid, getIsIncomplete, getMeaningNames, getMeanings, getPendingTasks, getQualifiedName, getStatus, getUpdatedBy, getUpdateTime
Methods inherited from interface com.atlan.model.assets.IStakeholder
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPopularityScore, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName
-
Field Details
-
TYPE_NAME
- See Also:
-
-
Constructor Details
-
Stakeholder
-
-
Method Details
-
trimToReference
Builds the minimal object necessary to create a relationship to a Stakeholder, from a potentially more-complete Stakeholder object.- Overrides:
trimToReference
in classAsset
- Returns:
- the minimal object necessary to relate to the Stakeholder
- Throws:
InvalidRequestException
- if any of the minimal set of required properties for a Stakeholder relationship are not found in the initial object
-
select
Start a fluent search that will return all Stakeholder 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) Stakeholder assets will be included.- Returns:
- a fluent search that includes all Stakeholder assets
-
select
Start a fluent search that will return all Stakeholder 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) Stakeholder assets will be included.- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assets- Returns:
- a fluent search that includes all Stakeholder assets
-
select
Start a fluent search that will return all Stakeholder assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.- Parameters:
includeArchived
- when true, archived (soft-deleted) Stakeholders will be included- Returns:
- a fluent search that includes all Stakeholder assets
-
select
public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived) Start a fluent search that will return all Stakeholder assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assetsincludeArchived
- when true, archived (soft-deleted) Stakeholders will be included- Returns:
- a fluent search that includes all Stakeholder assets
-
refByGuid
Reference to a Stakeholder by GUID. Use this to create a relationship to this Stakeholder, where the relationship should be replaced.- Parameters:
guid
- the GUID of the Stakeholder to reference- Returns:
- reference to a Stakeholder that can be used for defining a relationship to a Stakeholder
-
refByGuid
Reference to a Stakeholder by GUID. Use this to create a relationship to this Stakeholder, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
guid
- the GUID of the Stakeholder to referencesemantic
- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a Stakeholder that can be used for defining a relationship to a Stakeholder
-
refByQualifiedName
Reference to a Stakeholder by qualifiedName. Use this to create a relationship to this Stakeholder, where the relationship should be replaced.- Parameters:
qualifiedName
- the qualifiedName of the Stakeholder to reference- Returns:
- reference to a Stakeholder that can be used for defining a relationship to a Stakeholder
-
refByQualifiedName
Reference to a Stakeholder by qualifiedName. Use this to create a relationship to this Stakeholder, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
qualifiedName
- the qualifiedName of the Stakeholder to referencesemantic
- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a Stakeholder that can be used for defining a relationship to a Stakeholder
-
get
Retrieves a Stakeholder by one of its identifiers, complete with all of its relationships.- Parameters:
id
- of the Stakeholder to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full Stakeholder, complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the Stakeholder does not exist or the provided GUID is not a Stakeholder
-
get
Retrieves a Stakeholder by one of its identifiers, complete with all of its relationships.- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assetid
- of the Stakeholder to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full Stakeholder, complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the Stakeholder does not exist or the provided GUID is not a Stakeholder
-
get
public static Stakeholder get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException Retrieves a Stakeholder by one of its identifiers, optionally complete with all of its relationships.- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assetid
- of the Stakeholder to retrieve, either its GUID or its full qualifiedNameincludeRelationships
- if true, all of the asset's relationships will also be retrieved; if false, no relationships will be retrieved- Returns:
- the requested full Stakeholder, optionally complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the Stakeholder does not exist or the provided GUID is not a Stakeholder
-
restore
Restore the archived (soft-deleted) Stakeholder to active.- Parameters:
qualifiedName
- for the Stakeholder- Returns:
- true if the Stakeholder is now active, and false otherwise
- Throws:
AtlanException
- on any API problems
-
restore
Restore the archived (soft-deleted) Stakeholder to active.- Parameters:
client
- connectivity to the Atlan tenant on which to restore the assetqualifiedName
- for the Stakeholder- Returns:
- true if the Stakeholder is now active, and false otherwise
- Throws:
AtlanException
- on any API problems
-
updater
Builds the minimal object necessary to update a Stakeholder.- Parameters:
qualifiedName
- of the Stakeholdername
- of the Stakeholder- Returns:
- the minimal request necessary to update the Stakeholder, as a builder
-
trimToRequired
Builds the minimal object necessary to apply an update to a Stakeholder, from a potentially more-complete Stakeholder object.- Overrides:
trimToRequired
in classAsset
- Returns:
- the minimal object necessary to update the Stakeholder, as a builder
- Throws:
InvalidRequestException
- if any of the minimal set of required properties for Stakeholder are not found in the initial object
-
removeDescription
public static Stakeholder removeDescription(String qualifiedName, String name) throws AtlanException Remove the system description from a Stakeholder.- Parameters:
qualifiedName
- of the Stakeholdername
- of the Stakeholder- Returns:
- the updated Stakeholder, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeDescription
public static Stakeholder removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the system description from a Stakeholder.- Parameters:
client
- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName
- of the Stakeholdername
- of the Stakeholder- Returns:
- the updated Stakeholder, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeUserDescription
public static Stakeholder removeUserDescription(String qualifiedName, String name) throws AtlanException Remove the user's description from a Stakeholder.- Parameters:
qualifiedName
- of the Stakeholdername
- of the Stakeholder- Returns:
- the updated Stakeholder, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeUserDescription
public static Stakeholder removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the user's description from a Stakeholder.- Parameters:
client
- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName
- of the Stakeholdername
- of the Stakeholder- Returns:
- the updated Stakeholder, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeOwners
Remove the owners from a Stakeholder.- Parameters:
qualifiedName
- of the Stakeholdername
- of the Stakeholder- Returns:
- the updated Stakeholder, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeOwners
public static Stakeholder removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the owners from a Stakeholder.- Parameters:
client
- connectivity to the Atlan tenant from which to remove the Stakeholder's ownersqualifiedName
- of the Stakeholdername
- of the Stakeholder- Returns:
- the updated Stakeholder, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
updateCertificate
public static Stakeholder updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a Stakeholder.- Parameters:
qualifiedName
- of the Stakeholdercertificate
- to usemessage
- (optional) message, or null if no message- Returns:
- the updated Stakeholder, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
updateCertificate
public static Stakeholder updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a Stakeholder.- Parameters:
client
- connectivity to the Atlan tenant on which to update the Stakeholder's certificatequalifiedName
- of the Stakeholdercertificate
- to usemessage
- (optional) message, or null if no message- Returns:
- the updated Stakeholder, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
removeCertificate
public static Stakeholder removeCertificate(String qualifiedName, String name) throws AtlanException Remove the certificate from a Stakeholder.- Parameters:
qualifiedName
- of the Stakeholdername
- of the Stakeholder- Returns:
- the updated Stakeholder, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeCertificate
public static Stakeholder removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the certificate from a Stakeholder.- Parameters:
client
- connectivity to the Atlan tenant from which to remove the Stakeholder's certificatequalifiedName
- of the Stakeholdername
- of the Stakeholder- Returns:
- the updated Stakeholder, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
updateAnnouncement
public static Stakeholder updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a Stakeholder.- Parameters:
qualifiedName
- of the Stakeholdertype
- type of announcement to settitle
- (optional) title of the announcement to set (or null for no title)message
- (optional) message of the announcement to set (or null for no message)- Returns:
- the result of the update, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
updateAnnouncement
public static Stakeholder updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a Stakeholder.- Parameters:
client
- connectivity to the Atlan tenant on which to update the Stakeholder's announcementqualifiedName
- of the Stakeholdertype
- type of announcement to settitle
- (optional) title of the announcement to set (or null for no title)message
- (optional) message of the announcement to set (or null for no message)- Returns:
- the result of the update, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
removeAnnouncement
public static Stakeholder removeAnnouncement(String qualifiedName, String name) throws AtlanException Remove the announcement from a Stakeholder.- Parameters:
qualifiedName
- of the Stakeholdername
- of the Stakeholder- Returns:
- the updated Stakeholder, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeAnnouncement
public static Stakeholder removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the announcement from a Stakeholder.- Parameters:
client
- connectivity to the Atlan client from which to remove the Stakeholder's announcementqualifiedName
- of the Stakeholdername
- of the Stakeholder- Returns:
- the updated Stakeholder, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
replaceTerms
public static Stakeholder replaceTerms(String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the Stakeholder.- Parameters:
qualifiedName
- for the Stakeholdername
- human-readable name of the Stakeholderterms
- the list of terms to replace on the Stakeholder, or null to remove all terms from the Stakeholder- Returns:
- the Stakeholder that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException
- on any API problems
-
replaceTerms
public static Stakeholder replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the Stakeholder.- Parameters:
client
- connectivity to the Atlan tenant on which to replace the Stakeholder's assigned termsqualifiedName
- for the Stakeholdername
- human-readable name of the Stakeholderterms
- the list of terms to replace on the Stakeholder, or null to remove all terms from the Stakeholder- Returns:
- the Stakeholder that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException
- on any API problems
-
appendTerms
public static Stakeholder appendTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Link additional terms to the Stakeholder, without replacing existing terms linked to the Stakeholder. Note: this operation must make two API calls — one to retrieve the Stakeholder's existing terms, and a second to append the new terms.- Parameters:
qualifiedName
- for the Stakeholderterms
- the list of terms to append to the Stakeholder- Returns:
- the Stakeholder that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException
- on any API problems
-
appendTerms
public static Stakeholder appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Link additional terms to the Stakeholder, without replacing existing terms linked to the Stakeholder. Note: this operation must make two API calls — one to retrieve the Stakeholder'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 StakeholderqualifiedName
- for the Stakeholderterms
- the list of terms to append to the Stakeholder- Returns:
- the Stakeholder that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException
- on any API problems
-
removeTerms
public static Stakeholder removeTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Remove terms from a Stakeholder, without replacing all existing terms linked to the Stakeholder. Note: this operation must make two API calls — one to retrieve the Stakeholder's existing terms, and a second to remove the provided terms.- Parameters:
qualifiedName
- for the Stakeholderterms
- the list of terms to remove from the Stakeholder, which must be referenced by GUID- Returns:
- the Stakeholder that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException
- on any API problems
-
removeTerms
public static Stakeholder removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Remove terms from a Stakeholder, without replacing all existing terms linked to the Stakeholder. Note: this operation must make two API calls — one to retrieve the Stakeholder'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 StakeholderqualifiedName
- for the Stakeholderterms
- the list of terms to remove from the Stakeholder, which must be referenced by GUID- Returns:
- the Stakeholder that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static Stakeholder appendAtlanTags(String qualifiedName, List<String> atlanTagNames) throws AtlanException Add Atlan tags to a Stakeholder, without replacing existing Atlan tags linked to the Stakeholder. Note: this operation must make two API calls — one to retrieve the Stakeholder's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
qualifiedName
- of the StakeholderatlanTagNames
- human-readable names of the Atlan tags to add- Returns:
- the updated Stakeholder
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static Stakeholder appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException Add Atlan tags to a Stakeholder, without replacing existing Atlan tags linked to the Stakeholder. Note: this operation must make two API calls — one to retrieve the Stakeholder'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 StakeholderqualifiedName
- of the StakeholderatlanTagNames
- human-readable names of the Atlan tags to add- Returns:
- the updated Stakeholder
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static Stakeholder appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a Stakeholder, without replacing existing Atlan tags linked to the Stakeholder. Note: this operation must make two API calls — one to retrieve the Stakeholder's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
qualifiedName
- of the StakeholderatlanTagNames
- human-readable names of the Atlan tags to addpropagate
- whether to propagate the Atlan tag (true) or not (false)removePropagationsOnDelete
- whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)restrictLineagePropagation
- whether to avoid propagating through lineage (true) or do propagate through lineage (false)- Returns:
- the updated Stakeholder
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static Stakeholder appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a Stakeholder, without replacing existing Atlan tags linked to the Stakeholder. Note: this operation must make two API calls — one to retrieve the Stakeholder'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 StakeholderqualifiedName
- of the StakeholderatlanTagNames
- human-readable names of the Atlan tags to addpropagate
- whether to propagate the Atlan tag (true) or not (false)removePropagationsOnDelete
- whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)restrictLineagePropagation
- whether to avoid propagating through lineage (true) or do propagate through lineage (false)- Returns:
- the updated Stakeholder
- Throws:
AtlanException
- on any API problems
-
removeAtlanTag
Remove an Atlan tag from a Stakeholder.- Parameters:
qualifiedName
- of the StakeholderatlanTagName
- 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 Stakeholder
-
removeAtlanTag
public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException Remove an Atlan tag from a Stakeholder.- Parameters:
client
- connectivity to the Atlan tenant from which to remove an Atlan tag from a StakeholderqualifiedName
- of the StakeholderatlanTagName
- 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 Stakeholder
-
_internal
-
toBuilder
-
getChannelLink
TBC- Specified by:
getChannelLink
in interfaceIAccessControl
- Specified by:
getChannelLink
in interfaceIPersona
- Specified by:
getChannelLink
in interfaceIStakeholder
-
getDenyAssetFilters
TBC- Specified by:
getDenyAssetFilters
in interfaceIAccessControl
- Specified by:
getDenyAssetFilters
in interfaceIPersona
- Specified by:
getDenyAssetFilters
in interfaceIStakeholder
-
getDenyAssetTabs
TBC- Specified by:
getDenyAssetTabs
in interfaceIAccessControl
- Specified by:
getDenyAssetTabs
in interfaceIPersona
- Specified by:
getDenyAssetTabs
in interfaceIStakeholder
-
getDenyAssetTypes
TBC- Specified by:
getDenyAssetTypes
in interfaceIAccessControl
- Specified by:
getDenyAssetTypes
in interfaceIPersona
- Specified by:
getDenyAssetTypes
in interfaceIStakeholder
-
getDenyCustomMetadataGuids
TBC- Specified by:
getDenyCustomMetadataGuids
in interfaceIAccessControl
- Specified by:
getDenyCustomMetadataGuids
in interfaceIPersona
- Specified by:
getDenyCustomMetadataGuids
in interfaceIStakeholder
-
getDisplayPreferences
TBC- Specified by:
getDisplayPreferences
in interfaceIAccessControl
- Specified by:
getDisplayPreferences
in interfaceIPersona
- Specified by:
getDisplayPreferences
in interfaceIStakeholder
-
getIsAccessControlEnabled
TBC- Specified by:
getIsAccessControlEnabled
in interfaceIAccessControl
- Specified by:
getIsAccessControlEnabled
in interfaceIPersona
- Specified by:
getIsAccessControlEnabled
in interfaceIStakeholder
-
getPersonaGroups
TBC- Specified by:
getPersonaGroups
in interfaceIPersona
- Specified by:
getPersonaGroups
in interfaceIStakeholder
-
getPersonaUsers
TBC- Specified by:
getPersonaUsers
in interfaceIPersona
- Specified by:
getPersonaUsers
in interfaceIStakeholder
-
getPolicies
TBC- Specified by:
getPolicies
in interfaceIAccessControl
- Specified by:
getPolicies
in interfaceIPersona
- Specified by:
getPolicies
in interfaceIStakeholder
-
getRoleId
TBC- Specified by:
getRoleId
in interfaceIPersona
- Specified by:
getRoleId
in interfaceIStakeholder
-
getStakeholderDataDomain
Domain assigned to the Stakeholder- Specified by:
getStakeholderDataDomain
in interfaceIStakeholder
-
getStakeholderDomainQualifiedName
TBC- Specified by:
getStakeholderDomainQualifiedName
in interfaceIStakeholder
-
getStakeholderTitle
Stakeholder-title assigned for this Stakeholder-Persona- Specified by:
getStakeholderTitle
in interfaceIStakeholder
-
getStakeholderTitleGuid
TBC- Specified by:
getStakeholderTitleGuid
in interfaceIStakeholder
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
Description copied from class:AtlanObject
-
getTypeName
Fixed typeName for Stakeholders.- Specified by:
getTypeName
in interfaceAuditDetail
- Specified by:
getTypeName
in interfaceIAccessControl
- Specified by:
getTypeName
in interfaceIAsset
- Specified by:
getTypeName
in interfaceIPersona
- Specified by:
getTypeName
in interfaceIReferenceable
- Specified by:
getTypeName
in interfaceIStakeholder
- Overrides:
getTypeName
in classReference
-