Class: Aws::IoT::Types::MqttHeaders

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::MqttHeaders

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Specifies MQTT Version 5.0 headers information. For more information, see [ MQTT] from Amazon Web Services IoT Core Developer Guide.

[1]: docs.aws.amazon.com/iot/latest/developerguide/mqtt.html

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #content_type ⇒ String

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

• #correlation_data ⇒ String

  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.

• #message_expiry ⇒ String

  A user-defined integer value that will persist a message at the message broker for a specified amount of time to ensure that the message will expire if it’s no longer relevant to the subscriber.

• #payload_format_indicator ⇒ String

  An ‘Enum` string value that indicates whether the payload is formatted as UTF-8.

• #response_topic ⇒ String

  A UTF-8 encoded string that’s used as the topic name for a response message.

• #user_properties ⇒ Array<Types::UserProperty>

  An array of key-value pairs that you define in the MQTT5 header.

Instance Attribute Details

#content_type ⇒ String

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

For more information, see [ Content Type] from the MQTT Version 5.0 specification.

Supports [substitution templates].

[1]: docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901118 [2]: docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 12326

class MqttHeaders < Struct.new(
  :payload_format_indicator,
  :content_type,
  :response_topic,
  :correlation_data,
  :message_expiry,
  :user_properties)
  SENSITIVE = []
  include Aws::Structure
end

#correlation_data ⇒ String

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.

For more information, see [ Correlation Data] from the MQTT Version 5.0 specification.

<note markdown=“1”> This binary data must be based64-encoded.

</note>

Supports [substitution templates].

[1]: docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901115 [2]: docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 12326

class MqttHeaders < Struct.new(
  :payload_format_indicator,
  :content_type,
  :response_topic,
  :correlation_data,
  :message_expiry,
  :user_properties)
  SENSITIVE = []
  include Aws::Structure
end

#message_expiry ⇒ String

A user-defined integer value that will persist a message at the message broker for a specified amount of time to ensure that the message will expire if it’s no longer relevant to the subscriber. The value of ‘messageExpiry` represents the number of seconds before it expires. For more information about the limits of `messageExpiry`, see [Amazon Web Services IoT Core message broker and protocol limits and quotas ][1] from the Amazon Web Services Reference Guide.

Supports [substitution templates].

[1]: docs.aws.amazon.com/iot/latest/developerguide/mqtt.html [2]: docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 12326

class MqttHeaders < Struct.new(
  :payload_format_indicator,
  :content_type,
  :response_topic,
  :correlation_data,
  :message_expiry,
  :user_properties)
  SENSITIVE = []
  include Aws::Structure
end

#payload_format_indicator ⇒ String

An ‘Enum` string value that indicates whether the payload is formatted as UTF-8.

Valid values are ‘UNSPECIFIED_BYTES` and `UTF8_DATA`.

For more information, see [ Payload Format Indicator] from the MQTT Version 5.0 specification.

Supports [substitution templates].

[1]: docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901111 [2]: docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 12326

class MqttHeaders < Struct.new(
  :payload_format_indicator,
  :content_type,
  :response_topic,
  :correlation_data,
  :message_expiry,
  :user_properties)
  SENSITIVE = []
  include Aws::Structure
end

#response_topic ⇒ String

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.

For more information, see [ Response Topic] from the MQTT Version 5.0 specification.

Supports [substitution templates].

[1]: docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901114 [2]: docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 12326

class MqttHeaders < Struct.new(
  :payload_format_indicator,
  :content_type,
  :response_topic,
  :correlation_data,
  :message_expiry,
  :user_properties)
  SENSITIVE = []
  include Aws::Structure
end

#user_properties ⇒ Array<Types::UserProperty>

An array of key-value pairs that you define in the MQTT5 header.

Returns:

• (Array<Types::UserProperty>)

# File 'lib/aws-sdk-iot/types.rb', line 12326

class MqttHeaders < Struct.new(
  :payload_format_indicator,
  :content_type,
  :response_topic,
  :correlation_data,
  :message_expiry,
  :user_properties)
  SENSITIVE = []
  include Aws::Structure
end