Interface FutureResponse

The response from the server when an organization is created or updated

interface FutureResponse {
    id: string;
    remainingTimeMs?: number;
    progress?: number;
    endState?: FutureEndState;
    reason?: string;
    clientData?: Record<string, unknown>;
    reasonData?: {
        name: string;
        version: string;
    } | {
        vmId: string;
        target: string;
    } | {
        vmId: string;
        target: string;
    }[];
    note?: string;
}

Properties

id remainingTimeMs? progress? endState? reason? clientData? reasonData? note?

Properties

id

id: string

the id of the Future

Optional remainingTimeMs

remainingTimeMs?: number

the remaining time of the Future

Optional progress

progress?: number

the progress of the Future

Optional endState

endState?: FutureEndState

the end state of the Future

Optional reason

reason?: string

the reason for a failure

Optional clientData

clientData?: Record<string, unknown>

object containing client data

Optional reasonData

reasonData?: {
    name: string;
    version: string;
} | {
    vmId: string;
    target: string;
} | {
    vmId: string;
    target: string;
}[]

object containing reason data

Type declaration

  • name: string
  • version: string

Type declaration

  • vmId: string
  • target: string

Optional note

note?: string

object containing client data

Settings

Member Visibility

Theme

On This Page

idremainingTimeMsprogressendStatereasonclientDatareasonDatanote