RpcHeaderProtos.RpcResponseHeaderProto (Apache Hadoop Common 3.3.0 API)

java.lang.Object
- com.google.protobuf.GeneratedMessageV3
- - org.apache.hadoop.ipc.protobuf.RpcHeaderProtos.RpcResponseHeaderProto

All Implemented Interfaces:: com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

Enclosing class:: RpcHeaderProtos

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


 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.

Protobuf type hadoop.common.RpcResponseHeaderProto

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RpcHeaderProtos.RpcResponseHeaderProto.Builder` 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.
`static class`	`RpcHeaderProtos.RpcResponseHeaderProto.RpcErrorCodeProto` Protobuf enum `hadoop.common.RpcResponseHeaderProto.RpcErrorCodeProto`
`static class`	`RpcHeaderProtos.RpcResponseHeaderProto.RpcStatusProto` Protobuf enum `hadoop.common.RpcResponseHeaderProto.RpcStatusProto`

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` Deprecated.
`static int`	`RETRYCOUNT_FIELD_NUMBER`
`static int`	`SERVERIPCVERSIONNUM_FIELD_NUMBER`
`static int`	`STATEID_FIELD_NUMBER`
`static int`	`STATUS_FIELD_NUMBER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`int`	`getCallId()` callId used in Request
`com.google.protobuf.ByteString`	`getClientId()` Globally unique client ID
`static RpcHeaderProtos.RpcResponseHeaderProto`	`getDefaultInstance()`
`RpcHeaderProtos.RpcResponseHeaderProto`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`RpcHeaderProtos.RpcResponseHeaderProto.RpcErrorCodeProto`	`getErrorDetail()` in case of error
`String`	`getErrorMsg()` if request fails, often contains strack trace
`com.google.protobuf.ByteString`	`getErrorMsgBytes()` if request fails, often contains strack trace
`String`	`getExceptionClassName()` if request fails
`com.google.protobuf.ByteString`	`getExceptionClassNameBytes()` if request fails
`com.google.protobuf.Parser<RpcHeaderProtos.RpcResponseHeaderProto>`	`getParserForType()`
`int`	`getRetryCount()` `optional sint32 retryCount = 8 [default = -1];`
`int`	`getSerializedSize()`
`int`	`getServerIpcVersionNum()` Sent if success or fail
`long`	`getStateId()` The last written Global State ID
`RpcHeaderProtos.RpcResponseHeaderProto.RpcStatusProto`	`getStatus()` `required .hadoop.common.RpcResponseHeaderProto.RpcStatusProto status = 2;`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasCallId()` callId used in Request
`boolean`	`hasClientId()` Globally unique client ID
`boolean`	`hasErrorDetail()` in case of error
`boolean`	`hasErrorMsg()` if request fails, often contains strack trace
`boolean`	`hasExceptionClassName()` if request fails
`int`	`hashCode()`
`boolean`	`hasRetryCount()` `optional sint32 retryCount = 8 [default = -1];`
`boolean`	`hasServerIpcVersionNum()` Sent if success or fail
`boolean`	`hasStateId()` The last written Global State ID
`boolean`	`hasStatus()` `required .hadoop.common.RpcResponseHeaderProto.RpcStatusProto status = 2;`
`protected com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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(ByteBuffer data)`
`static RpcHeaderProtos.RpcResponseHeaderProto`	`parseFrom(ByteBuffer 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)`
`static com.google.protobuf.Parser<RpcHeaderProtos.RpcResponseHeaderProto>`	`parser()`
`RpcHeaderProtos.RpcResponseHeaderProto.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getRepeatedField, getRepeatedFieldCount, hasField

Field Detail

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

STATEID_FIELD_NUMBER
```
public static final int STATEID_FIELD_NUMBER
```
See Also:

Constant Field Values

PARSER

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

Deprecated.

Method Detail

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

getDescriptor

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

internalGetFieldAccessorTable

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

hasCallId
```
public boolean hasCallId()
```
```
 callId used in Request
 
```
required uint32 callId = 1;
Specified by:

hasCallId in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getCallId
```
public int getCallId()
```
```
 callId used in Request
 
```
required uint32 callId = 1;
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()
```
```
 Sent if success or fail
 
```
optional uint32 serverIpcVersionNum = 3;
Specified by:

hasServerIpcVersionNum in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getServerIpcVersionNum
```
public int getServerIpcVersionNum()
```
```
 Sent if success or fail
 
```
optional uint32 serverIpcVersionNum = 3;
Specified by:

getServerIpcVersionNum in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

hasExceptionClassName
```
public boolean hasExceptionClassName()
```
```
 if request fails
 
```
optional string exceptionClassName = 4;
Specified by:

hasExceptionClassName in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getExceptionClassName
```
public String getExceptionClassName()
```
```
 if request fails
 
```
optional string exceptionClassName = 4;
Specified by:

getExceptionClassName in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getExceptionClassNameBytes
```
public com.google.protobuf.ByteString getExceptionClassNameBytes()
```
```
 if request fails
 
```
optional string exceptionClassName = 4;
Specified by:

getExceptionClassNameBytes in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

hasErrorMsg
```
public boolean hasErrorMsg()
```
```
 if request fails, often contains strack trace
 
```
optional string errorMsg = 5;
Specified by:

hasErrorMsg in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getErrorMsg
```
public String getErrorMsg()
```
```
 if request fails, often contains strack trace
 
```
optional string errorMsg = 5;
Specified by:

getErrorMsg in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getErrorMsgBytes
```
public com.google.protobuf.ByteString getErrorMsgBytes()
```
```
 if request fails, often contains strack trace
 
```
optional string errorMsg = 5;
Specified by:

getErrorMsgBytes in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

hasErrorDetail
```
public boolean hasErrorDetail()
```
```
 in case of error
 
```
optional .hadoop.common.RpcResponseHeaderProto.RpcErrorCodeProto errorDetail = 6;
Specified by:

hasErrorDetail in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getErrorDetail
```
public RpcHeaderProtos.RpcResponseHeaderProto.RpcErrorCodeProto getErrorDetail()
```
```
 in case of error
 
```
optional .hadoop.common.RpcResponseHeaderProto.RpcErrorCodeProto errorDetail = 6;
Specified by:

getErrorDetail in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

hasClientId
```
public boolean hasClientId()
```
```
 Globally unique client ID
 
```
optional bytes clientId = 7;
Specified by:

hasClientId in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getClientId
```
public com.google.protobuf.ByteString getClientId()
```
```
 Globally unique client ID
 
```
optional bytes clientId = 7;
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

hasStateId
```
public boolean hasStateId()
```
```
 The last written Global State ID
 
```
optional int64 stateId = 9;
Specified by:

hasStateId in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

getStateId
```
public long getStateId()
```
```
 The last written Global State ID
 
```
optional int64 stateId = 9;
Specified by:

getStateId in interface RpcHeaderProtos.RpcResponseHeaderProtoOrBuilder

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

writeTo

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

Throws:: IOException

getSerializedSize
```
public int getSerializedSize()
```

equals
```
public boolean equals(Object obj)
```

hashCode
```
public int hashCode()
```

parseFrom

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

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:: com.google.protobuf.InvalidProtocolBufferException

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

newBuilderForType

public RpcHeaderProtos.RpcResponseHeaderProto.Builder newBuilderForType()

newBuilder

public static RpcHeaderProtos.RpcResponseHeaderProto.Builder newBuilder()

newBuilder

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

toBuilder

public RpcHeaderProtos.RpcResponseHeaderProto.Builder toBuilder()

newBuilderForType

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

getDefaultInstance

public static RpcHeaderProtos.RpcResponseHeaderProto getDefaultInstance()

parser

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

getParserForType

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

getDefaultInstanceForType
```
public RpcHeaderProtos.RpcResponseHeaderProto getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

Class RpcHeaderProtos.RpcResponseHeaderProto

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Field Detail

CALLID_FIELD_NUMBER

STATUS_FIELD_NUMBER

SERVERIPCVERSIONNUM_FIELD_NUMBER

EXCEPTIONCLASSNAME_FIELD_NUMBER

ERRORMSG_FIELD_NUMBER

ERRORDETAIL_FIELD_NUMBER

CLIENTID_FIELD_NUMBER

RETRYCOUNT_FIELD_NUMBER

STATEID_FIELD_NUMBER

PARSER

Method Detail

getUnknownFields

getDescriptor

internalGetFieldAccessorTable

hasCallId

getCallId

hasStatus

getStatus

hasServerIpcVersionNum

getServerIpcVersionNum

hasExceptionClassName

getExceptionClassName

getExceptionClassNameBytes

hasErrorMsg

getErrorMsg

getErrorMsgBytes

hasErrorDetail

getErrorDetail

hasClientId

getClientId

hasRetryCount

getRetryCount

hasStateId

getStateId

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

newBuilderForType

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType