Class StackService

Index

Constructors

Methods

applyStack applyStackAsync createStack deleteStack destroyStack destroyStackAsync generateStack generateStackAsync getStack listRun listStack previewStackAsync updateStack

Constructors

constructor

new StackService(): StackService
Returns StackService

Methods

`Static`applyStack

applyStack<ThrowOnError extends boolean = false>(
    options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & ApplyStackData & Pick<
        RequestOptions<ThrowOnError, string>,
        "headers",
    >,
): RequestResult<string, unknown, ThrowOnError>
Apply stack Apply stack information by stack ID
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & ApplyStackData & Pick<
  RequestOptions<ThrowOnError, string>,
  "headers",
  >
Returns RequestResult<string, unknown, ThrowOnError>
- Defined in sdk.gen.ts:444

`Static`applyStackAsync

applyStackAsync<ThrowOnError extends boolean = false>(
    options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & ApplyStackAsyncData & Pick<
        RequestOptions<ThrowOnError, string>,
        "headers",
    >,
): RequestResult<entity_Run, unknown, ThrowOnError>
Asynchronously apply stack Start a run and asynchronously apply stack changes by stack ID
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & ApplyStackAsyncData & Pick<
  RequestOptions<ThrowOnError, string>,
  "headers",
  >
Returns RequestResult<entity_Run, unknown, ThrowOnError>
- Defined in sdk.gen.ts:455

`Static`createStack

createStack<ThrowOnError extends boolean = false>(
    options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & CreateStackData & Pick<
        RequestOptions<ThrowOnError, string>,
        "headers",
    >,
): RequestResult<entity_Stack, unknown, ThrowOnError>
Create stack Create a new stack
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & CreateStackData & Pick<
  RequestOptions<ThrowOnError, string>,
  "headers",
  >
Returns RequestResult<entity_Stack, unknown, ThrowOnError>
- Defined in sdk.gen.ts:400

`Static`deleteStack

deleteStack<ThrowOnError extends boolean = false>(
options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & DeleteStackData,
): RequestResult<string, unknown, ThrowOnError>
Delete stack Delete specified stack by ID
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & DeleteStackData
Returns RequestResult<string, unknown, ThrowOnError>
- Defined in sdk.gen.ts:411

`Static`destroyStack

destroyStack<ThrowOnError extends boolean = false>(
options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & DestroyStackData,
): RequestResult<string, unknown, ThrowOnError>
Destroy stack Destroy stack information by stack ID
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & DestroyStackData
Returns RequestResult<string, unknown, ThrowOnError>
- Defined in sdk.gen.ts:466

`Static`destroyStackAsync

destroyStackAsync<ThrowOnError extends boolean = false>(
options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & DestroyStackAsyncData,
): RequestResult<string, unknown, ThrowOnError>
Asynchronously destroy stack Start a run and asynchronously destroy stack resources by stack ID
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & DestroyStackAsyncData
Returns RequestResult<string, unknown, ThrowOnError>
- Defined in sdk.gen.ts:477

`Static`generateStack

generateStack<ThrowOnError extends boolean = false>(
options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & GenerateStackData,
): RequestResult<v1_Spec, unknown, ThrowOnError>
Generate stack Generate stack information by stack ID
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & GenerateStackData
Returns RequestResult<v1_Spec, unknown, ThrowOnError>
- Defined in sdk.gen.ts:488

`Static`generateStackAsync

generateStackAsync<ThrowOnError extends boolean = false>(
options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & GenerateStackAsyncData,
): RequestResult<v1_Spec, unknown, ThrowOnError>
Asynchronously generate stack Start a run and asynchronously generate stack spec by stack ID
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & GenerateStackAsyncData
Returns RequestResult<v1_Spec, unknown, ThrowOnError>
- Defined in sdk.gen.ts:499

`Static`getStack

getStack<ThrowOnError extends boolean = false>(
options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & GetStackData,
): RequestResult<entity_Stack, unknown, ThrowOnError>
Get stack Get stack information by stack ID
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & GetStackData
Returns RequestResult<entity_Stack, unknown, ThrowOnError>
- Defined in sdk.gen.ts:422

`Static`listRun

listRun<ThrowOnError extends boolean = false>(
options?: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & ListRunData,
): RequestResult<ListRunResponse, unknown, ThrowOnError>
List runs List all runs
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- Optionaloptions: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & ListRunData
Returns RequestResult<ListRunResponse, unknown, ThrowOnError>
- Defined in sdk.gen.ts:378

`Static`listStack

listStack<ThrowOnError extends boolean = false>(
options?: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & ListStackData,
): RequestResult<ListStackResponse, unknown, ThrowOnError>
List stacks List all stacks
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- Optionaloptions: OmitKeys<RequestOptions<ThrowOnError, string>, "url"> & ListStackData
Returns RequestResult<ListStackResponse, unknown, ThrowOnError>
- Defined in sdk.gen.ts:389

`Static`previewStackAsync

previewStackAsync<ThrowOnError extends boolean = false>(
    options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & PreviewStackAsyncData & Pick<
        RequestOptions<ThrowOnError, string>,
        "headers",
    >,
): RequestResult<entity_Run, unknown, ThrowOnError>
Asynchronously preview stack Start a run and asynchronously preview stack changes by stack ID
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & PreviewStackAsyncData & Pick<
  RequestOptions<ThrowOnError, string>,
  "headers",
  >
Returns RequestResult<entity_Run, unknown, ThrowOnError>
- Defined in sdk.gen.ts:510

`Static`updateStack

updateStack<ThrowOnError extends boolean = false>(
    options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & UpdateStackData & Pick<
        RequestOptions<ThrowOnError, string>,
        "headers",
    >,
): RequestResult<entity_Stack, unknown, ThrowOnError>
Update stack Update the specified stack
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- options: OmitKeys<RequestOptions<ThrowOnError, string>, "body" | "url"> & UpdateStackData & Pick<
  RequestOptions<ThrowOnError, string>,
  "headers",
  >
Returns RequestResult<entity_Stack, unknown, ThrowOnError>
- Defined in sdk.gen.ts:433

Class StackService

Index

Constructors

Methods

Constructors

constructor

Returns StackService

Methods

StaticapplyStack

Type Parameters

Parameters

Returns RequestResult<string, unknown, ThrowOnError>

StaticapplyStackAsync

Type Parameters

Parameters

Returns RequestResult<entity_Run, unknown, ThrowOnError>

StaticcreateStack

Type Parameters

Parameters

Returns RequestResult<entity_Stack, unknown, ThrowOnError>

StaticdeleteStack

Type Parameters

Parameters

Returns RequestResult<string, unknown, ThrowOnError>

StaticdestroyStack

Type Parameters

Parameters

Returns RequestResult<string, unknown, ThrowOnError>

StaticdestroyStackAsync

Type Parameters

Parameters

Returns RequestResult<string, unknown, ThrowOnError>

StaticgenerateStack

Type Parameters

Parameters

Returns RequestResult<v1_Spec, unknown, ThrowOnError>

StaticgenerateStackAsync

Type Parameters

Parameters

Returns RequestResult<v1_Spec, unknown, ThrowOnError>

StaticgetStack

Type Parameters

Parameters

Returns RequestResult<entity_Stack, unknown, ThrowOnError>

StaticlistRun

Type Parameters

Parameters

Returns RequestResult<ListRunResponse, unknown, ThrowOnError>

StaticlistStack

Type Parameters

Parameters

Returns RequestResult<ListStackResponse, unknown, ThrowOnError>

StaticpreviewStackAsync

Type Parameters

Parameters

Returns RequestResult<entity_Run, unknown, ThrowOnError>

StaticupdateStack

Type Parameters

Parameters

Returns RequestResult<entity_Stack, unknown, ThrowOnError>

Settings

On This Page

`Static`applyStack

`Static`applyStackAsync

`Static`createStack

`Static`deleteStack

`Static`destroyStack

`Static`destroyStackAsync

`Static`generateStack

`Static`generateStackAsync

`Static`getStack

`Static`listRun

`Static`listStack

`Static`previewStackAsync

`Static`updateStack