Class PublishRequest

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.PublishRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PublishRequest.Builder,PublishRequest>
@Generated("software.amazon.awssdk:codegen") public final class PublishRequest extends IotDataPlaneRequest implements ToCopyableBuilder<PublishRequest.Builder,PublishRequest>

The input for the Publish operation.

  • Method Details

    • topic

      public final String topic()

      The name of the MQTT topic.

      Returns:
      The name of the MQTT topic.

    • qos

      public final Integer qos()

      The Quality of Service (QoS) level. The default QoS level is 0.

      Returns:
      The Quality of Service (QoS) level. The default QoS level is 0.

    • retain

      public final Boolean retain()

      A Boolean value that determines whether to set the RETAIN flag when the message is published.

      Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

      Valid values: true | false

      Default value: false

      Returns:
      A Boolean value that determines whether to set the RETAIN flag when the message is published.

      Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

      Valid values: true | false

      Default value: false

    • payload

      public final SdkBytes payload()

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

      Publishing an empty (null) payload with retain = true deletes the retained message identified by topic from Amazon Web Services IoT Core.

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

      Publishing an empty (null) payload with retain = true deletes the retained message identified by topic from Amazon Web Services IoT Core.

    • 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.

      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.

      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:

    • contentType

      public final String contentType()

      A UTF-8 encoded string that describes the content of the publishing message.

      Returns:
      A UTF-8 encoded string that describes the content of the publishing message.

    • responseTopic

      public final String responseTopic()

      A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.

      Returns:
      A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.

    • 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.

    • messageExpiry

      public final Long messageExpiry()

      A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn't expire. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.

      Returns:
      A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn't expire. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.

    • toBuilder

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

    • builder

      public static PublishRequest.Builder builder()

    • serializableBuilderClass

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