com.amazonaws.mobileconnectors.appsync

Class AWSAppSyncClient.Builder

java.lang.Object

com.amazonaws.mobileconnectors.appsync.AWSAppSyncClient.Builder

Enclosing class:

AWSAppSyncClient

public static class AWSAppSyncClient.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
<T> AWSAppSyncClient.Builder	addCustomTypeAdapter(ScalarType scalarType, <any> customTypeAdapter)
AWSAppSyncClient.Builder	apiKey(APIKeyAuthProvider apiKey)
AWSAppSyncClient.Builder	awsConfiguration(AWSConfiguration awsConfiguration) Read the AppSync section of the awsconfiguration.json file and populate the serverUrl and region variables from the ApiUrl and Region keys.
AWSAppSyncClient	build() Extract the parameters from the AWSAppSyncClient.Builder object and create the AWSAppSyncClient object.
AWSAppSyncClient.Builder	clientDatabasePrefix(java.lang.String clientDatabasePrefix) Specify a name that uniquely identifies the AWSAppSyncClient object.
AWSAppSyncClient.Builder	cognitoUserPoolsAuthProvider(CognitoUserPoolsAuthProvider cognitoUserPoolsAuthProvider)
AWSAppSyncClient.Builder	conflictResolver(ConflictResolverInterface conflictResolver)
AWSAppSyncClient.Builder	context(android.content.Context context)
AWSAppSyncClient.Builder	credentialsProvider(AWSCredentialsProvider credentialsProvider)
AWSAppSyncClient.Builder	defaultCacheHeaders(CacheHeaders cacheHeaders)
AWSAppSyncClient.Builder	defaultResponseFetcher(ResponseFetcher defaultResponseFetcher)
AWSAppSyncClient.Builder	dispatcher(java.util.concurrent.Executor dispatcher)
AWSAppSyncClient.Builder	mutationQueueExecutionTimeout(long mutationQueueExecutionTimeout) Specify the maximum duration for which a mutation will be allowed to execute before it is evicted from the Mutation queue.
AWSAppSyncClient.Builder	normalizedCache(NormalizedCacheFactory normalizedCacheFactory)
AWSAppSyncClient.Builder	oidcAuthProvider(OidcAuthProvider oidcAuthProvider)
AWSAppSyncClient.Builder	okHttpClient(OkHttpClient okHttpClient)
AWSAppSyncClient.Builder	persistentMutationsCallback(PersistentMutationsCallback persistentMutationsCallback)
AWSAppSyncClient.Builder	region(Regions region)
AWSAppSyncClient.Builder	resolver(CacheKeyResolver resolver)
AWSAppSyncClient.Builder	s3ObjectManager(S3ObjectManager s3ObjectManager)
AWSAppSyncClient.Builder	serverUrl(java.lang.String serverUrl)
AWSAppSyncClient.Builder	subscriptionsAutoReconnect(boolean subscriptionsAutoReconnect) Specify automatic reconnection for Subscriptions in case of errors.
AWSAppSyncClient.Builder	useClientDatabasePrefix(boolean useClientDatabasePrefix) Flag if true will use the ClientDatabasePrefix passed in through the awsconfiguration.json or from the #clientDatabasePrefix builder.

Methods inherited from class java.lang.Object

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

Method Detail

region

public AWSAppSyncClient.Builder region(Regions region)

credentialsProvider

public AWSAppSyncClient.Builder credentialsProvider(AWSCredentialsProvider credentialsProvider)

apiKey

public AWSAppSyncClient.Builder apiKey(APIKeyAuthProvider apiKey)

cognitoUserPoolsAuthProvider

public AWSAppSyncClient.Builder cognitoUserPoolsAuthProvider(CognitoUserPoolsAuthProvider cognitoUserPoolsAuthProvider)

oidcAuthProvider

public AWSAppSyncClient.Builder oidcAuthProvider(OidcAuthProvider oidcAuthProvider)

serverUrl

public AWSAppSyncClient.Builder serverUrl(java.lang.String serverUrl)

context

public AWSAppSyncClient.Builder context(android.content.Context context)

s3ObjectManager

public AWSAppSyncClient.Builder s3ObjectManager(S3ObjectManager s3ObjectManager)

normalizedCache

public AWSAppSyncClient.Builder normalizedCache(NormalizedCacheFactory normalizedCacheFactory)

resolver

public AWSAppSyncClient.Builder resolver(CacheKeyResolver resolver)

conflictResolver

public AWSAppSyncClient.Builder conflictResolver(ConflictResolverInterface conflictResolver)

addCustomTypeAdapter

public <T> AWSAppSyncClient.Builder addCustomTypeAdapter(ScalarType scalarType,
                                                         <any> customTypeAdapter)

dispatcher

public AWSAppSyncClient.Builder dispatcher(java.util.concurrent.Executor dispatcher)

defaultCacheHeaders

public AWSAppSyncClient.Builder defaultCacheHeaders(CacheHeaders cacheHeaders)

okHttpClient

public AWSAppSyncClient.Builder okHttpClient(OkHttpClient okHttpClient)

defaultResponseFetcher

public AWSAppSyncClient.Builder defaultResponseFetcher(ResponseFetcher defaultResponseFetcher)

persistentMutationsCallback

public AWSAppSyncClient.Builder persistentMutationsCallback(PersistentMutationsCallback persistentMutationsCallback)

awsConfiguration

public AWSAppSyncClient.Builder awsConfiguration(AWSConfiguration awsConfiguration)

Read the AppSync section of the awsconfiguration.json file and populate the serverUrl and region variables from the ApiUrl and Region keys. The AuthMode specified in the file will be used to validate the Authentication mechanism chosen during the object construction. Example: API_KEY

"AppSync": { "Default": { "ApiUrl": "https://xxxx.appsync-api..amazonaws.com/graphql", "Region": "us-east-1", "ApiKey": "da2-yyyy", "AuthMode": "API_KEY" } }

Usage: .awsConfiguration(new AWSConfiguration(getApplicationContext())

Parameters:

awsConfiguration - The object representing the configuration information from awsconfiguration.json

Returns:

the builder object

subscriptionsAutoReconnect

public AWSAppSyncClient.Builder subscriptionsAutoReconnect(boolean subscriptionsAutoReconnect)

Specify automatic reconnection for Subscriptions in case of errors. Reconnection is enabled by default.

Parameters:

subscriptionsAutoReconnect - true to to enable and false to disable automatic reconnection of subscriptions.

Returns:

the builder object

mutationQueueExecutionTimeout

public AWSAppSyncClient.Builder mutationQueueExecutionTimeout(long mutationQueueExecutionTimeout)

Specify the maximum duration for which a mutation will be allowed to execute before it is evicted from the Mutation queue. Default value is 5 minutes. Note that this limit is for execution time - the mutation can wait in the queue for its turn to be processed independent of this limit.

Parameters:

mutationQueueExecutionTimeout - the max execution time allowed.

Returns:

the builder object

useClientDatabasePrefix

public AWSAppSyncClient.Builder useClientDatabasePrefix(boolean useClientDatabasePrefix)

Flag if true will use the ClientDatabasePrefix passed in through the awsconfiguration.json or from the #clientDatabasePrefix builder.

Parameters:

useClientDatabasePrefix - use a prefix for the client databases.

Returns:

the builder object.

clientDatabasePrefix

public AWSAppSyncClient.Builder clientDatabasePrefix(java.lang.String clientDatabasePrefix)

Specify a name that uniquely identifies the AWSAppSyncClient object.

Parameters:

clientDatabasePrefix - prefix used for the database names.

Returns:

the builder object.

build

public AWSAppSyncClient build()

Extract the parameters from the AWSAppSyncClient.Builder object and create the AWSAppSyncClient object.

Returns:

AWSAppSyncClient object built from AWSAppSyncClient.Builder