TypeScript SDK Reference
api/client.gen.Port
A port exposed by a container.
Hierarchy
-
BaseClient
↳
Port
Constructors
constructor
new Port(parent?
, _id?
, _description?
, _experimentalSkipHealthcheck?
, _port?
, _protocol?
): Port
Constructor is used for internal usage only, do not create object from it.
Parameters
Name | Type |
---|---|
parent? | Object |
parent.ctx | Context |
parent.queryTree? | QueryTree [] |
_id? | PortID |
_description? | string |
_experimentalSkipHealthcheck? | boolean |
_port? | number |
_protocol? | NetworkProtocol |
Returns
Overrides
BaseClient.constructor
Properties
_description
Private
Optional
Readonly
_description: string
= undefined
_experimentalSkipHealthcheck
Private
Optional
Readonly
_experimentalSkipHealthcheck: boolean
= undefined
_id
Private
Optional
Readonly
_id: PortID
= undefined
_port
Private
Optional
Readonly
_port: number
= undefined
_protocol
Private
Optional
Readonly
_protocol: NetworkProtocol
= undefined
Methods
description
description(): Promise
<string
>
The port description.
Returns
Promise
<string
>
experimentalSkipHealthcheck
experimentalSkipHealthcheck(): Promise
<boolean
>
Skip the health check when run as a service.
Returns
Promise
<boolean
>
id
id(): Promise
<PortID
>
A unique identifier for this Port.
Returns
Promise
<PortID
>
port
port(): Promise
<number
>
The port number.
Returns
Promise
<number
>
protocol
protocol(): Promise
<NetworkProtocol
>
The transport layer protocol.
Returns
Promise
<NetworkProtocol
>