RequestResult Class

Package:

com.microsoft.azure.storage

• java.lang.Object
• • com.microsoft.azure.storage.RequestResult

public class RequestResult

Represents the result of a physical request.

Method Summary

Modifier and Type	Method and Description
String	getContentMD5() Gets the MD5 hash for the request.
String	getEncryptionKeySHA256() Gets the hash of the key used to server-side encrypt for client-provided keys.
String	getErrorCode() Gets the service ErrorCode for the request.
String	getEtag() Gets the ETag for the request.
Exception	getException() Gets the for the request.
String	getRequestDate() Gets the request date.
String	getServiceRequestID() Gets the service request ID.
Date	getStartDate() Gets the start date for the request.
int	getStatusCode() Gets the HTTP status code for the request.
String	getStatusMessage() Gets the HTTP status message for the request.
Date	getStopDate() Gets the stop date for the request.
StorageLocation	getTargetLocation() Gets the location that the request was sent to.
boolean	isRequestServiceEncrypted() Gets whether the request is server-side encrypted.
boolean	isServiceEncrypted() Gets whether the result is server-side encrypted.
void	setContentMD5(final String contentMD5) Sets the MD5 hash for the request.
void	setEncryptionKeySHA256(String keyHash) Sets the request's key hash for client-provided key requests.
void	setErrorCode(final String errorCode) Sets the service ErrorCode for the request.
void	setEtag(final String etag) Sets the ETag for the request.
void	setException(final Exception exception) Sets the for the request.
void	setRequestDate(final String requestDate) Sets the request date.
void	setRequestServiceEncrypted(boolean requestServiceEncrypted) Sets the request's server-encryption status.
void	setServiceEncrypted(boolean requestServiceEncrypted) Sets the server-encryption status.
void	setServiceRequestID(final String serviceRequestID) Sets the service request ID.
void	setStartDate(final Date startDate) Sets the start date for the request.
void	setStatusCode(final int statusCode) Sets the HTTP status code for the request.
void	setStatusMessage(final String statusMessage) Sets the HTTP status message for the request.
void	setStopDate(final Date stopDate) Sets the stop date for the request.
void	setTargetLocation(StorageLocation targetLocation) Sets the location that the request was sent to.

Method Details

getContentMD5

public String getContentMD5()

Gets the MD5 hash for the request.

Returns:

A String which contains the MD5 hash.

getEncryptionKeySHA256

public String getEncryptionKeySHA256()

Gets the hash of the key used to server-side encrypt for client-provided keys.

Returns:

A base64 encoded string which represents the key hash.

getErrorCode

public String getErrorCode()

Gets the service ErrorCode for the request.

Returns:

A String which contains the service ErrorCode.

getEtag

public String getEtag()

Gets the ETag for the request.

Returns:

A String which contains the ETag.

getException

public Exception getException()

Gets the for the request.

Returns:

An Exception.

getRequestDate

public String getRequestDate()

Gets the request date.

Returns:

A String which contains the date of the request.

getServiceRequestID

public String getServiceRequestID()

Gets the service request ID.

Returns:

A String which contains the service request ID.

getStartDate

public Date getStartDate()

Gets the start date for the request.

Returns:

A java.util.Date object which contains the start date.

getStatusCode

public int getStatusCode()

Gets the HTTP status code for the request.

Returns:

An int which contains the HTTP status code.

getStatusMessage

public String getStatusMessage()

Gets the HTTP status message for the request.

Returns:

A String which contains the HTTP status message.

getStopDate

public Date getStopDate()

Gets the stop date for the request.

Returns:

A java.util.Date object which contains the stop date.

getTargetLocation

public StorageLocation getTargetLocation()

Gets the location that the request was sent to.

Returns:

A StorageLocation object.

isRequestServiceEncrypted

public boolean isRequestServiceEncrypted()

Gets whether the request is server-side encrypted.

Returns:

A boolean which contains the server-side encryption status of the request.

isServiceEncrypted

public boolean isServiceEncrypted()

Gets whether the result is server-side encrypted.

Returns:

A boolean which contains the server-side encryption status of the request.

setContentMD5

public void setContentMD5(final String contentMD5)

Sets the MD5 hash for the request.

Parameters:

contentMD5 - A String object which contains the MD5 hash to set.

setEncryptionKeySHA256

public void setEncryptionKeySHA256(String keyHash)

Sets the request's key hash for client-provided key requests.

Parameters:

keyHash - The hash of the key, represented by a base64 encoded string.

setErrorCode

public void setErrorCode(final String errorCode)

Sets the service ErrorCode for the request.

Parameters:

errorCode - A String which contains the service ErrorCode to set.

setEtag

public void setEtag(final String etag)

Sets the ETag for the request.

Parameters:

etag - A String object which contains the ETag to set.

setException

public void setException(final Exception exception)

Sets the for the request.

Parameters:

exception - The Exception to set.

setRequestDate

public void setRequestDate(final String requestDate)

Sets the request date.

Parameters:

requestDate - A java.util.Date object which contains the request date to set.

setRequestServiceEncrypted

public void setRequestServiceEncrypted(boolean requestServiceEncrypted)

Sets the request's server-encryption status.

Parameters:

requestServiceEncrypted - A boolean object which represents the server-encryption status to set.

setServiceEncrypted

public void setServiceEncrypted(boolean requestServiceEncrypted)

Sets the server-encryption status.

Parameters:

requestServiceEncrypted - A boolean object which represents the server-encryption status to set.

setServiceRequestID

public void setServiceRequestID(final String serviceRequestID)

Sets the service request ID.

Parameters:

serviceRequestID - A String object which contains the service request ID to set.

setStartDate

public void setStartDate(final Date startDate)

Sets the start date for the request.

Parameters:

startDate - A java.util.Date object which contains the start date to set.

setStatusCode

public void setStatusCode(final int statusCode)

Sets the HTTP status code for the request.

Parameters:

statusCode - An int which contains the HTTP status code to set.

setStatusMessage

public void setStatusMessage(final String statusMessage)

Sets the HTTP status message for the request.

Parameters:

statusMessage - A String which contains the status message to set.

setStopDate

public void setStopDate(final Date stopDate)

Sets the stop date for the request.

Parameters:

stopDate - A java.util.Date object which contains the stop date to set.

setTargetLocation

public void setTargetLocation(StorageLocation targetLocation)

Sets the location that the request was sent to.

Parameters:

targetLocation - A StorageLocation object to set.