java.lang.Object
- software.amazon.awssdk.services.notifications.model.MessageComponents

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<MessageComponents.Builder,MessageComponents>

@Generated("software.amazon.awssdk:codegen")
public final class MessageComponents
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MessageComponents.Builder,MessageComponents>

Describes the components of a notification message.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface MessageComponents.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static MessageComponents.Builder`	`builder()`
`String`	`completeDescription()`	A complete summary with all possible relevant information.
`List<Dimension>`	`dimensions()`	A list of properties in key-value pairs.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDimensions()`	For responses, this returns true if the service returned a value for the Dimensions property.
`int`	`hashCode()`
`String`	`headline()`	A sentence long summary.
`String`	`paragraphSummary()`	A paragraph long or multiple sentence summary.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends MessageComponents.Builder>`	`serializableBuilderClass()`
`MessageComponents.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - headline
```
public final String headline()
```
    A sentence long summary. For example, titles or an email subject line.
    
    Returns:
    
    A sentence long summary. For example, titles or an email subject line.
  - paragraphSummary
```
public final String paragraphSummary()
```
    A paragraph long or multiple sentence summary. For example, Chatbot notifications.
    
    Returns:
    
    A paragraph long or multiple sentence summary. For example, Chatbot notifications.
  - completeDescription
```
public final String completeDescription()
```
    A complete summary with all possible relevant information.
    
    Returns:
    
    A complete summary with all possible relevant information.
  - hasDimensions
```
public final boolean hasDimensions()
```
    For responses, this returns true if the service returned a value for the Dimensions 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.
  - dimensions
```
public final List<Dimension> dimensions()
```
    A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.
    
    Included dimensions, keys, and values are subject to change.
    
    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 hasDimensions() method.
    
    Returns:
    
    A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.
    
    Included dimensions, keys, and values are subject to change.
  - toBuilder
```
public MessageComponents.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MessageComponents.Builder,MessageComponents>
  - builder
```
public static MessageComponents.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends MessageComponents.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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class MessageComponents

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

headline

paragraphSummary

completeDescription

hasDimensions

dimensions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField