tech.ydb.coordination

Interface CoordinationClient

All Known Implementing Classes:

CoordinationClientImpl

public interface CoordinationClient

Author:

Kirill Kurdyukov

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Status>	alterNode(String path, CoordinationNodeSettings coordinationNodeSettings) Modifies settings of a coordination node
CompletableFuture<Status>	createNode(String path, CoordinationNodeSettings coordinationNodeSettings) Creates a new coordination node.
CoordinationSession	createSession() Bidirectional stream used to establish a session with a coordination node
CompletableFuture<Status>	describeNode(String path, DescribeCoordinationNodeSettings describeCoordinationNodeSettings) Describes a coordination node
CompletableFuture<Status>	dropNode(String path, DropCoordinationNodeSettings dropCoordinationNodeSettings) Drops a coordination node
String	getDatabase() Database path Using for creating coordination node path
static CoordinationClient	newClient(GrpcTransport transport)

Method Detail

newClient

static CoordinationClient newClient(@WillNotClose
                                    GrpcTransport transport)

createSession

CoordinationSession createSession()

Bidirectional stream used to establish a session with a coordination node

Relevant APIs for managing semaphores, distributed locking, creating or restoring a previously established session are described using nested messages in SessionRequest and SessionResponse. Session is established with a specific coordination node (previously created using CreateNode below) and semaphores are local to that coordination node.

Returns:

coordination node session

createNode

CompletableFuture<Status> createNode(String path,
                                     CoordinationNodeSettings coordinationNodeSettings)

Creates a new coordination node.

Parameters:

path - full path to coordination node

coordinationNodeSettings - coordination node settings

Returns:

status of request

alterNode

CompletableFuture<Status> alterNode(String path,
                                    CoordinationNodeSettings coordinationNodeSettings)

Modifies settings of a coordination node

Parameters:

path - full path to coordination node

coordinationNodeSettings - coordination node settings

Returns:

status of request

dropNode

CompletableFuture<Status> dropNode(String path,
                                   DropCoordinationNodeSettings dropCoordinationNodeSettings)

Drops a coordination node

Parameters:

path - full path to coordination node

dropCoordinationNodeSettings - drop coordination node settings

Returns:

request of status

describeNode

CompletableFuture<Status> describeNode(String path,
                                       DescribeCoordinationNodeSettings describeCoordinationNodeSettings)

Describes a coordination node

Parameters:

path - full path to coordination node

describeCoordinationNodeSettings - describe coordination node settings

Returns:

request of status

getDatabase

String getDatabase()

Database path Using for creating coordination node path

Returns:

path to database