Package com.atlan.model.assets

Class AuthService

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.AuthService
All Implemented Interfaces:
IAsset, IAuthService, IReferenceable, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class AuthService extends Asset implements IAuthService, IAsset, IReferenceable
Model to store auth service in Atlas
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

      public AuthService trimToReference() throws InvalidRequestException
      Builds the minimal object necessary to create a relationship to a AuthService, from a potentially more-complete AuthService object.
      Overrides:
      trimToReference in class Asset
      Returns:
      the minimal object necessary to relate to the AuthService
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for a AuthService relationship are not found in the initial object

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select()
      Start a fluent search that will return all AuthService 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) AuthService assets will be included.
      Returns:
      a fluent search that includes all AuthService assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
      Start a fluent search that will return all AuthService 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) AuthService assets will be included.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      Returns:
      a fluent search that includes all AuthService assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(boolean includeArchived)
      Start a fluent search that will return all AuthService 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) AuthServices will be included
      Returns:
      a fluent search that includes all AuthService assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
      Start a fluent search that will return all AuthService 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) AuthServices will be included
      Returns:
      a fluent search that includes all AuthService assets

    • refByGuid

      public static AuthService refByGuid(String guid)
      Reference to a AuthService by GUID. Use this to create a relationship to this AuthService, where the relationship should be replaced.
      Parameters:
      guid - the GUID of the AuthService to reference
      Returns:
      reference to a AuthService that can be used for defining a relationship to a AuthService

    • refByGuid

      public static AuthService refByGuid(String guid, Reference.SaveSemantic semantic)
      Reference to a AuthService by GUID. Use this to create a relationship to this AuthService, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      guid - the GUID of the AuthService to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a AuthService that can be used for defining a relationship to a AuthService

    • refByQualifiedName

      public static AuthService refByQualifiedName(String qualifiedName)
      Reference to a AuthService by qualifiedName. Use this to create a relationship to this AuthService, where the relationship should be replaced.
      Parameters:
      qualifiedName - the qualifiedName of the AuthService to reference
      Returns:
      reference to a AuthService that can be used for defining a relationship to a AuthService

    • refByQualifiedName

      public static AuthService refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)
      Reference to a AuthService by qualifiedName. Use this to create a relationship to this AuthService, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      qualifiedName - the qualifiedName of the AuthService to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a AuthService that can be used for defining a relationship to a AuthService

    • get

      public static AuthService get(String id) throws AtlanException
      Retrieves a AuthService by one of its identifiers, complete with all of its relationships.
      Parameters:
      id - of the AuthService to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full AuthService, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the AuthService does not exist or the provided GUID is not a AuthService

    • get

      public static AuthService get(AtlanClient client, String id) throws AtlanException
      Retrieves a AuthService 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 AuthService to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full AuthService, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the AuthService does not exist or the provided GUID is not a AuthService

    • get

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

    • restore

      public static boolean restore(String qualifiedName) throws AtlanException
      Restore the archived (soft-deleted) AuthService to active.
      Parameters:
      qualifiedName - for the AuthService
      Returns:
      true if the AuthService is now active, and false otherwise
      Throws:
      AtlanException - on any API problems

    • restore

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

    • updater

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

    • trimToRequired

      public AuthService.AuthServiceBuilder<?,?> trimToRequired() throws InvalidRequestException
      Builds the minimal object necessary to apply an update to a AuthService, from a potentially more-complete AuthService object.
      Overrides:
      trimToRequired in class Asset
      Returns:
      the minimal object necessary to update the AuthService, as a builder
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for AuthService are not found in the initial object

    • removeDescription

      public static AuthService removeDescription(String qualifiedName, String name) throws AtlanException
      Remove the system description from a AuthService.
      Parameters:
      qualifiedName - of the AuthService
      name - of the AuthService
      Returns:
      the updated AuthService, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeDescription

      public static AuthService removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the system description from a AuthService.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's description
      qualifiedName - of the AuthService
      name - of the AuthService
      Returns:
      the updated AuthService, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeUserDescription

      public static AuthService removeUserDescription(String qualifiedName, String name) throws AtlanException
      Remove the user's description from a AuthService.
      Parameters:
      qualifiedName - of the AuthService
      name - of the AuthService
      Returns:
      the updated AuthService, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeUserDescription

      public static AuthService removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the user's description from a AuthService.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's description
      qualifiedName - of the AuthService
      name - of the AuthService
      Returns:
      the updated AuthService, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeOwners

      public static AuthService removeOwners(String qualifiedName, String name) throws AtlanException
      Remove the owners from a AuthService.
      Parameters:
      qualifiedName - of the AuthService
      name - of the AuthService
      Returns:
      the updated AuthService, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeOwners

      public static AuthService removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the owners from a AuthService.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the AuthService's owners
      qualifiedName - of the AuthService
      name - of the AuthService
      Returns:
      the updated AuthService, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • updateCertificate

      public static AuthService updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a AuthService.
      Parameters:
      qualifiedName - of the AuthService
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated AuthService, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • updateCertificate

      public static AuthService updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a AuthService.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the AuthService's certificate
      qualifiedName - of the AuthService
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated AuthService, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • removeCertificate

      public static AuthService removeCertificate(String qualifiedName, String name) throws AtlanException
      Remove the certificate from a AuthService.
      Parameters:
      qualifiedName - of the AuthService
      name - of the AuthService
      Returns:
      the updated AuthService, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeCertificate

      public static AuthService removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the certificate from a AuthService.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the AuthService's certificate
      qualifiedName - of the AuthService
      name - of the AuthService
      Returns:
      the updated AuthService, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • updateAnnouncement

      public static AuthService updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a AuthService.
      Parameters:
      qualifiedName - of the AuthService
      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

    • updateAnnouncement

      public static AuthService updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a AuthService.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the AuthService's announcement
      qualifiedName - of the AuthService
      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 AuthService removeAnnouncement(String qualifiedName, String name) throws AtlanException
      Remove the announcement from a AuthService.
      Parameters:
      qualifiedName - of the AuthService
      name - of the AuthService
      Returns:
      the updated AuthService, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • removeAnnouncement

      public static AuthService removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the announcement from a AuthService.
      Parameters:
      client - connectivity to the Atlan client from which to remove the AuthService's announcement
      qualifiedName - of the AuthService
      name - of the AuthService
      Returns:
      the updated AuthService, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • replaceTerms

      public static AuthService replaceTerms(String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
      Replace the terms linked to the AuthService.
      Parameters:
      qualifiedName - for the AuthService
      name - human-readable name of the AuthService
      terms - the list of terms to replace on the AuthService, or null to remove all terms from the AuthService
      Returns:
      the AuthService that was updated (note that it will NOT contain details of the replaced terms)
      Throws:
      AtlanException - on any API problems

    • replaceTerms

      public static AuthService replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
      Replace the terms linked to the AuthService.
      Parameters:
      client - connectivity to the Atlan tenant on which to replace the AuthService's assigned terms
      qualifiedName - for the AuthService
      name - human-readable name of the AuthService
      terms - the list of terms to replace on the AuthService, or null to remove all terms from the AuthService
      Returns:
      the AuthService that was updated (note that it will NOT contain details of the replaced terms)
      Throws:
      AtlanException - on any API problems

    • appendTerms

      public static AuthService appendTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the AuthService, without replacing existing terms linked to the AuthService. Note: this operation must make two API calls — one to retrieve the AuthService's existing terms, and a second to append the new terms.
      Parameters:
      qualifiedName - for the AuthService
      terms - the list of terms to append to the AuthService
      Returns:
      the AuthService that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • appendTerms

      public static AuthService appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the AuthService, without replacing existing terms linked to the AuthService. Note: this operation must make two API calls — one to retrieve the AuthService'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 AuthService
      qualifiedName - for the AuthService
      terms - the list of terms to append to the AuthService
      Returns:
      the AuthService that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

      public static AuthService removeTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a AuthService, without replacing all existing terms linked to the AuthService. Note: this operation must make two API calls — one to retrieve the AuthService's existing terms, and a second to remove the provided terms.
      Parameters:
      qualifiedName - for the AuthService
      terms - the list of terms to remove from the AuthService, which must be referenced by GUID
      Returns:
      the AuthService that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

      public static AuthService removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a AuthService, without replacing all existing terms linked to the AuthService. Note: this operation must make two API calls — one to retrieve the AuthService'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 AuthService
      qualifiedName - for the AuthService
      terms - the list of terms to remove from the AuthService, which must be referenced by GUID
      Returns:
      the AuthService that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static AuthService appendAtlanTags(String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a AuthService, without replacing existing Atlan tags linked to the AuthService. Note: this operation must make two API calls — one to retrieve the AuthService's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the AuthService
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated AuthService
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static AuthService appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a AuthService, without replacing existing Atlan tags linked to the AuthService. Note: this operation must make two API calls — one to retrieve the AuthService'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 AuthService
      qualifiedName - of the AuthService
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated AuthService
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static AuthService appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a AuthService, without replacing existing Atlan tags linked to the AuthService. Note: this operation must make two API calls — one to retrieve the AuthService's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the AuthService
      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 AuthService
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      public static AuthService appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a AuthService, without replacing existing Atlan tags linked to the AuthService. Note: this operation must make two API calls — one to retrieve the AuthService'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 AuthService
      qualifiedName - of the AuthService
      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 AuthService
      Throws:
      AtlanException - on any API problems

    • removeAtlanTag

      public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a AuthService.
      Parameters:
      qualifiedName - of the AuthService
      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 AuthService

    • removeAtlanTag

      public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a AuthService.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a AuthService
      qualifiedName - of the AuthService
      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 AuthService

    • _internal

      public static AuthService.AuthServiceBuilder<?,?> _internal()

    • toBuilder

      public AuthService.AuthServiceBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getAuthServiceConfig

      public Map<String,String> getAuthServiceConfig()
      TBC
      Specified by:
      getAuthServiceConfig in interface IAuthService

    • getAuthServiceIsEnabled

      public Boolean getAuthServiceIsEnabled()
      TBC
      Specified by:
      getAuthServiceIsEnabled in interface IAuthService

    • getAuthServicePolicyLastSync

      public Long getAuthServicePolicyLastSync()
      TBC
      Specified by:
      getAuthServicePolicyLastSync in interface IAuthService

    • getAuthServiceType

      public String getAuthServiceType()
      TBC
      Specified by:
      getAuthServiceType in interface IAuthService

    • getTagService

      public String getTagService()
      TBC
      Specified by:
      getTagService in interface IAuthService

    • 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 AuthServices.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface IAuthService
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference