Package software.amazon.awssdk.opensdk.model

Class RawRequest

java.lang.Object

software.amazon.awssdk.opensdk.BaseRequest

software.amazon.awssdk.opensdk.model.RawRequest

All Implemented Interfaces:

Cloneable

public class RawRequest
extends BaseRequest

Low level request class for accessing the service resources. This class is useful for example when an operation was not modeled or otherwise unable to be represented by a higher level modeled request class.

This defaults to a HttpMethodName.GET request.

Constructor Summary

Constructors

Constructor	Description
RawRequest()

Method Summary

Modifier and Type	Method	Description
RawRequest	header(String name, String value)	Set a header value for the underlying HTTP request.
HttpMethodName	httpMethod()
RawRequest	httpMethod(HttpMethodName httpMethod)	Set the HTTP method to perform against the configured resouce.
String	path()
RawRequest	path(String path)	Set the path to the resource.
InputStream	payload()
RawRequest	payload(InputStream is)	Set a payload for the underlying HTTP request.
RawRequest	queryParameter(String name, String value)	Set a query parameter value for the underlying HTTP request.
SdkRequestConfig	sdkRequestConfig()
RawRequest	sdkRequestConfig(SdkRequestConfig sdkRequestConfig)	Set the configuration for this request.

Methods inherited from class software.amazon.awssdk.opensdk.BaseRequest

clone

Methods inherited from class java.lang.Object

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

Constructor Detail

RawRequest

public RawRequest()

Method Detail

path

public String path()

Returns:

The path to the resource.

path

public RawRequest path(String path)

Set the path to the resource.

Parameters:

path - The path.

Returns:

This object for method chaining.

httpMethod

public HttpMethodName httpMethod()

Returns:

The HTTP method to perform against the configured resource.

httpMethod

public RawRequest httpMethod(HttpMethodName httpMethod)

Set the HTTP method to perform against the configured resouce.

Parameters:

httpMethod - The HTTP method.

Returns:

This object for method chaining.

header

public RawRequest header(String name,
                         String value)

Set a header value for the underlying HTTP request.

Headers set with this method will take precedence over headers found in the configured SdkRequestConfig.

Parameters:

name - The name of the header.

value - The value of the header.

Returns:

This object for method chaining.

queryParameter

public RawRequest queryParameter(String name,
                                 String value)

Set a query parameter value for the underlying HTTP request.

Query parameters set with this method will be merged with query parameters found in the configured SdkRequestConfig.

Parameters:

name - The name of the header.

value - The value of the header.

Returns:

This object for method chaining.

payload

public RawRequest payload(InputStream is)

Set a payload for the underlying HTTP request.

Parameters:

is - The payload.

Returns:

This object for method chaining.

payload

public InputStream payload()

Returns:

The payload.

sdkRequestConfig

public RawRequest sdkRequestConfig(SdkRequestConfig sdkRequestConfig)

Set the configuration for this request.

Header values set using header(String, String) take precedence over values present in the request config. Query parameter values set using queryParameter(String, String) will be merged with the values present in the request config.

Overrides:

sdkRequestConfig in class BaseRequest

Parameters:

sdkRequestConfig - The request config.

Returns:

This object for method chaining.

sdkRequestConfig

public SdkRequestConfig sdkRequestConfig()

Overrides:

sdkRequestConfig in class BaseRequest

Returns:

The configuration for this particular request.