Package zowe.client.sdk.zosconsole.response

Class ConsoleCmdResponse

java.lang.Object

zowe.client.sdk.zosconsole.response.ConsoleCmdResponse

public class ConsoleCmdResponse
extends Object

z/OSMF synchronous console command response messages. See the z/OSMF REST API publication for complete details.

Version:

5.0

Author:

Frank Giordano

Constructor Summary

Constructors

Constructor	Description
ConsoleCmdResponse(String cmdResponseKey, String cmdResponseUrl, String cmdResponseUri, String cmdResponse, String solKeyDetected)	ConsoleCmdResponse constructor for JSON deserialization

Method Summary

Modifier and Type	Method	Description
String	getCmdResponse()	Retrieve cmdResponse value
String	getCmdResponseKey()	Retrieve cmdResponseKey value
String	getCmdResponseUri()	Retrieve cmdResponseUri value
String	getCmdResponseUrl()	Retrieve cmdResponseUrl value
String	getSolKeyDetected()	Retrieve solKeyDetected value
String	toString()	Return string value representing IssueCommandResponse object
ConsoleCmdResponse	withCmdResponse(String newCmdResponse)	Create a new ConsoleCmdResponse with a different cmdResponse value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConsoleCmdResponse

public ConsoleCmdResponse(String cmdResponseKey,
                          String cmdResponseUrl,
                          String cmdResponseUri,
                          String cmdResponse,
                          String solKeyDetected)

ConsoleCmdResponse constructor for JSON deserialization

Parameters:

cmdResponseKey - Key that can be used to retrieve the command response

cmdResponseUrl - URL that can be used to retrieve the command response later

cmdResponseUri - URI that can be used to retrieve the command response later

cmdResponse - Command response text

solKeyDetected - Indicates if the keyword was detected in the command response

Method Detail

getCmdResponseKey

public String getCmdResponseKey()

Retrieve cmdResponseKey value

Returns:

cmdResponseKey value

getCmdResponseUrl

public String getCmdResponseUrl()

Retrieve cmdResponseUrl value

Returns:

cmdResponseUrl value

getCmdResponseUri

public String getCmdResponseUri()

Retrieve cmdResponseUri value

Returns:

cmdResponseUri value

getCmdResponse

public String getCmdResponse()

Retrieve cmdResponse value

Returns:

cmdResponse value

getSolKeyDetected

public String getSolKeyDetected()

Retrieve solKeyDetected value

Returns:

solKeyDetected value

withCmdResponse

public ConsoleCmdResponse withCmdResponse(String newCmdResponse)

Create a new ConsoleCmdResponse with a different cmdResponse value

Parameters:

newCmdResponse - the new command response value

Returns:

a new ConsoleCmdResponse instance with the updated cmdResponse

toString

public String toString()

Return string value representing IssueCommandResponse object

Overrides:

toString in class Object

Returns:

string representation of IssueCommandResponse