java.lang.Object
- software.amazon.awssdk.services.iotfleetwise.model.StructuredMessage

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StructuredMessage.Builder,StructuredMessage>
```
@Generated("software.amazon.awssdk:codegen")
public final class StructuredMessage
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StructuredMessage.Builder,StructuredMessage>
```
The structured message for the message signal. It can be defined with either a primitiveMessageDefinition, structuredMessageListDefinition, or structuredMessageDefinition recursively.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StructuredMessage.Builder

static class StructuredMessage.Type

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static StructuredMessage.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`static StructuredMessage`	`fromPrimitiveMessageDefinition(Consumer<PrimitiveMessageDefinition.Builder> primitiveMessageDefinition)`	Create an instance of this class with `primitiveMessageDefinition()` initialized to the given value.
`static StructuredMessage`	`fromPrimitiveMessageDefinition(PrimitiveMessageDefinition primitiveMessageDefinition)`	Create an instance of this class with `primitiveMessageDefinition()` initialized to the given value.
`static StructuredMessage`	`fromStructuredMessageDefinition(List<StructuredMessageFieldNameAndDataTypePair> structuredMessageDefinition)`	Create an instance of this class with `structuredMessageDefinition()` initialized to the given value.
`static StructuredMessage`	`fromStructuredMessageListDefinition(Consumer<StructuredMessageListDefinition.Builder> structuredMessageListDefinition)`	Create an instance of this class with `structuredMessageListDefinition()` initialized to the given value.
`static StructuredMessage`	`fromStructuredMessageListDefinition(StructuredMessageListDefinition structuredMessageListDefinition)`	Create an instance of this class with `structuredMessageListDefinition()` initialized to the given value.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasStructuredMessageDefinition()`	For responses, this returns true if the service returned a value for the StructuredMessageDefinition property.
`PrimitiveMessageDefinition`	`primitiveMessageDefinition()`	Represents a primitive type node of the complex data structure.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StructuredMessage.Builder>`	`serializableBuilderClass()`
`List<StructuredMessageFieldNameAndDataTypePair>`	`structuredMessageDefinition()`	Represents a struct type node of the complex data structure.
`StructuredMessageListDefinition`	`structuredMessageListDefinition()`	Represents a list type node of the complex data structure.
`StructuredMessage.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`StructuredMessage.Type`	`type()`	Retrieve an enum value representing which member of this object is populated.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - primitiveMessageDefinition
```
public final PrimitiveMessageDefinition primitiveMessageDefinition()
```
    Represents a primitive type node of the complex data structure.
    
    Returns:
    
    Represents a primitive type node of the complex data structure.
  - structuredMessageListDefinition
```
public final StructuredMessageListDefinition structuredMessageListDefinition()
```
    Represents a list type node of the complex data structure.
    
    Returns:
    
    Represents a list type node of the complex data structure.
  - hasStructuredMessageDefinition
```
public final boolean hasStructuredMessageDefinition()
```
    For responses, this returns true if the service returned a value for the StructuredMessageDefinition property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - structuredMessageDefinition
```
public final List<StructuredMessageFieldNameAndDataTypePair> structuredMessageDefinition()
```
    Represents a struct type node of the complex data structure.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStructuredMessageDefinition() method.
    
    Returns:
    
    Represents a struct type node of the complex data structure.
  - toBuilder
```
public StructuredMessage.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StructuredMessage.Builder,StructuredMessage>
  - builder
```
public static StructuredMessage.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StructuredMessage.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - fromPrimitiveMessageDefinition
```
public static StructuredMessage fromPrimitiveMessageDefinition(PrimitiveMessageDefinition primitiveMessageDefinition)
```
    Create an instance of this class with primitiveMessageDefinition() initialized to the given value.
    Represents a primitive type node of the complex data structure.
    
    Parameters:
    
    primitiveMessageDefinition - Represents a primitive type node of the complex data structure.
  - fromPrimitiveMessageDefinition
```
public static StructuredMessage fromPrimitiveMessageDefinition(Consumer<PrimitiveMessageDefinition.Builder> primitiveMessageDefinition)
```
    Create an instance of this class with primitiveMessageDefinition() initialized to the given value.
    Represents a primitive type node of the complex data structure.
    
    Parameters:
    
    primitiveMessageDefinition - Represents a primitive type node of the complex data structure.
  - fromStructuredMessageListDefinition
```
public static StructuredMessage fromStructuredMessageListDefinition(StructuredMessageListDefinition structuredMessageListDefinition)
```
    Create an instance of this class with structuredMessageListDefinition() initialized to the given value.
    Represents a list type node of the complex data structure.
    
    Parameters:
    
    structuredMessageListDefinition - Represents a list type node of the complex data structure.
  - fromStructuredMessageListDefinition
```
public static StructuredMessage fromStructuredMessageListDefinition(Consumer<StructuredMessageListDefinition.Builder> structuredMessageListDefinition)
```
    Create an instance of this class with structuredMessageListDefinition() initialized to the given value.
    Represents a list type node of the complex data structure.
    
    Parameters:
    
    structuredMessageListDefinition - Represents a list type node of the complex data structure.
  - fromStructuredMessageDefinition
```
public static StructuredMessage fromStructuredMessageDefinition(List<StructuredMessageFieldNameAndDataTypePair> structuredMessageDefinition)
```
    Create an instance of this class with structuredMessageDefinition() initialized to the given value.
    Represents a struct type node of the complex data structure.
    
    Parameters:
    
    structuredMessageDefinition - Represents a struct type node of the complex data structure.
  - type
```
public StructuredMessage.Type type()
```
    Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be StructuredMessage.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be StructuredMessage.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Modifier and Type	Class	Description
`static interface`	`StructuredMessage.Builder`
`static class`	`StructuredMessage.Type`

Class StructuredMessage

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

primitiveMessageDefinition

structuredMessageListDefinition

hasStructuredMessageDefinition

structuredMessageDefinition

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

fromPrimitiveMessageDefinition

fromPrimitiveMessageDefinition

fromStructuredMessageListDefinition

fromStructuredMessageListDefinition

fromStructuredMessageDefinition

type

sdkFields