tech.ydb.topic

Interface TopicClient

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

TopicClientImpl

public interface TopicClient
extends AutoCloseable

Author:

Nikolay Perfilov

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TopicClient.Builder BUILDER

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Status>	alterTopic(String path, AlterTopicSettings settings) Alter topic.
void	close()
CompletableFuture<Status>	commitOffset(String path, CommitOffsetSettings settings) Commit offset to topic
AsyncReader	createAsyncReader(ReaderSettings settings, ReadEventHandlersSettings handlersSettings) Create async topic reader.
AsyncWriter	createAsyncWriter(WriterSettings settings) Create async topic writer.
SyncReader	createSyncReader(ReaderSettings settings) Create sync topic reader.
SyncWriter	createSyncWriter(WriterSettings settings) Create sync topic writer.
CompletableFuture<Status>	createTopic(String path, CreateTopicSettings settings) Create topic.
default CompletableFuture<Result<TopicDescription>>	describeTopic(String path) Describe topic.
CompletableFuture<Result<TopicDescription>>	describeTopic(String path, DescribeTopicSettings settings) Describe topic.
default CompletableFuture<Status>	dropTopic(String path) Drop topic.
CompletableFuture<Status>	dropTopic(String path, DropTopicSettings settings) Drop topic.
static TopicClient.Builder	newClient(GrpcTransport transport)

Method Detail

newClient

static TopicClient.Builder newClient(@WillNotClose
                                     GrpcTransport transport)

createTopic

CompletableFuture<Status> createTopic(String path,
                                      CreateTopicSettings settings)

Create topic. Parent directories must be already present.

Parameters:

path - path to topic

settings - topic creation settings

Returns:

CompletableFuture to operation status

alterTopic

CompletableFuture<Status> alterTopic(String path,
                                     AlterTopicSettings settings)

Alter topic.

Parameters:

path - path to topic

settings - alter topic settings

Returns:

CompletableFuture to operation status

dropTopic

CompletableFuture<Status> dropTopic(String path,
                                    DropTopicSettings settings)

Drop topic.

Parameters:

path - path to topic

settings - request settings (i.e. timeouts)

Returns:

CompletableFuture to operation status

dropTopic

default CompletableFuture<Status> dropTopic(String path)

Drop topic.

Parameters:

path - path to topic

Returns:

CompletableFuture to operation status

describeTopic

CompletableFuture<Result<TopicDescription>> describeTopic(String path,
                                                          DescribeTopicSettings settings)

Describe topic. Receives all topic properties.

Parameters:

path - path to topic

settings - request settings

Returns:

CompletableFuture to a result with TopicDescription

describeTopic

default CompletableFuture<Result<TopicDescription>> describeTopic(String path)

Describe topic. Receives all topic properties.

Parameters:

path - path to topic

Returns:

CompletableFuture to a result with TopicDescription

createSyncReader

SyncReader createSyncReader(ReaderSettings settings)

Create sync topic reader.

Parameters:

settings - reader settings

Returns:

topic SyncReader

createAsyncReader

AsyncReader createAsyncReader(ReaderSettings settings,
                              ReadEventHandlersSettings handlersSettings)

Create async topic reader.

Parameters:

settings - reader settings

handlersSettings - settings for read event handling

Returns:

topic AsyncReader

commitOffset

CompletableFuture<Status> commitOffset(String path,
                                       CommitOffsetSettings settings)

Commit offset to topic

Parameters:

path - path to topic

settings - request settings

Returns:

CompletableFuture to operation status

createSyncWriter

SyncWriter createSyncWriter(WriterSettings settings)

Create sync topic writer.

Parameters:

settings - WriterSettings

Returns:

topic SyncWriter

createAsyncWriter

AsyncWriter createAsyncWriter(WriterSettings settings)

Create async topic writer.

Parameters:

settings - WriterSettings

Returns:

topic AsyncWriter

close

void close()

Specified by:

close in interface AutoCloseable