org.apache.hadoop.ipc.protobuf

Class RpcHeaderProtos.RpcResponseHeaderProto

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

org.apache.hadoop.ipc.protobuf.RpcHeaderProtos.RpcResponseHeaderProto

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

Enclosing class:

RpcHeaderProtos

public static final class RpcHeaderProtos.RpcResponseHeaderProto
extends com.google.protobuf.GeneratedMessage
implements RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

Protobuf type hadoop.common.RpcResponseHeaderProto

 Rpc Response Header
 +------------------------------------------------------------------+
 | Rpc total response length in bytes (4 bytes int)                 |
 |  (sum of next two parts)                                         |
 +------------------------------------------------------------------+
 | RpcResponseHeaderProto - serialized delimited ie has len         |
 +------------------------------------------------------------------+
 | if request is successful:                                        |
 |   - RpcResponse -  The actual rpc response  bytes follow         |
 |     the response header                                          |
 |     This response is serialized based on RpcKindProto            |
 | if request fails :                                               |
 |   The rpc response header contains the necessary info            |
 +------------------------------------------------------------------+

 Note that rpc response header is also used when connection setup fails. 
 Ie the response looks like a rpc response with a fake callId.
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RpcHeaderProtos.RpcResponseHeaderProto.Builder Protobuf type hadoop.common.RpcResponseHeaderProto
static class	RpcHeaderProtos.RpcResponseHeaderProto.RpcErrorCodeProto Protobuf enum hadoop.common.RpcResponseHeaderProto.RpcErrorCodeProto
static class	RpcHeaderProtos.RpcResponseHeaderProto.RpcStatusProto Protobuf enum hadoop.common.RpcResponseHeaderProto.RpcStatusProto

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.BuilderParent, com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessage.ExtendableBuilder>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingType extends com.google.protobuf.Message,Type>

Field Summary

Fields

Modifier and Type	Field and Description
static int	CALLID_FIELD_NUMBER
static int	CLIENTID_FIELD_NUMBER
static int	ERRORDETAIL_FIELD_NUMBER
static int	ERRORMSG_FIELD_NUMBER
static int	EXCEPTIONCLASSNAME_FIELD_NUMBER
static com.google.protobuf.Parser<RpcHeaderProtos.RpcResponseHeaderProto>	PARSER
static int	RETRYCOUNT_FIELD_NUMBER
static int	SERVERIPCVERSIONNUM_FIELD_NUMBER
static int	STATUS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getCallId() required uint32 callId = 1;
com.google.protobuf.ByteString	getClientId() optional bytes clientId = 7;
static RpcHeaderProtos.RpcResponseHeaderProto	getDefaultInstance()
RpcHeaderProtos.RpcResponseHeaderProto	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
RpcHeaderProtos.RpcResponseHeaderProto.RpcErrorCodeProto	getErrorDetail() optional .hadoop.common.RpcResponseHeaderProto.RpcErrorCodeProto errorDetail = 6;
String	getErrorMsg() optional string errorMsg = 5;
com.google.protobuf.ByteString	getErrorMsgBytes() optional string errorMsg = 5;
String	getExceptionClassName() optional string exceptionClassName = 4;
com.google.protobuf.ByteString	getExceptionClassNameBytes() optional string exceptionClassName = 4;
com.google.protobuf.Parser<RpcHeaderProtos.RpcResponseHeaderProto>	getParserForType()
int	getRetryCount() optional sint32 retryCount = 8 [default = -1];
int	getSerializedSize()
int	getServerIpcVersionNum() optional uint32 serverIpcVersionNum = 3;
RpcHeaderProtos.RpcResponseHeaderProto.RpcStatusProto	getStatus() required .hadoop.common.RpcResponseHeaderProto.RpcStatusProto status = 2;
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasCallId() required uint32 callId = 1;
boolean	hasClientId() optional bytes clientId = 7;
boolean	hasErrorDetail() optional .hadoop.common.RpcResponseHeaderProto.RpcErrorCodeProto errorDetail = 6;
boolean	hasErrorMsg() optional string errorMsg = 5;
boolean	hasExceptionClassName() optional string exceptionClassName = 4;
int	hashCode()
boolean	hasRetryCount() optional sint32 retryCount = 8 [default = -1];
boolean	hasServerIpcVersionNum() optional uint32 serverIpcVersionNum = 3;
boolean	hasStatus() required .hadoop.common.RpcResponseHeaderProto.RpcStatusProto status = 2;
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RpcHeaderProtos.RpcResponseHeaderProto.Builder	newBuilder()
static RpcHeaderProtos.RpcResponseHeaderProto.Builder	newBuilder(RpcHeaderProtos.RpcResponseHeaderProto prototype)
RpcHeaderProtos.RpcResponseHeaderProto.Builder	newBuilderForType()
protected RpcHeaderProtos.RpcResponseHeaderProto.Builder	newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)
static RpcHeaderProtos.RpcResponseHeaderProto	parseDelimitedFrom(InputStream input)
static RpcHeaderProtos.RpcResponseHeaderProto	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RpcHeaderProtos.RpcResponseHeaderProto	parseFrom(byte[] data)
static RpcHeaderProtos.RpcResponseHeaderProto	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RpcHeaderProtos.RpcResponseHeaderProto	parseFrom(com.google.protobuf.ByteString data)
static RpcHeaderProtos.RpcResponseHeaderProto	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RpcHeaderProtos.RpcResponseHeaderProto	parseFrom(com.google.protobuf.CodedInputStream input)
static RpcHeaderProtos.RpcResponseHeaderProto	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RpcHeaderProtos.RpcResponseHeaderProto	parseFrom(InputStream input)
static RpcHeaderProtos.RpcResponseHeaderProto	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RpcHeaderProtos.RpcResponseHeaderProto.Builder	toBuilder()
protected Object	writeReplace()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

getAllFields, getDescriptorForType, getField, getRepeatedField, getRepeatedFieldCount, hasField, makeExtensionsImmutable, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, parseUnknownField

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getRepeatedField, getRepeatedFieldCount, hasField

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARSER

public static com.google.protobuf.Parser<RpcHeaderProtos.RpcResponseHeaderProto> PARSER

CALLID_FIELD_NUMBER

public static final int CALLID_FIELD_NUMBER

See Also:

Constant Field Values

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER

See Also:

Constant Field Values

SERVERIPCVERSIONNUM_FIELD_NUMBER

public static final int SERVERIPCVERSIONNUM_FIELD_NUMBER

See Also:

Constant Field Values

EXCEPTIONCLASSNAME_FIELD_NUMBER

public static final int EXCEPTIONCLASSNAME_FIELD_NUMBER

See Also:

Constant Field Values

ERRORMSG_FIELD_NUMBER

public static final int ERRORMSG_FIELD_NUMBER

See Also:

Constant Field Values

ERRORDETAIL_FIELD_NUMBER

public static final int ERRORDETAIL_FIELD_NUMBER

See Also:

Constant Field Values

CLIENTID_FIELD_NUMBER

public static final int CLIENTID_FIELD_NUMBER

See Also:

Constant Field Values

RETRYCOUNT_FIELD_NUMBER

public static final int RETRYCOUNT_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDefaultInstance

public static RpcHeaderProtos.RpcResponseHeaderProto getDefaultInstance()

getDefaultInstanceForType

public RpcHeaderProtos.RpcResponseHeaderProto getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessage

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getParserForType

public com.google.protobuf.Parser<RpcHeaderProtos.RpcResponseHeaderProto> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

hasCallId

public boolean hasCallId()

required uint32 callId = 1;

 callId used in Request
 

Specified by:

hasCallId in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getCallId

public int getCallId()

required uint32 callId = 1;

 callId used in Request
 

Specified by:

getCallId in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

hasStatus

public boolean hasStatus()

required .hadoop.common.RpcResponseHeaderProto.RpcStatusProto status = 2;

Specified by:

hasStatus in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getStatus

public RpcHeaderProtos.RpcResponseHeaderProto.RpcStatusProto getStatus()

required .hadoop.common.RpcResponseHeaderProto.RpcStatusProto status = 2;

Specified by:

getStatus in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

hasServerIpcVersionNum

public boolean hasServerIpcVersionNum()

optional uint32 serverIpcVersionNum = 3;

 Sent if success or fail
 

Specified by:

hasServerIpcVersionNum in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getServerIpcVersionNum

public int getServerIpcVersionNum()

optional uint32 serverIpcVersionNum = 3;

 Sent if success or fail
 

Specified by:

getServerIpcVersionNum in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

hasExceptionClassName

public boolean hasExceptionClassName()

optional string exceptionClassName = 4;

 if request fails
 

Specified by:

hasExceptionClassName in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getExceptionClassName

public String getExceptionClassName()

optional string exceptionClassName = 4;

 if request fails
 

Specified by:

getExceptionClassName in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getExceptionClassNameBytes

public com.google.protobuf.ByteString getExceptionClassNameBytes()

optional string exceptionClassName = 4;

 if request fails
 

Specified by:

getExceptionClassNameBytes in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

hasErrorMsg

public boolean hasErrorMsg()

optional string errorMsg = 5;

 if request fails, often contains strack trace
 

Specified by:

hasErrorMsg in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getErrorMsg

public String getErrorMsg()

optional string errorMsg = 5;

 if request fails, often contains strack trace
 

Specified by:

getErrorMsg in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getErrorMsgBytes

public com.google.protobuf.ByteString getErrorMsgBytes()

optional string errorMsg = 5;

 if request fails, often contains strack trace
 

Specified by:

getErrorMsgBytes in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

hasErrorDetail

public boolean hasErrorDetail()

optional .hadoop.common.RpcResponseHeaderProto.RpcErrorCodeProto errorDetail = 6;

 in case of error
 

Specified by:

hasErrorDetail in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getErrorDetail

public RpcHeaderProtos.RpcResponseHeaderProto.RpcErrorCodeProto getErrorDetail()

optional .hadoop.common.RpcResponseHeaderProto.RpcErrorCodeProto errorDetail = 6;

 in case of error
 

Specified by:

getErrorDetail in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

hasClientId

public boolean hasClientId()

optional bytes clientId = 7;

 Globally unique client ID
 

Specified by:

hasClientId in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getClientId

public com.google.protobuf.ByteString getClientId()

optional bytes clientId = 7;

 Globally unique client ID
 

Specified by:

getClientId in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

hasRetryCount

public boolean hasRetryCount()

optional sint32 retryCount = 8 [default = -1];

Specified by:

hasRetryCount in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getRetryCount

public int getRetryCount()

optional sint32 retryCount = 8 [default = -1];

Specified by:

getRetryCount in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.AbstractMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.AbstractMessage

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException

Overrides:

writeReplace in class com.google.protobuf.GeneratedMessage

Throws:

ObjectStreamException

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static RpcHeaderProtos.RpcResponseHeaderProto parseFrom(com.google.protobuf.ByteString data)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RpcHeaderProtos.RpcResponseHeaderProto parseFrom(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RpcHeaderProtos.RpcResponseHeaderProto parseFrom(byte[] data)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RpcHeaderProtos.RpcResponseHeaderProto parseFrom(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RpcHeaderProtos.RpcResponseHeaderProto parseFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseFrom

public static RpcHeaderProtos.RpcResponseHeaderProto parseFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static RpcHeaderProtos.RpcResponseHeaderProto parseDelimitedFrom(InputStream input)
                                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static RpcHeaderProtos.RpcResponseHeaderProto parseDelimitedFrom(InputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                 throws IOException

Throws:

IOException

parseFrom

public static RpcHeaderProtos.RpcResponseHeaderProto parseFrom(com.google.protobuf.CodedInputStream input)
                                                        throws IOException

Throws:

IOException

parseFrom

public static RpcHeaderProtos.RpcResponseHeaderProto parseFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws IOException

Throws:

IOException

newBuilder

public static RpcHeaderProtos.RpcResponseHeaderProto.Builder newBuilder()

newBuilderForType

public RpcHeaderProtos.RpcResponseHeaderProto.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RpcHeaderProtos.RpcResponseHeaderProto.Builder newBuilder(RpcHeaderProtos.RpcResponseHeaderProto prototype)

toBuilder

public RpcHeaderProtos.RpcResponseHeaderProto.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RpcHeaderProtos.RpcResponseHeaderProto.Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessage