Package com.atlan.model.assets

Class SalesforceReport

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

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • creator

      public static SalesforceReport.SalesforceReportBuilder<?,?> creator(String name, String organizationQualifiedName)
      Builds the minimal object necessary to create a SalesforceReport asset.
      Parameters:
      name - of the report
      organizationQualifiedName - unique name of the organization through which the asset is accessible
      Returns:
      the minimal object necessary to create the asset, as a builder

    • creator

      public static SalesforceReport.SalesforceReportBuilder<?,?> creator(String name, SalesforceOrganization organization) throws InvalidRequestException
      Builds the minimal object necessary to create a SalesforceReport asset.
      Parameters:
      name - of the report
      organization - Salesforce organization 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 organization does not have a qualifiedName

    • creator

      public static SalesforceReport.SalesforceReportBuilder<?,?> creator(String name, SalesforceOrganization organization, String salesforceId) throws InvalidRequestException
      Builds the minimal object necessary to create a SalesforceReport asset.
      Parameters:
      name - of the report
      organization - Salesforce organization through which the asset is accessible, which must have its qualifiedName populated
      salesforceId - unique identifier of this report in Salesforce
      Returns:
      the minimal object necessary to create the asset, as a builder
      Throws:
      InvalidRequestException - if the provided organization does not have a qualifiedName

    • creator

      public static SalesforceReport.SalesforceReportBuilder<?,?> creator(String name, String organizationQualifiedName, String salesforceId)
      Builds the minimal object necessary to create a SalesforceReport asset.
      Parameters:
      name - of the report
      organizationQualifiedName - unique name of the organization through which the asset is accessible
      salesforceId - unique identifier of this report in Salesforce
      Returns:
      the minimal object necessary to create the asset, as a builder

    • creator

      public static SalesforceReport.SalesforceReportBuilder<?,?> creator(String name, String connectionQualifiedName, String organizationQualifiedName, String salesforceId)
      Builds the minimal object necessary to create a SalesforceReport asset.
      Parameters:
      name - of the report
      connectionQualifiedName - unique name of the connection in which to create the SalesforceReport
      organizationQualifiedName - unique name of the organization in which to create the SalesforceReport
      salesforceId - unique identifier of this report in Salesforce
      Returns:
      the minimal object necessary to create the asset, as a builder

    • generateQualifiedName

      public static String generateQualifiedName(String salesforceId, String organizationQualifiedName)
      Generate a unique SalesforceReport name.
      Parameters:
      salesforceId - unique identifier of this report in Salesforce
      organizationQualifiedName - unique name of the organization through which the SalesforceReport is accessible
      Returns:
      a unique name for the SalesforceReport

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • updateCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • replaceTerms

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

    • appendTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

      @Deprecated public static SalesforceReport 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 SalesforceReport, without replacing existing Atlan tags linked to the SalesforceReport. Note: this operation must make two API calls — one to retrieve the SalesforceReport'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 SalesforceReport
      qualifiedName - of the SalesforceReport
      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 SalesforceReport
      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 SalesforceReport.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a SalesforceReport
      qualifiedName - of the SalesforceReport
      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 SalesforceReport

    • _internal

      public static SalesforceReport.SalesforceReportBuilder<?,?> _internal()

    • toBuilder

      public SalesforceReport.SalesforceReportBuilder<?,?> 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 ISalesforceReport

    • getDashboards

      public SortedSet<ISalesforceDashboard> getDashboards()
      TBC
      Specified by:
      getDashboards in interface ISalesforceReport

    • getDetailColumns

      public SortedSet<String> getDetailColumns()
      List of column names on the report.
      Specified by:
      getDetailColumns in interface ISalesforceReport

    • 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 ISalesforceReport

    • 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 ISalesforceReport

    • 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 ISalesforceReport

    • getModelImplementedAttributes

      public SortedSet<IModelAttribute> getModelImplementedAttributes()
      Attributes implemented by this asset.
      Specified by:
      getModelImplementedAttributes in interface ICatalog
      Specified by:
      getModelImplementedAttributes in interface ISaaS
      Specified by:
      getModelImplementedAttributes in interface ISalesforce
      Specified by:
      getModelImplementedAttributes in interface ISalesforceReport

    • 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 ISalesforceReport

    • getOrganization

      public ISalesforceOrganization getOrganization()
      Organization in which this report exists.
      Specified by:
      getOrganization in interface ISalesforceReport

    • getOrganizationQualifiedName

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

    • 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 ISalesforceReport

    • 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 ISalesforceReport

    • 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 ISalesforceReport

    • getReportType

      public Map<String,String> getReportType()
      Type of report in Salesforce.
      Specified by:
      getReportType in interface ISalesforceReport

    • getSourceId

      public String getSourceId()
      Identifier of the report in Salesforce.
      Specified by:
      getSourceId in interface ISalesforceReport

    • 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 SalesforceReports.
      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 ISalesforceReport
      Overrides:
      getTypeName in class Reference