iotfleetwise/aws.sdk.kotlin.services.iotfleetwise.model/StructuredMessage

StructuredMessage

The structured message for the message signal. It can be defined with either a primitiveMessageDefinition, structuredMessageListDefinition, or structuredMessageDefinition recursively.

Inheritors

PrimitiveMessageDefinition

StructuredMessageDefinition

StructuredMessageListDefinition

SdkUnknown

Types

PrimitiveMessageDefinition

data class PrimitiveMessageDefinition(val value: PrimitiveMessageDefinition) : StructuredMessage

Represents a primitive type node of the complex data structure.

SdkUnknown

object SdkUnknown : StructuredMessage

StructuredMessageDefinition

data class StructuredMessageDefinition(val value: List<StructuredMessageFieldNameAndDataTypePair>) : StructuredMessage

Represents a struct type node of the complex data structure.

StructuredMessageListDefinition

data class StructuredMessageListDefinition(val value: StructuredMessageListDefinition) : StructuredMessage

Represents a list type node of the complex data structure.

Functions

asPrimitiveMessageDefinition

fun asPrimitiveMessageDefinition(): PrimitiveMessageDefinition

Casts this StructuredMessage as a PrimitiveMessageDefinition and retrieves its aws.sdk.kotlin.services.iotfleetwise.model.PrimitiveMessageDefinition value. Throws an exception if the StructuredMessage is not a PrimitiveMessageDefinition.

asPrimitiveMessageDefinitionOrNull

fun asPrimitiveMessageDefinitionOrNull(): PrimitiveMessageDefinition?

Casts this StructuredMessage as a PrimitiveMessageDefinition and retrieves its aws.sdk.kotlin.services.iotfleetwise.model.PrimitiveMessageDefinition value. Returns null if the StructuredMessage is not a PrimitiveMessageDefinition.

asStructuredMessageDefinition

fun asStructuredMessageDefinition(): List<StructuredMessageFieldNameAndDataTypePair>

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

asStructuredMessageDefinitionOrNull

fun asStructuredMessageDefinitionOrNull(): List<StructuredMessageFieldNameAndDataTypePair>?

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

asStructuredMessageListDefinition

fun asStructuredMessageListDefinition(): StructuredMessageListDefinition

Casts this StructuredMessage as a StructuredMessageListDefinition and retrieves its aws.sdk.kotlin.services.iotfleetwise.model.StructuredMessageListDefinition value. Throws an exception if the StructuredMessage is not a StructuredMessageListDefinition.

asStructuredMessageListDefinitionOrNull

fun asStructuredMessageListDefinitionOrNull(): StructuredMessageListDefinition?

Casts this StructuredMessage as a StructuredMessageListDefinition and retrieves its aws.sdk.kotlin.services.iotfleetwise.model.StructuredMessageListDefinition value. Returns null if the StructuredMessage is not a StructuredMessageListDefinition.