RequestClientOptions (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws

Class RequestClientOptions

java.lang.Object
- com.amazonaws.RequestClientOptions

```
@NotThreadSafe
public final class RequestClientOptions
extends Object 
```
Client request options such as client markers for individual AmazonWebServiceRequests.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RequestClientOptions.Marker

Nested Classes
Modifier and Type	Class and Description
`static class`	`RequestClientOptions.Marker`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_STREAM_BUFFER_SIZE` Used to enable mark-and-reset for non-mark-and-resettable non-file input stream for up to 128K memory buffering by default.

Constructor Summary

Constructors
Constructor and Description

RequestClientOptions ()

Constructors
Constructor and Description
`RequestClientOptions ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`void`	`appendUserAgent (String userAgent)` Appends a user agent to the USER_AGENT client marker.
`String`	`getClientMarker (RequestClientOptions.Marker marker)` Returns the value of the specified marker; or null if there is no such value.
`int`	`getReadLimit ()` Returns the mark-and-reset read limit; defaults to 131073.
`boolean`	`isSkipAppendUriPath ()` Gets the boolean value to skip the appendUri call in `ApacheHttpRequestFactory.create(Request, HttpClientSettings)` method.
`void`	`putClientMarker (RequestClientOptions.Marker marker, String value)` Associates the given value with the given marker.
`void`	`setReadLimit (int readLimit)` Sets the optional mark-and-reset read limit used for signing and retry purposes.
`void`	`setSkipAppendUriPath (boolean skipAppendUriPath)` Sets the boolean value to skip the appendUri call in `ApacheHttpRequestFactory.create(Request, HttpClientSettings)` method.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_STREAM_BUFFER_SIZE
```
public static final int DEFAULT_STREAM_BUFFER_SIZE
```
    Used to enable mark-and-reset for non-mark-and-resettable non-file input stream for up to 128K memory buffering by default. Add 1 to get around an implementation quirk of BufferedInputStream. Retries after reading DEFAULT_STREAM_BUFFER_SIZE bytes would fail to reset the underlying input stream as the mark position would have been invalidated.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RequestClientOptions
```
public RequestClientOptions()
```
- Method Detail
  - getClientMarker
```
public String getClientMarker(RequestClientOptions.Marker marker)
```
    Returns the value of the specified marker; or null if there is no such value.
  - putClientMarker
```
public void putClientMarker(RequestClientOptions.Marker marker,
 String value)
```
    Associates the given value with the given marker. Note the RequestClientOptions.Marker.USER_AGENT is only intended for internal use by the AWS SDK.
  - appendUserAgent
```
public void appendUserAgent(String userAgent)
```
    Appends a user agent to the USER_AGENT client marker. This method is intended only for internal use by the AWS SDK.
  - getReadLimit
```
public final int getReadLimit()
```
    Returns the mark-and-reset read limit; defaults to 131073.
    
    See Also:
    
    InputStream.mark(int)
  - setReadLimit
```
public final void setReadLimit(int readLimit)
```
    Sets the optional mark-and-reset read limit used for signing and retry purposes.
    
    See Also:
    
    InputStream.mark(int)
  - isSkipAppendUriPath
```
public boolean isSkipAppendUriPath()
```
    Gets the boolean value to skip the appendUri call in ApacheHttpRequestFactory.create(Request, HttpClientSettings) method. The default value is false, which means the appendUri call is not skipped. This options is used in APIs that directly execute given presigned urls. For these requests, the extra slash should not be included.
  - setSkipAppendUriPath
```
public void setSkipAppendUriPath(boolean skipAppendUriPath)
```
    Sets the boolean value to skip the appendUri call in ApacheHttpRequestFactory.create(Request, HttpClientSettings) method. The default value is false, which means the appendUri call is not skipped. This options is used in APIs that directly execute given presigned urls. For these requests, the extra slash should not be included.