Package software.amazon.awssdk.core.client.handler

Class ClientExecutionParams<InputT extends SdkRequest,OutputT>

java.lang.Object

software.amazon.awssdk.core.client.handler.ClientExecutionParams<InputT,OutputT>

Type Parameters:

InputT - Input POJO type.

OutputT - Output POJO type.

@NotThreadSafe
public final class ClientExecutionParams<InputT extends SdkRequest,OutputT>
extends Object

Encapsulates parameters needed for a particular API call. Captures input and output pojo types.

Constructor Summary

Constructors

Constructor	Description
ClientExecutionParams()

Method Summary

Modifier and Type	Method	Description
CredentialType	credentialType()
ClientExecutionParams<InputT,OutputT>	credentialType(CredentialType credentialType)
URI	discoveredEndpoint()
ClientExecutionParams<InputT,OutputT>	discoveredEndpoint(URI discoveredEndpoint)
ExecutionAttributes	executionAttributes()
AsyncRequestBody	getAsyncRequestBody()
HttpResponseHandler<Response<OutputT>>	getCombinedResponseHandler()	Non-streaming requests can use handlers that handle both error and success as a single handler instead of submitting individual success and error handlers.
HttpResponseHandler<? extends SdkException>	getErrorResponseHandler()
InputT	getInput()
Marshaller<InputT>	getMarshaller()
MetricCollector	getMetricCollector()
String	getOperationName()
SdkProtocolMetadata	getProtocolMetadata()
RequestBody	getRequestBody()
HttpResponseHandler<OutputT>	getResponseHandler()
boolean	hasInitialRequestEvent()
String	hostPrefixExpression()
ClientExecutionParams<InputT,OutputT>	hostPrefixExpression(String hostPrefixExpression)	Sets the resolved host prefix expression that will be added as a prefix to the original endpoint.
boolean	isFullDuplex()
<T> ClientExecutionParams<InputT,OutputT>	putExecutionAttribute(ExecutionAttribute<T> attribute, T value)
SdkClientConfiguration	requestConfiguration()
ClientExecutionParams<InputT,OutputT>	withAsyncRequestBody(AsyncRequestBody asyncRequestBody)
ClientExecutionParams<InputT,OutputT>	withCombinedResponseHandler(HttpResponseHandler<Response<OutputT>> combinedResponseHandler)
ClientExecutionParams<InputT,OutputT>	withErrorResponseHandler(HttpResponseHandler<? extends SdkException> errorResponseHandler)
ClientExecutionParams<InputT,OutputT>	withFullDuplex(boolean fullDuplex)	Sets whether the API is a full duplex ie, request and response are streamed in parallel.
ClientExecutionParams<InputT,OutputT>	withInitialRequestEvent(boolean hasInitialRequestEvent)	Sets whether this is an event streaming request over RPC.
ClientExecutionParams<InputT,OutputT>	withInput(InputT input)
ClientExecutionParams<InputT,OutputT>	withMarshaller(Marshaller<InputT> marshaller)
ClientExecutionParams<InputT,OutputT>	withMetricCollector(MetricCollector metricCollector)
ClientExecutionParams<InputT,OutputT>	withOperationName(String operationName)	Sets the operation name of the API.
ClientExecutionParams<InputT,OutputT>	withProtocolMetadata(SdkProtocolMetadata protocolMetadata)	Sets the protocol metadata of the API.
ClientExecutionParams<InputT,OutputT>	withRequestBody(RequestBody requestBody)
<T> ClientExecutionParams<InputT,OutputT>	withRequestConfiguration(SdkClientConfiguration requestConfiguration)
ClientExecutionParams<InputT,OutputT>	withResponseHandler(HttpResponseHandler<OutputT> responseHandler)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientExecutionParams

public ClientExecutionParams()

Method Detail

getMarshaller

public Marshaller<InputT> getMarshaller()

withMarshaller

public ClientExecutionParams<InputT,OutputT> withMarshaller(Marshaller<InputT> marshaller)

getInput

public InputT getInput()

withInput

public ClientExecutionParams<InputT,OutputT> withInput(InputT input)

getResponseHandler

public HttpResponseHandler<OutputT> getResponseHandler()

withResponseHandler

public ClientExecutionParams<InputT,OutputT> withResponseHandler(HttpResponseHandler<OutputT> responseHandler)

getErrorResponseHandler

public HttpResponseHandler<? extends SdkException> getErrorResponseHandler()

withErrorResponseHandler

public ClientExecutionParams<InputT,OutputT> withErrorResponseHandler(HttpResponseHandler<? extends SdkException> errorResponseHandler)

getCombinedResponseHandler

public HttpResponseHandler<Response<OutputT>> getCombinedResponseHandler()

Non-streaming requests can use handlers that handle both error and success as a single handler instead of submitting individual success and error handlers. This allows the protocol to have more control over how to determine success and failure from a given HTTP response. This handler is mutually exclusive to getResponseHandler() and getErrorResponseHandler() and an exception will be thrown if this constraint is violated.

withCombinedResponseHandler

public ClientExecutionParams<InputT,OutputT> withCombinedResponseHandler(HttpResponseHandler<Response<OutputT>> combinedResponseHandler)

getRequestBody

public RequestBody getRequestBody()

withRequestBody

public ClientExecutionParams<InputT,OutputT> withRequestBody(RequestBody requestBody)

getAsyncRequestBody

public AsyncRequestBody getAsyncRequestBody()

withAsyncRequestBody

public ClientExecutionParams<InputT,OutputT> withAsyncRequestBody(AsyncRequestBody asyncRequestBody)

isFullDuplex

public boolean isFullDuplex()

withFullDuplex

public ClientExecutionParams<InputT,OutputT> withFullDuplex(boolean fullDuplex)

Sets whether the API is a full duplex ie, request and response are streamed in parallel.

hasInitialRequestEvent

public boolean hasInitialRequestEvent()

withInitialRequestEvent

public ClientExecutionParams<InputT,OutputT> withInitialRequestEvent(boolean hasInitialRequestEvent)

Sets whether this is an event streaming request over RPC.

getOperationName

public String getOperationName()

withOperationName

public ClientExecutionParams<InputT,OutputT> withOperationName(String operationName)

Sets the operation name of the API.

getProtocolMetadata

public SdkProtocolMetadata getProtocolMetadata()

withProtocolMetadata

public ClientExecutionParams<InputT,OutputT> withProtocolMetadata(SdkProtocolMetadata protocolMetadata)

Sets the protocol metadata of the API.

hostPrefixExpression

public String hostPrefixExpression()

hostPrefixExpression

public ClientExecutionParams<InputT,OutputT> hostPrefixExpression(String hostPrefixExpression)

Sets the resolved host prefix expression that will be added as a prefix to the original endpoint. This value is present only if the operation is tagged with endpoint trait.

discoveredEndpoint

public URI discoveredEndpoint()

discoveredEndpoint

public ClientExecutionParams<InputT,OutputT> discoveredEndpoint(URI discoveredEndpoint)

credentialType

public CredentialType credentialType()

credentialType

public ClientExecutionParams<InputT,OutputT> credentialType(CredentialType credentialType)

withMetricCollector

public ClientExecutionParams<InputT,OutputT> withMetricCollector(MetricCollector metricCollector)

putExecutionAttribute

public <T> ClientExecutionParams<InputT,OutputT> putExecutionAttribute(ExecutionAttribute<T> attribute,
                                                                             T value)

executionAttributes

public ExecutionAttributes executionAttributes()

getMetricCollector

public MetricCollector getMetricCollector()

requestConfiguration

public SdkClientConfiguration requestConfiguration()

withRequestConfiguration

public <T> ClientExecutionParams<InputT,OutputT> withRequestConfiguration(SdkClientConfiguration requestConfiguration)