com.microsoft.azure.datalake.store

Class OperationResponse

java.lang.Object

com.microsoft.azure.datalake.store.OperationResponse

public class OperationResponse
extends Object

information about a response from a server call. This class is a container for all the information from making a server call.

Field Summary

Fields

Modifier and Type	Field and Description
Exception	ex exceptions encountered when processing the request or response
String	exceptionHistory Comma-separated list of exceptions encountered but not thrown by this call.
int	httpResponseCode the HTTP response code from the call
String	httpResponseMessage the message that came with the HTTP response
long	lastCallLatency the latency of the last try, in milliseconds
String	message error message, used for errors that originate within the SDK
int	numRetries the number of retries attempted before returning from the call
String	opCode The WebHDFS opCode of the remote operation
String	remoteExceptionJavaClassName the exception's Java Class Name as reported by the server, if the call failed on server This is there for WebHDFS compatibility.
String	remoteExceptionMessage the exception message as reported by the server, if the call failed on server
String	remoteExceptionName the exception name as reported by the server, if the call failed on server
String	requestId the server request ID.
boolean	responseChunked indicates whether HTTP body used chunked for Transfer-Encoding of the response
long	responseContentLength Content-Length of the returned HTTP body (if return was not chunked).
InputStream	responseStream for methods that return data from server, this field contains the ADLFileInputStream.
boolean	successful whether the request was successful.
long	tokenAcquisitionLatency time taken to get the token for this request, in nanoseconds.

Constructor Summary

Constructors

Constructor and Description
OperationResponse()

Method Summary

Modifier and Type	Method and Description
void	reset() Reset response object to initial state

Methods inherited from class java.lang.Object

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

Field Detail

successful

public boolean successful

whether the request was successful. Callers should always check for success before using any return value from any of the calls.

opCode

public String opCode

The WebHDFS opCode of the remote operation

httpResponseCode

public int httpResponseCode

the HTTP response code from the call

httpResponseMessage

public String httpResponseMessage

the message that came with the HTTP response

responseStream

public InputStream responseStream

for methods that return data from server, this field contains the ADLFileInputStream. null for methods that return no data in the HTTP body.

requestId

public String requestId

the server request ID.

numRetries

public int numRetries

the number of retries attempted before returning from the call

lastCallLatency

public long lastCallLatency

the latency of the last try, in milliseconds

tokenAcquisitionLatency

public long tokenAcquisitionLatency

time taken to get the token for this request, in nanoseconds. Should mostly be small.

responseContentLength

public long responseContentLength

Content-Length of the returned HTTP body (if return was not chunked). Callers should look at both this and responseChunked values to determine whether any data was returned by server.

responseChunked

public boolean responseChunked

indicates whether HTTP body used chunked for Transfer-Encoding of the response

remoteExceptionName

public String remoteExceptionName

the exception name as reported by the server, if the call failed on server

remoteExceptionMessage

public String remoteExceptionMessage

the exception message as reported by the server, if the call failed on server

remoteExceptionJavaClassName

public String remoteExceptionJavaClassName

the exception's Java Class Name as reported by the server, if the call failed on server This is there for WebHDFS compatibility.

ex

public Exception ex

exceptions encountered when processing the request or response

message

public String message

error message, used for errors that originate within the SDK

exceptionHistory

public String exceptionHistory

Comma-separated list of exceptions encountered but not thrown by this call. This may happen because of retries.

Constructor Detail

OperationResponse

public OperationResponse()

Method Detail

reset

public void reset()

Reset response object to initial state