Record Class SshCommandResult

java.lang.Object

java.lang.Record

com.shaft.cli.SshCommandResult

Record Components:

command - the exact command text that was executed

stdout - standard output captured from the remote command

stderr - standard error captured from the remote command

exitCode - remote process exit code

durationMillis - elapsed execution time in milliseconds

public record SshCommandResult(String command, String stdout, String stderr, int exitCode, long durationMillis)
extends Record

Structured result of a remote SSH command executed through TerminalActions.

Constructor Summary

Constructors

Constructor	Description
SshCommandResult(String command, String stdout, String stderr, int exitCode, long durationMillis)	Creates an immutable SSH command result with non-null stream values.

Method Summary

Modifier and Type	Method	Description
String	combinedOutput()
String	command()	Returns the value of the command record component.
long	durationMillis()	Returns the value of the durationMillis record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	exitCode()	Returns the value of the exitCode record component.
final int	hashCode()	Returns a hash code value for this object.
String	stderr()	Returns the value of the stderr record component.
String	stdout()	Returns the value of the stdout record component.
boolean	succeeded()
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SshCommandResult

public SshCommandResult(String command,
 String stdout,
 String stderr,
 int exitCode,
 long durationMillis)

Creates an immutable SSH command result with non-null stream values.

Method Details

succeeded

public boolean succeeded()

Returns:

true when the remote command exited with code 0

combinedOutput

public String combinedOutput()

Returns:

stdout and stderr merged in execution order for callers that expect one combined log

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

command

public String command()

Returns the value of the command record component.

Returns:

the value of the command record component

stdout

public String stdout()

Returns the value of the stdout record component.

Returns:

the value of the stdout record component

stderr

public String stderr()

Returns the value of the stderr record component.

Returns:

the value of the stderr record component

exitCode

public int exitCode()

Returns the value of the exitCode record component.

Returns:

the value of the exitCode record component

durationMillis

public long durationMillis()

Returns the value of the durationMillis record component.

Returns:

the value of the durationMillis record component