Class 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:
  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

      public PrivateLink trimToReference() throws InvalidRequestException
      Builds the minimal object necessary to create a relationship to a PrivateLink, from a potentially more-complete PrivateLink object.
      Overrides:
      trimToReference in class Asset
      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

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
      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 assets
      includeArchived - when true, archived (soft-deleted) PrivateLinks will be included
      Returns:
      a fluent search that includes all PrivateLink assets
    • refByGuid

      public static PrivateLink refByGuid(String guid)
      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

      public static PrivateLink refByGuid(String guid, Reference.SaveSemantic semantic)
      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 reference
      semantic - 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

      public static PrivateLink refByQualifiedName(String qualifiedName)
      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

      public static PrivateLink refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)
      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 reference
      semantic - 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

      public static PrivateLink get(AtlanClient client, String id) throws AtlanException
      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 asset
      id - 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 the NotFoundException if 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 asset
      id - of the PrivateLink to retrieve, either its GUID or its full qualifiedName
      includeAllRelationships - if true, all the asset's relationships will also be retrieved; if false, no relationships will be retrieved
      Returns:
      the requested full PrivateLink, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if 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 asset
      id - of the PrivateLink to retrieve, either its GUID or its full qualifiedName
      attributes - 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 the NotFoundException if 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 asset
      id - of the PrivateLink to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the PrivateLink, including any relationships
      attributesOnRelated - 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 the NotFoundException if the PrivateLink does not exist or the provided GUID is not a PrivateLink
    • restore

      public static boolean restore(AtlanClient client, String qualifiedName) throws AtlanException
      Restore the archived (soft-deleted) PrivateLink to active.
      Parameters:
      client - connectivity to the Atlan tenant on which to restore the asset
      qualifiedName - for the PrivateLink
      Returns:
      true if the PrivateLink is now active, and false otherwise
      Throws:
      AtlanException - on any API problems
    • updater

      public static PrivateLink.PrivateLinkBuilder<?,?> updater(String qualifiedName, String name)
      Builds the minimal object necessary to update a PrivateLink.
      Parameters:
      qualifiedName - of the PrivateLink
      name - of the PrivateLink
      Returns:
      the minimal request necessary to update the PrivateLink, as a builder
    • trimToRequired

      public PrivateLink.PrivateLinkBuilder<?,?> trimToRequired() throws InvalidRequestException
      Builds the minimal object necessary to apply an update to a PrivateLink, from a potentially more-complete PrivateLink object.
      Overrides:
      trimToRequired in class Asset
      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 description
      qualifiedName - of the PrivateLink
      name - 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 description
      qualifiedName - of the PrivateLink
      name - 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 owners
      qualifiedName - of the PrivateLink
      name - 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 certificate
      qualifiedName - of the PrivateLink
      certificate - to use
      message - (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 certificate
      qualifiedName - of the PrivateLink
      name - 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 announcement
      qualifiedName - of the PrivateLink
      type - type of announcement to set
      title - (optional) title of the announcement to set (or null for no title)
      message - (optional) message of the announcement to set (or null for no message)
      Returns:
      the result of the update, or null if the update failed
      Throws:
      AtlanException - on any API problems
    • removeAnnouncement

      public static 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 announcement
      qualifiedName - of the PrivateLink
      name - 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 terms
      qualifiedName - for the PrivateLink
      name - human-readable name of the PrivateLink
      terms - 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
      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 PrivateLink
      qualifiedName - for the PrivateLink
      terms - 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
      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 PrivateLink
      qualifiedName - for the PrivateLink
      terms - 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
      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 PrivateLink
      qualifiedName - of the PrivateLink
      atlanTagNames - 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 PrivateLink
      qualifiedName - of the PrivateLink
      atlanTagNames - human-readable names of the Atlan tags to add
      propagate - whether to propagate the Atlan tag (true) or not (false)
      removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
      restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
      Returns:
      the updated PrivateLink
      Throws:
      AtlanException - on any API problems
    • removeAtlanTag

      @Deprecated public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a PrivateLink.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a PrivateLink
      qualifiedName - of the PrivateLink
      atlanTagName - human-readable name of the Atlan tag to remove
      Throws:
      AtlanException - on any API problems, or if the Atlan tag does not exist on the PrivateLink
    • _internal

      public static PrivateLink.PrivateLinkBuilder<?,?> _internal()
    • toBuilder

      public PrivateLink.PrivateLinkBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference
    • getPrivateLinkCloud

      public PrivateLinkCloud getPrivateLinkCloud()
      Cloud provider on which this private link is set up.
      Specified by:
      getPrivateLinkCloud in interface IPrivateLink
    • getPrivateLinkDestPort

      public Integer getPrivateLinkDestPort()
      Destination port on the customer's service that traffic over this private link is sent to.
      Specified by:
      getPrivateLinkDestPort in interface IPrivateLink
    • getPrivateLinkDnsEntries

      public SortedSet<String> getPrivateLinkDnsEntries()
      DNS names that the cloud provider assigned to the endpoint.
      Specified by:
      getPrivateLinkDnsEntries in interface IPrivateLink
    • getPrivateLinkDnsHostname

      public String getPrivateLinkDnsHostname()
      Hostname that resolves to this private link's endpoint inside Atlan.
      Specified by:
      getPrivateLinkDnsHostname in interface IPrivateLink
    • getPrivateLinkEndpointId

      public String 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:
      getPrivateLinkEndpointId in interface IPrivateLink
    • getPrivateLinkEndpointName

      public String getPrivateLinkEndpointName()
      Name of the endpoint for this private link, as shown to users.
      Specified by:
      getPrivateLinkEndpointName in interface IPrivateLink
    • getPrivateLinkGithubPrUrl

      public String getPrivateLinkGithubPrUrl()
      URL of the pull request that applies the infrastructure change for this private link.
      Specified by:
      getPrivateLinkGithubPrUrl in interface IPrivateLink
    • getPrivateLinkLastStatusAt

      public Long getPrivateLinkLastStatusAt()
      Time (epoch) at which the status of this private link last changed, in milliseconds.
      Specified by:
      getPrivateLinkLastStatusAt in interface IPrivateLink
    • getPrivateLinkOperationId

      public String getPrivateLinkOperationId()
      Identifier of the most recent provisioning operation for this private link.
      Specified by:
      getPrivateLinkOperationId in interface IPrivateLink
    • getPrivateLinkProviderState

      public String getPrivateLinkProviderState()
      Raw state of the endpoint as reported by the cloud provider, for example pendingAcceptance on AWS or Pending on Azure.
      Specified by:
      getPrivateLinkProviderState in interface IPrivateLink
    • getPrivateLinkRegion

      public String getPrivateLinkRegion()
      Cloud region of the customer's service and of the Atlan endpoint, for example us-east-1.
      Specified by:
      getPrivateLinkRegion in interface IPrivateLink
    • getPrivateLinkServiceName

      public String 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:
      getPrivateLinkServiceName in interface IPrivateLink
    • getPrivateLinkStatus

      public String getPrivateLinkStatus()
      Lifecycle status of this private link: DRAFT, EXPIRED, SUBMITTING, REQUESTED, SETTING_UP, WAITING_FOR_ACCEPTANCE, SETTING_UP_DNS, READY or FAILED.
      Specified by:
      getPrivateLinkStatus in interface IPrivateLink
    • getPrivateLinkStatusMessage

      public String getPrivateLinkStatusMessage()
      Human-readable detail about the current status, such as the reason for a failure.
      Specified by:
      getPrivateLinkStatusMessage in interface IPrivateLink
    • getPrivateLinkWizardState

      public String getPrivateLinkWizardState()
      JSON state of the setup wizard (path, version, step and answers), as saved by the frontend.
      Specified by:
      getPrivateLinkWizardState in interface IPrivateLink
    • getPrivateLinkZoneIds

      public SortedSet<String> getPrivateLinkZoneIds()
      Availability zone IDs in which the customer's service is available, on clouds that use them (AWS).
      Specified by:
      getPrivateLinkZoneIds in interface IPrivateLink
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Asset
    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class Asset
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Asset
    • toString

      public String toString()
      Description copied from class: AtlanObject
      Overrides:
      toString in class Asset
    • getTypeName

      public String getTypeName()
      Fixed typeName for PrivateLinks.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface IPrivateLink
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference