com.amazonaws.services.iotdata

Class AbstractAWSIotData

java.lang.Object

com.amazonaws.services.iotdata.AbstractAWSIotData

All Implemented Interfaces:

AWSIotData

Direct Known Subclasses:

AbstractAWSIotDataAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSIotData
extends Object
implements AWSIotData

Abstract implementation of AWSIotData. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.iotdata.AWSIotData

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
DeleteThingShadowResult	deleteThingShadow(DeleteThingShadowRequest request) Deletes the thing shadow for the specified thing.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetThingShadowResult	getThingShadow(GetThingShadowRequest request) Gets the thing shadow for the specified thing.
PublishResult	publish(PublishRequest request) Publishes state information.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://data.iot.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to AWSIotData.setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateThingShadowResult	updateThingShadow(UpdateThingShadowRequest request) Updates the thing shadow for the specified thing.

Methods inherited from class java.lang.Object

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

Method Detail

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AWSIotData

Overrides the default endpoint for this client ("https://data.iot.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "data.iot.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://data.iot.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Specified by:

setEndpoint in interface AWSIotData

Parameters:

endpoint - The endpoint (ex: "data.iot.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://data.iot.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

public void setRegion(Region region)

Description copied from interface: AWSIotData

An alternative to AWSIotData.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Specified by:

setRegion in interface AWSIotData

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

deleteThingShadow

public DeleteThingShadowResult deleteThingShadow(DeleteThingShadowRequest request)

Description copied from interface: AWSIotData

Deletes the thing shadow for the specified thing.

For more information, see DeleteThingShadow in the AWS IoT Developer Guide.

Specified by:

deleteThingShadow in interface AWSIotData

Parameters:

request - The input for the DeleteThingShadow operation.

Returns:

Result of the DeleteThingShadow operation returned by the service.

getThingShadow

public GetThingShadowResult getThingShadow(GetThingShadowRequest request)

Description copied from interface: AWSIotData

Gets the thing shadow for the specified thing.

For more information, see GetThingShadow in the AWS IoT Developer Guide.

Specified by:

getThingShadow in interface AWSIotData

Parameters:

request - The input for the GetThingShadow operation.

Returns:

Result of the GetThingShadow operation returned by the service.

publish

public PublishResult publish(PublishRequest request)

Description copied from interface: AWSIotData

Publishes state information.

For more information, see HTTP Protocol in the AWS IoT Developer Guide.

Specified by:

publish in interface AWSIotData

Parameters:

request - The input for the Publish operation.

Returns:

Result of the Publish operation returned by the service.

updateThingShadow

public UpdateThingShadowResult updateThingShadow(UpdateThingShadowRequest request)

Description copied from interface: AWSIotData

Updates the thing shadow for the specified thing.

For more information, see UpdateThingShadow in the AWS IoT Developer Guide.

Specified by:

updateThingShadow in interface AWSIotData

Parameters:

request - The input for the UpdateThingShadow operation.

Returns:

Result of the UpdateThingShadow operation returned by the service.

shutdown

public void shutdown()

Description copied from interface: AWSIotData

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSIotData

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AWSIotData

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Specified by:

getCachedResponseMetadata in interface AWSIotData

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.