com.ibm.cos.v2.http.async

Interface SdkAsyncHttpClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

All Known Implementing Classes:

AwsCrtAsyncHttpClient, NettyNioAsyncHttpClient, SdkDefaultClientBuilder.NonManagedSdkAsyncHttpClient

@Immutable
 @ThreadSafe
public interface SdkAsyncHttpClient
extends SdkAutoCloseable

Interface to take a representation of an HTTP request, asynchronously make an HTTP call, and return a representation of an HTTP response.

Implementations MUST be thread safe.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SdkAsyncHttpClient.Builder<T extends SdkAsyncHttpClient.Builder<T>>

Method Summary

Modifier and Type	Method and Description
default String	clientName() Each HTTP client implementation should return a well-formed client name that allows requests to be identifiable back to the client that made the request.
CompletableFuture<Void>	execute(AsyncExecuteRequest request) Execute the request.

Methods inherited from interface com.ibm.cos.v2.utils.SdkAutoCloseable

close

Method Detail

execute

CompletableFuture<Void> execute(AsyncExecuteRequest request)

Execute the request.

Parameters:

request - The request object.

Returns:

The future holding the result of the request execution. Upon success execution of the request, the future is completed with null, otherwise it is completed exceptionally.

clientName

default String clientName()

Each HTTP client implementation should return a well-formed client name that allows requests to be identifiable back to the client that made the request. The client name should include the backing implementation as well as the Sync or Async to identify the transmission type of the request. Client names should only include alphanumeric characters. Examples of well formed client names include, Apache, for requests using Apache's http client or NettyNio for Netty's http client.

Returns:

String containing the name of the client