Class AdminCommandEvent`Abstract`

Common base class for all admin command events.

Hierarchy (view full)

DataAPIClientEvent
- AdminCommandEvent

Index

Constructors

`Protected` constructor

new AdminCommandEvent(name, info, longRunning): AdminCommandEvent
Internal
Should not be instantiated directly.
Parameters
- name: string
- info: DevOpsAPIRequestInfo
- longRunning: boolean
Returns AdminCommandEvent
Overrides DataAPIClientEvent.constructor
- Defined in src/administration/events.ts:91

Properties

`Readonly` longRunning

longRunning: boolean

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

`Readonly` method

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

The HTTP method for the request.

`Readonly` methodName

methodName: string

The method which invoked the request

`Readonly` name

name: string

The name of the event.

`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.

Methods

`Protected` _desc

_desc(): string
Internal
Returns string
- Defined in src/administration/events.ts:104

formatted

formatted(): string
Returns the event in a formatted string, as it would be logged to stdout/stderr (if enabled).

Returns string
Inherited from DataAPIClientEvent.formatted
- Defined in src/lib/logging/events.ts:41

`Static` formattedPrefix

formattedPrefix(): string
Internal
Formats the current date in a way that is suitable for logging.

Returns string
Inherited from DataAPIClientEvent.formattedPrefix
- Defined in src/lib/logging/events.ts:50

Class AdminCommandEvent`Abstract`

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

`Protected` constructor

Parameters

Returns AdminCommandEvent

Properties

`Readonly` longRunning

`Readonly` method

`Readonly` methodName

`Readonly` name

`Optional` `Readonly` params

`Readonly` path

`Optional` `Readonly` reqBody

Methods

`Protected` _desc

Returns string

formatted

Returns string

`Static` formattedPrefix

Returns string

Settings

Member Visibility

Theme

On This Page

Class AdminCommandEventAbstract

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Parameters

Returns AdminCommandEvent

Properties

Readonly longRunning

Readonly method

Readonly methodName

Readonly name

Optional Readonly params

Readonly path

Optional Readonly reqBody

Methods

Protected _desc

Returns string

formatted

Returns string

Static formattedPrefix

Returns string

Settings

Member Visibility

Theme

On This Page

Class AdminCommandEvent`Abstract`

`Protected` constructor

`Readonly` longRunning

`Readonly` method

`Readonly` methodName

`Readonly` name

`Optional` `Readonly` params

`Readonly` path

`Optional` `Readonly` reqBody

`Protected` _desc

`Static` formattedPrefix