shells

« Previous section Next section »

UCloud Developer Guide / Orchestration of Resources / Compute / Provider APIs / Shells

Shells

Table of Contents

1. Remote Procedure Calls

2. Data Models

Remote Procedure Calls

open

Request	Response	Error
ShellRequest	ShellResponse	CommonErrorMessage

Data Models

ShellRequest

sealed class ShellRequest {
    class Initialize : ShellRequest()
    class Input : ShellRequest()
    class Resize : ShellRequest()
}

---

ShellRequest.Initialize

data class Initialize(
    val sessionIdentifier: String,
    val cols: Int?,
    val rows: Int?,
    val type: String /* "initialize" */,
)

Properties

---

ShellRequest.Input

An event triggered when a user types any sort of input into a terminal

data class Input(
    val data: String,
    val type: String /* "input" */,
)

Properties

---

ShellRequest.Resize

An event triggered when a user resizes a terminal

data class Resize(
    val cols: Int,
    val rows: Int,
    val type: String /* "resize" */,
)

Properties

---

ShellResponse

sealed class ShellResponse {
    class Acknowledged : ShellResponse()
    class Data : ShellResponse()
    class Initialized : ShellResponse()
}

---

ShellResponse.Acknowledged

Emitted by the provider to acknowledge a previous request

data class Acknowledged(
    val type: String /* "ack" */,
)

Properties

---

ShellResponse.Data

Emitted by the provider when new data is available for the terminal

data class Data(
    val data: String,
    val type: String /* "data" */,
)

Properties

---

ShellResponse.Initialized

Emitted by the provider when the terminal has been initialized

data class Initialized(
    val type: String /* "initialize" */,
)

Properties

---