Package com.atlan.model.assets

Class KafkaTopic

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

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • creator

      public static KafkaTopic.KafkaTopicBuilder<?,?> creator(String name, String connectionQualifiedName)
      Builds the minimal object necessary to create a KafkaTopic.
      Parameters:
      name - of the KafkaTopic
      connectionQualifiedName - unique name of the connection through which the KafkaTopic is accessible
      Returns:
      the minimal object necessary to create the KafkaTopic, as a builder

    • generateQualifiedName

      public static String generateQualifiedName(String name, String connectionQualifiedName)
      Generate a unique KafkaTopic name.
      Parameters:
      name - of the KafkaTopic
      connectionQualifiedName - unique name of the connection through which the KafkaTopic is accessible
      Returns:
      a unique name for the KafkaTopic

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

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

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static KafkaTopic.KafkaTopicBuilder<?,?> _internal()

    • toBuilder

      public KafkaTopic.KafkaTopicBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getApplicationContainer

      public IApplicationContainer getApplicationContainer()
      ApplicationContainer asset containing this Catalog asset.
      Specified by:
      getApplicationContainer in interface ICatalog
      Specified by:
      getApplicationContainer in interface IEventStore
      Specified by:
      getApplicationContainer in interface IKafka
      Specified by:
      getApplicationContainer in interface IKafkaTopic

    • 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 IEventStore
      Specified by:
      getAssetApplicationQualifiedName in interface IKafka
      Specified by:
      getAssetApplicationQualifiedName in interface IKafkaTopic

    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface ICatalog
      Specified by:
      getInputToAirflowTasks in interface IEventStore
      Specified by:
      getInputToAirflowTasks in interface IKafka
      Specified by:
      getInputToAirflowTasks in interface IKafkaTopic

    • getInputToProcesses

      public SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
      Specified by:
      getInputToProcesses in interface ICatalog
      Specified by:
      getInputToProcesses in interface IEventStore
      Specified by:
      getInputToProcesses in interface IKafka
      Specified by:
      getInputToProcesses in interface IKafkaTopic

    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface IEventStore
      Specified by:
      getInputToSparkJobs in interface IKafka
      Specified by:
      getInputToSparkJobs in interface IKafkaTopic

    • getKafkaConsumerGroups

      public SortedSet<IKafkaConsumerGroup> getKafkaConsumerGroups()
      Consumer groups subscribed to this topic.
      Specified by:
      getKafkaConsumerGroups in interface IKafkaTopic

    • getKafkaTopicCleanupPolicy

      public KafkaTopicCleanupPolicy getKafkaTopicCleanupPolicy()
      Cleanup policy for this topic.
      Specified by:
      getKafkaTopicCleanupPolicy in interface IKafkaTopic

    • getKafkaTopicCompressionType

      public KafkaTopicCompressionType getKafkaTopicCompressionType()
      Type of compression used for this topic.
      Specified by:
      getKafkaTopicCompressionType in interface IKafkaTopic

    • getKafkaTopicIsInternal

      public Boolean getKafkaTopicIsInternal()
      Whether this topic is an internal topic (true) or not (false).
      Specified by:
      getKafkaTopicIsInternal in interface IKafkaTopic

    • getKafkaTopicLogCleanupPolicy

      public String getKafkaTopicLogCleanupPolicy()
      Comma seperated Cleanup policy for this topic.
      Specified by:
      getKafkaTopicLogCleanupPolicy in interface IKafkaTopic

    • getKafkaTopicPartitionsCount

      public Long getKafkaTopicPartitionsCount()
      Number of partitions for this topic.
      Specified by:
      getKafkaTopicPartitionsCount in interface IKafkaTopic

    • getKafkaTopicRecordCount

      public Long getKafkaTopicRecordCount()
      Number of (unexpired) messages in this topic.
      Specified by:
      getKafkaTopicRecordCount in interface IKafkaTopic

    • getKafkaTopicReplicationFactor

      public Long getKafkaTopicReplicationFactor()
      Replication factor for this topic.
      Specified by:
      getKafkaTopicReplicationFactor in interface IKafkaTopic

    • getKafkaTopicRetentionTimeInMs

      public Long getKafkaTopicRetentionTimeInMs()
      Amount of time messages will be retained in this topic, in milliseconds.
      Specified by:
      getKafkaTopicRetentionTimeInMs in interface IKafkaTopic

    • getKafkaTopicSegmentBytes

      public Long getKafkaTopicSegmentBytes()
      Segment size for this topic.
      Specified by:
      getKafkaTopicSegmentBytes in interface IKafkaTopic

    • getKafkaTopicSizeInBytes

      public Long getKafkaTopicSizeInBytes()
      Size of this topic, in bytes.
      Specified by:
      getKafkaTopicSizeInBytes in interface IKafkaTopic

    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface IEventStore
      Specified by:
      getModelImplementedEntities in interface IKafka
      Specified by:
      getModelImplementedEntities in interface IKafkaTopic

    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface IEventStore
      Specified by:
      getOutputFromAirflowTasks in interface IKafka
      Specified by:
      getOutputFromAirflowTasks in interface IKafkaTopic

    • 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 IEventStore
      Specified by:
      getOutputFromProcesses in interface IKafka
      Specified by:
      getOutputFromProcesses in interface IKafkaTopic

    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface IEventStore
      Specified by:
      getOutputFromSparkJobs in interface IKafka
      Specified by:
      getOutputFromSparkJobs in interface IKafkaTopic

    • 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 KafkaTopics.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IEventStore
      Specified by:
      getTypeName in interface IKafka
      Specified by:
      getTypeName in interface IKafkaTopic
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference