Package com.atlan.model.assets
Class PrivateLink
java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.PrivateLink
- All Implemented Interfaces:
IAsset,IPrivateLink,IReferenceable,AuditDetail,Serializable,Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2")
public class PrivateLink
extends Asset
implements IPrivateLink, IAsset, IReferenceable
Instance of a private connection (AWS PrivateLink, Azure Private Link or GCP Private Service Connect) from a customer network to Atlan, set up from the Networking admin page.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classPrivateLink.PrivateLinkBuilder<C extends PrivateLink,B extends PrivateLink.PrivateLinkBuilder<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
FieldsFields inherited from class com.atlan.model.core.AtlanObject
rawJsonObjectFields inherited from interface com.atlan.model.assets.IAsset
ADMIN_GROUPS, ADMIN_ROLES, ADMIN_USERS, ANNOUNCEMENT_MESSAGE, ANNOUNCEMENT_TITLE, ANNOUNCEMENT_TYPE, ANNOUNCEMENT_UPDATED_AT, ANNOUNCEMENT_UPDATED_BY, ANOMALO_CHECKS, APPLICATION, APPLICATION_FIELD, APPLICATION_FIELD_QUALIFIED_NAME, APPLICATION_QUALIFIED_NAME, ASSET_AI_ALIAS, ASSET_AI_GENERATED_DESCRIPTION, ASSET_AI_GENERATED_DESCRIPTION_CONFIDENCE, ASSET_AI_GENERATED_DESCRIPTION_REASONING, ASSET_ANNOUNCEMENT_EXPIRED_AT, ASSET_ANOMALO_APPLIED_CHECK_TYPES, ASSET_ANOMALO_CHECK_COUNT, ASSET_ANOMALO_CHECK_STATUSES, ASSET_ANOMALO_DQ_STATUS, ASSET_ANOMALO_FAILED_CHECK_COUNT, ASSET_ANOMALO_FAILED_CHECK_TYPES, ASSET_ANOMALO_LAST_CHECK_RUN_AT, ASSET_ANOMALO_SOURCE_URL, ASSET_COVER_IMAGE, ASSET_DBT_ACCOUNT_NAME, ASSET_DBT_ALIAS, ASSET_DBT_ENVIRONMENT_DBT_VERSION, ASSET_DBT_ENVIRONMENT_NAME, ASSET_DBT_JOB_LAST_RUN, ASSET_DBT_JOB_LAST_RUN_ARTIFACT_S3PATH, ASSET_DBT_JOB_LAST_RUN_ARTIFACTS_SAVED, ASSET_DBT_JOB_LAST_RUN_CREATED_AT, ASSET_DBT_JOB_LAST_RUN_DEQUED_AT, ASSET_DBT_JOB_LAST_RUN_EXECUTED_BY_THREAD_ID, ASSET_DBT_JOB_LAST_RUN_GIT_BRANCH, ASSET_DBT_JOB_LAST_RUN_GIT_SHA, ASSET_DBT_JOB_LAST_RUN_HAS_DOCS_GENERATED, ASSET_DBT_JOB_LAST_RUN_HAS_SOURCES_GENERATED, ASSET_DBT_JOB_LAST_RUN_NOTIFICATIONS_SENT, ASSET_DBT_JOB_LAST_RUN_OWNER_THREAD_ID, ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION, ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_RUN_DURATION, ASSET_DBT_JOB_LAST_RUN_RUN_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_STARTED_AT, ASSET_DBT_JOB_LAST_RUN_STATUS_MESSAGE, ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION, ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_UPDATED_AT, ASSET_DBT_JOB_LAST_RUN_URL, ASSET_DBT_JOB_NAME, ASSET_DBT_JOB_NEXT_RUN, ASSET_DBT_JOB_NEXT_RUN_HUMANIZED, ASSET_DBT_JOB_SCHEDULE, ASSET_DBT_JOB_SCHEDULE_CRON_HUMANIZED, ASSET_DBT_JOB_STATUS, ASSET_DBT_META, ASSET_DBT_PACKAGE_NAME, ASSET_DBT_PROJECT_NAME, ASSET_DBT_SEMANTIC_LAYER_PROXY_URL, ASSET_DBT_SOURCE_FRESHNESS_CRITERIA, ASSET_DBT_TAGS, ASSET_DBT_TEST_STATUS, ASSET_DBT_UNIQUE_ID, ASSET_DBT_WORKFLOW_LAST_UPDATED, ASSET_DQ_FRESHNESS_EXPECTATION, ASSET_DQ_FRESHNESS_VALUE, ASSET_DQ_MANUAL_RUN_STATUS, ASSET_DQ_RESULT, ASSET_DQ_ROW_SCOPE_FILTER_COLUMN_QUALIFIED_NAME, ASSET_DQ_RULE_ATTACHED_DIMENSIONS, ASSET_DQ_RULE_ATTACHED_RULE_TYPES, ASSET_DQ_RULE_FAILED_COUNT, ASSET_DQ_RULE_FAILED_DIMENSIONS, ASSET_DQ_RULE_FAILED_RULE_TYPES, ASSET_DQ_RULE_LAST_RUN_AT, ASSET_DQ_RULE_PASSED_COUNT, ASSET_DQ_RULE_PASSED_DIMENSIONS, ASSET_DQ_RULE_PASSED_RULE_TYPES, ASSET_DQ_RULE_RESULT_TAGS, ASSET_DQ_RULE_TOTAL_COUNT, ASSET_DQ_SCHEDULE_CRONTAB, ASSET_DQ_SCHEDULE_SOURCE_SYNC_ERROR_CODE, ASSET_DQ_SCHEDULE_SOURCE_SYNC_ERROR_MESSAGE, ASSET_DQ_SCHEDULE_SOURCE_SYNC_RAW_ERROR, ASSET_DQ_SCHEDULE_SOURCE_SYNC_STATUS, ASSET_DQ_SCHEDULE_SOURCE_SYNCED_AT, ASSET_DQ_SCHEDULE_TIME_ZONE, ASSET_DQ_SCHEDULE_TYPE, ASSET_EXTERNAL_DQ_METADATA_DETAILS, ASSET_EXTERNAL_DQ_SCORE_VALUE, ASSET_EXTERNAL_DQ_TEST_AVG_SCORES, ASSET_EXTERNAL_DQ_TEST_ENTITIES, ASSET_EXTERNAL_DQ_TEST_LATEST_SCORES, ASSET_EXTERNAL_DQ_TEST_MIN_SCORES, ASSET_GCP_DATAPLEX_ASPECT_FIELD_LIST, ASSET_GCP_DATAPLEX_ASPECT_LIST, ASSET_GCP_DATAPLEX_METADATA_DETAILS, ASSET_HAS_AI_README, ASSET_ICON, ASSET_IMMUTA_REQUEST_TYPE, ASSET_IMMUTA_REQUEST_URL, ASSET_INTERNAL_POPULARITY_SCORE, ASSET_MANAGED_BY, ASSET_MC_ALERT_QUALIFIED_NAMES, ASSET_MC_INCIDENT_NAMES, ASSET_MC_INCIDENT_PRIORITIES, ASSET_MC_INCIDENT_QUALIFIED_NAMES, ASSET_MC_INCIDENT_SEVERITIES, ASSET_MC_INCIDENT_STATES, ASSET_MC_INCIDENT_SUB_TYPES, ASSET_MC_INCIDENT_TYPES, ASSET_MC_IS_MONITORED, ASSET_MC_LAST_SYNC_RUN_AT, ASSET_MC_MONITOR_NAMES, ASSET_MC_MONITOR_QUALIFIED_NAMES, ASSET_MC_MONITOR_SCHEDULE_TYPES, ASSET_MC_MONITOR_STATUSES, ASSET_MC_MONITOR_TYPES, ASSET_POLICIES_COUNT, ASSET_POLICY_GUIDS, ASSET_REDIRECT_GUIDS, ASSET_SMUS_METADATA_FORM_DETAILS, ASSET_SMUS_METADATA_FORM_KEY_VALUE_DETAILS, ASSET_SMUS_METADATA_FORM_NAMES, ASSET_SODA_CHECK_COUNT, ASSET_SODA_CHECK_STATUSES, ASSET_SODA_DQ_STATUS, ASSET_SODA_LAST_SCAN_AT, ASSET_SODA_LAST_SYNC_RUN_AT, ASSET_SODA_SOURCE_URL, ASSET_SOURCE_ID, ASSET_SOURCE_README, ASSET_SPACE_NAME, ASSET_SPACE_QUALIFIED_NAME, ASSET_SUMMARY, ASSET_SUMMARY_FILTER_TOKENS, ASSET_SUMMARY_PROVIDER, ASSET_TAGS, ASSET_THEME_HEX, ASSET_USER_DEFINED_TYPE, CERTIFICATE_STATUS, CERTIFICATE_STATUS_MESSAGE, CERTIFICATE_UPDATED_AT, CERTIFICATE_UPDATED_BY, CONNECTION_NAME, CONNECTION_QUALIFIED_NAME, CONNECTOR_NAME, CONNECTOR_TYPE, CUSTOM_CONNECTOR_TYPE, DATA_CONTRACT_LATEST, DATA_CONTRACT_LATEST_CERTIFIED, DBT_QUALIFIED_NAME, DESCRIPTION, DISPLAY_NAME, DOMAIN_GUIDS, DQ_BASE_DATASET_RULES, DQ_REFERENCE_DATASET_RULES, FILES, HAS_CONTRACT, HAS_LINEAGE, INPUT_PORT_DATA_PRODUCTS, IS_AI_GENERATED, IS_DISCOVERABLE, IS_EDITABLE, IS_PARTIAL, LAST_ROW_CHANGED_AT, LAST_SYNC_RUN, LAST_SYNC_RUN_AT, LAST_SYNC_WORKFLOW_NAME, LEXICOGRAPHICAL_SORT_ORDER, LINKS, MC_INCIDENTS, MC_MONITORS, METRICS, NAME, NON_COMPLIANT_ASSET_POLICY_GUIDS, OUTPUT_PORT_DATA_PRODUCTS, OUTPUT_PRODUCT_GUIDS, OWNER_GROUPS, OWNER_USERS, POPULARITY_SCORE, PRODUCT_GUIDS, QUALIFIED_NAME, README, SAMPLE_DATA_URL, SCHEMA_REGISTRY_SUBJECTS, SODA_CHECKS, SOURCE_COST_UNIT, SOURCE_CREATED_AT, SOURCE_CREATED_BY, SOURCE_EMBED_URL, SOURCE_LAST_READ_AT, SOURCE_OWNERS, SOURCE_QUERY_COMPUTE_COST_RECORDS, SOURCE_QUERY_COMPUTE_COSTS, SOURCE_READ_COUNT, SOURCE_READ_EXPENSIVE_QUERY_RECORDS, SOURCE_READ_POPULAR_QUERY_RECORDS, SOURCE_READ_QUERY_COST, SOURCE_READ_RECENT_USER_RECORDS, SOURCE_READ_RECENT_USERS, SOURCE_READ_SLOW_QUERY_RECORDS, SOURCE_READ_TOP_USER_RECORDS, SOURCE_READ_TOP_USERS, SOURCE_READ_USER_COUNT, SOURCE_TOTAL_COST, SOURCE_UPDATED_AT, SOURCE_UPDATED_BY, SOURCE_URL, STARRED_BY, STARRED_COUNT, STARRED_DETAILS, SUB_TYPE, TENANT_ID, USER_DEF_RELATIONSHIP_FROMS, USER_DEF_RELATIONSHIP_TOS, USER_DESCRIPTION, VIEW_SCORE, VIEWER_GROUPS, VIEWER_USERSFields inherited from interface com.atlan.model.assets.IPrivateLink
PRIVATE_LINK_CLOUD, PRIVATE_LINK_DEST_PORT, PRIVATE_LINK_DNS_ENTRIES, PRIVATE_LINK_DNS_HOSTNAME, PRIVATE_LINK_ENDPOINT_ID, PRIVATE_LINK_ENDPOINT_NAME, PRIVATE_LINK_GITHUB_PR_URL, PRIVATE_LINK_LAST_STATUS_AT, PRIVATE_LINK_OPERATION_ID, PRIVATE_LINK_PROVIDER_STATE, PRIVATE_LINK_REGION, PRIVATE_LINK_SERVICE_NAME, PRIVATE_LINK_STATUS, PRIVATE_LINK_STATUS_MESSAGE, PRIVATE_LINK_WIZARD_STATE, PRIVATE_LINK_ZONE_IDSFields 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 -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic PrivateLink.PrivateLinkBuilder<?, ?> static PrivateLinkappendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) Deprecated.static PrivateLinkappendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) static PrivateLinkappendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Deprecated.protected booleanbooleanstatic PrivateLinkget(AtlanClient client, String id) Retrieves a PrivateLink by one of its identifiers, complete with all of its relationships.static PrivateLinkget(AtlanClient client, String id, boolean includeAllRelationships) Retrieves a PrivateLink by one of its identifiers, optionally complete with all of its relationships.static PrivateLinkget(AtlanClient client, String id, Collection<AtlanField> attributes) Retrieves a PrivateLink by one of its identifiers, with only the requested attributes (and relationships).static PrivateLinkget(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) Retrieves a PrivateLink by one of its identifiers, with only the requested attributes (and relationships).Cloud provider on which this private link is set up.Destination port on the customer's service that traffic over this private link is sent to.DNS names that the cloud provider assigned to the endpoint.Hostname that resolves to this private link's endpoint inside Atlan.Identifier of the endpoint created on the Atlan side: an AWS VPC endpoint ID, an Azure private endpoint resource ID or a GCP forwarding rule.Name of the endpoint for this private link, as shown to users.URL of the pull request that applies the infrastructure change for this private link.Time (epoch) at which the status of this private link last changed, in milliseconds.Identifier of the most recent provisioning operation for this private link.Raw state of the endpoint as reported by the cloud provider, for example pendingAcceptance on AWS or Pending on Azure.Cloud region of the customer's service and of the Atlan endpoint, for example us-east-1.Identifier of the customer's service that Atlan connects to: an AWS VPC endpoint service name, an Azure Private Link service alias or a GCP service attachment URI.Lifecycle status of this private link: DRAFT, EXPIRED, SUBMITTING, REQUESTED, SETTING_UP, WAITING_FOR_ACCEPTANCE, SETTING_UP_DNS, READY or FAILED.Human-readable detail about the current status, such as the reason for a failure.JSON state of the setup wizard (path, version, step and answers), as saved by the frontend.Availability zone IDs in which the customer's service is available, on clouds that use them (AWS).Fixed typeName for PrivateLinks.inthashCode()static PrivateLinkReference to a PrivateLink by GUID.static PrivateLinkrefByGuid(String guid, Reference.SaveSemantic semantic) Reference to a PrivateLink by GUID.static PrivateLinkrefByQualifiedName(String qualifiedName) Reference to a PrivateLink by qualifiedName.static PrivateLinkrefByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic) Reference to a PrivateLink by qualifiedName.static PrivateLinkremoveAnnouncement(AtlanClient client, String qualifiedName, String name) Remove the announcement from a PrivateLink.static voidremoveAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) Deprecated.static PrivateLinkremoveCertificate(AtlanClient client, String qualifiedName, String name) Remove the certificate from a PrivateLink.static PrivateLinkremoveDescription(AtlanClient client, String qualifiedName, String name) Remove the system description from a PrivateLink.static PrivateLinkremoveOwners(AtlanClient client, String qualifiedName, String name) Remove the owners from a PrivateLink.static PrivateLinkremoveTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Deprecated.static PrivateLinkremoveUserDescription(AtlanClient client, String qualifiedName, String name) Remove the user's description from a PrivateLink.static PrivateLinkreplaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the PrivateLink.static booleanrestore(AtlanClient client, String qualifiedName) Restore the archived (soft-deleted) PrivateLink to active.static FluentSearch.FluentSearchBuilder<?, ?> select(AtlanClient client) Start a fluent search that will return all PrivateLink assets.static FluentSearch.FluentSearchBuilder<?, ?> select(AtlanClient client, boolean includeArchived) Start a fluent search that will return all PrivateLink assets.toString()Builds the minimal object necessary to create a relationship to a PrivateLink, from a potentially more-complete PrivateLink object.Builds the minimal object necessary to apply an update to a PrivateLink, from a potentially more-complete PrivateLink object.static PrivateLinkupdateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a PrivateLink.static PrivateLinkupdateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a PrivateLink.static PrivateLink.PrivateLinkBuilder<?, ?> Builds the minimal object necessary to update a PrivateLink.Methods inherited from class com.atlan.model.assets.Asset
addApiTokenAsAdmin, appendAtlanTags, appendAtlanTags, appendTerms, delete, get, getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiAlias, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetExternalDQScoreValue, getAssetExternalDQTestAvgScores, getAssetExternalDQTestEntities, getAssetExternalDQTestLatestScores, getAssetExternalDQTestMinScores, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetHasAiReadme, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetManagedBy, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetSummary, getAssetSummaryFilterTokens, getAssetSummaryProvider, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getAtlanTagNames, getAtlanTags, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCreatedBy, getCreateTime, getCustomConnectorType, getCustomMetadata, getCustomMetadataSets, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDeleteHandler, getDepth, getDescription, getDisplayName, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getFiles, getHasContract, getHasLineage, getIconUrl, getImmediateDownstream, getImmediateUpstream, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsIncomplete, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMeaningNames, getMeanings, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getNullFields, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPendingTasks, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getStatus, getSubType, getTenantId, getUpdatedBy, getUpdateTime, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, lineage, lineage, purge, removeAnnouncement, removeAtlanTag, removeCertificate, removeCustomMetadata, removeDescription, removeOwners, removeTerms, removeUserDescription, replaceCustomMetadata, replaceTerms, requestLineage, restore, save, save, saveMergingCM, saveMergingCM, saveReplacingCM, saveReplacingCM, updateAnnouncement, updateAnnouncement, updateCertificate, updateCertificate, updateCustomMetadataAttributes, updateMergingCM, updateMergingCM, updateReplacingCM, updateReplacingCMMethods inherited from class com.atlan.model.relations.Reference
builder, by, compareTo, getAddedRelationshipAttributes, getCompleteObject, getCustomAttributes, getDisplayText, getDocId, getEntityStatus, getGuid, getLabels, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getRemovedRelationshipAttributes, getSemantic, getUniqueAttributes, isComplete, isValidReference, isValidReferenceByGuid, isValidReferenceByQualifiedName, setCompleteObject, to, validateRelationship, validateRequiredMethods inherited from class com.atlan.model.core.AtlanObject
getRawJsonObject, setRawJsonObject, toJsonMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.atlan.model.search.AuditDetail
getRawJsonObject, setRawJsonObjectMethods inherited from interface com.atlan.model.assets.IAsset
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiAlias, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetExternalDQScoreValue, getAssetExternalDQTestAvgScores, getAssetExternalDQTestEntities, getAssetExternalDQTestLatestScores, getAssetExternalDQTestMinScores, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetHasAiReadme, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetManagedBy, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetSummary, getAssetSummaryFilterTokens, getAssetSummaryProvider, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedNameMethods inherited from interface com.atlan.model.assets.IPrivateLink
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAiAlias, getAssetAiGeneratedDescription, getAssetAiGeneratedDescriptionConfidence, getAssetAiGeneratedDescriptionReasoning, getAssetAnnouncementExpiredAt, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQManualRunStatus, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetExternalDQScoreValue, getAssetExternalDQTestAvgScores, getAssetExternalDQTestEntities, getAssetExternalDQTestLatestScores, getAssetExternalDQTestMinScores, getAssetGCPDataplexAspectFieldList, getAssetGCPDataplexAspectList, getAssetGCPDataplexMetadataDetails, getAssetHasAiReadme, getAssetIcon, getAssetImmutaRequestType, getAssetImmutaRequestUrl, getAssetInternalPopularityScore, getAssetManagedBy, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSmusMetadataFormDetails, getAssetSmusMetadataFormKeyValueDetails, getAssetSmusMetadataFormNames, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceId, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetSummary, getAssetSummaryFilterTokens, getAssetSummaryProvider, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedNameMethods inherited from interface com.atlan.model.assets.IReferenceable
getAtlanTagNames, getAtlanTags, getCreatedBy, getCreateTime, getCustomMetadataSets, getDeleteHandler, getGuid, getIsIncomplete, getMeaningNames, getMeanings, getPendingTasks, getQualifiedName, getStatus, getUpdatedBy, getUpdateTime
-
Field Details
-
TYPE_NAME
- See Also:
-
-
Constructor Details
-
PrivateLink
-
-
Method Details
-
trimToReference
Builds the minimal object necessary to create a relationship to a PrivateLink, from a potentially more-complete PrivateLink object.- Overrides:
trimToReferencein classAsset- Returns:
- the minimal object necessary to relate to the PrivateLink
- Throws:
InvalidRequestException- if any of the minimal set of required properties for a PrivateLink relationship are not found in the initial object
-
select
Start a fluent search that will return all PrivateLink 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) PrivateLink assets will be included.- Parameters:
client- connectivity to the Atlan tenant from which to retrieve the assets- Returns:
- a fluent search that includes all PrivateLink assets
-
select
public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived) Start a fluent search that will return all PrivateLink 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) PrivateLinks will be included- Returns:
- a fluent search that includes all PrivateLink assets
-
refByGuid
Reference to a PrivateLink by GUID. Use this to create a relationship to this PrivateLink, where the relationship should be replaced.- Parameters:
guid- the GUID of the PrivateLink to reference- Returns:
- reference to a PrivateLink that can be used for defining a relationship to a PrivateLink
-
refByGuid
Reference to a PrivateLink by GUID. Use this to create a relationship to this PrivateLink, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
guid- the GUID of the PrivateLink to referencesemantic- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a PrivateLink that can be used for defining a relationship to a PrivateLink
-
refByQualifiedName
Reference to a PrivateLink by qualifiedName. Use this to create a relationship to this PrivateLink, where the relationship should be replaced.- Parameters:
qualifiedName- the qualifiedName of the PrivateLink to reference- Returns:
- reference to a PrivateLink that can be used for defining a relationship to a PrivateLink
-
refByQualifiedName
Reference to a PrivateLink by qualifiedName. Use this to create a relationship to this PrivateLink, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
qualifiedName- the qualifiedName of the PrivateLink to referencesemantic- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a PrivateLink that can be used for defining a relationship to a PrivateLink
-
get
Retrieves a PrivateLink 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 PrivateLink to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full PrivateLink, complete with all of its relationships
- Throws:
AtlanException- on any error during the API invocation, such as theNotFoundExceptionif the PrivateLink does not exist or the provided GUID is not a PrivateLink
-
get
public static PrivateLink get(AtlanClient client, String id, boolean includeAllRelationships) throws AtlanException Retrieves a PrivateLink 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 PrivateLink to retrieve, either its GUID or its full qualifiedNameincludeAllRelationships- if true, all the asset's relationships will also be retrieved; if false, no relationships will be retrieved- Returns:
- the requested full PrivateLink, optionally complete with all of its relationships
- Throws:
AtlanException- on any error during the API invocation, such as theNotFoundExceptionif the PrivateLink does not exist or the provided GUID is not a PrivateLink
-
get
public static PrivateLink get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException Retrieves a PrivateLink by one of its identifiers, with only the requested attributes (and relationships).- Parameters:
client- connectivity to the Atlan tenant from which to retrieve the assetid- of the PrivateLink to retrieve, either its GUID or its full qualifiedNameattributes- to retrieve for the PrivateLink, including any relationships- Returns:
- the requested PrivateLink, with only its minimal information and the requested attributes (and relationships)
- Throws:
AtlanException- on any error during the API invocation, such as theNotFoundExceptionif the PrivateLink does not exist or the provided GUID is not a PrivateLink
-
get
public static PrivateLink get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException Retrieves a PrivateLink by one of its identifiers, with only the requested attributes (and relationships).- Parameters:
client- connectivity to the Atlan tenant from which to retrieve the assetid- of the PrivateLink to retrieve, either its GUID or its full qualifiedNameattributes- to retrieve for the PrivateLink, including any relationshipsattributesOnRelated- to retrieve on each relationship retrieved for the PrivateLink- Returns:
- the requested PrivateLink, with only its minimal information and the requested attributes (and relationships)
- Throws:
AtlanException- on any error during the API invocation, such as theNotFoundExceptionif the PrivateLink does not exist or the provided GUID is not a PrivateLink
-
restore
Restore the archived (soft-deleted) PrivateLink to active.- Parameters:
client- connectivity to the Atlan tenant on which to restore the assetqualifiedName- for the PrivateLink- Returns:
- true if the PrivateLink is now active, and false otherwise
- Throws:
AtlanException- on any API problems
-
updater
Builds the minimal object necessary to update a PrivateLink.- Parameters:
qualifiedName- of the PrivateLinkname- of the PrivateLink- Returns:
- the minimal request necessary to update the PrivateLink, as a builder
-
trimToRequired
Builds the minimal object necessary to apply an update to a PrivateLink, from a potentially more-complete PrivateLink object.- Overrides:
trimToRequiredin classAsset- Returns:
- the minimal object necessary to update the PrivateLink, as a builder
- Throws:
InvalidRequestException- if any of the minimal set of required fields for a PrivateLink are not present in the initial object
-
removeDescription
public static PrivateLink removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the system description from a PrivateLink.- Parameters:
client- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName- of the PrivateLinkname- of the PrivateLink- Returns:
- the updated PrivateLink, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
removeUserDescription
public static PrivateLink removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the user's description from a PrivateLink.- Parameters:
client- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName- of the PrivateLinkname- of the PrivateLink- Returns:
- the updated PrivateLink, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
removeOwners
public static PrivateLink removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the owners from a PrivateLink.- Parameters:
client- connectivity to the Atlan tenant from which to remove the PrivateLink's ownersqualifiedName- of the PrivateLinkname- of the PrivateLink- Returns:
- the updated PrivateLink, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
updateCertificate
public static PrivateLink updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a PrivateLink.- Parameters:
client- connectivity to the Atlan tenant on which to update the PrivateLink's certificatequalifiedName- of the PrivateLinkcertificate- to usemessage- (optional) message, or null if no message- Returns:
- the updated PrivateLink, or null if the update failed
- Throws:
AtlanException- on any API problems
-
removeCertificate
public static PrivateLink removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the certificate from a PrivateLink.- Parameters:
client- connectivity to the Atlan tenant from which to remove the PrivateLink's certificatequalifiedName- of the PrivateLinkname- of the PrivateLink- Returns:
- the updated PrivateLink, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
updateAnnouncement
public static PrivateLink updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a PrivateLink.- Parameters:
client- connectivity to the Atlan tenant on which to update the PrivateLink's announcementqualifiedName- of the PrivateLinktype- 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 PrivateLink removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the announcement from a PrivateLink.- Parameters:
client- connectivity to the Atlan client from which to remove the PrivateLink's announcementqualifiedName- of the PrivateLinkname- of the PrivateLink- Returns:
- the updated PrivateLink, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
replaceTerms
public static PrivateLink replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the PrivateLink.- Parameters:
client- connectivity to the Atlan tenant on which to replace the PrivateLink's assigned termsqualifiedName- for the PrivateLinkname- human-readable name of the PrivateLinkterms- the list of terms to replace on the PrivateLink, or null to remove all terms from the PrivateLink- Returns:
- the PrivateLink that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException- on any API problems
-
appendTerms
@Deprecated public static PrivateLink appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Deprecated.Link additional terms to the PrivateLink, without replacing existing terms linked to the PrivateLink. Note: this operation must make two API calls — one to retrieve the PrivateLink'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 PrivateLinkqualifiedName- for the PrivateLinkterms- the list of terms to append to the PrivateLink- Returns:
- the PrivateLink that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException- on any API problems
-
removeTerms
@Deprecated public static PrivateLink removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Deprecated.Remove terms from a PrivateLink, without replacing all existing terms linked to the PrivateLink. Note: this operation must make two API calls — one to retrieve the PrivateLink'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 PrivateLinkqualifiedName- for the PrivateLinkterms- the list of terms to remove from the PrivateLink, which must be referenced by GUID- Returns:
- the PrivateLink that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException- on any API problems
-
appendAtlanTags
@Deprecated public static PrivateLink appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException Deprecated.Add Atlan tags to a PrivateLink, without replacing existing Atlan tags linked to the PrivateLink. Note: this operation must make two API calls — one to retrieve the PrivateLink'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 PrivateLinkqualifiedName- of the PrivateLinkatlanTagNames- human-readable names of the Atlan tags to add- Returns:
- the updated PrivateLink
- Throws:
AtlanException- on any API problems
-
appendAtlanTags
@Deprecated public static PrivateLink appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a PrivateLink, without replacing existing Atlan tags linked to the PrivateLink. Note: this operation must make two API calls — one to retrieve the PrivateLink'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 PrivateLinkqualifiedName- of the PrivateLinkatlanTagNames- 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 PrivateLink
- Throws:
AtlanException- on any API problems
-
removeAtlanTag
@Deprecated public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException Deprecated.Remove an Atlan tag from a PrivateLink.- Parameters:
client- connectivity to the Atlan tenant from which to remove an Atlan tag from a PrivateLinkqualifiedName- of the PrivateLinkatlanTagName- 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 PrivateLink
-
_internal
-
toBuilder
-
getPrivateLinkCloud
Cloud provider on which this private link is set up.- Specified by:
getPrivateLinkCloudin interfaceIPrivateLink
-
getPrivateLinkDestPort
Destination port on the customer's service that traffic over this private link is sent to.- Specified by:
getPrivateLinkDestPortin interfaceIPrivateLink
-
getPrivateLinkDnsEntries
DNS names that the cloud provider assigned to the endpoint.- Specified by:
getPrivateLinkDnsEntriesin interfaceIPrivateLink
-
getPrivateLinkDnsHostname
Hostname that resolves to this private link's endpoint inside Atlan.- Specified by:
getPrivateLinkDnsHostnamein interfaceIPrivateLink
-
getPrivateLinkEndpointId
Identifier of the endpoint created on the Atlan side: an AWS VPC endpoint ID, an Azure private endpoint resource ID or a GCP forwarding rule.- Specified by:
getPrivateLinkEndpointIdin interfaceIPrivateLink
-
getPrivateLinkEndpointName
Name of the endpoint for this private link, as shown to users.- Specified by:
getPrivateLinkEndpointNamein interfaceIPrivateLink
-
getPrivateLinkGithubPrUrl
URL of the pull request that applies the infrastructure change for this private link.- Specified by:
getPrivateLinkGithubPrUrlin interfaceIPrivateLink
-
getPrivateLinkLastStatusAt
Time (epoch) at which the status of this private link last changed, in milliseconds.- Specified by:
getPrivateLinkLastStatusAtin interfaceIPrivateLink
-
getPrivateLinkOperationId
Identifier of the most recent provisioning operation for this private link.- Specified by:
getPrivateLinkOperationIdin interfaceIPrivateLink
-
getPrivateLinkProviderState
Raw state of the endpoint as reported by the cloud provider, for example pendingAcceptance on AWS or Pending on Azure.- Specified by:
getPrivateLinkProviderStatein interfaceIPrivateLink
-
getPrivateLinkRegion
Cloud region of the customer's service and of the Atlan endpoint, for example us-east-1.- Specified by:
getPrivateLinkRegionin interfaceIPrivateLink
-
getPrivateLinkServiceName
Identifier of the customer's service that Atlan connects to: an AWS VPC endpoint service name, an Azure Private Link service alias or a GCP service attachment URI.- Specified by:
getPrivateLinkServiceNamein interfaceIPrivateLink
-
getPrivateLinkStatus
Lifecycle status of this private link: DRAFT, EXPIRED, SUBMITTING, REQUESTED, SETTING_UP, WAITING_FOR_ACCEPTANCE, SETTING_UP_DNS, READY or FAILED.- Specified by:
getPrivateLinkStatusin interfaceIPrivateLink
-
getPrivateLinkStatusMessage
Human-readable detail about the current status, such as the reason for a failure.- Specified by:
getPrivateLinkStatusMessagein interfaceIPrivateLink
-
getPrivateLinkWizardState
JSON state of the setup wizard (path, version, step and answers), as saved by the frontend.- Specified by:
getPrivateLinkWizardStatein interfaceIPrivateLink
-
getPrivateLinkZoneIds
Availability zone IDs in which the customer's service is available, on clouds that use them (AWS).- Specified by:
getPrivateLinkZoneIdsin interfaceIPrivateLink
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
Description copied from class:AtlanObject -
getTypeName
Fixed typeName for PrivateLinks.- Specified by:
getTypeNamein interfaceAuditDetail- Specified by:
getTypeNamein interfaceIAsset- Specified by:
getTypeNamein interfaceIPrivateLink- Specified by:
getTypeNamein interfaceIReferenceable- Overrides:
getTypeNamein classReference
-
Asset.AssetBuilder.appendAtlanTags(List)