Class BatchPutMessageRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.iotanalytics.model.IoTAnalyticsRequest
software.amazon.awssdk.services.iotanalytics.model.BatchPutMessageRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<BatchPutMessageRequest.Builder,BatchPutMessageRequest>
@Generated("software.amazon.awssdk:codegen") public final class BatchPutMessageRequest extends IoTAnalyticsRequest implements ToCopyableBuilder<BatchPutMessageRequest.Builder,BatchPutMessageRequest>

  • Method Details

    • channelName

      public final String channelName()

      The name of the channel where the messages are sent.

      Returns:
      The name of the channel where the messages are sent.

    • hasMessages

      public final boolean hasMessages()
      For responses, this returns true if the service returned a value for the Messages 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.

    • messages

      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.

      Returns:
      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.

    • toBuilder

      public BatchPutMessageRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<BatchPutMessageRequest.Builder,BatchPutMessageRequest>
      Specified by:
      toBuilder in class IoTAnalyticsRequest
      Returns:
      a builder for type T

    • builder

      public static BatchPutMessageRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BatchPutMessageRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.