Interface MessageSignal.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<MessageSignal.Builder,
,MessageSignal> SdkBuilder<MessageSignal.Builder,
,MessageSignal> SdkPojo
- Enclosing class:
MessageSignal
public static interface MessageSignal.Builder
extends SdkPojo, CopyableBuilder<MessageSignal.Builder,MessageSignal>
-
Method Summary
Modifier and TypeMethodDescriptiondefault MessageSignal.Builder
structuredMessage
(Consumer<StructuredMessage.Builder> structuredMessage) The structured message for the message signal.structuredMessage
(StructuredMessage structuredMessage) The structured message for the message signal.The topic name for the message signal.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
topicName
The topic name for the message signal. It corresponds to topics in ROS 2.
- Parameters:
topicName
- The topic name for the message signal. It corresponds to topics in ROS 2.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
structuredMessage
The structured message for the message signal. It can be defined with either a
primitiveMessageDefinition
,structuredMessageListDefinition
, orstructuredMessageDefinition
recursively.- Parameters:
structuredMessage
- The structured message for the message signal. It can be defined with either aprimitiveMessageDefinition
,structuredMessageListDefinition
, orstructuredMessageDefinition
recursively.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
structuredMessage
default MessageSignal.Builder structuredMessage(Consumer<StructuredMessage.Builder> structuredMessage) The structured message for the message signal. It can be defined with either a
This is a convenience method that creates an instance of theprimitiveMessageDefinition
,structuredMessageListDefinition
, orstructuredMessageDefinition
recursively.StructuredMessage.Builder
avoiding the need to create one manually viaStructuredMessage.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostructuredMessage(StructuredMessage)
.- Parameters:
structuredMessage
- a consumer that will call methods onStructuredMessage.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-