Package software.amazon.awssdk.services.iotdataplane.model

Interface PublishRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<PublishRequest.Builder,PublishRequest>, IotDataPlaneRequest.Builder, SdkBuilder<PublishRequest.Builder,PublishRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PublishRequest
public static interface PublishRequest.Builder extends IotDataPlaneRequest.Builder, SdkPojo, CopyableBuilder<PublishRequest.Builder,PublishRequest>

  • Method Details

    • topic

      PublishRequest.Builder topic(String topic)

      The name of the MQTT topic.

      Parameters:
      topic - The name of the MQTT topic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • qos

      PublishRequest.Builder qos(Integer qos)

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

      Parameters:
      qos - The Quality of Service (QoS) level. The default QoS level is 0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retain

      PublishRequest.Builder retain(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • payload

      PublishRequest.Builder payload(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • userProperties

      PublishRequest.Builder userProperties(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"}]

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • payloadFormatIndicator

      PublishRequest.Builder payloadFormatIndicator(String payloadFormatIndicator)

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

      Parameters:
      payloadFormatIndicator - An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • payloadFormatIndicator

      PublishRequest.Builder payloadFormatIndicator(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.

      Parameters:
      payloadFormatIndicator - An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • contentType

      PublishRequest.Builder contentType(String contentType)

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

      Parameters:
      contentType - A UTF-8 encoded string that describes the content of the publishing message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • responseTopic

      PublishRequest.Builder responseTopic(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • correlationData

      PublishRequest.Builder correlationData(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • messageExpiry

      PublishRequest.Builder messageExpiry(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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