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

DateValue

data class DateValue(val value: Instant) : DocumentAttributeValue

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

Constructors

DateValue

constructor(value: Instant)

Properties

value

val value: Instant

Inherited functions

asDateValue

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.

asLongValue

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.

asStringValue

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.