com.amazonaws

Class AmazonWebServiceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

AssumeRoleRequest, AssumeRoleWithWebIdentityRequest, GetCallerIdentityRequest, GetCredentialsForIdentityRequest, GetFederationTokenRequest, GetIdRequest, GetOpenIdTokenRequest, GetSessionTokenRequest

public abstract class AmazonWebServiceRequest
extends Object
implements Cloneable

Base class for all user facing web service requests.

Constructor Summary

Constructors

Constructor and Description
AmazonWebServiceRequest()

Method Summary

Modifier and Type	Method and Description
AmazonWebServiceRequest	clone() Creates a shallow clone of this request.
protected <T extends AmazonWebServiceRequest> T	copyBaseTo(T target) Copies the internal state of this base class to that of the target request.
AmazonWebServiceRequest	getCloneRoot()
AmazonWebServiceRequest	getCloneSource()
ProgressListener	getGeneralProgressListener() Returns the optional progress listener for receiving updates about object upload status.
RequestClientOptions	getRequestClientOptions()
AWSCredentials	getRequestCredentials() Returns the optional credentials to use to sign this request, overriding the default credentials set at the client level.
RequestMetricCollector	getRequestMetricCollector() Deprecated. metrics is deprecated
void	setGeneralProgressListener(ProgressListener generalProgressListener) Sets the optional progress listener for receiving updates about object upload status.
void	setRequestCredentials(AWSCredentials credentials) Sets the optional credentials to use for this request, overriding the default credentials set at the client level.
void	setRequestMetricCollector(RequestMetricCollector requestMetricCollector) Deprecated. metrics is deprecated
<T extends AmazonWebServiceRequest> T	withGeneralProgressListener(ProgressListener generalProgressListener) Sets the optional progress listener for receiving updates about the progress of the request, and returns a reference to this object so that method calls can be chained together.
<T extends AmazonWebServiceRequest> T	withRequestMetricCollector(RequestMetricCollector metricCollector) Deprecated. metrics is deprecated

Methods inherited from class java.lang.Object

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

Constructor Detail

AmazonWebServiceRequest

public AmazonWebServiceRequest()

Method Detail

setRequestCredentials

public void setRequestCredentials(AWSCredentials credentials)

Sets the optional credentials to use for this request, overriding the default credentials set at the client level.

Parameters:

credentials - The optional AWS security credentials to use for this request, overriding the default credentials set at the client level.

getRequestCredentials

public AWSCredentials getRequestCredentials()

Returns the optional credentials to use to sign this request, overriding the default credentials set at the client level.

Returns:

The optional credentials to use to sign this request, overriding the default credentials set at the client level.

getRequestClientOptions

public RequestClientOptions getRequestClientOptions()

Returns:

the options stored with this request object. Intended for internal use only.

getRequestMetricCollector

@Deprecated
public RequestMetricCollector getRequestMetricCollector()

Deprecated. metrics is deprecated

Returns:

a request level metric collector; or null if not specified.

setRequestMetricCollector

@Deprecated
public void setRequestMetricCollector(RequestMetricCollector requestMetricCollector)

Deprecated. metrics is deprecated

Sets a request level request metric collector which takes precedence over the ones at the http client level and AWS SDK level.

Parameters:

requestMetricCollector - the request metric collector.

withRequestMetricCollector

@Deprecated
public <T extends AmazonWebServiceRequest> T withRequestMetricCollector(RequestMetricCollector metricCollector)

Deprecated. metrics is deprecated

Specifies a request level metric collector which takes precedence over the ones at the http client level and AWS SDK level.

Type Parameters:

T - class type.

Parameters:

metricCollector - the request metric collector.

Returns:

this for method chaining.

setGeneralProgressListener

public void setGeneralProgressListener(ProgressListener generalProgressListener)

Sets the optional progress listener for receiving updates about object upload status.

Parameters:

generalProgressListener - The new progress listener.

getGeneralProgressListener

public ProgressListener getGeneralProgressListener()

Returns the optional progress listener for receiving updates about object upload status.

Returns:

the optional progress listener for receiving updates about object upload status.

withGeneralProgressListener

public <T extends AmazonWebServiceRequest> T withGeneralProgressListener(ProgressListener generalProgressListener)

Sets the optional progress listener for receiving updates about the progress of the request, and returns a reference to this object so that method calls can be chained together.

Type Parameters:

T - class type.

Parameters:

generalProgressListener - The new progress listener.

Returns:

This updated PutObjectRequest object.

copyBaseTo

protected final <T extends AmazonWebServiceRequest> T copyBaseTo(T target)

Copies the internal state of this base class to that of the target request.

Returns:

the target request

getCloneSource

public AmazonWebServiceRequest getCloneSource()

Returns:

the source object from which the current object was cloned; or null if there isn't one.

getCloneRoot

public AmazonWebServiceRequest getCloneRoot()

Returns:

the root object from which the current object was cloned; or null if there isn't one.

clone

public AmazonWebServiceRequest clone()

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class Object

See Also:

Object.clone()