Class S2Locations

Account-scoped helper for listing locations and managing the default location.

Retrieve this via S2.locations.

Index

Constructors

Methods

getDefault list setDefault

Constructors

constructor

new S2Locations(client: Client, retryConfig: RetryConfig): S2Locations
Parameters
- client: Client
- retryConfig: RetryConfig
Returns S2Locations
- Defined in packages/streamstore/src/locations.ts:26

Methods

getDefault

getDefault(options?: S2RequestOptions): Promise<LocationInfo>
Get the default location used when creating basins without an explicit location.
Parameters
- Optionaloptions: S2RequestOptions
Returns Promise<LocationInfo>
- Defined in packages/streamstore/src/locations.ts:51

list

list(options?: S2RequestOptions): Promise<ListLocationsResponse>
List available locations.
Parameters
- Optionaloptions: S2RequestOptions
Returns Promise<ListLocationsResponse>
- Defined in packages/streamstore/src/locations.ts:34

setDefault

setDefault(
args: SetDefaultLocationInput,
options?: S2RequestOptions,
): Promise<LocationInfo>
Set the default location used when creating basins without an explicit location.
Parameters
- args: SetDefaultLocationInput
  Input for setting the default location.
  - location: string
    Location name.
- Optionaloptions: S2RequestOptions
Returns Promise<LocationInfo>
- Defined in packages/streamstore/src/locations.ts:70