zosmf-retrofit2/eu.ibagroup.r2z.zowe.client.sdk.zosconsole/ConsoleResponse

ConsoleResponse

data class ConsoleResponse(val success: Boolean? = false, val zosmfResponse: IssueResponse? = null, val failureResponse: String? = null, var commandResponse: String? = null, val lastResponseKey: String? = null, val keywordDetected: Boolean? = false, val cmdResponseUrl: String? = null)

The Console API response.

Constructors

ConsoleResponse

fun ConsoleResponse(success: Boolean? = false, zosmfResponse: IssueResponse? = null, failureResponse: String? = null, commandResponse: String? = null, lastResponseKey: String? = null, keywordDetected: Boolean? = false, cmdResponseUrl: String? = null)

Properties

cmdResponseUrl

val cmdResponseUrl: String? = null

The "follow-up" command response URL - you can paste this in the browser to do a "GET" using the command response key provided in the URI route.

commandResponse

var commandResponse: String? = null

The command response text.

failureResponse

val failureResponse: String? = null

If an error occurs, returns the ImperativeError, which contains case error.

keywordDetected

val keywordDetected: Boolean? = false

If the solicited keyword is specified, indicates that the keyword was detected.

lastResponseKey

val lastResponseKey: String? = null

The final command response key - used to "follow-up" and check for additional response messages for the command.

success

val success: Boolean? = false

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

zosmfResponse

val zosmfResponse: IssueResponse? = null

The list of zOSMF console API responses. May issue multiple requests (because of user request) or to ensure that all messages are collected. Each individual response is placed here.