AdminClient (Oracle Database Transactional Event Queues Java API Reference)

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

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

KafkaAdminClient
```
@InterfaceStability.Evolving
public abstract class AdminClient
extends java.lang.Object
implements java.lang.AutoCloseable
```
The administrative client for Transactional Event Queues(TxEventQ), which supports managing and inspecting topics. Topic can be created or altered with following configs. If these configs are not overriden by client then server default values are used. retention.ms: Amount of time in milliseconds messages stay in topic and are available for consumption. In kafka retention time starts after enqueue of a message whereas in TxEventQ retention starts after all subscribers(goups) of a topic consume a message. In TxEventQ retention.ms is rounded to seconds. This property is supported on or later 23c database.

Constructor Summary

Constructors
Constructor and Description

AdminClient()

Constructors
Constructor and Description
`AdminClient()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`AlterConfigsResult`	`alterConfigs(java.util.Map<ConfigResource,Config> configs)` This method is not yet supported.
`abstract 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)` This method is not yet supported.
`abstract AlterReplicaLogDirsResult`	`alterReplicaLogDirs(java.util.Map<TopicPartitionReplica,java.lang.String> replicaAssignment, AlterReplicaLogDirsOptions options)` This method is not yet supported.
`void`	`close()` Close the AdminClient and release all associated resources.
`abstract void`	`close(long duration, java.util.concurrent.TimeUnit unit)` Close the AdminClient and release all associated resources.
`static AdminClient`	`create(java.util.Map<java.lang.String,java.lang.Object> conf)` Create a new AdminClient with the given configuration.
`static AdminClient`	`create(java.util.Properties props)` Create a new AdminClient with the given configuration.
`CreateAclsResult`	`createAcls(java.util.Collection<org.oracle.okafka.common.acl.AclBinding> acls)` This method is not yet supported.
`abstract CreateAclsResult`	`createAcls(java.util.Collection<org.oracle.okafka.common.acl.AclBinding> acls, CreateAclsOptions options)` This method is not yet supported.
`CreateDelegationTokenResult`	`createDelegationToken()` This method is not yet supported.
`abstract CreateDelegationTokenResult`	`createDelegationToken(CreateDelegationTokenOptions options)` This method is not yet supported.
`CreatePartitionsResult`	`createPartitions(java.util.Map<java.lang.String,NewPartitions> newPartitions)` This method is not yet supported.
`abstract 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)` Create a batch of new topics .This call doen't consider options for topic creation.
`abstract 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)` This method is not yet supported.
`abstract 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)` This method is not yet supported.
`abstract 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)` This method is not yet supported.
`abstract DeleteRecordsResult`	`deleteRecords(java.util.Map<TopicPartition,RecordsToDelete> recordsToDelete, DeleteRecordsOptions options)` This method is not yet supported.
`DeleteTopicsResult`	`deleteTopics(java.util.Collection<java.lang.String> topics)` Delete a batch of topics.
`abstract DeleteTopicsResult`	`deleteTopics(java.util.Collection<java.lang.String> topics, DeleteTopicsOptions options)` Delete a batch of topics.
`DescribeAclsResult`	`describeAcls(org.oracle.okafka.common.acl.AclBindingFilter filter)` This method is not yet supported.
`abstract DescribeAclsResult`	`describeAcls(org.oracle.okafka.common.acl.AclBindingFilter filter, DescribeAclsOptions options)` This method is not yet supported.
`DescribeClusterResult`	`describeCluster()` This method is not yet supported.
`abstract DescribeClusterResult`	`describeCluster(DescribeClusterOptions options)` This method is not yet supported.
`DescribeConfigsResult`	`describeConfigs(java.util.Collection<ConfigResource> resources)` This method is not yet supported.
`abstract DescribeConfigsResult`	`describeConfigs(java.util.Collection<ConfigResource> resources, DescribeConfigsOptions options)` This method is not yet supported.
`DescribeConsumerGroupsResult`	`describeConsumerGroups(java.util.Collection<java.lang.String> groupIds)` This method is not yet supported.
`abstract DescribeConsumerGroupsResult`	`describeConsumerGroups(java.util.Collection<java.lang.String> groupIds, DescribeConsumerGroupsOptions options)` DThis method is not yet supported.
`DescribeDelegationTokenResult`	`describeDelegationToken()` This method is not yet supported.
`abstract DescribeDelegationTokenResult`	`describeDelegationToken(DescribeDelegationTokenOptions options)` This method is not yet supported.
`DescribeLogDirsResult`	`describeLogDirs(java.util.Collection<java.lang.Integer> brokers)` This method is not yet supported.
`abstract DescribeLogDirsResult`	`describeLogDirs(java.util.Collection<java.lang.Integer> brokers, DescribeLogDirsOptions options)` This method is not yet supported.
`DescribeReplicaLogDirsResult`	`describeReplicaLogDirs(java.util.Collection<TopicPartitionReplica> replicas)` This method is not yet supported.
`abstract DescribeReplicaLogDirsResult`	`describeReplicaLogDirs(java.util.Collection<TopicPartitionReplica> replicas, DescribeReplicaLogDirsOptions options)` This method is not yet supported.
`DescribeTopicsResult`	`describeTopics(java.util.Collection<java.lang.String> topicNames)` This method is not yet supported.
`abstract DescribeTopicsResult`	`describeTopics(java.util.Collection<java.lang.String> topicNames, DescribeTopicsOptions options)` This method is not yet supported.
`ExpireDelegationTokenResult`	`expireDelegationToken(byte[] hmac)` <This method is not yet supported.
`abstract ExpireDelegationTokenResult`	`expireDelegationToken(byte[] hmac, ExpireDelegationTokenOptions options)` This method is not yet supported.
`ListConsumerGroupOffsetsResult`	`listConsumerGroupOffsets(java.lang.String groupId)` This method is not yet supported.
`abstract ListConsumerGroupOffsetsResult`	`listConsumerGroupOffsets(java.lang.String groupId, ListConsumerGroupOffsetsOptions options)` This method is not yet supported.
`ListConsumerGroupsResult`	`listConsumerGroups()` This method is not yet supported.
`abstract ListConsumerGroupsResult`	`listConsumerGroups(ListConsumerGroupsOptions options)` This method is not yet supported.
`ListTopicsResult`	`listTopics()` This method is not yet supported.
`abstract ListTopicsResult`	`listTopics(ListTopicsOptions options)` This method is not yet supported.
`RenewDelegationTokenResult`	`renewDelegationToken(byte[] hmac)` This method is not yet supported.
`abstract RenewDelegationTokenResult`	`renewDelegationToken(byte[] hmac, RenewDelegationTokenOptions options)` This method is not yet supported.

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

Constructor Detail
- AdminClient
```
public AdminClient()
```

Method Detail

create
```
public static AdminClient create(java.util.Properties props)
```
Create a new AdminClient with the given configuration.

Parameters:

props - The configuration.

Returns:

The new KafkaAdminClient.

create
```
public static AdminClient create(java.util.Map<java.lang.String,java.lang.Object> conf)
```
Create a new AdminClient with the given configuration.

Parameters:

conf - The configuration.

Returns:

The new KafkaAdminClient.

close
```
public void close()
```
Close the AdminClient and release all associated resources. See close(long, TimeUnit)

Specified by:

close in interface java.lang.AutoCloseable

close
```
public abstract void close(long duration,
                           java.util.concurrent.TimeUnit unit)
```
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.

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)
```
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.

Parameters:

newTopics - The new topics to create.

Returns:

The CreateTopicsResult.

createTopics
```
public abstract CreateTopicsResult createTopics(java.util.Collection<NewTopic> newTopics,
                                                CreateTopicsOptions options)
```
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.

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> topics)
```
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.

Parameters:

topics - The topic names to delete.

Returns:

The DeleteTopicsResult.

deleteTopics
```
public abstract DeleteTopicsResult deleteTopics(java.util.Collection<java.lang.String> topics,
                                                DeleteTopicsOptions options)
```
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.

Parameters:

topics - The topic names to delete.

options - The options to use when deleting the topics.

Returns:

The DeleteTopicsResult.

listTopics
```
public ListTopicsResult listTopics()
```
This method is not yet supported.