Interface SendDirectMessageRequest.Builder

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

  • Method Details

    • clientId

      SendDirectMessageRequest.Builder clientId(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.

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

    • topic

      SendDirectMessageRequest.Builder topic(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.

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

    • contentType

      SendDirectMessageRequest.Builder contentType(String contentType)

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

      Parameters:
      contentType - The MQTT5 content type property forwarded to the receiving client (for example, application/json).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • responseTopic

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

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

    • confirmation

      SendDirectMessageRequest.Builder confirmation(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

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

    • timeout

      SendDirectMessageRequest.Builder timeout(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.

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

    • payload

      SendDirectMessageRequest.Builder payload(SdkBytes payload)

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

      Parameters:
      payload - The message body. MQTT accepts text, binary, and empty (null) message payloads.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userProperties

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

      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"}]

      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.

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

    • payloadFormatIndicator

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

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

    • correlationData

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

    • overrideConfiguration

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

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