com.amazonaws.services.braket

Class AWSBraketAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.braket.AWSBraketClient

com.amazonaws.services.braket.AWSBraketAsyncClient

All Implemented Interfaces:

AWSBraket, AWSBraketAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSBraketAsyncClient
extends AWSBraketClient
implements AWSBraketAsync

Client for accessing Braket asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.

Field Summary

Fields inherited from class com.amazonaws.services.braket.AWSBraketClient

configFactory

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.braket.AWSBraket

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSBraketAsyncClientBuilder	asyncBuilder()
Future<CancelQuantumTaskResult>	cancelQuantumTaskAsync(CancelQuantumTaskRequest request) Cancels the specified task.
Future<CancelQuantumTaskResult>	cancelQuantumTaskAsync(CancelQuantumTaskRequest request, AsyncHandler<CancelQuantumTaskRequest,CancelQuantumTaskResult> asyncHandler) Cancels the specified task.
Future<CreateQuantumTaskResult>	createQuantumTaskAsync(CreateQuantumTaskRequest request) Creates a quantum task.
Future<CreateQuantumTaskResult>	createQuantumTaskAsync(CreateQuantumTaskRequest request, AsyncHandler<CreateQuantumTaskRequest,CreateQuantumTaskResult> asyncHandler) Creates a quantum task.
Future<GetDeviceResult>	getDeviceAsync(GetDeviceRequest request) Retrieves the devices available in Amazon Braket.
Future<GetDeviceResult>	getDeviceAsync(GetDeviceRequest request, AsyncHandler<GetDeviceRequest,GetDeviceResult> asyncHandler) Retrieves the devices available in Amazon Braket.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetQuantumTaskResult>	getQuantumTaskAsync(GetQuantumTaskRequest request) Retrieves the specified quantum task.
Future<GetQuantumTaskResult>	getQuantumTaskAsync(GetQuantumTaskRequest request, AsyncHandler<GetQuantumTaskRequest,GetQuantumTaskResult> asyncHandler) Retrieves the specified quantum task.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request) Shows the tags associated with this resource.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) Shows the tags associated with this resource.
Future<SearchDevicesResult>	searchDevicesAsync(SearchDevicesRequest request) Searches for devices using the specified filters.
Future<SearchDevicesResult>	searchDevicesAsync(SearchDevicesRequest request, AsyncHandler<SearchDevicesRequest,SearchDevicesResult> asyncHandler) Searches for devices using the specified filters.
Future<SearchQuantumTasksResult>	searchQuantumTasksAsync(SearchQuantumTasksRequest request) Searches for tasks that match the specified filter values.
Future<SearchQuantumTasksResult>	searchQuantumTasksAsync(SearchQuantumTasksRequest request, AsyncHandler<SearchQuantumTasksRequest,SearchQuantumTasksResult> asyncHandler) Searches for tasks that match the specified filter values.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request) Add a tag to the specified resource.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler) Add a tag to the specified resource.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request) Remove tags from a resource.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler) Remove tags from a resource.

Methods inherited from class com.amazonaws.services.braket.AWSBraketClient

builder, cancelQuantumTask, createQuantumTask, getCachedResponseMetadata, getDevice, getQuantumTask, listTagsForResource, searchDevices, searchQuantumTasks, tagResource, untagResource

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.braket.AWSBraket

cancelQuantumTask, createQuantumTask, getCachedResponseMetadata, getDevice, getQuantumTask, listTagsForResource, searchDevices, searchQuantumTasks, tagResource, untagResource

Method Detail

asyncBuilder

public static AWSBraketAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

cancelQuantumTaskAsync

public Future<CancelQuantumTaskResult> cancelQuantumTaskAsync(CancelQuantumTaskRequest request)

Description copied from interface: AWSBraketAsync

Cancels the specified task.

Specified by:

cancelQuantumTaskAsync in interface AWSBraketAsync

Returns:

A Java Future containing the result of the CancelQuantumTask operation returned by the service.

See Also:

AWS API Documentation

cancelQuantumTaskAsync

public Future<CancelQuantumTaskResult> cancelQuantumTaskAsync(CancelQuantumTaskRequest request,
                                                              AsyncHandler<CancelQuantumTaskRequest,CancelQuantumTaskResult> asyncHandler)

Description copied from interface: AWSBraketAsync

Cancels the specified task.

Specified by:

cancelQuantumTaskAsync in interface AWSBraketAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CancelQuantumTask operation returned by the service.

See Also:

AWS API Documentation

createQuantumTaskAsync

public Future<CreateQuantumTaskResult> createQuantumTaskAsync(CreateQuantumTaskRequest request)

Description copied from interface: AWSBraketAsync

Creates a quantum task.

Specified by:

createQuantumTaskAsync in interface AWSBraketAsync

Returns:

A Java Future containing the result of the CreateQuantumTask operation returned by the service.

See Also:

AWS API Documentation

createQuantumTaskAsync

public Future<CreateQuantumTaskResult> createQuantumTaskAsync(CreateQuantumTaskRequest request,
                                                              AsyncHandler<CreateQuantumTaskRequest,CreateQuantumTaskResult> asyncHandler)

Description copied from interface: AWSBraketAsync

Creates a quantum task.

Specified by:

createQuantumTaskAsync in interface AWSBraketAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateQuantumTask operation returned by the service.

See Also:

AWS API Documentation

getDeviceAsync

public Future<GetDeviceResult> getDeviceAsync(GetDeviceRequest request)

Description copied from interface: AWSBraketAsync

Retrieves the devices available in Amazon Braket.

Specified by:

getDeviceAsync in interface AWSBraketAsync

Returns:

A Java Future containing the result of the GetDevice operation returned by the service.

See Also:

AWS API Documentation

getDeviceAsync

public Future<GetDeviceResult> getDeviceAsync(GetDeviceRequest request,
                                              AsyncHandler<GetDeviceRequest,GetDeviceResult> asyncHandler)

Description copied from interface: AWSBraketAsync

Retrieves the devices available in Amazon Braket.

Specified by:

getDeviceAsync in interface AWSBraketAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetDevice operation returned by the service.

See Also:

AWS API Documentation

getQuantumTaskAsync

public Future<GetQuantumTaskResult> getQuantumTaskAsync(GetQuantumTaskRequest request)

Description copied from interface: AWSBraketAsync

Retrieves the specified quantum task.

Specified by:

getQuantumTaskAsync in interface AWSBraketAsync

Returns:

A Java Future containing the result of the GetQuantumTask operation returned by the service.

See Also:

AWS API Documentation

getQuantumTaskAsync

public Future<GetQuantumTaskResult> getQuantumTaskAsync(GetQuantumTaskRequest request,
                                                        AsyncHandler<GetQuantumTaskRequest,GetQuantumTaskResult> asyncHandler)

Description copied from interface: AWSBraketAsync

Retrieves the specified quantum task.

Specified by:

getQuantumTaskAsync in interface AWSBraketAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetQuantumTask operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)

Description copied from interface: AWSBraketAsync

Shows the tags associated with this resource.

Specified by:

listTagsForResourceAsync in interface AWSBraketAsync

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request,
                                                                  AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)

Description copied from interface: AWSBraketAsync

Shows the tags associated with this resource.

Specified by:

listTagsForResourceAsync in interface AWSBraketAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

searchDevicesAsync

public Future<SearchDevicesResult> searchDevicesAsync(SearchDevicesRequest request)

Description copied from interface: AWSBraketAsync

Searches for devices using the specified filters.

Specified by:

searchDevicesAsync in interface AWSBraketAsync

Returns:

A Java Future containing the result of the SearchDevices operation returned by the service.

See Also:

AWS API Documentation

searchDevicesAsync

public Future<SearchDevicesResult> searchDevicesAsync(SearchDevicesRequest request,
                                                      AsyncHandler<SearchDevicesRequest,SearchDevicesResult> asyncHandler)

Description copied from interface: AWSBraketAsync

Searches for devices using the specified filters.

Specified by:

searchDevicesAsync in interface AWSBraketAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the SearchDevices operation returned by the service.

See Also:

AWS API Documentation

searchQuantumTasksAsync

public Future<SearchQuantumTasksResult> searchQuantumTasksAsync(SearchQuantumTasksRequest request)

Description copied from interface: AWSBraketAsync

Searches for tasks that match the specified filter values.

Specified by:

searchQuantumTasksAsync in interface AWSBraketAsync

Returns:

A Java Future containing the result of the SearchQuantumTasks operation returned by the service.

See Also:

AWS API Documentation

searchQuantumTasksAsync

public Future<SearchQuantumTasksResult> searchQuantumTasksAsync(SearchQuantumTasksRequest request,
                                                                AsyncHandler<SearchQuantumTasksRequest,SearchQuantumTasksResult> asyncHandler)

Description copied from interface: AWSBraketAsync

Searches for tasks that match the specified filter values.

Specified by:

searchQuantumTasksAsync in interface AWSBraketAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the SearchQuantumTasks operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)

Description copied from interface: AWSBraketAsync

Add a tag to the specified resource.

Specified by:

tagResourceAsync in interface AWSBraketAsync

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request,
                                                  AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)

Description copied from interface: AWSBraketAsync

Add a tag to the specified resource.

Specified by:

tagResourceAsync in interface AWSBraketAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)

Description copied from interface: AWSBraketAsync

Remove tags from a resource.

Specified by:

untagResourceAsync in interface AWSBraketAsync

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request,
                                                      AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)

Description copied from interface: AWSBraketAsync

Remove tags from a resource.

Specified by:

untagResourceAsync in interface AWSBraketAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSBraket

Overrides:

shutdown in class AWSBraketClient