connect/aws.sdk.kotlin.services.connect.model/ReferenceSummary

ReferenceSummary

Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.

Inheritors

Types

Attachment

data class Attachment(val value: AttachmentReference) : ReferenceSummary

Information about the reference when the referenceType is ATTACHMENT. Otherwise, null.

Date

data class Date(val value: DateReference) : ReferenceSummary

Information about a reference when the referenceType is DATE. Otherwise, null.

data class Email(val value: EmailReference) : ReferenceSummary

Information about a reference when the referenceType is EMAIL. Otherwise, null.

Number

data class Number(val value: NumberReference) : ReferenceSummary

Information about a reference when the referenceType is NUMBER. Otherwise, null.

SdkUnknown

object SdkUnknown : ReferenceSummary

String

data class String(val value: StringReference) : ReferenceSummary

Information about a reference when the referenceType is STRING. Otherwise, null.

Url

data class Url(val value: UrlReference) : ReferenceSummary

Information about the reference when the referenceType is URL. Otherwise, null.

Functions

asAttachment

fun asAttachment(): AttachmentReference

Casts this ReferenceSummary as a Attachment and retrieves its aws.sdk.kotlin.services.connect.model.AttachmentReference value. Throws an exception if the ReferenceSummary is not a Attachment.

asAttachmentOrNull

fun asAttachmentOrNull(): AttachmentReference?

Casts this ReferenceSummary as a Attachment and retrieves its aws.sdk.kotlin.services.connect.model.AttachmentReference value. Returns null if the ReferenceSummary is not a Attachment.

asDate

fun asDate(): DateReference

Casts this ReferenceSummary as a Date and retrieves its aws.sdk.kotlin.services.connect.model.DateReference value. Throws an exception if the ReferenceSummary is not a Date.

asDateOrNull

fun asDateOrNull(): DateReference?

Casts this ReferenceSummary as a Date and retrieves its aws.sdk.kotlin.services.connect.model.DateReference value. Returns null if the ReferenceSummary is not a Date.

asEmail

fun asEmail(): EmailReference

Casts this ReferenceSummary as a Email and retrieves its aws.sdk.kotlin.services.connect.model.EmailReference value. Throws an exception if the ReferenceSummary is not a Email.

asEmailOrNull

fun asEmailOrNull(): EmailReference?

Casts this ReferenceSummary as a Email and retrieves its aws.sdk.kotlin.services.connect.model.EmailReference value. Returns null if the ReferenceSummary is not a Email.

asNumber

fun asNumber(): NumberReference

Casts this ReferenceSummary as a Number and retrieves its aws.sdk.kotlin.services.connect.model.NumberReference value. Throws an exception if the ReferenceSummary is not a Number.

asNumberOrNull

fun asNumberOrNull(): NumberReference?

Casts this ReferenceSummary as a Number and retrieves its aws.sdk.kotlin.services.connect.model.NumberReference value. Returns null if the ReferenceSummary is not a Number.

asString

fun asString(): StringReference

Casts this ReferenceSummary as a String and retrieves its aws.sdk.kotlin.services.connect.model.StringReference value. Throws an exception if the ReferenceSummary is not a String.

asStringOrNull

fun asStringOrNull(): StringReference?

Casts this ReferenceSummary as a String and retrieves its aws.sdk.kotlin.services.connect.model.StringReference value. Returns null if the ReferenceSummary is not a String.

asUrl

fun asUrl(): UrlReference

Casts this ReferenceSummary as a Url and retrieves its aws.sdk.kotlin.services.connect.model.UrlReference value. Throws an exception if the ReferenceSummary is not a Url.

asUrlOrNull

fun asUrlOrNull(): UrlReference?

Casts this ReferenceSummary as a Url and retrieves its aws.sdk.kotlin.services.connect.model.UrlReference value. Returns null if the ReferenceSummary is not a Url.