com.amazon.ask.model.services.datastore

Class DatastoreServiceClient

java.lang.Object

com.amazon.ask.model.services.BaseServiceClient

com.amazon.ask.model.services.datastore.DatastoreServiceClient

All Implemented Interfaces:

DatastoreService

public class DatastoreServiceClient
extends com.amazon.ask.model.services.BaseServiceClient
implements DatastoreService

Field Summary

Fields inherited from class com.amazon.ask.model.services.BaseServiceClient

apiClient, apiEndpoint, authorizationValue, serializer

Constructor Summary

Constructors

Constructor and Description
DatastoreServiceClient(com.amazon.ask.model.services.ApiConfiguration apiConfiguration, com.amazon.ask.model.services.AuthenticationConfiguration authenticationConfiguration)
DatastoreServiceClient(com.amazon.ask.model.services.ApiConfiguration apiConfiguration, com.amazon.ask.model.services.lwa.LwaClient lwaClient)

Method Summary

Modifier and Type	Method and Description
com.amazon.ask.model.services.ApiResponse<Void>	callCancelCommandsV1(String queuedResultId) Cancel pending DataStore commands.
com.amazon.ask.model.services.ApiResponse<CommandsResponse>	callCommandsV1(CommandsRequest commandsRequest) Send DataStore commands to Alexa device.
com.amazon.ask.model.services.ApiResponse<QueuedResultResponse>	callQueuedResultV1(String queuedResultId, Integer maxResults, String nextToken) Query statuses of deliveries to offline devices returned by commands API.
void	cancelCommandsV1(String queuedResultId) Cancel pending DataStore commands.
CommandsResponse	commandsV1(CommandsRequest commandsRequest) Send DataStore commands to Alexa device.
QueuedResultResponse	queuedResultV1(String queuedResultId, Integer maxResults, String nextToken) Query statuses of deliveries to offline devices returned by commands API.

Methods inherited from class com.amazon.ask.model.services.BaseServiceClient

executeRequest, invoke, invoke

Methods inherited from class java.lang.Object

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

Constructor Detail

DatastoreServiceClient

public DatastoreServiceClient(com.amazon.ask.model.services.ApiConfiguration apiConfiguration,
                              com.amazon.ask.model.services.AuthenticationConfiguration authenticationConfiguration)

DatastoreServiceClient

public DatastoreServiceClient(com.amazon.ask.model.services.ApiConfiguration apiConfiguration,
                              com.amazon.ask.model.services.lwa.LwaClient lwaClient)

Method Detail

callCommandsV1

public com.amazon.ask.model.services.ApiResponse<CommandsResponse> callCommandsV1(CommandsRequest commandsRequest)
                                                                           throws com.amazon.ask.model.services.ServiceException

Send DataStore commands to Alexa device.

Specified by:

callCommandsV1 in interface DatastoreService

Parameters:

commandsRequest - (required)

Returns:

com.amazon.ask.model.services.datastore.v1.CommandsResponse

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

commandsV1

public CommandsResponse commandsV1(CommandsRequest commandsRequest)
                            throws com.amazon.ask.model.services.ServiceException

Send DataStore commands to Alexa device.

Specified by:

commandsV1 in interface DatastoreService

Parameters:

commandsRequest - (required)

Returns:

com.amazon.ask.model.services.datastore.v1.CommandsResponse

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callCancelCommandsV1

public com.amazon.ask.model.services.ApiResponse<Void> callCancelCommandsV1(String queuedResultId)
                                                                     throws com.amazon.ask.model.services.ServiceException

Cancel pending DataStore commands.

Specified by:

callCancelCommandsV1 in interface DatastoreService

Parameters:

queuedResultId - A unique identifier to query result for queued delivery for offline devices (DEVICE_UNAVAILABLE). (required)

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

cancelCommandsV1

public void cancelCommandsV1(String queuedResultId)
                      throws com.amazon.ask.model.services.ServiceException

Cancel pending DataStore commands.

Specified by:

cancelCommandsV1 in interface DatastoreService

Parameters:

queuedResultId - A unique identifier to query result for queued delivery for offline devices (DEVICE_UNAVAILABLE). (required)

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callQueuedResultV1

public com.amazon.ask.model.services.ApiResponse<QueuedResultResponse> callQueuedResultV1(String queuedResultId,
                                                                                          Integer maxResults,
                                                                                          String nextToken)
                                                                                   throws com.amazon.ask.model.services.ServiceException

Query statuses of deliveries to offline devices returned by commands API.

Specified by:

callQueuedResultV1 in interface DatastoreService

Parameters:

queuedResultId - A unique identifier to query result for queued delivery for offline devices (DEVICE_UNAVAILABLE). (required)

maxResults - Maximum number of CommandsDispatchResult items to return. (optional, default to 20)

nextToken - The value of nextToken in the response to fetch next page. If not specified, the request fetches result for the first page. (optional)

Returns:

com.amazon.ask.model.services.datastore.v1.QueuedResultResponse

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

queuedResultV1

public QueuedResultResponse queuedResultV1(String queuedResultId,
                                           Integer maxResults,
                                           String nextToken)
                                    throws com.amazon.ask.model.services.ServiceException

Query statuses of deliveries to offline devices returned by commands API.

Specified by:

queuedResultV1 in interface DatastoreService

Parameters:

queuedResultId - A unique identifier to query result for queued delivery for offline devices (DEVICE_UNAVAILABLE). (required)

maxResults - Maximum number of CommandsDispatchResult items to return. (optional, default to 20)

nextToken - The value of nextToken in the response to fetch next page. If not specified, the request fetches result for the first page. (optional)

Returns:

com.amazon.ask.model.services.datastore.v1.QueuedResultResponse

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call