deadline/aws.sdk.kotlin.services.deadline.model/JobParameter

JobParameter

sealed class JobParameter

The details of job parameters.

Inheritors

Types

data class Bool(val value: String) : JobParameter

A boolean value represented as a string. Accepted values are true, false, yes, no, on, off, 1, and 0, case-insensitive.

data class BoolList(val value: List<String>) : JobParameter

A list of boolean values, each represented as a string.

data class Float(val value: String) : JobParameter

A double precision IEEE-754 floating point number represented as a string.

data class FloatList(val value: List<String>) : JobParameter

A list of double precision IEEE-754 floating point numbers, each represented as a string.

data class Int(val value: String) : JobParameter

A signed integer represented as a string.

data class IntList(val value: List<String>) : JobParameter

A list of signed integers, each represented as a string.

data class IntListList(val value: List<List<String>>) : JobParameter

A list of lists of signed integers, each represented as a string.

data class Path(val value: String) : JobParameter

A file system path represented as a string.

data class PathList(val value: List<String>) : JobParameter

A list of file system paths, each represented as a string.

data class RangeExpr(val value: String) : JobParameter

An Open Job Description range expression represented as a string, such as 1-10:2.

object SdkUnknown : JobParameter

data class String(val value: String) : JobParameter

A UTF-8 string.

data class StringList(val value: List<String>) : JobParameter

A list of UTF-8 strings.

Functions

fun asBool(): String

Casts this JobParameter as a Bool and retrieves its kotlin.String value. Throws an exception if the JobParameter is not a Bool.

fun asBoolList(): List<String>

Casts this JobParameter as a BoolList and retrieves its kotlin.collections.List value. Throws an exception if the JobParameter is not a BoolList.

asBoolListOrNull

fun asBoolListOrNull(): List<String>?

Casts this JobParameter as a BoolList and retrieves its kotlin.collections.List value. Returns null if the JobParameter is not a BoolList.

fun asBoolOrNull(): String?

Casts this JobParameter as a Bool and retrieves its kotlin.String value. Returns null if the JobParameter is not a Bool.

fun asFloat(): String

Casts this JobParameter as a Float and retrieves its kotlin.String value. Throws an exception if the JobParameter is not a Float.

fun asFloatList(): List<String>

Casts this JobParameter as a FloatList and retrieves its kotlin.collections.List value. Throws an exception if the JobParameter is not a FloatList.

asFloatListOrNull

fun asFloatListOrNull(): List<String>?

Casts this JobParameter as a FloatList and retrieves its kotlin.collections.List value. Returns null if the JobParameter is not a FloatList.

fun asFloatOrNull(): String?

Casts this JobParameter as a Float and retrieves its kotlin.String value. Returns null if the JobParameter is not a Float.

fun asInt(): String

Casts this JobParameter as a Int and retrieves its kotlin.String value. Throws an exception if the JobParameter is not a Int.

fun asIntList(): List<String>

Casts this JobParameter as a IntList and retrieves its kotlin.collections.List value. Throws an exception if the JobParameter is not a IntList.

fun asIntListList(): List<List<String>>

Casts this JobParameter as a IntListList and retrieves its kotlin.collections.List> value. Throws an exception if the JobParameter is not a IntListList.

asIntListListOrNull

fun asIntListListOrNull(): List<List<String>>?

Casts this JobParameter as a IntListList and retrieves its kotlin.collections.List> value. Returns null if the JobParameter is not a IntListList.

asIntListOrNull

fun asIntListOrNull(): List<String>?

Casts this JobParameter as a IntList and retrieves its kotlin.collections.List value. Returns null if the JobParameter is not a IntList.

fun asIntOrNull(): String?

Casts this JobParameter as a Int and retrieves its kotlin.String value. Returns null if the JobParameter is not a Int.

fun asPath(): String

Casts this JobParameter as a Path and retrieves its kotlin.String value. Throws an exception if the JobParameter is not a Path.

fun asPathList(): List<String>

Casts this JobParameter as a PathList and retrieves its kotlin.collections.List value. Throws an exception if the JobParameter is not a PathList.

asPathListOrNull

fun asPathListOrNull(): List<String>?

Casts this JobParameter as a PathList and retrieves its kotlin.collections.List value. Returns null if the JobParameter is not a PathList.

fun asPathOrNull(): String?

Casts this JobParameter as a Path and retrieves its kotlin.String value. Returns null if the JobParameter is not a Path.

fun asRangeExpr(): String

Casts this JobParameter as a RangeExpr and retrieves its kotlin.String value. Throws an exception if the JobParameter is not a RangeExpr.

asRangeExprOrNull

fun asRangeExprOrNull(): String?

Casts this JobParameter as a RangeExpr and retrieves its kotlin.String value. Returns null if the JobParameter is not a RangeExpr.

fun asString(): String

Casts this JobParameter as a String and retrieves its kotlin.String value. Throws an exception if the JobParameter is not a String.

fun asStringList(): List<String>

Casts this JobParameter as a StringList and retrieves its kotlin.collections.List value. Throws an exception if the JobParameter is not a StringList.

asStringListOrNull

fun asStringListOrNull(): List<String>?

Casts this JobParameter as a StringList and retrieves its kotlin.collections.List value. Returns null if the JobParameter is not a StringList.

fun asStringOrNull(): String?

Casts this JobParameter as a String and retrieves its kotlin.String value. Returns null if the JobParameter is not a String.