Package com.atlan.model.assets

Class WorkflowRun

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.WorkflowRun
All Implemented Interfaces:
IAsset, IReferenceable, IWorkflowRun, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class WorkflowRun extends Asset implements IWorkflowRun, IAsset, IReferenceable
Instance of an workflow run.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

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

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static WorkflowRun.WorkflowRunBuilder<?,?> _internal()

    • toBuilder

      public WorkflowRun.WorkflowRunBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getWorkflowRunComment

      public String getWorkflowRunComment()
      The comment added by the requester
      Specified by:
      getWorkflowRunComment in interface IWorkflowRun

    • getWorkflowRunConfig

      public String getWorkflowRunConfig()
      Details of the approval workflow run.
      Specified by:
      getWorkflowRunConfig in interface IWorkflowRun

    • getWorkflowRunCreatedBy

      public String getWorkflowRunCreatedBy()
      Username of the user who created this workflow run.
      Specified by:
      getWorkflowRunCreatedBy in interface IWorkflowRun

    • getWorkflowRunDeletedAt

      public Long getWorkflowRunDeletedAt()
      Deletion time of this workflow run.
      Specified by:
      getWorkflowRunDeletedAt in interface IWorkflowRun

    • getWorkflowRunExpiresAt

      public Long getWorkflowRunExpiresAt()
      Time at which this run will expire.
      Specified by:
      getWorkflowRunExpiresAt in interface IWorkflowRun

    • getWorkflowRunOnAssetGuid

      public String getWorkflowRunOnAssetGuid()
      The asset for which this run was created.
      Specified by:
      getWorkflowRunOnAssetGuid in interface IWorkflowRun

    • getWorkflowRunStatus

      public WorkflowRunStatus getWorkflowRunStatus()
      Status of the run.
      Specified by:
      getWorkflowRunStatus in interface IWorkflowRun

    • getWorkflowRunType

      public WorkflowRunType getWorkflowRunType()
      Type of the workflow from which this run was created.
      Specified by:
      getWorkflowRunType in interface IWorkflowRun

    • getWorkflowRunUpdatedBy

      public String getWorkflowRunUpdatedBy()
      Username of the user who updated this workflow run.
      Specified by:
      getWorkflowRunUpdatedBy in interface IWorkflowRun

    • getWorkflowRunWorkflowGuid

      public String getWorkflowRunWorkflowGuid()
      GUID of the workflow from which this run was created.
      Specified by:
      getWorkflowRunWorkflowGuid in interface IWorkflowRun

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