Package com.atlan.model.assets

Class SalesforceField

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

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • creator

      public static SalesforceField.SalesforceFieldBuilder<?,?> creator(String name, SalesforceObject object) throws InvalidRequestException
      Builds the minimal object necessary to create a SalesforceField asset.
      Parameters:
      name - of the field
      object - Salesforce object through which the asset is accessible, which must have its qualifiedName populated
      Returns:
      the minimal object necessary to create the asset, as a builder
      Throws:
      InvalidRequestException - if the provided object does not have a qualifiedName

    • creator

      public static SalesforceField.SalesforceFieldBuilder<?,?> creator(String name, String objectQualifiedName)
      Builds the minimal object necessary to create a SalesforceField asset.
      Parameters:
      name - of the field
      objectQualifiedName - unique name of the object through which the asset is accessible
      Returns:
      the minimal object necessary to create the asset, as a builder

    • creator

      public static SalesforceField.SalesforceFieldBuilder<?,?> creator(String name, String connectionQualifiedName, String organizationQualifiedName, String objectQualifiedName)
      Builds the minimal object necessary to create a SalesforceField asset.
      Parameters:
      name - of the field
      connectionQualifiedName - unique name of the connection in which to create the SalesforceField
      organizationQualifiedName - unique name of the SalesforceOrganization in which to create the SalesforceField
      objectQualifiedName - unique name of the object through which the asset is accessible
      Returns:
      the minimal object necessary to create the asset, as a builder

    • generateQualifiedName

      public static String generateQualifiedName(String name, String objectQualifiedName)
      Generate a unique SalesforceField name.
      Parameters:
      name - unique name of the object within Salesforce
      objectQualifiedName - unique name of the object through which the asset is accessible
      Returns:
      a unique name for the SalesforceField

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

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

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static SalesforceField.SalesforceFieldBuilder<?,?> _internal()

    • toBuilder

      public SalesforceField.SalesforceFieldBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getApiName

      public String getApiName()
      Name of this asset in the Salesforce API.
      Specified by:
      getApiName in interface ISalesforce
      Specified by:
      getApiName in interface ISalesforceField

    • getApplicationContainer

      public IApplicationContainer getApplicationContainer()
      ApplicationContainer asset containing this Catalog asset.
      Specified by:
      getApplicationContainer in interface ICatalog
      Specified by:
      getApplicationContainer in interface ISaaS
      Specified by:
      getApplicationContainer in interface ISalesforce
      Specified by:
      getApplicationContainer in interface ISalesforceField

    • getAssetApplicationQualifiedName

      public String getAssetApplicationQualifiedName()
      Qualified name of the Application Container that contains this asset.
      Specified by:
      getAssetApplicationQualifiedName in interface ICatalog
      Specified by:
      getAssetApplicationQualifiedName in interface ISaaS
      Specified by:
      getAssetApplicationQualifiedName in interface ISalesforce
      Specified by:
      getAssetApplicationQualifiedName in interface ISalesforceField

    • getDataType

      public String getDataType()
      Data type of values in this field.
      Specified by:
      getDataType in interface ISalesforceField

    • getDefaultValueFormula

      public String getDefaultValueFormula()
      Formula for the default value for this field.
      Specified by:
      getDefaultValueFormula in interface ISalesforceField

    • getFormula

      public String getFormula()
      Formula for this field, if it is a calculated field.
      Specified by:
      getFormula in interface ISalesforceField

    • getInlineHelpText

      public String getInlineHelpText()
      Help text for this field.
      Specified by:
      getInlineHelpText in interface ISalesforceField

    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface ICatalog
      Specified by:
      getInputToAirflowTasks in interface ISaaS
      Specified by:
      getInputToAirflowTasks in interface ISalesforce
      Specified by:
      getInputToAirflowTasks in interface ISalesforceField

    • getInputToProcesses

      public SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
      Specified by:
      getInputToProcesses in interface ICatalog
      Specified by:
      getInputToProcesses in interface ISaaS
      Specified by:
      getInputToProcesses in interface ISalesforce
      Specified by:
      getInputToProcesses in interface ISalesforceField

    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface ISaaS
      Specified by:
      getInputToSparkJobs in interface ISalesforce
      Specified by:
      getInputToSparkJobs in interface ISalesforceField

    • getIsCalculated

      public Boolean getIsCalculated()
      Whether this field is calculated (true) or not (false).
      Specified by:
      getIsCalculated in interface ISalesforceField

    • getIsCaseSensitive

      public Boolean getIsCaseSensitive()
      Whether this field is case sensitive (true) or in-sensitive (false).
      Specified by:
      getIsCaseSensitive in interface ISalesforceField

    • getIsEncrypted

      public Boolean getIsEncrypted()
      Whether this field is encrypted (true) or not (false).
      Specified by:
      getIsEncrypted in interface ISalesforceField

    • getIsNullable

      public Boolean getIsNullable()
      Whether this field allows null values (true) or not (false).
      Specified by:
      getIsNullable in interface ISalesforceField

    • getIsPolymorphicForeignKey

      public Boolean getIsPolymorphicForeignKey()
      Whether this field references a record of multiple objects (true) or not (false).
      Specified by:
      getIsPolymorphicForeignKey in interface ISalesforceField

    • getIsUnique

      public Boolean getIsUnique()
      Whether this field must have unique values (true) or not (false).
      Specified by:
      getIsUnique in interface ISalesforceField

    • getLookupObjects

      public SortedSet<ISalesforceObject> getLookupObjects()
      TBC
      Specified by:
      getLookupObjects in interface ISalesforceField

    • getMaxLength

      public Long getMaxLength()
      Maximum length of this field.
      Specified by:
      getMaxLength in interface ISalesforceField

    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface ISaaS
      Specified by:
      getModelImplementedEntities in interface ISalesforce
      Specified by:
      getModelImplementedEntities in interface ISalesforceField

    • getNumericScale

      public Double getNumericScale()
      Number of digits allowed to the right of the decimal point.
      Specified by:
      getNumericScale in interface ISalesforceField

    • getObject

      public ISalesforceObject getObject()
      Object in which this field exists.
      Specified by:
      getObject in interface ISalesforceField

    • getObjectQualifiedName

      public String getObjectQualifiedName()
      Unique name of the object in which this field exists.
      Specified by:
      getObjectQualifiedName in interface ISalesforceField

    • getOrder

      public Integer getOrder()
      Order (position) of this field within the object.
      Specified by:
      getOrder in interface ISalesforceField

    • getOrganizationQualifiedName

      public String getOrganizationQualifiedName()
      Fully-qualified name of the organization in Salesforce.
      Specified by:
      getOrganizationQualifiedName in interface ISalesforce
      Specified by:
      getOrganizationQualifiedName in interface ISalesforceField

    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface ISaaS
      Specified by:
      getOutputFromAirflowTasks in interface ISalesforce
      Specified by:
      getOutputFromAirflowTasks in interface ISalesforceField

    • getOutputFromProcesses

      public SortedSet<ILineageProcess> getOutputFromProcesses()
      Processes from which this asset is produced as output.
      Specified by:
      getOutputFromProcesses in interface ICatalog
      Specified by:
      getOutputFromProcesses in interface ISaaS
      Specified by:
      getOutputFromProcesses in interface ISalesforce
      Specified by:
      getOutputFromProcesses in interface ISalesforceField

    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface ISaaS
      Specified by:
      getOutputFromSparkJobs in interface ISalesforce
      Specified by:
      getOutputFromSparkJobs in interface ISalesforceField

    • getPicklistValues

      public SortedSet<String> getPicklistValues()
      List of values from which a user can pick while adding a record.
      Specified by:
      getPicklistValues in interface ISalesforceField

    • getPrecision

      public Integer getPrecision()
      Total number of digits allowed
      Specified by:
      getPrecision in interface ISalesforceField

    • 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 SalesforceFields.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IReferenceable
      Specified by:
      getTypeName in interface ISaaS
      Specified by:
      getTypeName in interface ISalesforce
      Specified by:
      getTypeName in interface ISalesforceField
      Overrides:
      getTypeName in class Reference