Class AdminCommandSucceededEvent

Event emitted when an admin command has succeeded, after any necessary polling.

See AdminCommandEvent for more information about all the common properties available on this event.

Hierarchy (view full)

Constructors

constructor

Properties

duration longRunning method params? path reqBody? resBody? warnings

Constructors

constructor

Properties

Readonly duration

duration: number

The duration of the command, in milliseconds.

Readonly longRunning

longRunning: boolean

Whether the command is long-running or not, i.e. requires polling.

Readonly method

method: "DELETE" | "GET" | "POST"

The HTTP method for the request.

Optional Readonly params

params?: Record<string, any>

The query parameters, if any.

Readonly path

path: string

The path for the request, not including the Base URL.

Optional Readonly reqBody

reqBody?: Record<string, any>

The request body, if any.

Optional Readonly resBody

resBody?: Record<string, any>

The response body of the command, if any.

Readonly warnings

warnings: string[]

Any warnings returned from the Data API that may point out deprecated/incorrect practices, or any other issues that aren't strictly an error.

Does not apply to Astra users, as the admin classes will use the DevOps API instead.

Settings

Member Visibility

Theme

On This Page

constructordurationlongRunningmethodparamspathreqBodyresBodywarnings