Class GetContainerResponse

Class that represents a response from a Get Container request.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

1.1.0

Hierarchy

AbstractResponse<ContainerData>
- GetContainerResponse

Index

Constructors

Properties

Methods

getContainerId getContainerStatus getContainerStatusCode getData

Constructors

constructor

new GetContainerResponse(data: ContainerData): GetContainerResponse
The constructor.
Parameters
- data: ContainerData
  
  the response data.
Returns GetContainerResponse
Inherited from AbstractResponse.constructor
- Defined in main/requests/AbstractResponse.ts:20

Properties

`Protected` data

data: ContainerData

The response data.

Methods

getContainerId

getContainerId(): string
Gets the container id.

Returns
the container id.

Returns string
- Defined in main/requests/container/GetContainerResponse.ts:16

getContainerStatus

getContainerStatus(): undefined | string
Gets the container status.

Returns
the container status.

Returns undefined | string
- Defined in main/requests/container/GetContainerResponse.ts:25

getContainerStatusCode

getContainerStatusCode(): undefined | CONTAINER_STATUS_CODE
Gets the container status code.

Returns
the container status code.

Returns undefined | CONTAINER_STATUS_CODE
- Defined in main/requests/container/GetContainerResponse.ts:34

getData

getData(): ContainerData
Gets the response data.

Returns
the response data.

Returns ContainerData
Inherited from AbstractResponse.getData
- Defined in main/requests/AbstractResponse.ts:29

Generated using TypeDoc