Connection class

Instructions for how to connect to a remote endpoint.

Constructors

Connection({Input<String>? agentSocketPath, Input<int>? dialErrorLimit, required Input<String> host, Input<String>? hostKey, Input<String>? password, Input<int>? perDialTimeout, Input<double>? port, Input<String>? privateKey, Input<String>? privateKeyPassword, Input<ProxyConnection>? proxy, Input<String>? user})
Creates a new Connection. agentSocketPath SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present. dialErrorLimit Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10. host The address of the resource to connect to. hostKey The expected host key to verify the server's identity. If not provided, the host key will be ignored. password The password we should use for the connection. perDialTimeout Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds. port The port to connect to. Defaults to 22. privateKey The contents of an SSH key to use for the connection. This takes preference over the password if provided. privateKeyPassword The password to use in case the private key is encrypted. proxy The connection settings for the bastion/proxy host. user The user that we should use for the connection.
const
Connection.fromMap(Map<String, dynamic> map)
factory

Properties

agentSocketPath → Input<String>?
SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
final
dialErrorLimit → Input<int>?
Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.
final
hashCode → int
The hash code for this object.
no setterinherited
host → Input<String>
The address of the resource to connect to.
final
hostKey → Input<String>?
The expected host key to verify the server's identity. If not provided, the host key will be ignored.
final
password → Input<String>?
The password we should use for the connection.
final
perDialTimeout → Input<int>?
Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
final
port → Input<double>?
The port to connect to. Defaults to 22.
final
privateKey → Input<String>?
The contents of an SSH key to use for the connection. This takes preference over the password if provided.
final
privateKeyPassword → Input<String>?
The password to use in case the private key is encrypted.
final
proxy → Input<ProxyConnection>?
The connection settings for the bastion/proxy host.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
user → Input<String>?
The user that we should use for the connection.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited