Class SendDirectMessageRequest

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

  • Method Details

    • clientId

      public final String clientId()

      The unique identifier of the MQTT client to send the message to.

      Client IDs must not exceed 128 characters and can't start with a dollar sign ($). MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.

      Returns:
      The unique identifier of the MQTT client to send the message to.

      Client IDs must not exceed 128 characters and can't start with a dollar sign ($). MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.

    • topic

      public final String topic()

      The topic of the outbound MQTT Publish message to the receiving client. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.

      Returns:
      The topic of the outbound MQTT Publish message to the receiving client. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.

    • contentType

      public final String contentType()

      The MQTT5 content type property forwarded to the receiving client (for example, application/json).

      Returns:
      The MQTT5 content type property forwarded to the receiving client (for example, application/json).

    • responseTopic

      public final String responseTopic()

      A UTF-8 encoded string that's used as the topic name for a response message. The response topic describes the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.

      Returns:
      A UTF-8 encoded string that's used as the topic name for a response message. The response topic describes the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.

    • confirmation

      public final Boolean confirmation()

      A Boolean value that specifies whether to wait for delivery confirmation from the receiving client.

      When set to true, the API delivers the message at QoS 1 and waits for the client to send a delivery confirmation (PUBACK) before returning a successful response. If delivery confirmation is not received within the specified timeout period, the API returns HTTP 504.

      When set to false, the API delivers the message at QoS 0 and returns after Amazon Web Services IoT Core attempts to deliver the message.

      Valid values: true | false

      Default value: false

      Returns:
      A Boolean value that specifies whether to wait for delivery confirmation from the receiving client.

      When set to true, the API delivers the message at QoS 1 and waits for the client to send a delivery confirmation (PUBACK) before returning a successful response. If delivery confirmation is not received within the specified timeout period, the API returns HTTP 504.

      When set to false, the API delivers the message at QoS 0 and returns after Amazon Web Services IoT Core attempts to deliver the message.

      Valid values: true | false

      Default value: false

    • timeout

      public final Integer timeout()

      An integer that represents the maximum time, in seconds, to wait for a delivery confirmation (PUBACK) from the receiving client after the message has been delivered. This parameter is only used when confirmation is set to true. If confirmation is false, this parameter is ignored.

      The total API response time may be higher than this value due to internal processing. Set your HTTP client timeout to a value greater than this parameter.

      Valid range: 1 to 15 seconds.

      Default value: 5 seconds.

      Returns:
      An integer that represents the maximum time, in seconds, to wait for a delivery confirmation (PUBACK) from the receiving client after the message has been delivered. This parameter is only used when confirmation is set to true. If confirmation is false , this parameter is ignored.

      The total API response time may be higher than this value due to internal processing. Set your HTTP client timeout to a value greater than this parameter.

      Valid range: 1 to 15 seconds.

      Default value: 5 seconds.

    • payload

      public final SdkBytes payload()

      The message body. MQTT accepts text, binary, and empty (null) message payloads.

      Returns:
      The message body. MQTT accepts text, binary, and empty (null) message payloads.

    • userProperties

      public final String userProperties()

      A JSON string that contains an array of JSON objects. If you don't use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. userProperties is an HTTP header value in the API.

      For MQTT 3.1.1 clients, user properties are silently dropped.

      The following example userProperties parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:

      [{"deviceName": "alpha"}, {"deviceCnt": "45"}]

      Returns:
      A JSON string that contains an array of JSON objects. If you don't use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. userProperties is an HTTP header value in the API.

      For MQTT 3.1.1 clients, user properties are silently dropped.

      The following example userProperties parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:

      [{"deviceName": "alpha"}, {"deviceCnt": "45"}]

    • payloadFormatIndicator

      public final PayloadFormatIndicator payloadFormatIndicator()

      An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.

      If the service returns an enum value that is not available in the current SDK version, payloadFormatIndicator will return PayloadFormatIndicator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from payloadFormatIndicatorAsString().

      Returns:
      An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
      See Also:

    • payloadFormatIndicatorAsString

      public final String payloadFormatIndicatorAsString()

      An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.

      If the service returns an enum value that is not available in the current SDK version, payloadFormatIndicator will return PayloadFormatIndicator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from payloadFormatIndicatorAsString().

      Returns:
      An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
      See Also:

    • correlationData

      public final String correlationData()

      The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received. correlationData is an HTTP header value in the API.

      Returns:
      The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received. correlationData is an HTTP header value in the API.

    • toBuilder

      public SendDirectMessageRequest.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<SendDirectMessageRequest.Builder,SendDirectMessageRequest>
      Specified by:
      toBuilder in class IotDataPlaneRequest
      Returns:
      a builder for type T

    • builder

      public static SendDirectMessageRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SendDirectMessageRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.