Package zowe.client.sdk.zostso.response

Class StartStopResponse

java.lang.Object

zowe.client.sdk.zostso.response.StartStopResponse

public class StartStopResponse
extends Object

The TsoStartStop API response

Version:

2.0

Author:

Frank Giordano

Field Summary

Fields

Modifier and Type	Field	Description
Optional<String>	failureResponse	If an error occurs, returns error which contains cause error.
Optional<String>	servletKey	Servlet key from ZosmfTsoResponse
boolean	success	True if the command was issued and the responses were collected.
Optional<ZosmfTsoResponse>	zosmfTsoResponse	Response from z/OSMF to start rest call

Constructor Summary

Constructors

Constructor	Description
StartStopResponse(boolean success, ZosmfTsoResponse zosmfTsoResponse, String servletKey)	StartStopResponse constructor

Method Summary

Modifier and Type	Method	Description
Optional<String>	getFailureResponse()	Retrieve failureResponse specified
Optional<String>	getServletKey()	Retrieve servletKey specified
Optional<ZosmfTsoResponse>	getZosmfTsoResponse()	Retrieve zosmfTsoResponse specified
boolean	isSuccess()	Retrieve is success
void	setFailureResponse(String failureResponse)	Assign failureResponse value
void	setSuccess(boolean success)	Assign success value
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

zosmfTsoResponse

public final Optional<ZosmfTsoResponse> zosmfTsoResponse

Response from z/OSMF to start rest call

servletKey

public final Optional<String> servletKey

Servlet key from ZosmfTsoResponse

failureResponse

public Optional<String> failureResponse

If an error occurs, returns error which contains cause error.

success

public boolean success

True if the command was issued and the responses were collected.

Constructor Detail

StartStopResponse

public StartStopResponse(boolean success,
                         ZosmfTsoResponse zosmfTsoResponse,
                         String servletKey)

StartStopResponse constructor

Parameters:

success - true or false if response seen

zosmfTsoResponse - tso response

servletKey - key value for tso address space

Method Detail

getFailureResponse

public Optional<String> getFailureResponse()

Retrieve failureResponse specified

Returns:

failureResponse value

setFailureResponse

public void setFailureResponse(String failureResponse)

Assign failureResponse value

Parameters:

failureResponse - failure response string

getServletKey

public Optional<String> getServletKey()

Retrieve servletKey specified

Returns:

servletKey value

isSuccess

public boolean isSuccess()

Retrieve is success

Returns:

boolean true or false

setSuccess

public void setSuccess(boolean success)

Assign success value

Parameters:

success - true or false is response seen

getZosmfTsoResponse

public Optional<ZosmfTsoResponse> getZosmfTsoResponse()

Retrieve zosmfTsoResponse specified

Returns:

ZosmfTsoResponse value

toString

public String toString()

Overrides:

toString in class Object