com.amazonaws.mobileconnectors.appsync

Class AWSAppSyncClient

java.lang.Object

com.amazonaws.mobileconnectors.appsync.AWSAppSyncClient

public class AWSAppSyncClient
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AWSAppSyncClient.AWSAppSyncDeltaSyncWatcher
static class	AWSAppSyncClient.Builder

Method Summary

Modifier and Type	Method and Description
static AWSAppSyncClient.Builder	builder()
void	clearCaches() Clears the different client databases on the local device which stores the following: 1) Query Cache - query responses 2) Mutation Queue - offline persistent mutations 3) Delta Sync Metadata Cache - Subscriptions Metadata If there are only on-going delta sync operations, they won't be impacted.
void	clearCaches(ClearCacheOptions clearCacheOptions) Clears the different client databases on the local device based on the ClearCacheOptions object passed in.
void	clearMutationQueue() Deprecated. Since 2.9.0. This method will be removed in the next minor version. Please use #clearCaches(ClearCacheOptions.builder() .clearMutations().build()) instead.
S3ObjectManager	getS3ObjectManager()
AppSyncStore	getStore()
boolean	isMutationQueueEmpty() Used to check if the mutation queue is empty.
<D extends Mutation.Data,T,V extends Mutation.Variables> <any>	mutate(<any> mutation)
protected <D extends Mutation.Data,T,V extends Mutation.Variables> <any>	mutate(<any> mutation, boolean isRetry)
<D extends Mutation.Data,T,V extends Mutation.Variables> <any>	mutate(<any> mutation, D withOptimisticUpdates)
protected <D extends Mutation.Data,T,V extends Mutation.Variables> <any>	mutate(<any> mutation, D withOptimisticUpdates, boolean isRetry)
<D extends Query.Data,T,V extends Query.Variables> <any>	query(<any> query)
<D extends Subscription.Data,T,V extends Subscription.Variables> <any>	subscribe(<any> subscription)
<D extends Query.Data,T,V extends Query.Variables> Cancelable	sync(<any> baseQuery, <any> baseQueryCallback, <any> deltaQuery, <any> deltaQueryCallback, long baseRefreshIntervalInSeconds) Provides the ability to sync using a baseQuery, deltaQuery, and a refresh interval
<D extends Query.Data,T,V extends Query.Variables> Cancelable	sync(<any> baseQuery, <any> baseQueryCallback, <any> subscription, AppSyncSubscriptionCall.Callback subscriptionCallback) Provides the ability to sync using a baseQuery and Subscription
<D extends Query.Data,T,V extends Query.Variables> Cancelable	sync(<any> baseQuery, <any> baseQueryCallback, <any> subscription, AppSyncSubscriptionCall.Callback subscriptionCallback, <any> deltaQuery, <any> deltaQueryCallback, long baseRefreshIntervalInSeconds) Provides the ability to sync using a baseQuery, deltaQuery, subscription, and a refresh interval
<D extends Query.Data,T,V extends Query.Variables> Cancelable	sync(<any> baseQuery, <any> baseQueryCallback, long baseRefreshIntervalInSeconds) Provides the ability to sync using a baseQuery and a refresh interval

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static AWSAppSyncClient.Builder builder()

Returns:

builder object

query

public <D extends Query.Data,T,V extends Query.Variables> <any> query(<any> query)

mutate

public <D extends Mutation.Data,T,V extends Mutation.Variables> <any> mutate(<any> mutation)

mutate

protected <D extends Mutation.Data,T,V extends Mutation.Variables> <any> mutate(<any> mutation,
                                                                                boolean isRetry)

mutate

protected <D extends Mutation.Data,T,V extends Mutation.Variables> <any> mutate(<any> mutation,
                                                                                D withOptimisticUpdates,
                                                                                boolean isRetry)

subscribe

public <D extends Subscription.Data,T,V extends Subscription.Variables> <any> subscribe(<any> subscription)

mutate

public <D extends Mutation.Data,T,V extends Mutation.Variables> <any> mutate(<any> mutation,
                                                                             D withOptimisticUpdates)

getStore

public AppSyncStore getStore()

getS3ObjectManager

public S3ObjectManager getS3ObjectManager()

sync

public <D extends Query.Data,T,V extends Query.Variables> Cancelable sync(<any> baseQuery,
                                                                          <any> baseQueryCallback,
                                                                          <any> subscription,
                                                                          AppSyncSubscriptionCall.Callback subscriptionCallback,
                                                                          <any> deltaQuery,
                                                                          <any> deltaQueryCallback,
                                                                          long baseRefreshIntervalInSeconds)

Provides the ability to sync using a baseQuery, deltaQuery, subscription, and a refresh interval

Type Parameters:

D -

T -

V -

Parameters:

baseQuery - the base query to get the baseline state

baseQueryCallback - callback to handle the baseQuery results

subscription - subscription to get changes on the fly

subscriptionCallback - callback to handle the subscription messages

deltaQuery - the catchup query

deltaQueryCallback - callback to handle the deltaQuery results

baseRefreshIntervalInSeconds - time duration (specified in seconds) when the base query will be re-run to get an updated baseline state.

Returns:

a Cancelable object that can be used later to cancel the sync operation by calling the cancel() method

sync

public <D extends Query.Data,T,V extends Query.Variables> Cancelable sync(<any> baseQuery,
                                                                          <any> baseQueryCallback,
                                                                          long baseRefreshIntervalInSeconds)

Provides the ability to sync using a baseQuery and a refresh interval

Type Parameters:

D -

T -

V -

Parameters:

baseQuery - the base query to get the baseline state

baseQueryCallback - callback to handle the baseQuery results

baseRefreshIntervalInSeconds - time duration (specified in seconds) when the base query will be re-run to get an updated baseline state.

Returns:

a Cancelable object that can be used later to cancel the sync operation by calling the cancel() method

sync

public <D extends Query.Data,T,V extends Query.Variables> Cancelable sync(<any> baseQuery,
                                                                          <any> baseQueryCallback,
                                                                          <any> deltaQuery,
                                                                          <any> deltaQueryCallback,
                                                                          long baseRefreshIntervalInSeconds)

Provides the ability to sync using a baseQuery, deltaQuery, and a refresh interval

Type Parameters:

D -

T -

V -

Parameters:

baseQuery - the base query to get the baseline state

baseQueryCallback - callback to handle the baseQuery results

deltaQuery - the catchup query

deltaQueryCallback - callback to handle the deltaQuery results

baseRefreshIntervalInSeconds - time duration (specified in seconds) when the base query will be re-run to get an updated baseline state.

Returns:

a Cancelable object that can be used later to cancel the sync operation by calling the cancel() method

sync

public <D extends Query.Data,T,V extends Query.Variables> Cancelable sync(<any> baseQuery,
                                                                          <any> baseQueryCallback,
                                                                          <any> subscription,
                                                                          AppSyncSubscriptionCall.Callback subscriptionCallback)

Provides the ability to sync using a baseQuery and Subscription

Type Parameters:

D -

T -

V -

Parameters:

baseQuery - the base query to get the baseline state

baseQueryCallback - callback to handle the baseQuery results

subscription - subscription to get changes on the fly

subscriptionCallback - callback to handle the subscription messages

Returns:

a Cancelable object that can be used later to cancel the sync operation by calling the cancel() method

isMutationQueueEmpty

public boolean isMutationQueueEmpty()

Used to check if the mutation queue is empty.

Returns:

true if queue is empty, false otherwise.

clearMutationQueue

@Deprecated
public void clearMutationQueue()

Deprecated. Since 2.9.0. This method will be removed in the next minor version. Please use #clearCaches(ClearCacheOptions.builder() .clearMutations().build()) instead.

Clear the mutation queue. A Mutation that is currently in progress will continue to execute until finished.

clearCaches

public void clearCaches()
                 throws ClearCacheException

Clears the different client databases on the local device which stores the following: 1) Query Cache - query responses 2) Mutation Queue - offline persistent mutations 3) Delta Sync Metadata Cache - Subscriptions Metadata If there are only on-going delta sync operations, they won't be impacted.

Throws:

ClearCacheException

clearCaches

public void clearCaches(ClearCacheOptions clearCacheOptions)
                 throws ClearCacheException

Clears the different client databases on the local device based on the ClearCacheOptions object passed in. 1) ClearCacheOptions#clearQueries - Query Cache - query responses 2) ClearCacheOptions#clearMutations - Mutation Queue - offline persistent mutations 3) ClearCacheOptions#clearSubscriptions - Delta Sync Metadata Cache - Subscriptions Metadata If there are only on-going delta sync operations, it is recommended to cancel those operations before calling clearCaches.

Throws:

ClearCacheException