Package-level declarations

Types

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class BytesConverterFactory : Converter.Factory
Link copied to clipboard
data class CancelJobPurgeOutRequest(    var jobid: String? = null,     var jobname: String? = null,     var originalJobid: String? = null,     var owner: String? = null,     var member: String? = null,     var sysname: String? = null,     var jobCorrelator: String? = null,     var status: String? = null)
Link copied to clipboard
data class CancelJobRequest(    var jobid: String? = null,     var jobname: String? = null,     var originalJobid: String? = null,     var owner: String? = null,     var member: String? = null,     var sysname: String? = null,     var jobCorrelator: String? = null,     var status: String? = null)
Link copied to clipboard
data class CancelJobRequestBody(    var requestType: RequestTypes = RequestTypes.CANCEL,     var requestVersion: RequestVersion = RequestVersion.SYNCHRONOUS)
Link copied to clipboard
data class ChangeMode(request: String = "chmod", var mode: FileMode, var links: Links? = null, var recursive: Boolean? = null)
Link copied to clipboard
data class ChangeOwner(request: String = "chown", var owner: String, var group: String?, var links: Links? = null, var recursive: Boolean? = null)
Link copied to clipboard
data class ChangeTag(    request: String = "chtag",     var action: TagAction,     var type: UssFileDataType? = null,     var links: Links? = null,     var codeSet: String? = null,     var recursive: Boolean? = null)
Link copied to clipboard
Link copied to clipboard
interface ConsoleAPI
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class CreateDataset(    var volumeSerial: String? = null,     var deviceType: String? = null,     var datasetOrganization: DatasetOrganization,     var allocationUnit: AllocationUnit? = null,     var primaryAllocation: Int,     var secondaryAllocation: Int,     var directoryBlocks: Int? = null,     var recordFormat: RecordFormat,     var blockSize: Int? = null,     var recordLength: Int? = null,     var storageClass: String? = null,     var managementClass: String? = null,     var dataClass: String? = null,     var averageBlockLength: Int? = null,     var dsnType: DsnameType? = null,     var datasetModel: String? = null)
Link copied to clipboard
data class CreateUssFile(var type: FileType, var mode: FileMode)
Link copied to clipboard
interface DataAPI
Link copied to clipboard
data class Dataset(    val name: String = "",     blksz: String? = null,     val catalogName: String? = null,     val creationDate: String? = null,     val deviceType: String? = null,     val dsnameType: DsnameType? = null,     val datasetOrganization: DatasetOrganization? = null,     val expirationDate: String? = null,     extx: String? = null,     lrecl: String? = null,     val migrated: HasMigrated? = null,     val multiVolume: MultipleVolumes? = null,     val spaceOverflowIndicator: String? = null,     val lastReferenceDate: String? = null,     val recordFormat: RecordFormat? = null,     val sizeInTracks: Int? = null,     val spaceUnits: SpaceUnits? = null,     used: String? = null,     val volumeSerial: String? = null,     val volumeSerials: String? = null)
Link copied to clipboard
data class DataSetsList(    val items: List<Dataset> = emptyList(),     val returnedRows: Int = 0,     val totalRows: Int? = null,     val moreRows: Boolean? = null,     val jsonVersion: Int = 0)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class FileMode(var owner: Int, var group: Int = 0, var all: Int = 0, var prefix: String = "")
Link copied to clipboard
class FileModeToStringAdapter : TypeAdapter<FileMode>
Link copied to clipboard
Link copied to clipboard
data class FilePath(path: String)
Link copied to clipboard
data class FileTagList(var stdout: List<String>)
Link copied to clipboard
Link copied to clipboard
interface HasBooleanValue
Link copied to clipboard
Link copied to clipboard
data class HDelete(request: String = "hdelete", var wait: Boolean? = null, var purge: Boolean? = null)
Link copied to clipboard
data class HMigrate(request: String = "hmigrate", var wait: Boolean? = null)
Link copied to clipboard
data class HoldJobRequest(    var jobid: String? = null,     var jobname: String? = null,     var originalJobid: String? = null,     var owner: String? = null,     var member: String? = null,     var sysname: String? = null,     var jobCorrelator: String? = null,     var status: Int? = null)
Link copied to clipboard
data class HoldJobRequestBody(    var requestType: RequestTypes = RequestTypes.HOLD,     var requestVersion: RequestVersion = RequestVersion.SYNCHRONOUS)
Link copied to clipboard
data class HRecall(request: String = "hrecall", var wait: Boolean? = null)
Link copied to clipboard
interface InfoAPI
Link copied to clipboard
data class InfoResponse(    val zosVersion: String = "null",     val zosmfPort: String = "null",     val zosmfVersion: String = "null",     val zosmfHostname: String = "null",     val plugins: List<Plugin> = emptyList(),     val zosmfSafRealm: String = "null",     val zosmfFullVersion: String = "null",     val apiVersion: String = "null")
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class IssueRequestBody(val cmd: String, val solKey: String? = null, val system: String? = null, val async: String? = null)

The z/OSMF console API parameters. See the z/OSMF REST API documentation for full details.

Link copied to clipboard
data class IssueResponse(    val cmdResponseUrl: String? = null,     val cmdResponse: String? = null,     val cmdResponseUri: String? = null,     val cmdResponseKey: String? = null,     val solKeyDetected: String? = null)

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

Link copied to clipboard
interface JESApi
Link copied to clipboard
data class Job(    val jobId: String,     val jobName: String,     val subSystem: String? = null,     val owner: String,     val status: Job.Status? = null,     val type: Job.JobType,     val jobClass: String? = null,     val returnedCode: String? = null,     val url: String,     val filesUrl: String,     val jobCorrelator: String? = null,     val phase: Int,     val phaseName: String,     val steps: List<StepData> = emptyList(),     val reasonNotRunning: String? = null,     val execSystem: String? = null,     val execMember: String? = null,     val execSubmitted: String? = null,     val execStarted: String? = null,     val execEnded: String? = null)
Link copied to clipboard
enum Links : Enum<Links>
Link copied to clipboard
data class Member(    val name: String = "",     val versionNumber: Int? = null,     val modificationLevel: Int? = null,     val creationDate: String? = null,     val modificationDate: String? = null,     val currentNumberOfRecords: Int? = null,     val beginningNumberOfRecords: Int? = null,     val numberOfChangedRecords: Int? = null,     val lastChangeTime: String? = null,     val secondsOfLastChangeTime: String? = null,     val user: String? = null,     val sclm: String? = null,     val authorizationCode: String? = null,     val aliasOf: String? = null,     val amode: String? = null,     val loadModuleAttributes: String? = null,     val rmode: String? = null,     val size: String? = null,     val ttr: String? = null,     val ssi: String? = null)
Link copied to clipboard
data class MembersList(    val items: List<Member> = emptyList(),     val returnedRows: Int = 0,     val totalRows: Int? = null,     val moreRows: Boolean? = null,     val jsonVersion: Int = 0)
Link copied to clipboard
data class MessageData(var messageText: String? = null, var messageId: String? = null)
Link copied to clipboard
data class MessageType(var version: String, var data: String? = null, var hidden: String? = null, var action: String? = null)
Link copied to clipboard
Link copied to clipboard
data class MoveUssFile(var request: String = "move", var from: String, var overwrite: Boolean? = null)
Link copied to clipboard
data class Plugin(val version: String? = null, val defaultName: String? = null, val status: String? = null)
Link copied to clipboard
class PluginsAdapter : TypeAdapter<List<Plugin>>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class ReleaseJobRequest(    var jobid: String? = null,     var jobname: String? = null,     var originalJobid: String? = null,     var owner: String? = null,     var member: String? = null,     var sysname: String? = null,     var jobCorrelator: String? = null,     var status: Int? = null)
Link copied to clipboard
data class ReleaseJobRequestBody(    var requestType: RequestTypes = RequestTypes.RELEASE,     var requestVersion: RequestVersion = RequestVersion.SYNCHRONOUS)
Link copied to clipboard
data class RenameData(var request: String = "rename", var fromDataset: RenameData.FromDataset, var enq: RenameData.Enq? = null)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class SpoolFile(    val jobname: String,     val recfm: String,     val byteCount: Int,     val recordCount: Int,     val jobCorrelator: String? = null,     val fileClass: String,     val jobId: String,     val id: Int,     val ddName: String,     val recordsUrl: String,     val recordLength: Int,     val subsystem: String? = null,     val stepName: String? = null,     val procStep: String? = null)
Link copied to clipboard
data class StepData(    val smfId: String? = null,     val completion: String? = null,     val stepNumber: Int,     val programName: String,     val endTime: String? = null,     val isActive: Boolean,     val stepName: String,     val procedureStepName: String,     val startedTime: String? = null,     val owner: String? = null,     val ussPathName: String? = null)
Link copied to clipboard
data class SubmitFileNameBody(var file: String)
Link copied to clipboard
data class SubmitJobRequest(    var jobid: String? = null,     var jobname: String? = null,     var subsystem: String? = null,     var owner: String? = null,     var status: SubmitJobRequest.Status? = null,     var type: String? = null,     var class_: String? = null,     var retcode: String? = null,     var url: String? = null,     var filesUrl: String? = null)
Link copied to clipboard
Link copied to clipboard
interface SystemsApi
Link copied to clipboard
data class SystemsResponse(val items: List<SystemZOSInfo> = emptyList(), val numRows: Int)

A data class which represents a systems response from z/OSMF instance

Link copied to clipboard
data class SystemZOSInfo(    val systemNickName: String = "null",     val systemName: String = "null",     val sysplexName: String = "null",     val groupNames: String = "null",     val url: String = "null",     val zosVR: String = "null",     val jesMemberName: String = "null",     val jesType: String = "null",     val cpcName: String = "null",     val cpcSerial: String = "null",     val httpProxyName: String = "null",     val ftpDestinationName: String = "null")

A data class which represents a single SystemZOSInfo instance defined to z/OSMF

Link copied to clipboard
Link copied to clipboard
class ToStringAdapter : TypeAdapter<Any>

For this project only

Link copied to clipboard
Link copied to clipboard
interface TsoApi
Link copied to clipboard
Link copied to clipboard
data class TsoData(var tsoMessage: MessageType? = null, var tsoPrompt: MessageType? = null, var tsoResponse: MessageType? = null)
Link copied to clipboard
data class TsoResponse(    var servletKey: String? = null,     var ver: Int? = null,     var queueId: String? = null,     var remoteSys: String? = null,     var tsoData: List<TsoData> = emptyList(),     var appData: String? = null,     var timeout: Boolean? = null,     var reused: Boolean? = null,     var msgData: List<MessageData> = emptyList(),     var messages: String? = null)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class UssFile(    val name: String = "",     val mode: String? = null,     val size: Long? = null,     val uid: Long? = null,     val user: String? = null,     val gid: Long? = null,     val groupId: String? = null,     val modificationTime: String? = null,     val target: String? = null)
Link copied to clipboard
Link copied to clipboard
data class UssFilesList(    val items: List<UssFile> = emptyList(),     val returnedRows: Int = 0,     val totalRows: Int? = null,     val moreRows: Boolean? = null,     val jsonVersion: Int = 0)
Link copied to clipboard
data class XIBMAttr(type: XIBMAttr.Type = Type.BASE, isTotal: Boolean = false)
Link copied to clipboard
Link copied to clipboard
data class XIBMDataType(val type: XIBMDataType.Type, val encoding: CodePage? = null)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class XIBMRecordRange(format: XIBMRecordRange.Format, sss: Int, nnn: Int)

Functions

Link copied to clipboard
inline fun <API> buildApi(baseUrl: String, httpClient: OkHttpClient): API
fun <API> buildApi(baseUrl: String, httpClient: OkHttpClient, apiClass: Class<out API>): API
Link copied to clipboard
inline fun <Api> buildApiWithBytesConverter(baseUrl: String, httpClient: OkHttpClient): Api
fun <API> buildApiWithBytesConverter(baseUrl: String, httpClient: OkHttpClient, apiClass: Class<out API>): API
Link copied to clipboard
fun digitToString(digit: Int): String
Link copied to clipboard
fun stringToDigit(modeString: CharSequence): Int
Link copied to clipboard

Properties

Link copied to clipboard
Link copied to clipboard
val gson: Gson