94 lines
3.1 KiB
TypeScript
94 lines
3.1 KiB
TypeScript
|
import { TunnelAccessControl } from './tunnelAccessControl';
|
||
|
|
import { TunnelOptions } from './tunnelOptions';
|
||
|
|
import { TunnelPortStatus } from './tunnelPortStatus';
|
||
|
|
/**
|
||
|
|
* Data contract for tunnel port objects managed through the tunnel service REST API.
|
||
|
|
*/
|
||
|
|
export interface TunnelPort {
|
||
|
|
/**
|
||
|
|
* Gets or sets the ID of the cluster the tunnel was created in.
|
||
|
|
*/
|
||
|
|
clusterId?: string;
|
||
|
|
/**
|
||
|
|
* Gets or sets the generated ID of the tunnel, unique within the cluster.
|
||
|
|
*/
|
||
|
|
tunnelId?: string;
|
||
|
|
/**
|
||
|
|
* Gets or sets the IP port number of the tunnel port.
|
||
|
|
*/
|
||
|
|
portNumber: number;
|
||
|
|
/**
|
||
|
|
* Gets or sets the optional short name of the port.
|
||
|
|
*
|
||
|
|
* The name must be unique among named ports of the same tunnel.
|
||
|
|
*/
|
||
|
|
name?: string;
|
||
|
|
/**
|
||
|
|
* Gets or sets the optional description of the port.
|
||
|
|
*/
|
||
|
|
description?: string;
|
||
|
|
/**
|
||
|
|
* Gets or sets the labels of the port.
|
||
|
|
*/
|
||
|
|
labels?: string[];
|
||
|
|
/**
|
||
|
|
* Gets or sets the protocol of the tunnel port.
|
||
|
|
*
|
||
|
|
* Should be one of the string constants from {@link TunnelProtocol}.
|
||
|
|
*/
|
||
|
|
protocol?: string;
|
||
|
|
/**
|
||
|
|
* Gets or sets a value indicating whether this port is a default port for the tunnel.
|
||
|
|
*
|
||
|
|
* A client that connects to a tunnel (by ID or name) without specifying a port number
|
||
|
|
* will connect to the default port for the tunnel, if a default is configured. Or if
|
||
|
|
* the tunnel has only one port then the single port is the implicit default.
|
||
|
|
*
|
||
|
|
* Selection of a default port for a connection also depends on matching the
|
||
|
|
* connection to the port {@link TunnelPort.protocol}, so it is possible to configure
|
||
|
|
* separate defaults for distinct protocols like {@link TunnelProtocol.http} and
|
||
|
|
* {@link TunnelProtocol.ssh}.
|
||
|
|
*/
|
||
|
|
isDefault?: boolean;
|
||
|
|
/**
|
||
|
|
* Gets or sets a dictionary mapping from scopes to tunnel access tokens.
|
||
|
|
*
|
||
|
|
* Unlike the tokens in {@link Tunnel.accessTokens}, these tokens are restricted to
|
||
|
|
* the individual port.
|
||
|
|
*/
|
||
|
|
accessTokens?: {
|
||
|
|
[scope: string]: string;
|
||
|
|
};
|
||
|
|
/**
|
||
|
|
* Gets or sets access control settings for the tunnel port.
|
||
|
|
*
|
||
|
|
* See {@link TunnelAccessControl} documentation for details about the access control
|
||
|
|
* model.
|
||
|
|
*/
|
||
|
|
accessControl?: TunnelAccessControl;
|
||
|
|
/**
|
||
|
|
* Gets or sets options for the tunnel port.
|
||
|
|
*/
|
||
|
|
options?: TunnelOptions;
|
||
|
|
/**
|
||
|
|
* Gets or sets current connection status of the tunnel port.
|
||
|
|
*/
|
||
|
|
status?: TunnelPortStatus;
|
||
|
|
/**
|
||
|
|
* Gets or sets the username for the ssh service user is trying to forward.
|
||
|
|
*
|
||
|
|
* Should be provided if the {@link TunnelProtocol} is Ssh.
|
||
|
|
*/
|
||
|
|
sshUser?: string;
|
||
|
|
/**
|
||
|
|
* Gets or sets web forwarding URIs. If set, it's a list of absolute URIs where the
|
||
|
|
* port can be accessed with web forwarding.
|
||
|
|
*/
|
||
|
|
portForwardingUris?: string[];
|
||
|
|
/**
|
||
|
|
* Gets or sets inspection URI. If set, it's an absolute URIs where the port's traffic
|
||
|
|
* can be inspected.
|
||
|
|
*/
|
||
|
|
inspectionUri?: string;
|
||
|
|
}
|
||
|
|
//# sourceMappingURL=tunnelPort.d.ts.map
|