Class S2Basins

Basin management helper.

Index

Constructors

Methods

create delete getConfig list reconfigure

Constructors

constructor

new S2Basins(client: Client, retryConfig: RetryConfig): S2Basins
Parameters
- client: Client
- retryConfig: RetryConfig
Returns S2Basins
- Defined in packages/streamstore/src/basins.ts:33

Methods

create

create(args: CreateBasinArgs, options?: S2RequestOptions): Promise<BasinInfo>
Create a basin.
Parameters
- args: CreateBasinArgs
- Optionaloptions: S2RequestOptions
Returns Promise<BasinInfo>
- Defined in packages/streamstore/src/basins.ts:67

delete

delete(args: DeleteBasinArgs, options?: S2RequestOptions): Promise<void>
Delete a basin.
Parameters
- args: DeleteBasinArgs
- Optionaloptions: S2RequestOptions
Returns Promise<void>
- Defined in packages/streamstore/src/basins.ts:107

getConfig

getConfig(
args: GetBasinConfigArgs,
options?: S2RequestOptions,
): Promise<BasinConfig>
Get basin configuration.
Parameters
- args: GetBasinConfigArgs
- Optionaloptions: S2RequestOptions
Returns Promise<BasinConfig>
- Defined in packages/streamstore/src/basins.ts:87

list

list(
args?: ListBasinsArgs,
options?: S2RequestOptions,
): Promise<ListBasinsResponse>
List basins.
Parameters
- Optionalargs: ListBasinsArgs
- Optionaloptions: S2RequestOptions
Returns Promise<ListBasinsResponse>
- Defined in packages/streamstore/src/basins.ts:45

reconfigure

reconfigure(
args: ReconfigureBasinArgs,
options?: S2RequestOptions,
): Promise<BasinConfig>
Reconfigure a basin.
Parameters
- args: ReconfigureBasinArgs
  Configuration for the basin to reconfigure (including basin name and fields to change)
- Optionaloptions: S2RequestOptions
Returns Promise<BasinConfig>
- Defined in packages/streamstore/src/basins.ts:127