Package s2.client

Class Client

java.lang.Object

s2.client.BaseClient

s2.client.Client

All Implemented Interfaces:

java.lang.AutoCloseable

public class Client
extends BaseClient

Client for account-level operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Client.ClientBuilder

Method Summary

Modifier and Type	Method	Description
com.google.common.util.concurrent.ListenableFuture<BasinInfo>	createBasin(CreateBasinRequest request)	Create a new basin.
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	deleteBasin(java.lang.String basin)	Delete a basin.
com.google.common.util.concurrent.ListenableFuture<BasinConfig>	getBasinConfig(java.lang.String basin)	Get a basin's config.
com.google.common.util.concurrent.ListenableFuture<Paginated<BasinInfo>>	listBasins(ListBasinsRequest request)	List basins.
static Client.ClientBuilder	newBuilder(Config config)
com.google.common.util.concurrent.ListenableFuture<BasinConfig>	reconfigureBasin(ReconfigureBasinRequest reconfigure)	Update configuration of an existing basin.

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

Method Detail

newBuilder

public static Client.ClientBuilder newBuilder(Config config)

listBasins

public com.google.common.util.concurrent.ListenableFuture<Paginated<BasinInfo>> listBasins(ListBasinsRequest request)

List basins.

Parameters:

request - the request

Returns:

future of a paginated list of basin infos

createBasin

public com.google.common.util.concurrent.ListenableFuture<BasinInfo> createBasin(CreateBasinRequest request)

Create a new basin.

Parameters:

request - the creation request

Returns:

future of the resulting basin's info

deleteBasin

public com.google.common.util.concurrent.ListenableFuture<java.lang.Void> deleteBasin(java.lang.String basin)

Delete a basin.

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

Parameters:

basin - the basin

Returns:

future representing the completion of the delete call

reconfigureBasin

public com.google.common.util.concurrent.ListenableFuture<BasinConfig> reconfigureBasin(ReconfigureBasinRequest reconfigure)

Update configuration of an existing basin.

Parameters:

reconfigure - the reconfigure request

Returns:

future of the updated configuration

getBasinConfig

public com.google.common.util.concurrent.ListenableFuture<BasinConfig> getBasinConfig(java.lang.String basin)

Get a basin's config.

Parameters:

basin - the basin

Returns:

future of the basin configuration