Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD DETAIL: FIELD | PROPERTY | CONSTR | METHOD

org.hidetake.gradle.ssh.api
[Groovy] Class Remote

java.lang.Object
  org.hidetake.gradle.ssh.api.Remote

@TupleConstructor
class Remote

Represents a remote host.

Authors:
hidetake.org

Property Summary
boolean agent

Use agent flag.

java.lang.String host

Remote host.
java.io.File identity

Identity key file for public-key authentication.
java.lang.String name

Name of this instance.
java.lang.String passphrase

Pass-phrase for the identity key.

java.lang.String password

Password.

int port

Port.
java.lang.Object roles

Roles.
java.lang.String user

Remote user.
 
Method Summary
void role(java.lang.String role)

Add a role to this remote.
java.lang.String toString()

Returns a string representation of this remote host.
 
Methods inherited from class java.lang.Object
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Property Detail

agent

boolean agent
Use agent flag. If true, Putty Agent or ssh-agent will be used to authenticate.

host

java.lang.String host
Remote host.

identity

java.io.File identity
Identity key file for public-key authentication.

name

final java.lang.String name
Name of this instance.

passphrase

java.lang.String passphrase
Pass-phrase for the identity key. This may be null.

password

java.lang.String password
Password. Leave as null if public key authentication.

port

int port
Port.

roles

final java.lang.Object roles
Roles.

user

java.lang.String user
Remote user.

 
Method Detail

role

void role(java.lang.String role)
Add a role to this remote.
Parameters:
role

toString

@Override
java.lang.String toString()
Returns a string representation of this remote host.

 

Groovy Documentation