@Generated(value="software.amazon.awssdk:codegen") public final class BatchPutMessageRequest extends IoTAnalyticsRequest implements ToCopyableBuilder<BatchPutMessageRequest.Builder,BatchPutMessageRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
BatchPutMessageRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static BatchPutMessageRequest.Builder |
builder() |
String |
channelName()
The name of the channel where the messages are sent.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasMessages()
For responses, this returns true if the service returned a value for the Messages property.
|
List<Message> |
messages()
The list of messages to be sent.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends BatchPutMessageRequest.Builder> |
serializableBuilderClass() |
BatchPutMessageRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String channelName()
The name of the channel where the messages are sent.
public final boolean hasMessages()
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.public final List<Message> messages()
The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.
The field names of message payloads (data) that you send to 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 more 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.
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 hasMessages() method.
The field names of message payloads (data) that you send to 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 more 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.
public BatchPutMessageRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<BatchPutMessageRequest.Builder,BatchPutMessageRequest>toBuilder in class IoTAnalyticsRequestpublic static BatchPutMessageRequest.Builder builder()
public static Class<? extends BatchPutMessageRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.