Class: Net::SSH::Simple::Result

Inherits:
Hashie::Dash
  • Object
show all
Defined in:
lib/net/ssh/simple.rb

Overview

Result of a Net::SSH::Simple operation.

Instance Attribute Summary collapse

Instance Attribute Details

#cmd ⇒ String

Shell command (ssh) or :upload/:download (scp)

Returns:

  • (String) —

    the current value of cmd



730
731
732
 
# File 'lib/net/ssh/simple.rb', line 730

def cmd
  @cmd
end

#exception ⇒ Exception

Exception that occurred during this operation (if any)

Returns:

  • (Exception) —

    the current value of exception



730
731
732
 
# File 'lib/net/ssh/simple.rb', line 730

def exception
  @exception
end

#exit_code ⇒ String

UNIX exit code (SSH only)

Returns:

  • (String) —

    the current value of exit_code



730
731
732
 
# File 'lib/net/ssh/simple.rb', line 730

def exit_code
  @exit_code
end

#exit_signal ⇒ String

Only present if the remote command terminated due to a signal (SSH only)

Returns:

  • (String) —

    the current value of exit_signal



730
731
732
 
# File 'lib/net/ssh/simple.rb', line 730

def exit_signal
  @exit_signal
end

#finish_at ⇒ Time

Timestamp of operation finish

Returns:

  • (Time) —

    the current value of finish_at



730
731
732
 
# File 'lib/net/ssh/simple.rb', line 730

def finish_at
  @finish_at
end

#host ⇒ String

Hostname/IP address

Returns:

  • (String) —

    the current value of host



730
731
732
 
# File 'lib/net/ssh/simple.rb', line 730

def host
  @host
end

#last_event_at ⇒ Time

Timestamp of last activity

Returns:

  • (Time) —

    the current value of last_event_at



730
731
732
 
# File 'lib/net/ssh/simple.rb', line 730

def last_event_at
  @last_event_at
end

#last_keepalive_at ⇒ Time

Timestamp of last keepalive (if any)

Returns:

  • (Time) —

    the current value of last_keepalive_at



730
731
732
 
# File 'lib/net/ssh/simple.rb', line 730

def last_keepalive_at
  @last_keepalive_at
end

#op ⇒ Symbol

:ssh or :scp

Returns:

  • (Symbol) —

    the current value of op



730
731
732
 
# File 'lib/net/ssh/simple.rb', line 730

def op
  @op
end

#opts ⇒ Hash

The options that the operation was parametrized with

Returns:

  • (Hash) —

    the current value of opts



730
731
732
 
# File 'lib/net/ssh/simple.rb', line 730

def opts
  @opts
end

#sent ⇒ Integer

Number of bytes transferred (SCP only)

Returns:

  • (Integer) —

    the current value of sent



730
731
732
 
# File 'lib/net/ssh/simple.rb', line 730

def sent
  @sent
end

#start_at ⇒ Time

Timestamp of operation start

Returns:

  • (Time) —

    the current value of start_at



730
731
732
 
# File 'lib/net/ssh/simple.rb', line 730

def start_at
  @start_at
end

#stderr ⇒ String

Output captured on stderr (SSH only)

Returns:

  • (String) —

    the current value of stderr



730
731
732
 
# File 'lib/net/ssh/simple.rb', line 730

def stderr
  @stderr
end

#stdout ⇒ String

Output captured on stdout (SSH only)

Returns:

  • (String) —

    the current value of stdout



730
731
732
 
# File 'lib/net/ssh/simple.rb', line 730

def stdout
  @stdout
end

#success ⇒ boolean

Indicates whether the transport-connection was successful

Returns:

  • (boolean) —

    the current value of success



730
731
732
 
# File 'lib/net/ssh/simple.rb', line 730

def success
  @success
end

#timed_out ⇒ Boolean

True if the operation timed out

Returns:

  • (Boolean) —

    the current value of timed_out



730
731
732
 
# File 'lib/net/ssh/simple.rb', line 730

def timed_out
  @timed_out
end

#total ⇒ Integer

Size of requested file (in bytes, SCP only)

Returns:

  • (Integer) —

    the current value of total



730
731
732
 
# File 'lib/net/ssh/simple.rb', line 730

def total
  @total
end