Package s2.client

Class BasinClient

java.lang.Object

s2.client.BaseClient

s2.client.BasinClient

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

StreamClient

public class BasinClient
extends BaseClient

Client for basin-level operations.

Constructor Summary

Constructors

Constructor	Description
BasinClient(String basin, Config config, io.grpc.ManagedChannel channel, ScheduledExecutorService executor)	Instantiates a new Basin client.
BasinClient(String basin, Config config, ScheduledExecutorService executor)	Instantiates a new Basin client.

Method Summary

Modifier and Type	Method	Description
com.google.common.util.concurrent.ListenableFuture<StreamInfo>	createStream(CreateStreamRequest createStreamRequest)	Create a new stream within this basin.
com.google.common.util.concurrent.ListenableFuture<Void>	deleteStream(String streamName)	Delete a stream.
com.google.common.util.concurrent.ListenableFuture<StreamConfig>	getStreamConfig(String streamName)	Get current config of a stream.
com.google.common.util.concurrent.ListenableFuture<Paginated<StreamInfo>>	listStreams(ListStreamsRequest listStreamsRequest)	List streams within the basin.
com.google.common.util.concurrent.ListenableFuture<StreamConfig>	reconfigureStream(ReconfigureStreamRequest reconfigureStreamRequest)	Reconfigure an existing stream.
StreamClient	streamClient(String streamName)	Create a StreamClient for interacting with stream-level RPCs.

Methods inherited from class s2.client.BaseClient

close

Methods inherited from class java.lang.Object

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

Constructor Details

BasinClient

public BasinClient(String basin,
 Config config,
 ScheduledExecutorService executor)

Instantiates a new Basin client.

Most users will prefer to use the Client.basinClient(String) method for construction.

Parameters:

basin - the basin

config - the config

executor - the executor

See Also:

• Client.basinClient(java.lang.String)

BasinClient

public BasinClient(String basin,
 Config config,
 io.grpc.ManagedChannel channel,
 ScheduledExecutorService executor)

Instantiates a new Basin client.

Most users will prefer to use the Client.basinClient(String) method for construction.

Parameters:

basin - the basin

config - the config

channel - the channel

executor - the executor

See Also:

• Client.basinClient(java.lang.String)

Method Details

listStreams

public com.google.common.util.concurrent.ListenableFuture<Paginated<StreamInfo>> listStreams(ListStreamsRequest listStreamsRequest)

List streams within the basin.

Parameters:

listStreamsRequest - the list streams request

Returns:

future of a paginated list of stream infos

createStream

public com.google.common.util.concurrent.ListenableFuture<StreamInfo> createStream(CreateStreamRequest createStreamRequest)

Create a new stream within this basin.

Parameters:

createStreamRequest - the create stream request

Returns:

future of the resulting stream info

deleteStream

public com.google.common.util.concurrent.ListenableFuture<Void> deleteStream(String streamName)

Delete a stream.

Stream deletion is asynchronous, and may take a few minutes to complete.

Parameters:

streamName - the stream name

Returns:

future representing the completion of this action

getStreamConfig

public com.google.common.util.concurrent.ListenableFuture<StreamConfig> getStreamConfig(String streamName)

Get current config of a stream.

Parameters:

streamName - the stream name

Returns:

future of the stream config

reconfigureStream

public com.google.common.util.concurrent.ListenableFuture<StreamConfig> reconfigureStream(ReconfigureStreamRequest reconfigureStreamRequest)

Reconfigure an existing stream.

Parameters:

reconfigureStreamRequest - the reconfigure stream request

Returns:

future of the resulting stream config

streamClient

public StreamClient streamClient(String streamName)

Create a StreamClient for interacting with stream-level RPCs.

Parameters:

streamName - the stream name

Returns:

the stream client