runtime-core/aws.smithy.kotlin.runtime.content/Document

Document

sealed class Document

A Document is used to store arbitrary or unstructured data.

The provided casting functions (eg. asInt, asMap) allow callers to unwrap contents of the Document at runtime.

Inheritors

Types

data class Boolean(val value: Boolean) : Document

Wraps a kotlin.Boolean.

data class List(val value: List<Document?>) : Document, List<Document?>

Wraps a kotlin.collections.List.

data class Map(val value: Map<String, Document?>) : Document, Map<String, Document?>

Wraps a kotlin.collections.Map.

data class Number(val value: Number) : Document

Wraps a kotlin.Number of arbitrary precision.

data class String(val value: String) : Document

Wraps a kotlin.String.

Functions

fun asBoolean(): Boolean

asBooleanOrNull

fun asBooleanOrNull(): Boolean?

fun asByte(): Byte

fun asByteOrNull(): Byte?

fun asDouble(): Double

fun asDoubleOrNull(): Double?

fun asFloat(): Float

fun asFloatOrNull(): Float?

fun asInt(): Int

fun asIntOrNull(): Int?

fun asList(): List<Document?>

fun asListOrNull(): List<Document?>?

fun asLong(): Long

fun asLongOrNull(): Long?

fun asMap(): Map<String, Document?>

fun asMapOrNull(): Map<String, Document?>?

fun asShort(): Short

fun asShortOrNull(): Short?

fun asString(): String

fun asStringOrNull(): String?