Package org.apache.kafka.clients.admin

Class DescribeTransactionsResult

java.lang.Object

org.apache.kafka.clients.admin.DescribeTransactionsResult

@Evolving
public class DescribeTransactionsResult
extends Object

Method Summary

Modifier and Type	Method	Description
KafkaFuture<Map<String,TransactionDescription>>	all()	Get a future which returns a map of the transaction descriptions requested in the respective call to Admin.describeTransactions(Collection, DescribeTransactionsOptions).
KafkaFuture<TransactionDescription>	description(String transactionalId)	Get the description of a specific transactional ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

description

public KafkaFuture<TransactionDescription> description(String transactionalId)

Get the description of a specific transactional ID.

Parameters:

transactionalId - the transactional ID to describe

Returns:

a future which completes when the transaction description of a particular transactional ID is available.

Throws:

IllegalArgumentException - if the `transactionalId` was not included in the respective call to Admin.describeTransactions(Collection, DescribeTransactionsOptions).

all

public KafkaFuture<Map<String,TransactionDescription>> all()

Get a future which returns a map of the transaction descriptions requested in the respective call to Admin.describeTransactions(Collection, DescribeTransactionsOptions). If the description fails on any of the transactional IDs in the request, then this future will also fail.

Returns:

a future which either completes when all transaction descriptions complete or fails if any of the descriptions cannot be obtained