com.amazonaws.services.artifact

Class AWSArtifactAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.artifact.AWSArtifactClient

com.amazonaws.services.artifact.AWSArtifactAsyncClient

All Implemented Interfaces:

AWSArtifact, AWSArtifactAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSArtifactAsyncClient
extends AWSArtifactClient
implements AWSArtifactAsync

Client for accessing AWS Artifact 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.

This reference provides descriptions of the low-level AWS Artifact Service API.

Field Summary

Fields inherited from class com.amazonaws.services.artifact.AWSArtifactClient

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.artifact.AWSArtifact

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSArtifactAsyncClientBuilder	asyncBuilder()
Future<GetAccountSettingsResult>	getAccountSettingsAsync(GetAccountSettingsRequest request) Get the account settings for Artifact.
Future<GetAccountSettingsResult>	getAccountSettingsAsync(GetAccountSettingsRequest request, AsyncHandler<GetAccountSettingsRequest,GetAccountSettingsResult> asyncHandler) Get the account settings for Artifact.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetReportResult>	getReportAsync(GetReportRequest request) Get the content for a single report.
Future<GetReportResult>	getReportAsync(GetReportRequest request, AsyncHandler<GetReportRequest,GetReportResult> asyncHandler) Get the content for a single report.
Future<GetReportMetadataResult>	getReportMetadataAsync(GetReportMetadataRequest request) Get the metadata for a single report.
Future<GetReportMetadataResult>	getReportMetadataAsync(GetReportMetadataRequest request, AsyncHandler<GetReportMetadataRequest,GetReportMetadataResult> asyncHandler) Get the metadata for a single report.
Future<GetTermForReportResult>	getTermForReportAsync(GetTermForReportRequest request) Get the Term content associated with a single report.
Future<GetTermForReportResult>	getTermForReportAsync(GetTermForReportRequest request, AsyncHandler<GetTermForReportRequest,GetTermForReportResult> asyncHandler) Get the Term content associated with a single report.
Future<ListReportsResult>	listReportsAsync(ListReportsRequest request) List available reports.
Future<ListReportsResult>	listReportsAsync(ListReportsRequest request, AsyncHandler<ListReportsRequest,ListReportsResult> asyncHandler) List available reports.
Future<PutAccountSettingsResult>	putAccountSettingsAsync(PutAccountSettingsRequest request) Put the account settings for Artifact.
Future<PutAccountSettingsResult>	putAccountSettingsAsync(PutAccountSettingsRequest request, AsyncHandler<PutAccountSettingsRequest,PutAccountSettingsResult> asyncHandler) Put the account settings for Artifact.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.artifact.AWSArtifactClient

builder, getAccountSettings, getCachedResponseMetadata, getReport, getReportMetadata, getTermForReport, listReports, putAccountSettings

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.artifact.AWSArtifact

getAccountSettings, getCachedResponseMetadata, getReport, getReportMetadata, getTermForReport, listReports, putAccountSettings

Method Detail

asyncBuilder

public static AWSArtifactAsyncClientBuilder 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.

getAccountSettingsAsync

public Future<GetAccountSettingsResult> getAccountSettingsAsync(GetAccountSettingsRequest request)

Description copied from interface: AWSArtifactAsync

Get the account settings for Artifact.

Specified by:

getAccountSettingsAsync in interface AWSArtifactAsync

Returns:

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

See Also:

AWS API Documentation

getAccountSettingsAsync

public Future<GetAccountSettingsResult> getAccountSettingsAsync(GetAccountSettingsRequest request,
                                                                AsyncHandler<GetAccountSettingsRequest,GetAccountSettingsResult> asyncHandler)

Description copied from interface: AWSArtifactAsync

Get the account settings for Artifact.

Specified by:

getAccountSettingsAsync in interface AWSArtifactAsync

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 GetAccountSettings operation returned by the service.

See Also:

AWS API Documentation

getReportAsync

public Future<GetReportResult> getReportAsync(GetReportRequest request)

Description copied from interface: AWSArtifactAsync

Get the content for a single report.

Specified by:

getReportAsync in interface AWSArtifactAsync

Returns:

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

See Also:

AWS API Documentation

getReportAsync

public Future<GetReportResult> getReportAsync(GetReportRequest request,
                                              AsyncHandler<GetReportRequest,GetReportResult> asyncHandler)

Description copied from interface: AWSArtifactAsync

Get the content for a single report.

Specified by:

getReportAsync in interface AWSArtifactAsync

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 GetReport operation returned by the service.

See Also:

AWS API Documentation

getReportMetadataAsync

public Future<GetReportMetadataResult> getReportMetadataAsync(GetReportMetadataRequest request)

Description copied from interface: AWSArtifactAsync

Get the metadata for a single report.

Specified by:

getReportMetadataAsync in interface AWSArtifactAsync

Returns:

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

See Also:

AWS API Documentation

getReportMetadataAsync

public Future<GetReportMetadataResult> getReportMetadataAsync(GetReportMetadataRequest request,
                                                              AsyncHandler<GetReportMetadataRequest,GetReportMetadataResult> asyncHandler)

Description copied from interface: AWSArtifactAsync

Get the metadata for a single report.

Specified by:

getReportMetadataAsync in interface AWSArtifactAsync

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 GetReportMetadata operation returned by the service.

See Also:

AWS API Documentation

getTermForReportAsync

public Future<GetTermForReportResult> getTermForReportAsync(GetTermForReportRequest request)

Description copied from interface: AWSArtifactAsync

Get the Term content associated with a single report.

Specified by:

getTermForReportAsync in interface AWSArtifactAsync

Returns:

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

See Also:

AWS API Documentation

getTermForReportAsync

public Future<GetTermForReportResult> getTermForReportAsync(GetTermForReportRequest request,
                                                            AsyncHandler<GetTermForReportRequest,GetTermForReportResult> asyncHandler)

Description copied from interface: AWSArtifactAsync

Get the Term content associated with a single report.

Specified by:

getTermForReportAsync in interface AWSArtifactAsync

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 GetTermForReport operation returned by the service.

See Also:

AWS API Documentation

listReportsAsync

public Future<ListReportsResult> listReportsAsync(ListReportsRequest request)

Description copied from interface: AWSArtifactAsync

List available reports.

Specified by:

listReportsAsync in interface AWSArtifactAsync

Returns:

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

See Also:

AWS API Documentation

listReportsAsync

public Future<ListReportsResult> listReportsAsync(ListReportsRequest request,
                                                  AsyncHandler<ListReportsRequest,ListReportsResult> asyncHandler)

Description copied from interface: AWSArtifactAsync

List available reports.

Specified by:

listReportsAsync in interface AWSArtifactAsync

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 ListReports operation returned by the service.

See Also:

AWS API Documentation

putAccountSettingsAsync

public Future<PutAccountSettingsResult> putAccountSettingsAsync(PutAccountSettingsRequest request)

Description copied from interface: AWSArtifactAsync

Put the account settings for Artifact.

Specified by:

putAccountSettingsAsync in interface AWSArtifactAsync

Returns:

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

See Also:

AWS API Documentation

putAccountSettingsAsync

public Future<PutAccountSettingsResult> putAccountSettingsAsync(PutAccountSettingsRequest request,
                                                                AsyncHandler<PutAccountSettingsRequest,PutAccountSettingsResult> asyncHandler)

Description copied from interface: AWSArtifactAsync

Put the account settings for Artifact.

Specified by:

putAccountSettingsAsync in interface AWSArtifactAsync

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 PutAccountSettings 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 AWSArtifact

Overrides:

shutdown in class AWSArtifactClient