Class SchemaRegistryVersion

All Implemented Interfaces:
IAsset, ICatalog, IReferenceable, ISchemaRegistry, ISchemaRegistryVersion, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class SchemaRegistryVersion extends Asset implements ISchemaRegistryVersion, ISchemaRegistry, ICatalog, IAsset, IReferenceable
Instance of a specific version of a schema registry subject in Atlan.
See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

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

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

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

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

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

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

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

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

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

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

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

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

      Builds the minimal object necessary to apply an update to a SchemaRegistryVersion, from a potentially more-complete SchemaRegistryVersion object.
      Overrides:
      trimToRequired in class Asset
      Returns:
      the minimal object necessary to update the SchemaRegistryVersion, as a builder
      Throws:
      InvalidRequestException - if any of the minimal set of required fields for a SchemaRegistryVersion are not present in the initial object
    • removeDescription

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

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

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

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

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

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

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

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

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

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

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

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

    • toBuilder

      Overrides:
      toBuilder in class Reference
    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface ICatalog
      Specified by:
      getInputToAirflowTasks in interface ISchemaRegistry
      Specified by:
      getInputToAirflowTasks in interface ISchemaRegistryVersion
    • getInputToProcesses

      public SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
      Specified by:
      getInputToProcesses in interface ICatalog
      Specified by:
      getInputToProcesses in interface ISchemaRegistry
      Specified by:
      getInputToProcesses in interface ISchemaRegistryVersion
    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface ISchemaRegistry
      Specified by:
      getInputToSparkJobs in interface ISchemaRegistryVersion
    • getModelImplementedAttributes

      public SortedSet<IModelAttribute> getModelImplementedAttributes()
      Attributes implemented by this asset.
      Specified by:
      getModelImplementedAttributes in interface ICatalog
      Specified by:
      getModelImplementedAttributes in interface ISchemaRegistry
      Specified by:
      getModelImplementedAttributes in interface ISchemaRegistryVersion
    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface ISchemaRegistry
      Specified by:
      getModelImplementedEntities in interface ISchemaRegistryVersion
    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface ISchemaRegistry
      Specified by:
      getOutputFromAirflowTasks in interface ISchemaRegistryVersion
    • 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 ISchemaRegistry
      Specified by:
      getOutputFromProcesses in interface ISchemaRegistryVersion
    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface ISchemaRegistry
      Specified by:
      getOutputFromSparkJobs in interface ISchemaRegistryVersion
    • getPartialChildFields

      public SortedSet<IPartialField> getPartialChildFields()
      Partial fields contained in the asset.
      Specified by:
      getPartialChildFields in interface ICatalog
      Specified by:
      getPartialChildFields in interface ISchemaRegistry
      Specified by:
      getPartialChildFields in interface ISchemaRegistryVersion
    • getPartialChildObjects

      public SortedSet<IPartialObject> getPartialChildObjects()
      Partial objects contained in the asset.
      Specified by:
      getPartialChildObjects in interface ICatalog
      Specified by:
      getPartialChildObjects in interface ISchemaRegistry
      Specified by:
      getPartialChildObjects in interface ISchemaRegistryVersion
    • getSchemaRegistrySchemaId

      public String getSchemaRegistrySchemaId()
      Unique identifier for schema definition set by the schema registry.
      Specified by:
      getSchemaRegistrySchemaId in interface ISchemaRegistry
      Specified by:
      getSchemaRegistrySchemaId in interface ISchemaRegistryVersion
    • getSchemaRegistrySchemaType

      public SchemaRegistrySchemaType getSchemaRegistrySchemaType()
      Type of language or specification used to define the schema, for example: JSON, Protobuf, etc.
      Specified by:
      getSchemaRegistrySchemaType in interface ISchemaRegistry
      Specified by:
      getSchemaRegistrySchemaType in interface ISchemaRegistryVersion
    • getSchemaRegistrySubject

      public ISchemaRegistrySubject getSchemaRegistrySubject()
      Schema registry subject to which this version belongs.
      Specified by:
      getSchemaRegistrySubject in interface ISchemaRegistryVersion
    • getSchemaRegistrySubjectQualifiedName

      public String getSchemaRegistrySubjectQualifiedName()
      Unique name of the schema registry subject to which this version belongs.
      Specified by:
      getSchemaRegistrySubjectQualifiedName in interface ISchemaRegistryVersion
    • getSchemaRegistryVersionNumber

      public String getSchemaRegistryVersionNumber()
      Version number of this schema version.
      Specified by:
      getSchemaRegistryVersionNumber in interface ISchemaRegistryVersion
    • getSchemaRegistryVersionSchemaDefinition

      public String getSchemaRegistryVersionSchemaDefinition()
      Full schema definition for this specific version.
      Specified by:
      getSchemaRegistryVersionSchemaDefinition in interface ISchemaRegistryVersion
    • getSchemaRegistryVersionSchemaType

      public SchemaRegistrySchemaType getSchemaRegistryVersionSchemaType()
      Type of schema language used in this version.
      Specified by:
      getSchemaRegistryVersionSchemaType in interface ISchemaRegistryVersion
    • 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 SchemaRegistryVersions.
      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 ISchemaRegistry
      Specified by:
      getTypeName in interface ISchemaRegistryVersion
      Overrides:
      getTypeName in class Reference