@my-swu/simulator-client

---

@my-swu/simulator-client / SetSimulatorMaintenanceRequest

Interface: SetSimulatorMaintenanceRequest

Defined in: packages/ts-sdk/src/generated/types/common.ts:5655

Request body for enabling or disabling simulator maintenance.

Example:

import type { SetSimulatorMaintenanceRequest } from '@my-swu/simulator-client'

const setSimulatorMaintenanceRequest: SetSimulatorMaintenanceRequest = {
  "enabled": false,
  "message": 'example',
}

console.log(setSimulatorMaintenanceRequest)

Properties

enabled

Example:

import type { SetSimulatorMaintenanceRequest } from '@my-swu/simulator-client'

const setSimulatorMaintenanceRequest: SetSimulatorMaintenanceRequest = {
  "enabled": false,
  "message": 'example',
}

const { enabled } = setSimulatorMaintenanceRequest

console.log(enabled)

enabled: boolean

Defined in: packages/ts-sdk/src/generated/types/common.ts:5659

Whether new simulator starts should be rejected.

---

message

Example:

import type { SetSimulatorMaintenanceRequest } from '@my-swu/simulator-client'

const setSimulatorMaintenanceRequest: SetSimulatorMaintenanceRequest = {
  "enabled": false,
  "message": 'example',
}

const { message } = setSimulatorMaintenanceRequest

console.log(message)

message: RequiredNullableMaintenanceMessage

Defined in: packages/ts-sdk/src/generated/types/common.ts:5663

Optional operator-supplied note displayed by admin clients.