GetRetainedMessageResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.iotdata.model.GetRetainedMessageResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetRetainedMessageResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

The output from the GetRetainedMessage operation.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetRetainedMessageResult()

Constructors
Constructor and Description
`GetRetainedMessageResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetRetainedMessageResult`	`clone()`
`boolean`	`equals(Object obj)`
`Long`	`getLastModifiedTime()` The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
`ByteBuffer`	`getPayload()` The Base64-encoded message payload of the retained message body.
`Integer`	`getQos()` The quality of service (QoS) level used to publish the retained message.
`String`	`getTopic()` The topic name to which the retained message was published.
`ByteBuffer`	`getUserProperties()` A base64-encoded JSON string that includes an array of JSON objects, or null if the retained message doesn't include any user properties.
`int`	`hashCode()`
`void`	`setLastModifiedTime(Long lastModifiedTime)` The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
`void`	`setPayload(ByteBuffer payload)` The Base64-encoded message payload of the retained message body.
`void`	`setQos(Integer qos)` The quality of service (QoS) level used to publish the retained message.
`void`	`setTopic(String topic)` The topic name to which the retained message was published.
`void`	`setUserProperties(ByteBuffer userProperties)` A base64-encoded JSON string that includes an array of JSON objects, or null if the retained message doesn't include any user properties.
`String`	`toString()` Returns a string representation of this object.
`GetRetainedMessageResult`	`withLastModifiedTime(Long lastModifiedTime)` The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
`GetRetainedMessageResult`	`withPayload(ByteBuffer payload)` The Base64-encoded message payload of the retained message body.
`GetRetainedMessageResult`	`withQos(Integer qos)` The quality of service (QoS) level used to publish the retained message.
`GetRetainedMessageResult`	`withTopic(String topic)` The topic name to which the retained message was published.
`GetRetainedMessageResult`	`withUserProperties(ByteBuffer userProperties)` A base64-encoded JSON string that includes an array of JSON objects, or null if the retained message doesn't include any user properties.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - GetRetainedMessageResult
```
public GetRetainedMessageResult()
```
- Method Detail
  - setTopic
```
public void setTopic(String topic)
```
    The topic name to which the retained message was published.
    
    Parameters:
    
    topic - The topic name to which the retained message was published.
  - getTopic
```
public String getTopic()
```
    The topic name to which the retained message was published.
    
    Returns:
    
    The topic name to which the retained message was published.
  - withTopic
```
public GetRetainedMessageResult withTopic(String topic)
```
    The topic name to which the retained message was published.
    
    Parameters:
    
    topic - The topic name to which the retained message was published.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPayload
```
public void setPayload(ByteBuffer payload)
```
    The Base64-encoded message payload of the retained message body.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    Parameters:
    
    payload - The Base64-encoded message payload of the retained message body.
  - getPayload
```
public ByteBuffer getPayload()
```
    The Base64-encoded message payload of the retained message body.
    
    ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.
    
    Returns:
    
    The Base64-encoded message payload of the retained message body.
  - withPayload
```
public GetRetainedMessageResult withPayload(ByteBuffer payload)
```
    The Base64-encoded message payload of the retained message body.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    Parameters:
    
    payload - The Base64-encoded message payload of the retained message body.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQos
```
public void setQos(Integer qos)
```
    The quality of service (QoS) level used to publish the retained message.
    
    Parameters:
    
    qos - The quality of service (QoS) level used to publish the retained message.
  - getQos
```
public Integer getQos()
```
    The quality of service (QoS) level used to publish the retained message.
    
    Returns:
    
    The quality of service (QoS) level used to publish the retained message.
  - withQos
```
public GetRetainedMessageResult withQos(Integer qos)
```
    The quality of service (QoS) level used to publish the retained message.
    
    Parameters:
    
    qos - The quality of service (QoS) level used to publish the retained message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Long lastModifiedTime)
```
    The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
    
    Parameters:
    
    lastModifiedTime - The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
  - getLastModifiedTime
```
public Long getLastModifiedTime()
```
    The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
    
    Returns:
    
    The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
  - withLastModifiedTime
```
public GetRetainedMessageResult withLastModifiedTime(Long lastModifiedTime)
```
    The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
    
    Parameters:
    
    lastModifiedTime - The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserProperties
```
public void setUserProperties(ByteBuffer userProperties)
```
    A base64-encoded JSON string that includes an array of JSON objects, or null if the retained message doesn't include any user properties.
    
    The following example userProperties parameter is a JSON string that represents two user properties. Note that it will be base64-encoded:
    
    [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    Parameters:
    
    userProperties - A base64-encoded JSON string that includes an array of JSON objects, or null if the retained message doesn't include any user properties.
    
    The following example userProperties parameter is a JSON string that represents two user properties. Note that it will be base64-encoded:
    
    [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
  - getUserProperties
```
public ByteBuffer getUserProperties()
```
    A base64-encoded JSON string that includes an array of JSON objects, or null if the retained message doesn't include any user properties.
    
    The following example userProperties parameter is a JSON string that represents two user properties. Note that it will be base64-encoded:
    
    [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
    
    ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.
    
    Returns:
    
    A base64-encoded JSON string that includes an array of JSON objects, or null if the retained message doesn't include any user properties.
    
    The following example userProperties parameter is a JSON string that represents two user properties. Note that it will be base64-encoded:
    
    [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
  - withUserProperties
```
public GetRetainedMessageResult withUserProperties(ByteBuffer userProperties)
```
    A base64-encoded JSON string that includes an array of JSON objects, or null if the retained message doesn't include any user properties.
    
    The following example userProperties parameter is a JSON string that represents two user properties. Note that it will be base64-encoded:
    
    [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    Parameters:
    
    userProperties - A base64-encoded JSON string that includes an array of JSON objects, or null if the retained message doesn't include any user properties.
    
    The following example userProperties parameter is a JSON string that represents two user properties. Note that it will be base64-encoded:
    
    [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
    
    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 GetRetainedMessageResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.778

Class GetRetainedMessageResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetRetainedMessageResult

Method Detail

setTopic

getTopic

withTopic

setPayload

getPayload

withPayload

setQos

getQos

withQos

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

setUserProperties

getUserProperties

withUserProperties

toString

equals

hashCode

clone