org.apache.hadoop.ipc.protobuf

Class RpcHeaderProtos.RpcResponseHeaderProto.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder<BuilderType>

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessage.Builder<RpcHeaderProtos.RpcResponseHeaderProto.Builder>

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

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

Enclosing class:

RpcHeaderProtos.RpcResponseHeaderProto

public static final class RpcHeaderProtos.RpcResponseHeaderProto.Builder
extends com.google.protobuf.GeneratedMessage.Builder<RpcHeaderProtos.RpcResponseHeaderProto.Builder>
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.
 

Method Summary

Methods

Modifier and Type	Method and Description
RpcHeaderProtos.RpcResponseHeaderProto	build()
RpcHeaderProtos.RpcResponseHeaderProto	buildPartial()
RpcHeaderProtos.RpcResponseHeaderProto.Builder	clear()
RpcHeaderProtos.RpcResponseHeaderProto.Builder	clearCallId() required uint32 callId = 1;
RpcHeaderProtos.RpcResponseHeaderProto.Builder	clearClientId() optional bytes clientId = 7;
RpcHeaderProtos.RpcResponseHeaderProto.Builder	clearErrorDetail() optional .hadoop.common.RpcResponseHeaderProto.RpcErrorCodeProto errorDetail = 6;
RpcHeaderProtos.RpcResponseHeaderProto.Builder	clearErrorMsg() optional string errorMsg = 5;
RpcHeaderProtos.RpcResponseHeaderProto.Builder	clearExceptionClassName() optional string exceptionClassName = 4;
RpcHeaderProtos.RpcResponseHeaderProto.Builder	clearRetryCount() optional sint32 retryCount = 8 [default = -1];
RpcHeaderProtos.RpcResponseHeaderProto.Builder	clearServerIpcVersionNum() optional uint32 serverIpcVersionNum = 3;
RpcHeaderProtos.RpcResponseHeaderProto.Builder	clearStatus() required .hadoop.common.RpcResponseHeaderProto.RpcStatusProto status = 2;
RpcHeaderProtos.RpcResponseHeaderProto.Builder	clone()
int	getCallId() required uint32 callId = 1;
com.google.protobuf.ByteString	getClientId() optional bytes clientId = 7;
RpcHeaderProtos.RpcResponseHeaderProto	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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;
int	getRetryCount() optional sint32 retryCount = 8 [default = -1];
int	getServerIpcVersionNum() optional uint32 serverIpcVersionNum = 3;
RpcHeaderProtos.RpcResponseHeaderProto.RpcStatusProto	getStatus() required .hadoop.common.RpcResponseHeaderProto.RpcStatusProto status = 2;
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;
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()
RpcHeaderProtos.RpcResponseHeaderProto.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RpcHeaderProtos.RpcResponseHeaderProto.Builder	mergeFrom(com.google.protobuf.Message other)
RpcHeaderProtos.RpcResponseHeaderProto.Builder	mergeFrom(RpcHeaderProtos.RpcResponseHeaderProto other)
RpcHeaderProtos.RpcResponseHeaderProto.Builder	setCallId(int value) required uint32 callId = 1;
RpcHeaderProtos.RpcResponseHeaderProto.Builder	setClientId(com.google.protobuf.ByteString value) optional bytes clientId = 7;
RpcHeaderProtos.RpcResponseHeaderProto.Builder	setErrorDetail(RpcHeaderProtos.RpcResponseHeaderProto.RpcErrorCodeProto value) optional .hadoop.common.RpcResponseHeaderProto.RpcErrorCodeProto errorDetail = 6;
RpcHeaderProtos.RpcResponseHeaderProto.Builder	setErrorMsg(String value) optional string errorMsg = 5;
RpcHeaderProtos.RpcResponseHeaderProto.Builder	setErrorMsgBytes(com.google.protobuf.ByteString value) optional string errorMsg = 5;
RpcHeaderProtos.RpcResponseHeaderProto.Builder	setExceptionClassName(String value) optional string exceptionClassName = 4;
RpcHeaderProtos.RpcResponseHeaderProto.Builder	setExceptionClassNameBytes(com.google.protobuf.ByteString value) optional string exceptionClassName = 4;
RpcHeaderProtos.RpcResponseHeaderProto.Builder	setRetryCount(int value) optional sint32 retryCount = 8 [default = -1];
RpcHeaderProtos.RpcResponseHeaderProto.Builder	setServerIpcVersionNum(int value) optional uint32 serverIpcVersionNum = 3;
RpcHeaderProtos.RpcResponseHeaderProto.Builder	setStatus(RpcHeaderProtos.RpcResponseHeaderProto.RpcStatusProto value) required .hadoop.common.RpcResponseHeaderProto.RpcStatusProto status = 2;

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, getAllFields, getField, getFieldBuilder, getParentForChildren, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, isClean, markClean, mergeUnknownFields, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, newUninitializedMessageException

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

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.Builder<RpcHeaderProtos.RpcResponseHeaderProto.Builder>

clear

public RpcHeaderProtos.RpcResponseHeaderProto.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<RpcHeaderProtos.RpcResponseHeaderProto.Builder>

clone

public RpcHeaderProtos.RpcResponseHeaderProto.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessage.Builder<RpcHeaderProtos.RpcResponseHeaderProto.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<RpcHeaderProtos.RpcResponseHeaderProto.Builder>

getDefaultInstanceForType

public RpcHeaderProtos.RpcResponseHeaderProto getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RpcHeaderProtos.RpcResponseHeaderProto build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public RpcHeaderProtos.RpcResponseHeaderProto buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public RpcHeaderProtos.RpcResponseHeaderProto.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RpcHeaderProtos.RpcResponseHeaderProto.Builder>

mergeFrom

public RpcHeaderProtos.RpcResponseHeaderProto.Builder mergeFrom(RpcHeaderProtos.RpcResponseHeaderProto other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<RpcHeaderProtos.RpcResponseHeaderProto.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RpcHeaderProtos.RpcResponseHeaderProto.Builder>

Throws:

IOException

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

setCallId

public RpcHeaderProtos.RpcResponseHeaderProto.Builder setCallId(int value)

required uint32 callId = 1;

 callId used in Request
 

clearCallId

public RpcHeaderProtos.RpcResponseHeaderProto.Builder clearCallId()

required uint32 callId = 1;

 callId used in Request
 

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

setStatus

public RpcHeaderProtos.RpcResponseHeaderProto.Builder setStatus(RpcHeaderProtos.RpcResponseHeaderProto.RpcStatusProto value)

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

clearStatus

public RpcHeaderProtos.RpcResponseHeaderProto.Builder clearStatus()

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

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

setServerIpcVersionNum

public RpcHeaderProtos.RpcResponseHeaderProto.Builder setServerIpcVersionNum(int value)

optional uint32 serverIpcVersionNum = 3;

 Sent if success or fail
 

clearServerIpcVersionNum

public RpcHeaderProtos.RpcResponseHeaderProto.Builder clearServerIpcVersionNum()

optional uint32 serverIpcVersionNum = 3;

 Sent if success or fail
 

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

setExceptionClassName

public RpcHeaderProtos.RpcResponseHeaderProto.Builder setExceptionClassName(String value)

optional string exceptionClassName = 4;

 if request fails
 

clearExceptionClassName

public RpcHeaderProtos.RpcResponseHeaderProto.Builder clearExceptionClassName()

optional string exceptionClassName = 4;

 if request fails
 

setExceptionClassNameBytes

public RpcHeaderProtos.RpcResponseHeaderProto.Builder setExceptionClassNameBytes(com.google.protobuf.ByteString value)

optional string exceptionClassName = 4;

 if request fails
 

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

setErrorMsg

public RpcHeaderProtos.RpcResponseHeaderProto.Builder setErrorMsg(String value)

optional string errorMsg = 5;

 if request fails, often contains strack trace
 

clearErrorMsg

public RpcHeaderProtos.RpcResponseHeaderProto.Builder clearErrorMsg()

optional string errorMsg = 5;

 if request fails, often contains strack trace
 

setErrorMsgBytes

public RpcHeaderProtos.RpcResponseHeaderProto.Builder setErrorMsgBytes(com.google.protobuf.ByteString value)

optional string errorMsg = 5;

 if request fails, often contains strack trace
 

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

setErrorDetail

public RpcHeaderProtos.RpcResponseHeaderProto.Builder setErrorDetail(RpcHeaderProtos.RpcResponseHeaderProto.RpcErrorCodeProto value)

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

 in case of error
 

clearErrorDetail

public RpcHeaderProtos.RpcResponseHeaderProto.Builder clearErrorDetail()

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

 in case of error
 

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

setClientId

public RpcHeaderProtos.RpcResponseHeaderProto.Builder setClientId(com.google.protobuf.ByteString value)

optional bytes clientId = 7;

 Globally unique client ID
 

clearClientId

public RpcHeaderProtos.RpcResponseHeaderProto.Builder clearClientId()

optional bytes clientId = 7;

 Globally unique client ID
 

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

setRetryCount

public RpcHeaderProtos.RpcResponseHeaderProto.Builder setRetryCount(int value)

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

clearRetryCount

public RpcHeaderProtos.RpcResponseHeaderProto.Builder clearRetryCount()

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