Class: Aws::IoT::Types::ThingConnectivity

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::ThingConnectivity

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

The connectivity status of the thing.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #clean_session ⇒ Boolean

  Indicates whether the client is using a clean session.

• #client_id ⇒ String

  The unique identifier of the MQTT client.

• #connected ⇒ Boolean

  True if the thing is connected to the Amazon Web Services IoT Core service; false if it is not connected.

• #disconnect_reason ⇒ String

  The reason why the client is disconnected.

• #keep_alive_duration ⇒ Integer

  The keep-alive interval in seconds that the client specified when establishing the connection.

• #session_expiry ⇒ Integer

  The session expiry interval in seconds for the MQTT client connection.

• #timestamp ⇒ Integer

  The epoch time (in milliseconds) when the thing last connected or disconnected.

Instance Attribute Details

#clean_session ⇒ Boolean

Indicates whether the client is using a clean session. Returns ‘true` for clean sessions.

Returns:

• (Boolean)

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

class ThingConnectivity < Struct.new(
  :connected,
  :timestamp,
  :disconnect_reason,
  :keep_alive_duration,
  :clean_session,
  :session_expiry,
  :client_id)
  SENSITIVE = []
  include Aws::Structure
end

#client_id ⇒ String

The unique identifier of the MQTT client.

Returns:

• (String)

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

class ThingConnectivity < Struct.new(
  :connected,
  :timestamp,
  :disconnect_reason,
  :keep_alive_duration,
  :clean_session,
  :session_expiry,
  :client_id)
  SENSITIVE = []
  include Aws::Structure
end

#connected ⇒ Boolean

True if the thing is connected to the Amazon Web Services IoT Core service; false if it is not connected.

Returns:

• (Boolean)

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

class ThingConnectivity < Struct.new(
  :connected,
  :timestamp,
  :disconnect_reason,
  :keep_alive_duration,
  :clean_session,
  :session_expiry,
  :client_id)
  SENSITIVE = []
  include Aws::Structure
end

#disconnect_reason ⇒ String

The reason why the client is disconnected. When you enable or update the indexing configuration, this value might be missing for devices that have never connected or have been disconnected for more than an hour.

Returns:

• (String)

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

class ThingConnectivity < Struct.new(
  :connected,
  :timestamp,
  :disconnect_reason,
  :keep_alive_duration,
  :clean_session,
  :session_expiry,
  :client_id)
  SENSITIVE = []
  include Aws::Structure
end

#keep_alive_duration ⇒ Integer

The keep-alive interval in seconds that the client specified when establishing the connection.

Returns:

• (Integer)

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

class ThingConnectivity < Struct.new(
  :connected,
  :timestamp,
  :disconnect_reason,
  :keep_alive_duration,
  :clean_session,
  :session_expiry,
  :client_id)
  SENSITIVE = []
  include Aws::Structure
end

#session_expiry ⇒ Integer

The session expiry interval in seconds for the MQTT client connection. This value indicates how long the session will remain active after the client disconnects.

Returns:

• (Integer)

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

class ThingConnectivity < Struct.new(
  :connected,
  :timestamp,
  :disconnect_reason,
  :keep_alive_duration,
  :clean_session,
  :session_expiry,
  :client_id)
  SENSITIVE = []
  include Aws::Structure
end

#timestamp ⇒ Integer

The epoch time (in milliseconds) when the thing last connected or disconnected. If the thing has been disconnected for approximately an hour, the time value might be missing. When you enable or update the indexing configuration, this value might be ‘0` (the Unix epoch time) for devices that have never connected or have been disconnected for more than an hour.

Returns:

• (Integer)

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

class ThingConnectivity < Struct.new(
  :connected,
  :timestamp,
  :disconnect_reason,
  :keep_alive_duration,
  :clean_session,
  :session_expiry,
  :client_id)
  SENSITIVE = []
  include Aws::Structure
end