software.amazon.awssdk.services.iotanalytics.model

Interface BatchPutMessageRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<BatchPutMessageRequest.Builder,BatchPutMessageRequest>, IoTAnalyticsRequest.Builder, SdkBuilder<BatchPutMessageRequest.Builder,BatchPutMessageRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

BatchPutMessageRequest

public static interface BatchPutMessageRequest.Builder
extends IoTAnalyticsRequest.Builder, SdkPojo, CopyableBuilder<BatchPutMessageRequest.Builder,BatchPutMessageRequest>

Method Summary

Modifier and Type	Method and Description
BatchPutMessageRequest.Builder	channelName(String channelName) The name of the channel where the messages are sent.
BatchPutMessageRequest.Builder	messages(Collection<Message> messages) The list of messages to be sent.
BatchPutMessageRequest.Builder	messages(Consumer<Message.Builder>... messages) The list of messages to be sent.
BatchPutMessageRequest.Builder	messages(Message... messages) The list of messages to be sent.
BatchPutMessageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
BatchPutMessageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.iotanalytics.model.IoTAnalyticsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

channelName

BatchPutMessageRequest.Builder channelName(String channelName)

The name of the channel where the messages are sent.

Parameters:

channelName - The name of the channel where the messages are sent.

Returns:

Returns a reference to this object so that method calls can be chained together.

messages

BatchPutMessageRequest.Builder messages(Collection<Message> messages)

The list of messages to be sent. Each message has format: '{ "messageId": "string", "payload": "string"}'.

Note that the field names of message payloads (data) that you send to AWS IoT Analytics:

• Must contain only alphanumeric characters and undescores (_); no other special characters are allowed.

• Must begin with an alphabetic character or single underscore (_).

• Cannot contain hyphens (-).

• In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".

• Cannot be greater than 255 characters.

• Are case-insensitive. (Fields named "foo" and "FOO" in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

Parameters:

messages - The list of messages to be sent. Each message has format: '{ "messageId": "string", "payload": "string"}'.

Note that the field names of message payloads (data) that you send to AWS IoT Analytics:

• Must contain only alphanumeric characters and undescores (_); no other special characters are allowed.

• Must begin with an alphabetic character or single underscore (_).

• Cannot contain hyphens (-).

• In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".

• Cannot be greater than 255 characters.

• Are case-insensitive. (Fields named "foo" and "FOO" in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

Returns:

Returns a reference to this object so that method calls can be chained together.

messages

BatchPutMessageRequest.Builder messages(Message... messages)

The list of messages to be sent. Each message has format: '{ "messageId": "string", "payload": "string"}'.

Note that the field names of message payloads (data) that you send to AWS IoT Analytics:

• Must contain only alphanumeric characters and undescores (_); no other special characters are allowed.

• Must begin with an alphabetic character or single underscore (_).

• Cannot contain hyphens (-).

• In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".

• Cannot be greater than 255 characters.

• Are case-insensitive. (Fields named "foo" and "FOO" in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

Parameters:

messages - The list of messages to be sent. Each message has format: '{ "messageId": "string", "payload": "string"}'.

Note that the field names of message payloads (data) that you send to AWS IoT Analytics:

• Must contain only alphanumeric characters and undescores (_); no other special characters are allowed.

• Must begin with an alphabetic character or single underscore (_).

• Cannot contain hyphens (-).

• In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".

• Cannot be greater than 255 characters.

• Are case-insensitive. (Fields named "foo" and "FOO" in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

Returns:

Returns a reference to this object so that method calls can be chained together.

messages

BatchPutMessageRequest.Builder messages(Consumer<Message.Builder>... messages)

The list of messages to be sent. Each message has format: '{ "messageId": "string", "payload": "string"}'.

Note that the field names of message payloads (data) that you send to AWS IoT Analytics:

• Must contain only alphanumeric characters and undescores (_); no other special characters are allowed.

• Must begin with an alphabetic character or single underscore (_).

• Cannot contain hyphens (-).

• In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".

• Cannot be greater than 255 characters.

• Are case-insensitive. (Fields named "foo" and "FOO" in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #messages(List).

Parameters:

messages - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#messages(List)

overrideConfiguration

BatchPutMessageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

BatchPutMessageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.