Class: Aws::IoTDataPlane::Types::GetRetainedMessageResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotdataplane/lib/aws-sdk-iotdataplane/types.rb

Overview

The output from the GetRetainedMessage operation.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#last_modified_time ⇒ Integer

The Epoch date and time, in milliseconds, when the retained message was stored by IoT.

Returns:

  • (Integer) 


98
99
100
101
102
103
104
105
106
 
# File 'gems/aws-sdk-iotdataplane/lib/aws-sdk-iotdataplane/types.rb', line 98

class GetRetainedMessageResponse < Struct.new(
  :topic,
  :payload,
  :qos,
  :last_modified_time,
  :user_properties)
  SENSITIVE = []
  include Aws::Structure
end

#payload ⇒ String

The Base64-encoded message payload of the retained message body.

Returns:

  • (String) 


98
99
100
101
102
103
104
105
106
 
# File 'gems/aws-sdk-iotdataplane/lib/aws-sdk-iotdataplane/types.rb', line 98

class GetRetainedMessageResponse < Struct.new(
  :topic,
  :payload,
  :qos,
  :last_modified_time,
  :user_properties)
  SENSITIVE = []
  include Aws::Structure
end

#qos ⇒ Integer

The quality of service (QoS) level used to publish the retained message.

Returns:

  • (Integer) 


98
99
100
101
102
103
104
105
106
 
# File 'gems/aws-sdk-iotdataplane/lib/aws-sdk-iotdataplane/types.rb', line 98

class GetRetainedMessageResponse < Struct.new(
  :topic,
  :payload,
  :qos,
  :last_modified_time,
  :user_properties)
  SENSITIVE = []
  include Aws::Structure
end

#topic ⇒ String

The topic name to which the retained message was published.

Returns:

  • (String) 


98
99
100
101
102
103
104
105
106
 
# File 'gems/aws-sdk-iotdataplane/lib/aws-sdk-iotdataplane/types.rb', line 98

class GetRetainedMessageResponse < Struct.new(
  :topic,
  :payload,
  :qos,
  :last_modified_time,
  :user_properties)
  SENSITIVE = []
  include Aws::Structure
end

#user_properties ⇒ String

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:

  • (String) 


98
99
100
101
102
103
104
105
106
 
# File 'gems/aws-sdk-iotdataplane/lib/aws-sdk-iotdataplane/types.rb', line 98

class GetRetainedMessageResponse < Struct.new(
  :topic,
  :payload,
  :qos,
  :last_modified_time,
  :user_properties)
  SENSITIVE = []
  include Aws::Structure
end