qbusiness/aws.sdk.kotlin.services.qbusiness.model/DocumentAttributeValue

DocumentAttributeValue

sealed class DocumentAttributeValue

The value of a document attribute. You can only provide one value for a document attribute.

Inheritors

StringListValue

Types

data class DateValue(val value: Instant) : DocumentAttributeValue

A date expressed as an ISO 8601 string.

data class LongValue(val value: Long) : DocumentAttributeValue

A long integer value.

object SdkUnknown : DocumentAttributeValue

StringListValue

data class StringListValue(val value: List<String>) : DocumentAttributeValue

A list of strings.

data class StringValue(val value: String) : DocumentAttributeValue

A string.

Functions

fun asDateValue(): Instant

Casts this DocumentAttributeValue as a DateValue and retrieves its aws.smithy.kotlin.runtime.time.Instant value. Throws an exception if the DocumentAttributeValue is not a DateValue.

asDateValueOrNull

fun asDateValueOrNull(): Instant?

Casts this DocumentAttributeValue as a DateValue and retrieves its aws.smithy.kotlin.runtime.time.Instant value. Returns null if the DocumentAttributeValue is not a DateValue.

fun asLongValue(): Long

Casts this DocumentAttributeValue as a LongValue and retrieves its kotlin.Long value. Throws an exception if the DocumentAttributeValue is not a LongValue.

asLongValueOrNull

fun asLongValueOrNull(): Long?

Casts this DocumentAttributeValue as a LongValue and retrieves its kotlin.Long value. Returns null if the DocumentAttributeValue is not a LongValue.

asStringListValue

fun asStringListValue(): List<String>

Casts this DocumentAttributeValue as a StringListValue and retrieves its List value. Throws an exception if the DocumentAttributeValue is not a StringListValue.

asStringListValueOrNull

fun asStringListValueOrNull(): List<String>?

Casts this DocumentAttributeValue as a StringListValue and retrieves its List value. Returns null if the DocumentAttributeValue is not a StringListValue.

fun asStringValue(): String

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

asStringValueOrNull

fun asStringValueOrNull(): String?

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