Package software.amazon.awssdk.http.auth.spi.signer

Interface BaseSignedRequest<PayloadT>

Type Parameters:

PayloadT - The type of payload of the request.

All Known Subinterfaces:

AsyncSignedRequest, SignedRequest

All Known Implementing Classes:

DefaultAsyncSignedRequest, DefaultSignedRequest

@Immutable
@ThreadSafe
public interface BaseSignedRequest<PayloadT>

/** Base interface to a request that has been signed by HttpSigner, independent of payload type. See specific sub-interfaces SignedRequest for sync payload and AsyncSignedRequest for async payload.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BaseSignedRequest.Builder<B extends BaseSignedRequest.Builder<B,PayloadT>,PayloadT>	A builder for a BaseSignedRequest.

Method Summary

Modifier and Type	Method	Description
Optional<PayloadT>	payload()	Returns the body payload of the request.
SdkHttpRequest	request()	Returns the HTTP request object, without the request body payload.

Method Details

request

SdkHttpRequest request()

Returns the HTTP request object, without the request body payload.

payload

Optional<PayloadT> payload()

Returns the body payload of the request. A payload is optional. By default, the payload will be empty.