com.amazonaws.services.mediatailor

Class AWSMediaTailorAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.mediatailor.AWSMediaTailorClient

com.amazonaws.services.mediatailor.AWSMediaTailorAsyncClient

All Implemented Interfaces:

AWSMediaTailor, AWSMediaTailorAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSMediaTailorAsyncClient
extends AWSMediaTailorClient
implements AWSMediaTailorAsync

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

Use the AWS Elemental MediaTailor SDK to configure scalable ad insertion for your live and VOD content. With AWS Elemental MediaTailor, you can serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the AWS Elemental MediaTailor User Guide.

Through the SDK, you manage AWS Elemental MediaTailor configurations the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).

Field Summary

Fields inherited from class com.amazonaws.services.mediatailor.AWSMediaTailorClient

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.mediatailor.AWSMediaTailor

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSMediaTailorAsyncClientBuilder	asyncBuilder()
Future<DeletePlaybackConfigurationResult>	deletePlaybackConfigurationAsync(DeletePlaybackConfigurationRequest request) Deletes the playback configuration for the specified name.
Future<DeletePlaybackConfigurationResult>	deletePlaybackConfigurationAsync(DeletePlaybackConfigurationRequest request, AsyncHandler<DeletePlaybackConfigurationRequest,DeletePlaybackConfigurationResult> asyncHandler) Deletes the playback configuration for the specified name.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetPlaybackConfigurationResult>	getPlaybackConfigurationAsync(GetPlaybackConfigurationRequest request) Returns the playback configuration for the specified name.
Future<GetPlaybackConfigurationResult>	getPlaybackConfigurationAsync(GetPlaybackConfigurationRequest request, AsyncHandler<GetPlaybackConfigurationRequest,GetPlaybackConfigurationResult> asyncHandler) Returns the playback configuration for the specified name.
Future<ListPlaybackConfigurationsResult>	listPlaybackConfigurationsAsync(ListPlaybackConfigurationsRequest request) Returns a list of the playback configurations defined in AWS Elemental MediaTailor.
Future<ListPlaybackConfigurationsResult>	listPlaybackConfigurationsAsync(ListPlaybackConfigurationsRequest request, AsyncHandler<ListPlaybackConfigurationsRequest,ListPlaybackConfigurationsResult> asyncHandler) Returns a list of the playback configurations defined in AWS Elemental MediaTailor.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request) Returns a list of the tags assigned to the specified playback configuration resource.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) Returns a list of the tags assigned to the specified playback configuration resource.
Future<PutPlaybackConfigurationResult>	putPlaybackConfigurationAsync(PutPlaybackConfigurationRequest request) Adds a new playback configuration to AWS Elemental MediaTailor.
Future<PutPlaybackConfigurationResult>	putPlaybackConfigurationAsync(PutPlaybackConfigurationRequest request, AsyncHandler<PutPlaybackConfigurationRequest,PutPlaybackConfigurationResult> asyncHandler) Adds a new playback configuration to AWS Elemental MediaTailor.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request) Adds tags to the specified playback configuration resource.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler) Adds tags to the specified playback configuration resource.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request) Removes tags from the specified playback configuration resource.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler) Removes tags from the specified playback configuration resource.

Methods inherited from class com.amazonaws.services.mediatailor.AWSMediaTailorClient

builder, deletePlaybackConfiguration, getCachedResponseMetadata, getPlaybackConfiguration, listPlaybackConfigurations, listTagsForResource, putPlaybackConfiguration, 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.mediatailor.AWSMediaTailor

deletePlaybackConfiguration, getCachedResponseMetadata, getPlaybackConfiguration, listPlaybackConfigurations, listTagsForResource, putPlaybackConfiguration, tagResource, untagResource

Method Detail

asyncBuilder

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

deletePlaybackConfigurationAsync

public Future<DeletePlaybackConfigurationResult> deletePlaybackConfigurationAsync(DeletePlaybackConfigurationRequest request)

Description copied from interface: AWSMediaTailorAsync

Deletes the playback configuration for the specified name.

Specified by:

deletePlaybackConfigurationAsync in interface AWSMediaTailorAsync

Returns:

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

See Also:

AWS API Documentation

deletePlaybackConfigurationAsync

public Future<DeletePlaybackConfigurationResult> deletePlaybackConfigurationAsync(DeletePlaybackConfigurationRequest request,
                                                                                  AsyncHandler<DeletePlaybackConfigurationRequest,DeletePlaybackConfigurationResult> asyncHandler)

Description copied from interface: AWSMediaTailorAsync

Deletes the playback configuration for the specified name.

Specified by:

deletePlaybackConfigurationAsync in interface AWSMediaTailorAsync

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

See Also:

AWS API Documentation

getPlaybackConfigurationAsync

public Future<GetPlaybackConfigurationResult> getPlaybackConfigurationAsync(GetPlaybackConfigurationRequest request)

Description copied from interface: AWSMediaTailorAsync

Returns the playback configuration for the specified name.

Specified by:

getPlaybackConfigurationAsync in interface AWSMediaTailorAsync

Returns:

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

See Also:

AWS API Documentation

getPlaybackConfigurationAsync

public Future<GetPlaybackConfigurationResult> getPlaybackConfigurationAsync(GetPlaybackConfigurationRequest request,
                                                                            AsyncHandler<GetPlaybackConfigurationRequest,GetPlaybackConfigurationResult> asyncHandler)

Description copied from interface: AWSMediaTailorAsync

Returns the playback configuration for the specified name.

Specified by:

getPlaybackConfigurationAsync in interface AWSMediaTailorAsync

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

See Also:

AWS API Documentation

listPlaybackConfigurationsAsync

public Future<ListPlaybackConfigurationsResult> listPlaybackConfigurationsAsync(ListPlaybackConfigurationsRequest request)

Description copied from interface: AWSMediaTailorAsync

Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful.

Specified by:

listPlaybackConfigurationsAsync in interface AWSMediaTailorAsync

Returns:

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

See Also:

AWS API Documentation

listPlaybackConfigurationsAsync

public Future<ListPlaybackConfigurationsResult> listPlaybackConfigurationsAsync(ListPlaybackConfigurationsRequest request,
                                                                                AsyncHandler<ListPlaybackConfigurationsRequest,ListPlaybackConfigurationsResult> asyncHandler)

Description copied from interface: AWSMediaTailorAsync

Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful.

Specified by:

listPlaybackConfigurationsAsync in interface AWSMediaTailorAsync

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

See Also:

AWS API Documentation

listTagsForResourceAsync

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)

Description copied from interface: AWSMediaTailorAsync

Returns a list of the tags assigned to the specified playback configuration resource.

Specified by:

listTagsForResourceAsync in interface AWSMediaTailorAsync

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: AWSMediaTailorAsync

Returns a list of the tags assigned to the specified playback configuration resource.

Specified by:

listTagsForResourceAsync in interface AWSMediaTailorAsync

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

putPlaybackConfigurationAsync

public Future<PutPlaybackConfigurationResult> putPlaybackConfigurationAsync(PutPlaybackConfigurationRequest request)

Description copied from interface: AWSMediaTailorAsync

Adds a new playback configuration to AWS Elemental MediaTailor.

Specified by:

putPlaybackConfigurationAsync in interface AWSMediaTailorAsync

Returns:

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

See Also:

AWS API Documentation

putPlaybackConfigurationAsync

public Future<PutPlaybackConfigurationResult> putPlaybackConfigurationAsync(PutPlaybackConfigurationRequest request,
                                                                            AsyncHandler<PutPlaybackConfigurationRequest,PutPlaybackConfigurationResult> asyncHandler)

Description copied from interface: AWSMediaTailorAsync

Adds a new playback configuration to AWS Elemental MediaTailor.

Specified by:

putPlaybackConfigurationAsync in interface AWSMediaTailorAsync

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

See Also:

AWS API Documentation

tagResourceAsync

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)

Description copied from interface: AWSMediaTailorAsync

Adds tags to the specified playback configuration resource. You can specify one or more tags to add.

Specified by:

tagResourceAsync in interface AWSMediaTailorAsync

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: AWSMediaTailorAsync

Adds tags to the specified playback configuration resource. You can specify one or more tags to add.

Specified by:

tagResourceAsync in interface AWSMediaTailorAsync

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: AWSMediaTailorAsync

Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.

Specified by:

untagResourceAsync in interface AWSMediaTailorAsync

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: AWSMediaTailorAsync

Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.

Specified by:

untagResourceAsync in interface AWSMediaTailorAsync

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 AWSMediaTailor

Overrides:

shutdown in class AmazonWebServiceClient