Package com.atlan.model.assets

Class Form

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.Form
All Implemented Interfaces:
IAsset, IForm, IReferenceable, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class Form extends Asset implements IForm, IAsset, IReferenceable
Instance of a form in Atlan.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

      public static Form get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException
      Retrieves a Form 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 Form to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the Form, including any relationships
      Returns:
      the requested Form, 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 Form does not exist or the provided GUID is not a Form

    • get

      public static Form get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException
      Retrieves a Form 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 Form to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the Form, including any relationships
      attributesOnRelated - to retrieve on each relationship retrieved for the Form
      Returns:
      the requested Form, 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 Form does not exist or the provided GUID is not a Form

    • restore

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

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • updateCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • replaceTerms

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

    • appendTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • _internal

      public static Form.FormBuilder<?,?> _internal()

    • toBuilder

      public Form.FormBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getFormFields

      public List<FormField> getFormFields()
      Fields in a form.
      Specified by:
      getFormFields in interface IForm

    • getFormOptions

      public Map<String,String> getFormOptions()
      Options of the form.
      Specified by:
      getFormOptions in interface IForm

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