Package com.atlan.model.assets

Class AzureEventHubConsumerGroup

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.AzureEventHubConsumerGroup
All Implemented Interfaces:
IAsset, IAzureEventHubConsumerGroup, ICatalog, IEventStore, IKafka, IKafkaConsumerGroup, IReferenceable, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class AzureEventHubConsumerGroup extends Asset implements IAzureEventHubConsumerGroup, IKafkaConsumerGroup, IKafka, IEventStore, ICatalog, IAsset, IReferenceable
Instance of an Azure Event Hub Consumer Group asset, equivalent to Kafka ConsumerGroup.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • creatorObj

      public static AzureEventHubConsumerGroup.AzureEventHubConsumerGroupBuilder<?,?> creatorObj(String name, List<AzureEventHub> hubs) throws InvalidRequestException
      Builds the minimal object necessary to create an AzureEventHubConsumerGroup.
      Parameters:
      name - of the AzureEventHubConsumerGroup
      hubs - in which the AzureEventHubConsumerGroup should be created, the first of which must have at least a qualifiedName
      Returns:
      the minimal request necessary to create the AzureEventHubConsumerGroup, as a builder
      Throws:
      InvalidRequestException - if the first hub provided is without a qualifiedName

    • creator

      public static AzureEventHubConsumerGroup.AzureEventHubConsumerGroupBuilder<?,?> creator(String name, List<String> hubQualifiedNames) throws InvalidRequestException
      Builds the minimal object necessary to create an AzureEventHubConsumerGroup.
      Parameters:
      name - of the AzureEventHubConsumerGroup
      hubQualifiedNames - unique names of the hubs in which the AzureEventHubConsumerGroup is contained
      Returns:
      the minimal object necessary to create the AzureEventHubConsumerGroup, as a builder
      Throws:
      InvalidRequestException - if no hub qualifiedNames are provided

    • creator

      public static AzureEventHubConsumerGroup.AzureEventHubConsumerGroupBuilder<?,?> creator(String name, String connectionQualifiedName, List<String> hubNames, List<String> hubQualifiedNames)
      Builds the minimal object necessary to create an AzureEventHubConsumerGroup.
      Parameters:
      name - of the AzureEventHubConsumerGroup
      connectionQualifiedName - unique name of the connection in which the AzureEventHubConsumerGroup should be created
      hubNames - simple names of the AzureEventHubs in which the AzureEventHubConsumerGroup should be created
      hubQualifiedNames - unique names of the AzureEventHubs in which the AzureEventHubConsumerGroup should be created
      Returns:
      the minimal object necessary to create the AzureEventHubConsumerGroup, as a builder

    • generateQualifiedName

      public static String generateQualifiedName(String name, String connectionQualifiedName, String hubName)
      Generate a unique AzureEventHubConsumerGroup name.
      Parameters:
      name - of the AzureEventHubConsumerGroup
      hubName - simple name of the first AzureEventHubs in which the AzureEventHubConsumerGroup is contained
      Returns:
      a unique name for the AzureEventHubConsumerGroup

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

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

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static AzureEventHubConsumerGroup.AzureEventHubConsumerGroupBuilder<?,?> _internal()

    • toBuilder

      public AzureEventHubConsumerGroup.AzureEventHubConsumerGroupBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getApplicationContainer

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

    • getAssetApplicationQualifiedName

      public String getAssetApplicationQualifiedName()
      Qualified name of the Application Container that contains this asset.
      Specified by:
      getAssetApplicationQualifiedName in interface IAzureEventHubConsumerGroup
      Specified by:
      getAssetApplicationQualifiedName in interface ICatalog
      Specified by:
      getAssetApplicationQualifiedName in interface IEventStore
      Specified by:
      getAssetApplicationQualifiedName in interface IKafka
      Specified by:
      getAssetApplicationQualifiedName in interface IKafkaConsumerGroup

    • getInputToAirflowTasks

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

    • getInputToProcesses

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

    • getInputToSparkJobs

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

    • getKafkaConsumerGroupMemberCount

      public Long getKafkaConsumerGroupMemberCount()
      Number of members in this consumer group.
      Specified by:
      getKafkaConsumerGroupMemberCount in interface IAzureEventHubConsumerGroup
      Specified by:
      getKafkaConsumerGroupMemberCount in interface IKafkaConsumerGroup

    • getKafkaConsumerGroupTopicConsumptionProperties

      public List<KafkaTopicConsumption> getKafkaConsumerGroupTopicConsumptionProperties()
      List of consumption properties for Kafka topics, for this consumer group.
      Specified by:
      getKafkaConsumerGroupTopicConsumptionProperties in interface IAzureEventHubConsumerGroup
      Specified by:
      getKafkaConsumerGroupTopicConsumptionProperties in interface IKafkaConsumerGroup

    • getKafkaTopicNames

      public SortedSet<String> getKafkaTopicNames()
      Simple names of the topics consumed by this consumer group.
      Specified by:
      getKafkaTopicNames in interface IAzureEventHubConsumerGroup
      Specified by:
      getKafkaTopicNames in interface IKafkaConsumerGroup

    • getKafkaTopicQualifiedNames

      public SortedSet<String> getKafkaTopicQualifiedNames()
      Unique names of the topics consumed by this consumer group.
      Specified by:
      getKafkaTopicQualifiedNames in interface IAzureEventHubConsumerGroup
      Specified by:
      getKafkaTopicQualifiedNames in interface IKafkaConsumerGroup

    • getKafkaTopics

      public SortedSet<IKafkaTopic> getKafkaTopics()
      Topics consumed by this consumer group.
      Specified by:
      getKafkaTopics in interface IAzureEventHubConsumerGroup
      Specified by:
      getKafkaTopics in interface IKafkaConsumerGroup

    • getModelImplementedEntities

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

    • getOutputFromAirflowTasks

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

    • getOutputFromProcesses

      public SortedSet<ILineageProcess> getOutputFromProcesses()
      Processes from which this asset is produced as output.
      Specified by:
      getOutputFromProcesses in interface IAzureEventHubConsumerGroup
      Specified by:
      getOutputFromProcesses in interface ICatalog
      Specified by:
      getOutputFromProcesses in interface IEventStore
      Specified by:
      getOutputFromProcesses in interface IKafka
      Specified by:
      getOutputFromProcesses in interface IKafkaConsumerGroup

    • getOutputFromSparkJobs

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

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