Class StreamsApi

Hierarchy (view full)

BaseAPI
- StreamsApi

Index

Constructors

Properties

Methods

deleteStreamsWithName deleteStreamsWithNameRaw getStreams getStreamsRaw getStreamsWithName getStreamsWithNameRaw isJsonMime patchStreamsWithName patchStreamsWithNameRaw postStreams postStreamsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new StreamsApi(configuration?): StreamsApi
Parameters
- configuration: Configuration = DefaultConfig
Returns StreamsApi
Inherited from BaseAPI.constructor
- Defined in cwmsjs/src/runtime.ts:97

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteStreamsWithName

deleteStreamsWithName(requestParameters, initOverrides?): Promise<void>
Delete CWMS Stream Delete cwmsData streams with name
Parameters
- requestParameters: DeleteStreamsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/StreamsApi.ts:116

deleteStreamsWithNameRaw

deleteStreamsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete CWMS Stream Delete cwmsData streams with name
Parameters
- requestParameters: DeleteStreamsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/StreamsApi.ts:71

getStreams

getStreams(requestParameters?, initOverrides?): Promise<Stream[]>
Returns matching CWMS Stream Data for a Reservoir Project. Get cwmsData streams
Parameters
- requestParameters: GetStreamsRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Stream[]>
- Defined in cwmsjs/src/apis/StreamsApi.ts:167

getStreamsRaw

getStreamsRaw(requestParameters, initOverrides?): Promise<ApiResponse<Stream[]>>
Returns matching CWMS Stream Data for a Reservoir Project. Get cwmsData streams
Parameters
- requestParameters: GetStreamsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Stream[]>>
- Defined in cwmsjs/src/apis/StreamsApi.ts:124

getStreamsWithName

getStreamsWithName(requestParameters, initOverrides?): Promise<Stream[]>
Returns CWMS Stream Data Get cwmsData streams with name
Parameters
- requestParameters: GetStreamsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Stream[]>
- Defined in cwmsjs/src/apis/StreamsApi.ts:221

getStreamsWithNameRaw

getStreamsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<Stream[]>>
Returns CWMS Stream Data Get cwmsData streams with name
Parameters
- requestParameters: GetStreamsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Stream[]>>
- Defined in cwmsjs/src/apis/StreamsApi.ts:176

`Protected` isJsonMime

isJsonMime(mime): boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
Parameters
- mime: string
  MIME (Multipurpose Internet Mail Extensions)
Returns boolean
True if the given MIME is JSON, false otherwise.
Inherited from BaseAPI.isJsonMime
- Defined in cwmsjs/src/runtime.ts:127

patchStreamsWithName

patchStreamsWithName(requestParameters, initOverrides?): Promise<void>
Rename CWMS Stream Patch cwmsData streams with name
Parameters
- requestParameters: PatchStreamsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/StreamsApi.ts:282

patchStreamsWithNameRaw

patchStreamsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Rename CWMS Stream Patch cwmsData streams with name
Parameters
- requestParameters: PatchStreamsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/StreamsApi.ts:230

postStreams

postStreams(requestParameters, initOverrides?): Promise<void>
Create CWMS Stream Post cwmsData streams
Parameters
- requestParameters: PostStreamsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/StreamsApi.ts:327

postStreamsRaw

postStreamsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create CWMS Stream Post cwmsData streams
Parameters
- requestParameters: PostStreamsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/StreamsApi.ts:290

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in cwmsjs/src/runtime.ts:134

withMiddleware

withMiddleware<T>(this, ...middlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in cwmsjs/src/runtime.ts:101

withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in cwmsjs/src/runtime.ts:112

withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in cwmsjs/src/runtime.ts:107