com.amazonaws.greengrass.javasdk

Class IotDataClient

java.lang.Object

com.amazonaws.greengrass.javasdk.IotDataClient

public class IotDataClient
extends Object

Iot Data client interacts with IPC. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete thing shadows.

Constructor Summary

Constructors

Modifier	Constructor and Description
	IotDataClient() Default Constructor.
	IotDataClient(LambdaClient lambdaClient) Constructor with customized lambda client.
protected	IotDataClient(LambdaClient lambdaClient, GreengrassLogger greengrassLogger) Constructor with customized lambda client.

Method Summary

Modifier and Type	Method and Description
DeleteThingShadowResult	deleteThingShadow(DeleteThingShadowRequest request) Delete a thing shadow.
GetThingShadowResult	getThingShadow(GetThingShadowRequest request) Get a thing shadow.
PublishResult	publish(PublishRequest request) Publish payload to a certain topic via IPC.
UpdateThingShadowResult	updateThingShadow(UpdateThingShadowRequest request) Update a thing shadow.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IotDataClient

public IotDataClient()

Default Constructor.

IotDataClient

public IotDataClient(LambdaClient lambdaClient)

Constructor with customized lambda client.

Parameters:

lambdaClient - a lambda client

IotDataClient

protected IotDataClient(LambdaClient lambdaClient,
                        GreengrassLogger greengrassLogger)

Constructor with customized lambda client.

Parameters:

lambdaClient - a lambda client

greengrassLogger - a Greengrass Logger

Method Detail

getThingShadow

public GetThingShadowResult getThingShadow(GetThingShadowRequest request)
                                    throws GGIotDataException

Get a thing shadow.

Parameters:

request - get shadow request object

Returns:

a result for get request

Throws:

GGIotDataException - thrown when get request failed

updateThingShadow

public UpdateThingShadowResult updateThingShadow(UpdateThingShadowRequest request)
                                          throws GGIotDataException

Update a thing shadow.

Parameters:

request - update shadow request object

Returns:

a result for the update request

Throws:

GGIotDataException - thrown when update request failed

deleteThingShadow

public DeleteThingShadowResult deleteThingShadow(DeleteThingShadowRequest request)
                                          throws GGIotDataException

Delete a thing shadow.

Parameters:

request - delete shadow request object

Returns:

a result for the delete request

Throws:

GGIotDataException - thrown when delete request failed

publish

public PublishResult publish(PublishRequest request)
                      throws GGIotDataException,
                             GGLambdaException

Publish payload to a certain topic via IPC.

Parameters:

request - publish request object

Returns:

a result for the publish request

Throws:

GGIotDataException - thrown when publish request invalid

GGLambdaException - thrown when publish request cannot invoke the router lambda