MqttHeaders (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iot.model.MqttHeaders

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MqttHeaders
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies MQTT Version 5.0 headers information. For more information, see MQTT from Amazon Web Services IoT Core Developer Guide.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

MqttHeaders()

Constructors
Constructor and Description
`MqttHeaders()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MqttHeaders`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getContentType()` A UTF-8 encoded string that describes the content of the publishing message.
`String`	`getCorrelationData()` 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.
`String`	`getMessageExpiry()` 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.
`String`	`getPayloadFormatIndicator()` An `Enum` string value that indicates whether the payload is formatted as UTF-8.
`String`	`getResponseTopic()` A UTF-8 encoded string that's used as the topic name for a response message.
`List<UserProperty>`	`getUserProperties()` An array of key-value pairs that you define in the MQTT5 header.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setContentType(String contentType)` A UTF-8 encoded string that describes the content of the publishing message.
`void`	`setCorrelationData(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.
`void`	`setMessageExpiry(String messageExpiry)` 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.
`void`	`setPayloadFormatIndicator(String payloadFormatIndicator)` An `Enum` string value that indicates whether the payload is formatted as UTF-8.
`void`	`setResponseTopic(String responseTopic)` A UTF-8 encoded string that's used as the topic name for a response message.
`void`	`setUserProperties(Collection<UserProperty> userProperties)` An array of key-value pairs that you define in the MQTT5 header.
`String`	`toString()` Returns a string representation of this object.
`MqttHeaders`	`withContentType(String contentType)` A UTF-8 encoded string that describes the content of the publishing message.
`MqttHeaders`	`withCorrelationData(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.
`MqttHeaders`	`withMessageExpiry(String messageExpiry)` 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.
`MqttHeaders`	`withPayloadFormatIndicator(String payloadFormatIndicator)` An `Enum` string value that indicates whether the payload is formatted as UTF-8.
`MqttHeaders`	`withResponseTopic(String responseTopic)` A UTF-8 encoded string that's used as the topic name for a response message.
`MqttHeaders`	`withUserProperties(Collection<UserProperty> userProperties)` An array of key-value pairs that you define in the MQTT5 header.
`MqttHeaders`	`withUserProperties(UserProperty... userProperties)` An array of key-value pairs that you define in the MQTT5 header.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MqttHeaders
```
public MqttHeaders()
```
- Method Detail
  - setPayloadFormatIndicator
```
public void setPayloadFormatIndicator(String payloadFormatIndicator)
```
    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.
    
    Parameters:
    
    payloadFormatIndicator - 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.
  - getPayloadFormatIndicator
```
public String getPayloadFormatIndicator()
```
    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.
    
    Returns:
    
    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.
  - withPayloadFormatIndicator
```
public MqttHeaders withPayloadFormatIndicator(String payloadFormatIndicator)
```
    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.
    
    Parameters:
    
    payloadFormatIndicator - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContentType
```
public void setContentType(String contentType)
```
    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.
    
    Parameters:
    
    contentType - 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.
  - getContentType
```
public String getContentType()
```
    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.
    
    Returns:
    
    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.
  - withContentType
```
public MqttHeaders withContentType(String contentType)
```
    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.
    
    Parameters:
    
    contentType - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResponseTopic
```
public void setResponseTopic(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.
    
    For more information, see Response Topic from the MQTT Version 5.0 specification.
    
    Supports substitution templates.
    
    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.
    
    For more information, see Response Topic from the MQTT Version 5.0 specification.
    
    Supports substitution templates.
  - getResponseTopic
```
public String getResponseTopic()
```
    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.
    
    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.
    
    For more information, see Response Topic from the MQTT Version 5.0 specification.
    
    Supports substitution templates.
  - withResponseTopic
```
public MqttHeaders withResponseTopic(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.
    
    For more information, see Response Topic from the MQTT Version 5.0 specification.
    
    Supports substitution templates.
    
    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.
    
    For more information, see Response Topic from the MQTT Version 5.0 specification.
    
    Supports substitution templates.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCorrelationData
```
public void setCorrelationData(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.
    
    For more information, see Correlation Data from the MQTT Version 5.0 specification.
    
    This binary data must be based64-encoded.
    
    Supports substitution templates.
    
    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.
    
    For more information, see Correlation Data from the MQTT Version 5.0 specification.
    
    This binary data must be based64-encoded.
    
    Supports substitution templates.
  - getCorrelationData
```
public String getCorrelationData()
```
    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.
    
    This binary data must be based64-encoded.
    
    Supports substitution templates.
    
    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.
    
    For more information, see Correlation Data from the MQTT Version 5.0 specification.
    
    This binary data must be based64-encoded.
    
    Supports substitution templates.
  - withCorrelationData
```
public MqttHeaders withCorrelationData(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.
    
    For more information, see Correlation Data from the MQTT Version 5.0 specification.
    
    This binary data must be based64-encoded.
    
    Supports substitution templates.
    
    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.
    
    For more information, see Correlation Data from the MQTT Version 5.0 specification.
    
    This binary data must be based64-encoded.
    
    Supports substitution templates.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMessageExpiry
```
public void setMessageExpiry(String messageExpiry)
```
    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 from the Amazon Web Services Reference Guide.
    
    Supports substitution templates.
    
    Parameters:
    
    messageExpiry - 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 from the Amazon Web Services Reference Guide.
    
    Supports substitution templates.
  - getMessageExpiry
```
public String getMessageExpiry()
```
    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 from the Amazon Web Services Reference Guide.
    
    Supports substitution templates.
    
    Returns:
    
    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 from the Amazon Web Services Reference Guide.
    
    Supports substitution templates.
  - withMessageExpiry
```
public MqttHeaders withMessageExpiry(String messageExpiry)
```
    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 from the Amazon Web Services Reference Guide.
    
    Supports substitution templates.
    
    Parameters:
    
    messageExpiry - 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 from the Amazon Web Services Reference Guide.
    
    Supports substitution templates.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUserProperties
```
public List<UserProperty> getUserProperties()
```
    An array of key-value pairs that you define in the MQTT5 header.
    
    Returns:
    
    An array of key-value pairs that you define in the MQTT5 header.
  - setUserProperties
```
public void setUserProperties(Collection<UserProperty> userProperties)
```
    An array of key-value pairs that you define in the MQTT5 header.
    
    Parameters:
    
    userProperties - An array of key-value pairs that you define in the MQTT5 header.
  - withUserProperties
```
public MqttHeaders withUserProperties(UserProperty... userProperties)
```
    An array of key-value pairs that you define in the MQTT5 header.
    
    NOTE: This method appends the values to the existing list (if any). Use setUserProperties(java.util.Collection) or withUserProperties(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    userProperties - An array of key-value pairs that you define in the MQTT5 header.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUserProperties
```
public MqttHeaders withUserProperties(Collection<UserProperty> userProperties)
```
    An array of key-value pairs that you define in the MQTT5 header.
    
    Parameters:
    
    userProperties - An array of key-value pairs that you define in the MQTT5 header.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public MqttHeaders clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class MqttHeaders

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MqttHeaders

Method Detail

setPayloadFormatIndicator

getPayloadFormatIndicator

withPayloadFormatIndicator

setContentType

getContentType

withContentType

setResponseTopic

getResponseTopic

withResponseTopic

setCorrelationData

getCorrelationData

withCorrelationData

setMessageExpiry

getMessageExpiry

withMessageExpiry

getUserProperties

setUserProperties

withUserProperties

withUserProperties

toString

equals

hashCode

clone

marshall