ProtoMessage (Alluxio Parent 305-SNAPSHOT API)

java.lang.Object
- alluxio.util.proto.ProtoMessage

```
public final class ProtoMessage
extends Object
```
A simple wrapper around the MessageLite class in Protobuf for a few messages defined and generated in Alluxio. In other parts of Alluxio code base that are outside of this module, use this class to replace MessageLite when it must reference MessageLite as a base class of different generated messages. This class is intended to be used internally only. For any new proto message added here, consider adding a test in alluxio.worker.netty.CodecTest.

Constructor Summary

Constructors
Constructor and Description
`ProtoMessage(Protocol.AsyncCacheRequest request)`
`ProtoMessage(Protocol.Heartbeat heartbeat)`
`ProtoMessage(Protocol.LocalBlockCloseRequest request)`
`ProtoMessage(Protocol.LocalBlockCompleteRequest request)`
`ProtoMessage(Protocol.LocalBlockCreateRequest request)`
`ProtoMessage(Protocol.LocalBlockCreateResponse response)`
`ProtoMessage(Protocol.LocalBlockOpenRequest request)`
`ProtoMessage(Protocol.LocalBlockOpenResponse response)`
`ProtoMessage(Protocol.ReadRequest readRequest)`
`ProtoMessage(Protocol.ReadResponse response)`
`ProtoMessage(Protocol.Response response)`
`ProtoMessage(Protocol.WriteRequest writeRequest)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Protocol.AsyncCacheRequest`	`asAsyncCacheRequest()`
`Protocol.LocalBlockCloseRequest`	`asLocalBlockCloseRequest()` Gets the local block close request or throws runtime exception if mMessage is not of type `Protocol.LocalBlockCloseRequest`.
`Protocol.LocalBlockCompleteRequest`	`asLocalBlockCompleteRequest()`
`Protocol.LocalBlockCreateRequest`	`asLocalBlockCreateRequest()`
`Protocol.LocalBlockCreateResponse`	`asLocalBlockCreateResponse()`
`Protocol.LocalBlockOpenRequest`	`asLocalBlockOpenRequest()` Gets the local block open request or throws runtime exception if mMessage is not of type `Protocol.LocalBlockOpenRequest`.
`Protocol.LocalBlockOpenResponse`	`asLocalBlockOpenResponse()` Gets the local block open response or throws runtime exception if mMessage is not of type `Protocol.LocalBlockOpenResponse`.
`Protocol.ReadRequest`	`asReadRequest()` Gets the read request or throws runtime exception if mMessage is not of type `Protocol.ReadRequest`.
`Protocol.ReadResponse`	`asReadResponse()` Gets the read response or throws runtime exception if mMessage is not of type `Protocol.ReadResponse`.
`Protocol.Response`	`asResponse()` Gets the response or throws runtime exception if mMessage is not of type `Protocol.Response`.
`Protocol.WriteRequest`	`asWriteRequest()` Gets the write request or throws runtime exception if mMessage is not of type `Protocol.WriteRequest`.
`boolean`	`isAsyncCacheRequest()`
`boolean`	`isHeartbeat()`
`boolean`	`isLocalBlockCloseRequest()`
`boolean`	`isLocalBlockCompleteRequest()`
`boolean`	`isLocalBlockCreateRequest()`
`boolean`	`isLocalBlockCreateResponse()`
`boolean`	`isLocalBlockOpenRequest()`
`boolean`	`isLocalBlockOpenResponse()`
`boolean`	`isReadRequest()`
`boolean`	`isReadResponse()`
`boolean`	`isResponse()`
`boolean`	`isWriteRequest()`
`static ProtoMessage`	`parseFrom(byte[] serialized, ProtoMessage prototype)` Parses proto message from bytes given a prototype.
`byte[]`	`toByteArray()`
`String`	`toString()`

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

- Constructor Detail
  - ProtoMessage
```
public ProtoMessage(Protocol.ReadRequest readRequest)
```
    Parameters:
    
    readRequest - the read request
  - ProtoMessage
```
public ProtoMessage(Protocol.WriteRequest writeRequest)
```
    Parameters:
    
    writeRequest - the write request
  - ProtoMessage
```
public ProtoMessage(Protocol.Response response)
```
    Parameters:
    
    response - the response
  - ProtoMessage
```
public ProtoMessage(Protocol.ReadResponse response)
```
    Parameters:
    
    response - the read response
  - ProtoMessage
```
public ProtoMessage(Protocol.LocalBlockOpenRequest request)
```
    Parameters:
    
    request - the local block open request
  - ProtoMessage
```
public ProtoMessage(Protocol.LocalBlockOpenResponse response)
```
    Parameters:
    
    response - the local block open response
  - ProtoMessage
```
public ProtoMessage(Protocol.LocalBlockCloseRequest request)
```
    Parameters:
    
    request - the local block close request
  - ProtoMessage
```
public ProtoMessage(Protocol.LocalBlockCreateRequest request)
```
    Parameters:
    
    request - the local block create request
  - ProtoMessage
```
public ProtoMessage(Protocol.LocalBlockCreateResponse response)
```
    Parameters:
    
    response - the local block create response
  - ProtoMessage
```
public ProtoMessage(Protocol.LocalBlockCompleteRequest request)
```
    Parameters:
    
    request - the local block complete request
  - ProtoMessage
```
public ProtoMessage(Protocol.AsyncCacheRequest request)
```
    Parameters:
    
    request - the async cache request
  - ProtoMessage
```
public ProtoMessage(Protocol.Heartbeat heartbeat)
```
    Parameters:
    
    heartbeat - the heartbeat
- Method Detail
  - asReadRequest
```
public Protocol.ReadRequest asReadRequest()
```
    Gets the read request or throws runtime exception if mMessage is not of type Protocol.ReadRequest.
    
    Returns:
    
    the read request
  - isReadRequest
```
public boolean isReadRequest()
```
    Returns:
    
    true if mMessage is of type Protocol.ReadRequest
  - asWriteRequest
```
public Protocol.WriteRequest asWriteRequest()
```
    Gets the write request or throws runtime exception if mMessage is not of type Protocol.WriteRequest.
    
    Returns:
    
    the write request
  - isWriteRequest
```
public boolean isWriteRequest()
```
    Returns:
    
    true if mMessage is of type Protocol.WriteRequest
  - asResponse
```
public Protocol.Response asResponse()
```
    Gets the response or throws runtime exception if mMessage is not of type Protocol.Response.
    
    Returns:
    
    the response
  - isResponse
```
public boolean isResponse()
```
    Returns:
    
    true if mMessage is of type Protocol.Response
  - asReadResponse
```
public Protocol.ReadResponse asReadResponse()
```
    Gets the read response or throws runtime exception if mMessage is not of type Protocol.ReadResponse.
    
    Returns:
    
    the read response
  - isReadResponse
```
public boolean isReadResponse()
```
    Returns:
    
    true if mMessage is of type Protocol.ReadResponse
  - asLocalBlockOpenRequest
```
public Protocol.LocalBlockOpenRequest asLocalBlockOpenRequest()
```
    Gets the local block open request or throws runtime exception if mMessage is not of type Protocol.LocalBlockOpenRequest.
    
    Returns:
    
    the Protocol.LocalBlockOpenRequest
  - isLocalBlockOpenRequest
```
public boolean isLocalBlockOpenRequest()
```
    Returns:
    
    true if mMessage is of type Protocol.LocalBlockOpenRequest
  - asLocalBlockOpenResponse
```
public Protocol.LocalBlockOpenResponse asLocalBlockOpenResponse()
```
    Gets the local block open response or throws runtime exception if mMessage is not of type Protocol.LocalBlockOpenResponse.
    
    Returns:
    
    the Protocol.LocalBlockOpenResponse
  - isLocalBlockOpenResponse
```
public boolean isLocalBlockOpenResponse()
```
    Returns:
    
    true if mMessage is of type Protocol.LocalBlockOpenResponse
  - asLocalBlockCloseRequest
```
public Protocol.LocalBlockCloseRequest asLocalBlockCloseRequest()
```
    Gets the local block close request or throws runtime exception if mMessage is not of type Protocol.LocalBlockCloseRequest.
    
    Returns:
    
    the Protocol.LocalBlockCloseRequest
  - isLocalBlockCloseRequest
```
public boolean isLocalBlockCloseRequest()
```
    Returns:
    
    true if mMessage is of type Protocol.LocalBlockCloseRequest
  - asLocalBlockCreateRequest
```
public Protocol.LocalBlockCreateRequest asLocalBlockCreateRequest()
```
    Returns:
    
    the Protocol.LocalBlockCreateRequest
  - isLocalBlockCreateRequest
```
public boolean isLocalBlockCreateRequest()
```
    Returns:
    
    true if mMessage is of type Protocol.LocalBlockCreateRequest
  - asLocalBlockCreateResponse
```
public Protocol.LocalBlockCreateResponse asLocalBlockCreateResponse()
```
    Returns:
    
    the Protocol.LocalBlockCreateResponse
  - isLocalBlockCreateResponse
```
public boolean isLocalBlockCreateResponse()
```
    Returns:
    
    true if mMessage is of type Protocol.LocalBlockCreateResponse
  - asLocalBlockCompleteRequest
```
public Protocol.LocalBlockCompleteRequest asLocalBlockCompleteRequest()
```
    Returns:
    
    the Protocol.LocalBlockCompleteRequest
  - isLocalBlockCompleteRequest
```
public boolean isLocalBlockCompleteRequest()
```
    Returns:
    
    true if mMessage is of type Protocol.LocalBlockCompleteRequest
  - asAsyncCacheRequest
```
public Protocol.AsyncCacheRequest asAsyncCacheRequest()
```
    Returns:
    
    an AsyncCacheRequest object if the message is of the same type
  - isAsyncCacheRequest
```
public boolean isAsyncCacheRequest()
```
    Returns:
    
    true if the message is of type AsyncCacheRequest
  - isHeartbeat
```
public boolean isHeartbeat()
```
    Returns:
    
    true if the message is of type Protocol.Heartbeat
  - toByteArray
```
public byte[] toByteArray()
```
    Returns:
    
    the serialized message as byte array
  - parseFrom
```
public static ProtoMessage parseFrom(byte[] serialized,
                                     ProtoMessage prototype)
```
    Parses proto message from bytes given a prototype.
    
    Parameters:
    
    serialized - the serialized message
    
    prototype - the prototype of the message to return which is usually constructed via new ProtoMessage(SomeProtoType.getDefaultInstance())
    
    Returns:
    
    the proto message
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ProtoMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProtoMessage

ProtoMessage

ProtoMessage

ProtoMessage

ProtoMessage

ProtoMessage

ProtoMessage

ProtoMessage

ProtoMessage

ProtoMessage

ProtoMessage

ProtoMessage

Method Detail

asReadRequest

isReadRequest

asWriteRequest

isWriteRequest

asResponse

isResponse

asReadResponse

isReadResponse

asLocalBlockOpenRequest

isLocalBlockOpenRequest

asLocalBlockOpenResponse

isLocalBlockOpenResponse

asLocalBlockCloseRequest

isLocalBlockCloseRequest

asLocalBlockCreateRequest

isLocalBlockCreateRequest

asLocalBlockCreateResponse

isLocalBlockCreateResponse

asLocalBlockCompleteRequest

isLocalBlockCompleteRequest

asAsyncCacheRequest

isAsyncCacheRequest

isHeartbeat

toByteArray

parseFrom

toString