KafkaAdminClient (Oracle Database Transactional Event Queues Java API Reference)

java.lang.Object
- org.oracle.okafka.clients.admin.AdminClient
- - org.oracle.okafka.clients.admin.KafkaAdminClient

All Implemented Interfaces:

java.lang.AutoCloseable
```
@InterfaceStability.Evolving
public class KafkaAdminClient
extends AdminClient
```
The default implementation of AdminClient. An instance of this class is created by invoking one of the create() methods in AdminClient. Users should not refer to this class directly. The API of this class is evolving, see AdminClient for details. Note: Topic name has to be in uppercase wherever used.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AlterConfigsResult`	`alterConfigs(java.util.Map<ConfigResource,Config> configs, AlterConfigsOptions options)` This method is not yet supported.
`AlterReplicaLogDirsResult`	`alterReplicaLogDirs(java.util.Map<TopicPartitionReplica,java.lang.String> replicaAssignment, AlterReplicaLogDirsOptions options)` This method is not yet supported.
`void`	`close(long duration, java.util.concurrent.TimeUnit unit)` Close the AdminClient and release all associated resources.
`CreateAclsResult`	`createAcls(java.util.Collection<org.oracle.okafka.common.acl.AclBinding> acls, CreateAclsOptions options)` This method is not yet supported.
`CreateDelegationTokenResult`	`createDelegationToken(CreateDelegationTokenOptions options)` This method is not yet supported.
`CreatePartitionsResult`	`createPartitions(java.util.Map<java.lang.String,NewPartitions> newPartitions, CreatePartitionsOptions options)` This method is not yet supported.
`CreateTopicsResult`	`createTopics(java.util.Collection<NewTopic> newTopics, CreateTopicsOptions options)` Create a batch of new topics.
`DeleteAclsResult`	`deleteAcls(java.util.Collection<org.oracle.okafka.common.acl.AclBindingFilter> filters, DeleteAclsOptions options)` This method is not yet supported.
`DeleteConsumerGroupsResult`	`deleteConsumerGroups(java.util.Collection<java.lang.String> groupIds, DeleteConsumerGroupsOptions options)` This method is not yet supported.
`DeleteRecordsResult`	`deleteRecords(java.util.Map<TopicPartition,RecordsToDelete> recordsToDelete, DeleteRecordsOptions options)` This method is not yet supported.
`DeleteTopicsResult`	`deleteTopics(java.util.Collection<java.lang.String> topicNames, DeleteTopicsOptions options)` Delete a batch of topics.
`DescribeAclsResult`	`describeAcls(org.oracle.okafka.common.acl.AclBindingFilter filter, DescribeAclsOptions options)` This method is not yet supported.
`DescribeClusterResult`	`describeCluster(DescribeClusterOptions options)` This method is not yet supported.
`DescribeConfigsResult`	`describeConfigs(java.util.Collection<ConfigResource> configResources, DescribeConfigsOptions options)` This method is not yet supported.
`DescribeConsumerGroupsResult`	`describeConsumerGroups(java.util.Collection<java.lang.String> groupIds, DescribeConsumerGroupsOptions options)` DThis method is not yet supported.
`DescribeDelegationTokenResult`	`describeDelegationToken(DescribeDelegationTokenOptions options)` This method is not yet supported.
`DescribeLogDirsResult`	`describeLogDirs(java.util.Collection<java.lang.Integer> brokers, DescribeLogDirsOptions options)` This method is not yet supported.
`DescribeReplicaLogDirsResult`	`describeReplicaLogDirs(java.util.Collection<TopicPartitionReplica> replicas, DescribeReplicaLogDirsOptions options)` This method is not yet supported.
`DescribeTopicsResult`	`describeTopics(java.util.Collection<java.lang.String> topicNames, DescribeTopicsOptions options)` This method is not yet supported.
`ExpireDelegationTokenResult`	`expireDelegationToken(byte[] hmac, ExpireDelegationTokenOptions options)` This method is not yet supported.
`ListConsumerGroupOffsetsResult`	`listConsumerGroupOffsets(java.lang.String groupId, ListConsumerGroupOffsetsOptions options)` This method is not yet supported.
`ListConsumerGroupsResult`	`listConsumerGroups(ListConsumerGroupsOptions options)` This method is not yet supported.
`ListTopicsResult`	`listTopics(ListTopicsOptions options)` This method is not yet supported.
`RenewDelegationTokenResult`	`renewDelegationToken(byte[] hmac, RenewDelegationTokenOptions options)` This method is not yet supported.

Methods inherited from class org.oracle.okafka.clients.admin.AdminClient
alterConfigs, alterReplicaLogDirs, close, create, create, createAcls, createDelegationToken, createPartitions, createTopics, deleteAcls, deleteConsumerGroups, deleteRecords, deleteTopics, describeAcls, describeCluster, describeConfigs, describeConsumerGroups, describeDelegationToken, describeLogDirs, describeReplicaLogDirs, describeTopics, expireDelegationToken, listConsumerGroupOffsets, listConsumerGroups, listTopics, renewDelegationToken

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

close
```
public void close(long duration,
                  java.util.concurrent.TimeUnit unit)
```
Description copied from class: AdminClient

Close the AdminClient and release all associated resources. The close operation has a grace period during which current operations will be allowed to complete, specified by the given duration and time unit. New operations will not be accepted during the grace period. Once the grace period is over, all operations that have not yet been completed will be aborted with a TimeoutException.

Specified by:

close in class AdminClient

Parameters:

duration - The duration to use for the wait time.

unit - The time unit to use for the wait time.

createTopics
```
public CreateTopicsResult createTopics(java.util.Collection<NewTopic> newTopics,
                                       CreateTopicsOptions options)
```
Description copied from class: AdminClient

Create a batch of new topics. This call doen't consider options for topic creation. This operation is not transactional so it may succeed for some topics while fail for others.

Specified by:

createTopics in class AdminClient

Parameters:

newTopics - The new topics to create.

options - The options to use when creating the new topics.

Returns:

The CreateTopicsResult.

deleteTopics
```
public DeleteTopicsResult deleteTopics(java.util.Collection<java.lang.String> topicNames,
                                       DeleteTopicsOptions options)
```
Description copied from class: AdminClient

Delete a batch of topics. This call doen't consider options for topic deletion. This operation is not transactional so it may succeed for some topics while fail for others. Property delete.topic.enable is not yet supported.

Specified by:

deleteTopics in class AdminClient

Parameters:

topicNames - The topic names to delete.

options - The options to use when deleting the topics.

Returns:

The DeleteTopicsResult.

listTopics
```
public ListTopicsResult listTopics(ListTopicsOptions options)
```
Description copied from class: AdminClient

This method is not yet supported.

Specified by:

listTopics in class AdminClient