Skip to content

KafkaTopicConsumption

Detailed information about the consumption of a Kafka topic.

Complete reference

This is a complete reference for the KafkaTopicConsumption struct in Atlan, showing all of its embedded properties. For an introduction, you probably want to start with:

  • Snippets — small, atomic examples of single-step use cases.
  • Patterns — walkthroughs of common multi-step implementation patterns.

Embedded properties

These are the attributes embedded within each instance of the KafkaTopicConsumption struct in an asset:

topicName
Name of the Kafka topic.
1
2
builder.topicName(...); // (1)
kafkaTopicConsumption.getTopicName(); // (2)

  1. Set the topicName for a KafkaTopicConsumption.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the topicName from a KafkaTopicConsumption.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

topicPartition
Partition of the Kafka topic.
1
2
builder.topicPartition(...); // (1)
kafkaTopicConsumption.getTopicPartition(); // (2)

  1. Set the topicPartition for a KafkaTopicConsumption.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the topicPartition from a KafkaTopicConsumption.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

topicLag
Lag of the Kafka topic.
1
2
builder.topicLag(...); // (1)
kafkaTopicConsumption.getTopicLag(); // (2)

  1. Set the topicLag for a KafkaTopicConsumption.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the topicLag from a KafkaTopicConsumption.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

topicCurrentOffset
Current offset of the Kafka topic.
1
2
builder.topicCurrentOffset(...); // (1)
kafkaTopicConsumption.getTopicCurrentOffset(); // (2)

  1. Set the topicCurrentOffset for a KafkaTopicConsumption.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the topicCurrentOffset from a KafkaTopicConsumption.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

topicName
Name of the Kafka topic.
1
2
3
4
5
{
  "attributes": {
    "topicName": ... // (1)
  }
}

  1. Set the topicName for a KafkaTopicConsumption.

    For more details

    For more information, see the asset CRUD snippets.

topicPartition
Partition of the Kafka topic.
1
2
3
4
5
{
  "attributes": {
    "topicPartition": ... // (1)
  }
}

  1. Set the topicPartition for a KafkaTopicConsumption.

    For more details

    For more information, see the asset CRUD snippets.

topicLag
Lag of the Kafka topic.
1
2
3
4
5
{
  "attributes": {
    "topicLag": ... // (1)
  }
}

  1. Set the topicLag for a KafkaTopicConsumption.

    For more details

    For more information, see the asset CRUD snippets.

topicCurrentOffset
Current offset of the Kafka topic.
1
2
3
4
5
{
  "attributes": {
    "topicCurrentOffset": ... // (1)
  }
}

  1. Set the topicCurrentOffset for a KafkaTopicConsumption.

    For more details

    For more information, see the asset CRUD snippets.