ProtobufUtil (Apache HBase 2.1.0-cdh6.3.2 API)

java.lang.Object
- org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil

```
@InterfaceAudience.Private
public final class ProtobufUtil
extends Object
```
Protobufs utility. Be aware that a class named org.apache.hadoop.hbase.protobuf.ProtobufUtil (i.e. no 'shaded' in the package name) carries a COPY of a subset of this class for non-shaded users; e.g. Coprocessor Endpoints. If you make change in here, be sure to make change in the companion class too (not the end of the world, especially if you are adding new functionality but something to be aware of.

See Also:

ProtobufUtil

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static AdminProtos.CloseRegionRequest`	`buildCloseRegionRequest(ServerName server, byte[] regionName)` Create a CloseRegionRequest for a given region name
`static AdminProtos.CloseRegionRequest`	`buildCloseRegionRequest(ServerName server, byte[] regionName, ServerName destinationServer)`
`static AdminProtos.GetStoreFileRequest`	`buildGetStoreFileRequest(byte[] regionName, byte[] family)` Create a protocol buffer GetStoreFileRequest for a given region name
`static HBaseProtos.ProcedureDescription`	`buildProcedureDescription(String signature, String instance, Map<String,String> props)`
`static <T> T`	`call(Callable<T> callable)` Contain ServiceException inside here.
`static void`	`closeRegion(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller, AdminProtos.AdminService.BlockingInterface admin, ServerName server, byte[] regionName)` A helper to close a region given a region name using admin protocol.
`static CompactionState`	`createCompactionState(AdminProtos.GetRegionInfoResponse.CompactionState state)` Creates `CompactionState` from `AdminProtos.GetRegionInfoResponse.CompactionState` state
`static AdminProtos.GetRegionInfoResponse.CompactionState`	`createCompactionState(CompactionState state)`
`static SnapshotProtos.SnapshotDescription`	`createHBaseProtosSnapshotDesc(SnapshotDescription snapshotDesc)` Convert from `SnapshotDescription` to `HBaseProtos.SnapshotDescription`
`static SnapshotProtos.SnapshotDescription.Type`	`createProtosSnapShotDescType(SnapshotType type)` Creates `HBaseProtos.SnapshotDescription.Type` from `SnapshotType`
`static SnapshotProtos.SnapshotDescription.Type`	`createProtosSnapShotDescType(String snapshotDesc)` Creates `HBaseProtos.SnapshotDescription.Type` from the type of SnapshotDescription string
`static RegionLoadStats`	`createRegionLoadStats(ClientProtos.RegionLoadStats stats)`
`static SnapshotDescription`	`createSnapshotDesc(SnapshotProtos.SnapshotDescription snapshotDesc)` Convert from `HBaseProtos.SnapshotDescription` to `SnapshotDescription`
`static SnapshotType`	`createSnapshotType(SnapshotProtos.SnapshotDescription.Type type)` Creates `SnapshotType` from the type of `HBaseProtos.SnapshotDescription`
`static void`	`expectPBMagicPrefix(byte[] bytes)`
`static KeyValue.Type`	`fromDeleteType(ClientProtos.MutationProto.DeleteType type)` Convert a protocol buffer DeleteType to delete KeyValue type.
`static List<RegionInfo>`	`getOnlineRegions(AdminProtos.AdminService.BlockingInterface admin)` A helper to get the all the online regions on a region server using admin protocol.
`static List<RegionInfo>`	`getOnlineRegions(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller, AdminProtos.AdminService.BlockingInterface admin)` A helper to get the all the online regions on a region server using admin protocol.
`static String`	`getRegionEncodedName(HBaseProtos.RegionSpecifier regionSpecifier)` Find the HRegion encoded name based on a region specifier
`static RegionInfo`	`getRegionInfo(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller, AdminProtos.AdminService.BlockingInterface admin, byte[] regionName)` A helper to retrieve region info given a region name using admin protocol.
`static List<RegionInfo>`	`getRegionInfos(AdminProtos.GetOnlineRegionResponse proto)` Get the list of region info from a GetOnlineRegionResponse
`static List<RegionLoad>`	`getRegionLoadInfo(AdminProtos.GetRegionLoadResponse regionLoadResponse)`
`static IOException`	`getRemoteException(org.apache.hbase.thirdparty.com.google.protobuf.ServiceException se)` Return the IOException thrown by the remote server wrapped in ServiceException as cause.
`static AdminProtos.ServerInfo`	`getServerInfo(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller, AdminProtos.AdminService.BlockingInterface admin)` A helper to get the info of a region server using admin protocol.
`static String`	`getShortTextFormat(org.apache.hbase.thirdparty.com.google.protobuf.Message m)` Return short version of Message toString'd, shorter than TextFormat#shortDebugString.
`static byte[][]`	`getSplitKeysArray(MasterProtos.CreateTableRequest proto)` get the split keys in form "byte [][]" from a CreateTableRequest proto
`static List<String>`	`getStoreFiles(AdminProtos.AdminService.BlockingInterface admin, byte[] regionName, byte[] family)` A helper to get the list of files of a column family on a given region using admin protocol.
`static List<String>`	`getStoreFiles(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller, AdminProtos.AdminService.BlockingInterface admin, byte[] regionName, byte[] family)` A helper to get the list of files of a column family on a given region using admin protocol.
`static TableName[]`	`getTableNameArray(List<HBaseProtos.TableName> tableNamesList)`
`static long`	`getTotalRequestsCount(ClusterStatusProtos.RegionLoad rl)`
`static HBaseProtos.VersionInfo`	`getVersionInfo()` Get a protocol buffer VersionInfo
`static IOException`	`handleRemoteException(Exception e)` Like `getRemoteException(ServiceException)` but more generic, able to handle more than just `ServiceException`.
`static boolean`	`isClassLoaderLoaded()`
`static boolean`	`isPBMagicPrefix(byte[] bytes)`
`static boolean`	`isPBMagicPrefix(byte[] bytes, int offset, int len)`
`static int`	`lengthOfPBMagic()`
`static void`	`mergeDelimitedFrom(org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder builder, InputStream in)` This version of protobuf's mergeDelimitedFrom avoid the hard-coded 64MB limit for decoding buffers
`static void`	`mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder builder, byte[] b)` This version of protobuf's mergeFrom avoids the hard-coded 64MB limit for decoding buffers when working with byte arrays
`static void`	`mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder builder, byte[] b, int offset, int length)` This version of protobuf's mergeFrom avoids the hard-coded 64MB limit for decoding buffers when working with byte arrays
`static void`	`mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder builder, org.apache.hbase.thirdparty.com.google.protobuf.ByteString bs)` This version of protobuf's mergeFrom avoids the hard-coded 64MB limit for decoding buffers when working with ByteStrings
`static void`	`mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder builder, org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream codedInput, int length)`
`static void`	`mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder builder, InputStream in)` This version of protobuf's mergeFrom avoids the hard-coded 64MB limit for decoding buffers where the message size is not known
`static void`	`mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder builder, InputStream in, int size)` This version of protobuf's mergeFrom avoids the hard-coded 64MB limit for decoding buffers where the message size is known
`static <T extends org.apache.hbase.thirdparty.com.google.protobuf.Service> T`	`newServiceStub(Class<T> service, org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel channel)`
`static void`	`openRegion(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller, AdminProtos.AdminService.BlockingInterface admin, ServerName server, RegionInfo region)` A helper to open a region using admin protocol.
`static ServerName`	`parseServerNameFrom(byte[] data)` Get a ServerName from the passed in data bytes.
`static byte[]`	`prependPBMagic(byte[] bytes)` Prepend the passed bytes with four bytes of magic, `ProtobufMagic.PB_MAGIC`, to flag what follows as a protobuf in hbase.
`static Append`	`toAppend(ClientProtos.MutationProto proto, CellScanner cellScanner)` Convert a protocol buffer Mutate to an Append
`static ClientProtos.Authorizations`	`toAuthorizations(Authorizations authorizations)` Create a protocol buffer Authorizations based on a client Authorizations.
`static Authorizations`	`toAuthorizations(byte[] protoBytes)` Convert a protocol buffer Authorizations bytes to a client Authorizations
`static Authorizations`	`toAuthorizations(ClientProtos.Authorizations proto)` Convert a protocol buffer Authorizations to a client Authorizations
`static WALProtos.BulkLoadDescriptor`	`toBulkLoadDescriptor(TableName tableName, org.apache.hbase.thirdparty.com.google.protobuf.ByteString encodedRegionName, Map<byte[],List<org.apache.hadoop.fs.Path>> storeFiles, Map<String,Long> storeFilesSize, long bulkloadSeqId)` Generates a marker for the WAL so that we propagate the notion of a bulk region load throughout the WAL.
`static ComparatorProtos.ByteArrayComparable`	`toByteArrayComparable(byte[] value)`
`static byte[]`	`toBytes(org.apache.hbase.thirdparty.com.google.protobuf.ByteString bs)`
`static HBaseProtos.CacheEvictionStats`	`toCacheEvictionStats(CacheEvictionStats cacheEvictionStats)`
`static CacheEvictionStats`	`toCacheEvictionStats(HBaseProtos.CacheEvictionStats stats)`
`static CellProtos.Cell`	`toCell(Cell kv)`
`static Cell`	`toCell(ExtendedCellBuilder cellBuilder, CellProtos.Cell cell)`
`static CellVisibility`	`toCellVisibility(byte[] protoBytes)` Convert a protocol buffer CellVisibility bytes to a client CellVisibility
`static ClientProtos.CellVisibility`	`toCellVisibility(CellVisibility cellVisibility)` Create a protocol buffer CellVisibility based on a client CellVisibility.
`static CellVisibility`	`toCellVisibility(ClientProtos.CellVisibility proto)` Convert a protocol buffer CellVisibility to a client CellVisibility
`static ColumnFamilyDescriptor`	`toColumnFamilyDescriptor(HBaseProtos.ColumnFamilySchema cfs)` Converts a ColumnFamilySchema to ColumnFamilyDescriptor
`static HBaseProtos.ColumnFamilySchema`	`toColumnFamilySchema(ColumnFamilyDescriptor hcd)` Converts an ColumnFamilyDescriptor to ColumnFamilySchema
`static WALProtos.CompactionDescriptor`	`toCompactionDescriptor(RegionInfo info, byte[] regionName, byte[] family, List<org.apache.hadoop.fs.Path> inputPaths, List<org.apache.hadoop.fs.Path> outputPaths, org.apache.hadoop.fs.Path storeDir)`
`static WALProtos.CompactionDescriptor`	`toCompactionDescriptor(RegionInfo info, byte[] family, List<org.apache.hadoop.fs.Path> inputPaths, List<org.apache.hadoop.fs.Path> outputPaths, org.apache.hadoop.fs.Path storeDir)`
`static ComparatorProtos.Comparator`	`toComparator(ByteArrayComparable comparator)` Convert a ByteArrayComparable to a protocol buffer Comparator
`static ByteArrayComparable`	`toComparator(ComparatorProtos.Comparator proto)` Convert a protocol buffer Comparator to a ByteArrayComparable
`static Consistency`	`toConsistency(ClientProtos.Consistency consistency)`
`static ClientProtos.Consistency`	`toConsistency(Consistency consistency)`
`static ClientProtos.Cursor`	`toCursor(Cell cell)`
`static Cursor`	`toCursor(ClientProtos.Cursor cursor)`
`static ClientProtos.Cursor`	`toCursor(Cursor cursor)`
`static Delete`	`toDelete(ClientProtos.MutationProto proto)` Convert a protocol buffer Mutate to a Delete
`static Delete`	`toDelete(ClientProtos.MutationProto proto, CellScanner cellScanner)` Convert a protocol buffer Mutate to a Delete
`static ClientProtos.MutationProto.DeleteType`	`toDeleteType(KeyValue.Type type)` Convert a delete KeyValue type to protocol buffer DeleteType.
`static byte[]`	`toDelimitedByteArray(org.apache.hbase.thirdparty.com.google.protobuf.Message m)`
`static Durability`	`toDurability(ClientProtos.MutationProto.Durability proto)` Convert a protobuf Durability into a client Durability
`static ClientProtos.MutationProto.Durability`	`toDurability(Durability d)` Convert a client Durability into a protbuf Durability
`static Throwable`	`toException(HBaseProtos.NameBytesPair parameter)` Convert a stringified protocol buffer exception Parameter to a Java Exception
`static FilterProtos.Filter`	`toFilter(Filter filter)` Convert a client Filter to a protocol buffer Filter
`static Filter`	`toFilter(FilterProtos.Filter proto)` Convert a protocol buffer Filter to a client Filter
`static WALProtos.FlushDescriptor`	`toFlushDescriptor(WALProtos.FlushDescriptor.FlushAction action, RegionInfo hri, long flushSeqId, Map<byte[],List<org.apache.hadoop.fs.Path>> committedFiles)`
`static Get`	`toGet(ClientProtos.Get proto)` Convert a protocol buffer Get to a client Get
`static Get`	`toGet(ClientProtos.MutationProto proto, CellScanner cellScanner)` Convert a protocol buffer Mutate to a Get.
`static ClientProtos.Get`	`toGet(Get get)` Create a protocol buffer Get based on a client Get.
`static Increment`	`toIncrement(ClientProtos.MutationProto proto, CellScanner cellScanner)` Convert a protocol buffer Mutate to an Increment
`static void`	`toIOException(org.apache.hbase.thirdparty.com.google.protobuf.ServiceException se)` Unwraps an exception from a protobuf service into the underlying (expected) IOException.
`static String`	`toLockJson(List<LockServiceProtos.LockedResource> lockedResourceProtos)`
`static ClientProtos.MutationProto`	`toMutation(ClientProtos.MutationProto.MutationType type, Mutation mutation)`
`static ClientProtos.MutationProto`	`toMutation(ClientProtos.MutationProto.MutationType type, Mutation mutation, ClientProtos.MutationProto.Builder builder)`
`static ClientProtos.MutationProto`	`toMutation(ClientProtos.MutationProto.MutationType type, Mutation mutation, ClientProtos.MutationProto.Builder builder, long nonce)`
`static ClientProtos.MutationProto`	`toMutation(ClientProtos.MutationProto.MutationType type, Mutation mutation, long nonce)` Create a protocol buffer Mutate based on a client Mutation
`static Mutation`	`toMutation(ClientProtos.MutationProto proto)` Convert a MutateRequest to Mutation
`static ClientProtos.MutationProto`	`toMutationNoData(ClientProtos.MutationProto.MutationType type, Mutation mutation)` Create a protocol buffer MutationProto based on a client Mutation.
`static ClientProtos.MutationProto`	`toMutationNoData(ClientProtos.MutationProto.MutationType type, Mutation mutation, ClientProtos.MutationProto.Builder builder)` Create a protocol buffer MutationProto based on a client Mutation.
`static ClientProtos.MutationProto`	`toMutationNoData(ClientProtos.MutationProto.MutationType type, Mutation mutation, ClientProtos.MutationProto.Builder builder, long nonce)`
`static NamespaceDescriptor`	`toNamespaceDescriptor(HBaseProtos.NamespaceDescriptor desc)`
`static List<NamespaceDescriptor>`	`toNamespaceDescriptorList(MasterProtos.ListNamespaceDescriptorsResponse proto)` Get a list of NamespaceDescriptor from ListNamespaceDescriptorsResponse protobuf
`static Optional<Long>`	`toOptionalTimestamp(MasterProtos.MajorCompactionTimestampResponse resp)`
`static String`	`toProcedureJson(List<ProcedureProtos.Procedure> procProtos)` Helper to convert the protobuf Procedure to JSON String
`static HBaseProtos.NamespaceDescriptor`	`toProtoNamespaceDescriptor(NamespaceDescriptor ns)`
`static QuotaProtos.QuotaScope`	`toProtoQuotaScope(QuotaScope scope)` Convert a client QuotaScope to a protocol buffer QuotaScope
`static QuotaProtos.QuotaType`	`toProtoQuotaScope(QuotaType type)` Convert a client QuotaType to a protocol buffer QuotaType
`static QuotaProtos.SpaceQuota`	`toProtoSpaceQuota(long limit, SpaceViolationPolicy violationPolicy)` Builds a protocol buffer SpaceQuota.
`static HBaseProtos.TableName`	`toProtoTableName(TableName tableName)`
`static QuotaProtos.ThrottleType`	`toProtoThrottleType(ThrottleType type)` Convert a client ThrottleType to a protocol buffer ThrottleType
`static HBaseProtos.TimeUnit`	`toProtoTimeUnit(TimeUnit timeUnit)` Convert a client TimeUnit to a protocol buffer TimeUnit
`static QuotaProtos.SpaceViolationPolicy`	`toProtoViolationPolicy(SpaceViolationPolicy policy)` Converts a client SpaceViolationPolicy to a protocol buffer SpaceViolationPolicy.
`static Put`	`toPut(ClientProtos.MutationProto proto)` Convert a protocol buffer Mutate to a Put.
`static Put`	`toPut(ClientProtos.MutationProto proto, CellScanner cellScanner)` Convert a protocol buffer Mutate to a Put.
`static QuotaScope`	`toQuotaScope(QuotaProtos.QuotaScope proto)` Convert a protocol buffer QuotaScope to a client QuotaScope
`static QuotaType`	`toQuotaScope(QuotaProtos.QuotaType proto)` Convert a protocol buffer QuotaType to a client QuotaType
`static Scan.ReadType`	`toReadType(ClientProtos.Scan.ReadType readType)`
`static ClientProtos.Scan.ReadType`	`toReadType(Scan.ReadType readType)`
`static WALProtos.RegionEventDescriptor`	`toRegionEventDescriptor(WALProtos.RegionEventDescriptor.EventType eventType, byte[] tableNameAsBytes, byte[] encodedNameAsBytes, byte[] regionNameAsBytes, long seqId, ServerName server, Map<byte[],List<org.apache.hadoop.fs.Path>> storeFiles)`
`static WALProtos.RegionEventDescriptor`	`toRegionEventDescriptor(WALProtos.RegionEventDescriptor.EventType eventType, RegionInfo hri, long seqId, ServerName server, Map<byte[],List<org.apache.hadoop.fs.Path>> storeFiles)`
`static RegionInfo`	`toRegionInfo(HBaseProtos.RegionInfo proto)` Convert HBaseProto.RegionInfo to a RegionInfo
`static HBaseProtos.RegionInfo`	`toRegionInfo(RegionInfo info)` Convert a RegionInfo to a Proto RegionInfo
`static HRegionLocation`	`toRegionLocation(HBaseProtos.RegionLocation proto)`
`static HBaseProtos.RegionLocation`	`toRegionLocation(HRegionLocation loc)`
`static ReplicationLoadSink`	`toReplicationLoadSink(ClusterStatusProtos.ReplicationLoadSink rls)`
`static ClusterStatusProtos.ReplicationLoadSink`	`toReplicationLoadSink(ReplicationLoadSink rls)`
`static ReplicationLoadSource`	`toReplicationLoadSource(ClusterStatusProtos.ReplicationLoadSource rls)`
`static ClusterStatusProtos.ReplicationLoadSource`	`toReplicationLoadSource(ReplicationLoadSource rls)`
`static ClientProtos.Result`	`toResult(boolean existence, boolean stale)` Convert a client Result to a protocol buffer Result
`static Result`	`toResult(ClientProtos.Result proto)` Convert a protocol buffer Result to a client Result
`static Result`	`toResult(ClientProtos.Result proto, CellScanner scanner)` Convert a protocol buffer Result to a client Result
`static ClientProtos.Result`	`toResult(Result result)` Convert a client Result to a protocol buffer Result
`static ClientProtos.Result`	`toResultNoData(Result result)` Convert a client Result to a protocol buffer Result.
`static Scan`	`toScan(ClientProtos.Scan proto)` Convert a protocol buffer Scan to a client Scan
`static ClientProtos.Scan`	`toScan(Scan scan)` Convert a client Scan to a protocol buffer Scan
`static ScanMetrics`	`toScanMetrics(byte[] bytes)`
`static MapReduceProtos.ScanMetrics`	`toScanMetrics(ScanMetrics scanMetrics, boolean reset)`
`static List<SecurityCapability>`	`toSecurityCapabilityList(List<MasterProtos.SecurityCapabilitiesResponse.Capability> capabilities)` Convert SecurityCapabilitiesResponse.Capability to SecurityCapability
`static ServerName`	`toServerName(HBaseProtos.ServerName proto)` Convert a protocol buffer ServerName to a ServerName
`static HBaseProtos.ServerName`	`toServerName(ServerName serverName)` Convert a ServerName to a protocol buffer ServerName
`static List<ServerName>`	`toServerNameList(List<HBaseProtos.ServerName> proto)` Convert a list of protocol buffer ServerName to a list of ServerName
`static List<SnapshotDescription>`	`toSnapshotDescriptionList(MasterProtos.GetCompletedSnapshotsResponse response, Pattern pattern)`
`static TableDescriptor`	`toTableDescriptor(HBaseProtos.TableSchema ts)` Converts a TableSchema to TableDescriptor
`static List<TableDescriptor>`	`toTableDescriptorList(MasterProtos.GetTableDescriptorsResponse proto)` Get a list of TableDescriptor from GetTableDescriptorsResponse protobuf
`static List<TableDescriptor>`	`toTableDescriptorList(MasterProtos.ListTableDescriptorsByNamespaceResponse proto)` Get a list of TableDescriptor from ListTableDescriptorsByNamespaceResponse protobuf
`static TableName`	`toTableName(HBaseProtos.TableName tableNamePB)`
`static List<TableName>`	`toTableNameList(List<HBaseProtos.TableName> tableNamesList)`
`static HBaseProtos.TableSchema`	`toTableSchema(TableDescriptor htd)` Converts an TableDescriptor to TableSchema
`static String`	`toText(org.apache.hbase.thirdparty.com.google.protobuf.Message msg)`
`static ThrottleType`	`toThrottleType(QuotaProtos.ThrottleType proto)` Convert a protocol buffer ThrottleType to a client ThrottleType
`static QuotaProtos.TimedQuota`	`toTimedQuota(long limit, TimeUnit timeUnit, QuotaScope scope)` Build a protocol buffer TimedQuota
`static TimeRange`	`toTimeRange(HBaseProtos.TimeRange timeRange)`
`static HBaseProtos.TimeRange`	`toTimeRange(TimeRange timeRange)`
`static TimeUnit`	`toTimeUnit(HBaseProtos.TimeUnit proto)` Convert a protocol buffer TimeUnit to a client TimeUnit
`static SpaceViolationPolicy`	`toViolationPolicy(QuotaProtos.SpaceViolationPolicy proto)` Converts a protocol buffer SpaceViolationPolicy to a client SpaceViolationPolicy.
`static void`	`warmupRegion(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller, AdminProtos.AdminService.BlockingInterface admin, RegionInfo regionInfo)` A helper to warmup a region given a region name using admin protocol

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

Method Detail

isClassLoaderLoaded

public static boolean isClassLoaderLoaded()

prependPBMagic
```
public static byte[] prependPBMagic(byte[] bytes)
```
Prepend the passed bytes with four bytes of magic, ProtobufMagic.PB_MAGIC, to flag what follows as a protobuf in hbase. Prepend these bytes to all content written to znodes, etc.

Parameters:

bytes - Bytes to decorate

Returns:

The passed bytes with magic prepended (Creates a new byte array that is bytes.length plus ProtobufMagic.PB_MAGIC.length.

isPBMagicPrefix
```
public static boolean isPBMagicPrefix(byte[] bytes)
```
Parameters:

bytes - Bytes to check.

Returns:

True if passed bytes has ProtobufMagic.PB_MAGIC for a prefix.

isPBMagicPrefix
```
public static boolean isPBMagicPrefix(byte[] bytes,
                                      int offset,
                                      int len)
```
Parameters:

bytes - Bytes to check.

offset - offset to start at

len - length to use

Returns:

True if passed bytes has ProtobufMagic.PB_MAGIC for a prefix.

expectPBMagicPrefix
```
public static void expectPBMagicPrefix(byte[] bytes)
                                throws DeserializationException
```
Parameters:

bytes - bytes to check

Throws:

DeserializationException - if we are missing the pb magic prefix

lengthOfPBMagic
```
public static int lengthOfPBMagic()
```
Returns:

Length of ProtobufMagic.lengthOfPBMagic()

toByteArrayComparable

public static ComparatorProtos.ByteArrayComparable toByteArrayComparable(byte[] value)

getRemoteException
```
public static IOException getRemoteException(org.apache.hbase.thirdparty.com.google.protobuf.ServiceException se)
```
Return the IOException thrown by the remote server wrapped in ServiceException as cause.

Parameters:

se - ServiceException that wraps IO exception thrown by the server

Returns:

Exception wrapped in ServiceException or a new IOException that wraps the unexpected ServiceException.

handleRemoteException
```
public static IOException handleRemoteException(Exception e)
```
Like getRemoteException(ServiceException) but more generic, able to handle more than just ServiceException. Prefer this method to getRemoteException(ServiceException) because trying to contain direct protobuf references.

Parameters:

e -

toServerName
```
public static HBaseProtos.ServerName toServerName(ServerName serverName)
```
Convert a ServerName to a protocol buffer ServerName

Parameters:

serverName - the ServerName to convert

Returns:

the converted protocol buffer ServerName

See Also:

toServerName(org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.ServerName)

toServerName
```
public static ServerName toServerName(HBaseProtos.ServerName proto)
```
Convert a protocol buffer ServerName to a ServerName

Parameters:

proto - the protocol buffer ServerName to convert

Returns:

the converted ServerName

toServerNameList
```
public static List<ServerName> toServerNameList(List<HBaseProtos.ServerName> proto)
```
Convert a list of protocol buffer ServerName to a list of ServerName

Parameters:

proto - protocol buffer ServerNameList

Returns:

a list of ServerName

toNamespaceDescriptorList
```
public static List<NamespaceDescriptor> toNamespaceDescriptorList(MasterProtos.ListNamespaceDescriptorsResponse proto)
```
Get a list of NamespaceDescriptor from ListNamespaceDescriptorsResponse protobuf

Parameters:

proto - the ListNamespaceDescriptorsResponse

Returns:

a list of NamespaceDescriptor

toTableDescriptorList
```
public static List<TableDescriptor> toTableDescriptorList(MasterProtos.GetTableDescriptorsResponse proto)
```
Get a list of TableDescriptor from GetTableDescriptorsResponse protobuf

Parameters:

proto - the GetTableDescriptorsResponse

Returns:

a list of TableDescriptor

toTableDescriptorList
```
public static List<TableDescriptor> toTableDescriptorList(MasterProtos.ListTableDescriptorsByNamespaceResponse proto)
```
Get a list of TableDescriptor from ListTableDescriptorsByNamespaceResponse protobuf

Parameters:

proto - the ListTableDescriptorsByNamespaceResponse

Returns:

a list of TableDescriptor

getSplitKeysArray
```
public static byte[][] getSplitKeysArray(MasterProtos.CreateTableRequest proto)
```
get the split keys in form "byte [][]" from a CreateTableRequest proto

Parameters:

proto - the CreateTableRequest

Returns:

the split keys

toDurability

public static Durability toDurability(ClientProtos.MutationProto.Durability proto)

Convert a protobuf Durability into a client Durability

toDurability

public static ClientProtos.MutationProto.Durability toDurability(Durability d)

Convert a client Durability into a protbuf Durability

toGet
```
public static Get toGet(ClientProtos.Get proto)
                 throws IOException
```
Convert a protocol buffer Get to a client Get

Parameters:

proto - the protocol buffer Get to convert

Returns:

the converted client Get

Throws:

IOException

toConsistency

public static Consistency toConsistency(ClientProtos.Consistency consistency)

toConsistency

public static ClientProtos.Consistency toConsistency(Consistency consistency)

toPut
```
public static Put toPut(ClientProtos.MutationProto proto)
                 throws IOException
```
Convert a protocol buffer Mutate to a Put.

Parameters:

proto - The protocol buffer MutationProto to convert

Returns:

A client Put.

Throws:

IOException

toPut
```
public static Put toPut(ClientProtos.MutationProto proto,
                        CellScanner cellScanner)
                 throws IOException
```
Convert a protocol buffer Mutate to a Put.

Parameters:

proto - The protocol buffer MutationProto to convert

cellScanner - If non-null, the Cell data that goes with this proto.

Returns:

A client Put.

Throws:

IOException

toDelete
```
public static Delete toDelete(ClientProtos.MutationProto proto)
                       throws IOException
```
Convert a protocol buffer Mutate to a Delete

Parameters:

proto - the protocol buffer Mutate to convert

Returns:

the converted client Delete

Throws:

IOException

toDelete
```
public static Delete toDelete(ClientProtos.MutationProto proto,
                              CellScanner cellScanner)
                       throws IOException
```
Convert a protocol buffer Mutate to a Delete

Parameters:

proto - the protocol buffer Mutate to convert

cellScanner - if non-null, the data that goes with this delete.

Returns:

the converted client Delete

Throws:

IOException

toAppend

public static Append toAppend(ClientProtos.MutationProto proto,
                              CellScanner cellScanner)
                       throws IOException

Convert a protocol buffer Mutate to an Append

Parameters:: cellScanner -; proto - the protocol buffer Mutate to convert
Returns:: the converted client Append
Throws:: IOException

toIncrement

public static Increment toIncrement(ClientProtos.MutationProto proto,
                                    CellScanner cellScanner)
                             throws IOException

Convert a protocol buffer Mutate to an Increment

Parameters:: proto - the protocol buffer Mutate to convert
Returns:: the converted client Increment
Throws:: IOException

toMutation
```
public static Mutation toMutation(ClientProtos.MutationProto proto)
                           throws IOException
```
Convert a MutateRequest to Mutation

Parameters:

proto - the protocol buffer Mutate to convert

Returns:

the converted Mutation

Throws:

IOException

toGet

public static Get toGet(ClientProtos.MutationProto proto,
                        CellScanner cellScanner)
                 throws IOException

Convert a protocol buffer Mutate to a Get.

Parameters:: proto - the protocol buffer Mutate to convert.; cellScanner -
Returns:: the converted client get.
Throws:: IOException

toReadType

public static ClientProtos.Scan.ReadType toReadType(Scan.ReadType readType)

toReadType

public static Scan.ReadType toReadType(ClientProtos.Scan.ReadType readType)

toScan
```
public static ClientProtos.Scan toScan(Scan scan)
                                throws IOException
```
Convert a client Scan to a protocol buffer Scan

Parameters:

scan - the client Scan to convert

Returns:

the converted protocol buffer Scan

Throws:

IOException

toScan
```
public static Scan toScan(ClientProtos.Scan proto)
                   throws IOException
```
Convert a protocol buffer Scan to a client Scan

Parameters:

proto - the protocol buffer Scan to convert

Returns:

the converted client Scan

Throws:

IOException

toCursor

public static ClientProtos.Cursor toCursor(Cursor cursor)

toCursor

public static ClientProtos.Cursor toCursor(Cell cell)

toCursor

public static Cursor toCursor(ClientProtos.Cursor cursor)

toGet
```
public static ClientProtos.Get toGet(Get get)
                              throws IOException
```
Create a protocol buffer Get based on a client Get.

Parameters:

get - the client Get

Returns:

a protocol buffer Get

Throws:

IOException

toMutation

public static ClientProtos.MutationProto toMutation(ClientProtos.MutationProto.MutationType type,
                                                    Mutation mutation)
                                             throws IOException

Throws:: IOException

toMutation

public static ClientProtos.MutationProto toMutation(ClientProtos.MutationProto.MutationType type,
                                                    Mutation mutation,
                                                    long nonce)
                                             throws IOException

Create a protocol buffer Mutate based on a client Mutation

Parameters:: type -; mutation -
Returns:: a protobuf'd Mutation
Throws:: IOException

toMutation

public static ClientProtos.MutationProto toMutation(ClientProtos.MutationProto.MutationType type,
                                                    Mutation mutation,
                                                    ClientProtos.MutationProto.Builder builder)
                                             throws IOException

Throws:: IOException

toMutation

public static ClientProtos.MutationProto toMutation(ClientProtos.MutationProto.MutationType type,
                                                    Mutation mutation,
                                                    ClientProtos.MutationProto.Builder builder,
                                                    long nonce)
                                             throws IOException

Throws:: IOException

toMutationNoData

public static ClientProtos.MutationProto toMutationNoData(ClientProtos.MutationProto.MutationType type,
                                                          Mutation mutation,
                                                          ClientProtos.MutationProto.Builder builder)
                                                   throws IOException

Create a protocol buffer MutationProto based on a client Mutation. Does NOT include data. Understanding is that the Cell will be transported other than via protobuf.

Parameters:: type -; mutation -; builder -
Returns:: a protobuf'd Mutation
Throws:: IOException

toMutationNoData

public static ClientProtos.MutationProto toMutationNoData(ClientProtos.MutationProto.MutationType type,
                                                          Mutation mutation)
                                                   throws IOException

Create a protocol buffer MutationProto based on a client Mutation. Does NOT include data. Understanding is that the Cell will be transported other than via protobuf.

Parameters:: type -; mutation -
Returns:: a protobuf'd Mutation
Throws:: IOException

toMutationNoData

public static ClientProtos.MutationProto toMutationNoData(ClientProtos.MutationProto.MutationType type,
                                                          Mutation mutation,
                                                          ClientProtos.MutationProto.Builder builder,
                                                          long nonce)
                                                   throws IOException

Throws:: IOException

toResult
```
public static ClientProtos.Result toResult(Result result)
```
Convert a client Result to a protocol buffer Result

Parameters:

result - the client Result to convert

Returns:

the converted protocol buffer Result

toResult
```
public static ClientProtos.Result toResult(boolean existence,
                                           boolean stale)
```
Convert a client Result to a protocol buffer Result

Parameters:

existence - the client existence to send

Returns:

the converted protocol buffer Result

toResultNoData
```
public static ClientProtos.Result toResultNoData(Result result)
```
Convert a client Result to a protocol buffer Result. The pb Result does not include the Cell data. That is for transport otherwise.

Parameters:

result - the client Result to convert

Returns:

the converted protocol buffer Result

toResult
```
public static Result toResult(ClientProtos.Result proto)
```
Convert a protocol buffer Result to a client Result

Parameters:

proto - the protocol buffer Result to convert

Returns:

the converted client Result

toResult
```
public static Result toResult(ClientProtos.Result proto,
                              CellScanner scanner)
                       throws IOException
```
Convert a protocol buffer Result to a client Result

Parameters:

proto - the protocol buffer Result to convert

scanner - Optional cell scanner.

Returns:

the converted client Result

Throws:

IOException

toComparator
```
public static ComparatorProtos.Comparator toComparator(ByteArrayComparable comparator)
```
Convert a ByteArrayComparable to a protocol buffer Comparator

Parameters:

comparator - the ByteArrayComparable to convert

Returns:

the converted protocol buffer Comparator

toComparator
```
public static ByteArrayComparable toComparator(ComparatorProtos.Comparator proto)
                                        throws IOException
```
Convert a protocol buffer Comparator to a ByteArrayComparable

Parameters:

proto - the protocol buffer Comparator to convert

Returns:

the converted ByteArrayComparable

Throws:

IOException

toFilter
```
public static Filter toFilter(FilterProtos.Filter proto)
                       throws IOException
```
Convert a protocol buffer Filter to a client Filter

Parameters:

proto - the protocol buffer Filter to convert

Returns:

the converted Filter

Throws:

IOException

toFilter
```
public static FilterProtos.Filter toFilter(Filter filter)
                                    throws IOException
```
Convert a client Filter to a protocol buffer Filter

Parameters:

filter - the Filter to convert

Returns:

the converted protocol buffer Filter

Throws:

IOException

toDeleteType

public static ClientProtos.MutationProto.DeleteType toDeleteType(KeyValue.Type type)
                                                          throws IOException

Convert a delete KeyValue type to protocol buffer DeleteType.

Parameters:: type -
Returns:: protocol buffer DeleteType
Throws:: IOException

fromDeleteType

public static KeyValue.Type fromDeleteType(ClientProtos.MutationProto.DeleteType type)
                                    throws IOException

Convert a protocol buffer DeleteType to delete KeyValue type.

Parameters:: type - The DeleteType
Returns:: The type.
Throws:: IOException

toException
```
public static Throwable toException(HBaseProtos.NameBytesPair parameter)
                             throws IOException
```
Convert a stringified protocol buffer exception Parameter to a Java Exception

Parameters:

parameter - the protocol buffer Parameter to convert

Returns:

the converted Exception

Throws:

IOException - if failed to deserialize the parameter

newServiceStub

public static <T extends org.apache.hbase.thirdparty.com.google.protobuf.Service> T newServiceStub(Class<T> service,
                                                                                                   org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel channel)
                                                                                            throws Exception

Throws:: Exception

getRegionInfo

public static RegionInfo getRegionInfo(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller,
                                       AdminProtos.AdminService.BlockingInterface admin,
                                       byte[] regionName)
                                throws IOException

A helper to retrieve region info given a region name using admin protocol.

Parameters:: admin -; regionName -
Returns:: the retrieved region info
Throws:: IOException

getRegionLoadInfo

public static List<RegionLoad> getRegionLoadInfo(AdminProtos.GetRegionLoadResponse regionLoadResponse)

closeRegion

public static void closeRegion(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller,
                               AdminProtos.AdminService.BlockingInterface admin,
                               ServerName server,
                               byte[] regionName)
                        throws IOException

A helper to close a region given a region name using admin protocol.

Parameters:: admin -; regionName -
Throws:: IOException

warmupRegion

public static void warmupRegion(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller,
                                AdminProtos.AdminService.BlockingInterface admin,
                                RegionInfo regionInfo)
                         throws IOException

A helper to warmup a region given a region name using admin protocol

Parameters:: admin -; regionInfo -
Throws:: IOException

openRegion

public static void openRegion(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller,
                              AdminProtos.AdminService.BlockingInterface admin,
                              ServerName server,
                              RegionInfo region)
                       throws IOException

A helper to open a region using admin protocol.

Parameters:: admin -; region -
Throws:: IOException

getOnlineRegions
```
public static List<RegionInfo> getOnlineRegions(AdminProtos.AdminService.BlockingInterface admin)
                                         throws IOException
```
A helper to get the all the online regions on a region server using admin protocol.

Parameters:

admin -

Returns:

a list of online region info

Throws:

IOException

getOnlineRegions

public static List<RegionInfo> getOnlineRegions(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller,
                                                AdminProtos.AdminService.BlockingInterface admin)
                                         throws IOException

A helper to get the all the online regions on a region server using admin protocol.

Returns:: a list of online region info
Throws:: IOException

getRegionInfos
```
public static List<RegionInfo> getRegionInfos(AdminProtos.GetOnlineRegionResponse proto)
```
Get the list of region info from a GetOnlineRegionResponse

Parameters:

proto - the GetOnlineRegionResponse

Returns:

the list of region info or empty if proto is null

getServerInfo

public static AdminProtos.ServerInfo getServerInfo(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller,
                                                   AdminProtos.AdminService.BlockingInterface admin)
                                            throws IOException

A helper to get the info of a region server using admin protocol.

Returns:: the server name
Throws:: IOException

getStoreFiles

public static List<String> getStoreFiles(AdminProtos.AdminService.BlockingInterface admin,
                                         byte[] regionName,
                                         byte[] family)
                                  throws IOException

A helper to get the list of files of a column family on a given region using admin protocol.

Returns:: the list of store files
Throws:: IOException

getStoreFiles

public static List<String> getStoreFiles(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller,
                                         AdminProtos.AdminService.BlockingInterface admin,
                                         byte[] regionName,
                                         byte[] family)
                                  throws IOException

A helper to get the list of files of a column family on a given region using admin protocol.

Returns:: the list of store files
Throws:: IOException

getTotalRequestsCount

public static long getTotalRequestsCount(ClusterStatusProtos.RegionLoad rl)

toDelimitedByteArray

public static byte[] toDelimitedByteArray(org.apache.hbase.thirdparty.com.google.protobuf.Message m)
                                   throws IOException

Parameters:: m - Message to get delimited pb serialization of (with pb magic prefix)
Throws:: IOException

getRegionEncodedName
```
public static String getRegionEncodedName(HBaseProtos.RegionSpecifier regionSpecifier)
                                   throws DoNotRetryIOException
```
Find the HRegion encoded name based on a region specifier

Parameters:

regionSpecifier - the region specifier

Returns:

the corresponding region's encoded name

Throws:

DoNotRetryIOException - if the specifier type is unsupported

toScanMetrics

public static ScanMetrics toScanMetrics(byte[] bytes)

toScanMetrics

public static MapReduceProtos.ScanMetrics toScanMetrics(ScanMetrics scanMetrics,
                                                        boolean reset)

toIOException
```
public static void toIOException(org.apache.hbase.thirdparty.com.google.protobuf.ServiceException se)
                          throws IOException
```
Unwraps an exception from a protobuf service into the underlying (expected) IOException. This method will always throw an exception.

Parameters:

se - the ServiceException instance to convert into an IOException

Throws:

IOException

toCell

public static CellProtos.Cell toCell(Cell kv)

toCell

public static Cell toCell(ExtendedCellBuilder cellBuilder,
                          CellProtos.Cell cell)

toProtoNamespaceDescriptor

public static HBaseProtos.NamespaceDescriptor toProtoNamespaceDescriptor(NamespaceDescriptor ns)

toNamespaceDescriptor

public static NamespaceDescriptor toNamespaceDescriptor(HBaseProtos.NamespaceDescriptor desc)

toCompactionDescriptor

public static WALProtos.CompactionDescriptor toCompactionDescriptor(RegionInfo info,
                                                                    byte[] family,
                                                                    List<org.apache.hadoop.fs.Path> inputPaths,
                                                                    List<org.apache.hadoop.fs.Path> outputPaths,
                                                                    org.apache.hadoop.fs.Path storeDir)

toCompactionDescriptor

public static WALProtos.CompactionDescriptor toCompactionDescriptor(RegionInfo info,
                                                                    byte[] regionName,
                                                                    byte[] family,
                                                                    List<org.apache.hadoop.fs.Path> inputPaths,
                                                                    List<org.apache.hadoop.fs.Path> outputPaths,
                                                                    org.apache.hadoop.fs.Path storeDir)

toFlushDescriptor

public static WALProtos.FlushDescriptor toFlushDescriptor(WALProtos.FlushDescriptor.FlushAction action,
                                                          RegionInfo hri,
                                                          long flushSeqId,
                                                          Map<byte[],List<org.apache.hadoop.fs.Path>> committedFiles)

toRegionEventDescriptor

public static WALProtos.RegionEventDescriptor toRegionEventDescriptor(WALProtos.RegionEventDescriptor.EventType eventType,
                                                                      RegionInfo hri,
                                                                      long seqId,
                                                                      ServerName server,
                                                                      Map<byte[],List<org.apache.hadoop.fs.Path>> storeFiles)

toRegionEventDescriptor

public static WALProtos.RegionEventDescriptor toRegionEventDescriptor(WALProtos.RegionEventDescriptor.EventType eventType,
                                                                      byte[] tableNameAsBytes,
                                                                      byte[] encodedNameAsBytes,
                                                                      byte[] regionNameAsBytes,
                                                                      long seqId,
                                                                      ServerName server,
                                                                      Map<byte[],List<org.apache.hadoop.fs.Path>> storeFiles)

getShortTextFormat
```
public static String getShortTextFormat(org.apache.hbase.thirdparty.com.google.protobuf.Message m)
```
Return short version of Message toString'd, shorter than TextFormat#shortDebugString. Tries to NOT print out data both because it can be big but also so we do not have data in our logs. Use judiciously.

Parameters:

m -

Returns:

toString of passed m

toTableName

public static TableName toTableName(HBaseProtos.TableName tableNamePB)

toProtoTableName

public static HBaseProtos.TableName toProtoTableName(TableName tableName)

toTableNameList

public static List<TableName> toTableNameList(List<HBaseProtos.TableName> tableNamesList)

getTableNameArray

public static TableName[] getTableNameArray(List<HBaseProtos.TableName> tableNamesList)

toCellVisibility
```
public static CellVisibility toCellVisibility(ClientProtos.CellVisibility proto)
```
Convert a protocol buffer CellVisibility to a client CellVisibility

Parameters:

proto -

Returns:

the converted client CellVisibility

toCellVisibility
```
public static CellVisibility toCellVisibility(byte[] protoBytes)
                                       throws DeserializationException
```
Convert a protocol buffer CellVisibility bytes to a client CellVisibility

Parameters:

protoBytes -

Returns:

the converted client CellVisibility

Throws:

DeserializationException

toCellVisibility
```
public static ClientProtos.CellVisibility toCellVisibility(CellVisibility cellVisibility)
```
Create a protocol buffer CellVisibility based on a client CellVisibility.

Parameters:

cellVisibility -

Returns:

a protocol buffer CellVisibility

toAuthorizations
```
public static Authorizations toAuthorizations(ClientProtos.Authorizations proto)
```
Convert a protocol buffer Authorizations to a client Authorizations

Parameters:

proto -

Returns:

the converted client Authorizations

toAuthorizations
```
public static Authorizations toAuthorizations(byte[] protoBytes)
                                       throws DeserializationException
```
Convert a protocol buffer Authorizations bytes to a client Authorizations

Parameters:

protoBytes -

Returns:

the converted client Authorizations

Throws:

DeserializationException

toAuthorizations
```
public static ClientProtos.Authorizations toAuthorizations(Authorizations authorizations)
```
Create a protocol buffer Authorizations based on a client Authorizations.

Parameters:

authorizations -

Returns:

a protocol buffer Authorizations

toTimeUnit
```
public static TimeUnit toTimeUnit(HBaseProtos.TimeUnit proto)
```
Convert a protocol buffer TimeUnit to a client TimeUnit

Parameters:

proto -

Returns:

the converted client TimeUnit

toProtoTimeUnit
```
public static HBaseProtos.TimeUnit toProtoTimeUnit(TimeUnit timeUnit)
```
Convert a client TimeUnit to a protocol buffer TimeUnit

Parameters:

timeUnit -

Returns:

the converted protocol buffer TimeUnit

toThrottleType
```
public static ThrottleType toThrottleType(QuotaProtos.ThrottleType proto)
```
Convert a protocol buffer ThrottleType to a client ThrottleType

Parameters:

proto -

Returns:

the converted client ThrottleType

toProtoThrottleType
```
public static QuotaProtos.ThrottleType toProtoThrottleType(ThrottleType type)
```
Convert a client ThrottleType to a protocol buffer ThrottleType

Parameters:

type -

Returns:

the converted protocol buffer ThrottleType

toQuotaScope
```
public static QuotaScope toQuotaScope(QuotaProtos.QuotaScope proto)
```
Convert a protocol buffer QuotaScope to a client QuotaScope

Parameters:

proto -

Returns:

the converted client QuotaScope

toProtoQuotaScope
```
public static QuotaProtos.QuotaScope toProtoQuotaScope(QuotaScope scope)
```
Convert a client QuotaScope to a protocol buffer QuotaScope

Parameters:

scope -

Returns:

the converted protocol buffer QuotaScope

toQuotaScope
```
public static QuotaType toQuotaScope(QuotaProtos.QuotaType proto)
```
Convert a protocol buffer QuotaType to a client QuotaType

Parameters:

proto -

Returns:

the converted client QuotaType

toProtoQuotaScope
```
public static QuotaProtos.QuotaType toProtoQuotaScope(QuotaType type)
```
Convert a client QuotaType to a protocol buffer QuotaType

Parameters:

type -

Returns:

the converted protocol buffer QuotaType

toViolationPolicy
```
public static SpaceViolationPolicy toViolationPolicy(QuotaProtos.SpaceViolationPolicy proto)
```
Converts a protocol buffer SpaceViolationPolicy to a client SpaceViolationPolicy.

Parameters:

proto - The protocol buffer space violation policy.

Returns:

The corresponding client SpaceViolationPolicy.

toProtoViolationPolicy
```
public static QuotaProtos.SpaceViolationPolicy toProtoViolationPolicy(SpaceViolationPolicy policy)
```
Converts a client SpaceViolationPolicy to a protocol buffer SpaceViolationPolicy.

Parameters:

policy - The client SpaceViolationPolicy object.

Returns:

The corresponding protocol buffer SpaceViolationPolicy.

toTimedQuota

public static QuotaProtos.TimedQuota toTimedQuota(long limit,
                                                  TimeUnit timeUnit,
                                                  QuotaScope scope)

Build a protocol buffer TimedQuota

Parameters:: limit - the allowed number of request/data per timeUnit; timeUnit - the limit time unit; scope - the quota scope
Returns:: the protocol buffer TimedQuota

toProtoSpaceQuota

public static QuotaProtos.SpaceQuota toProtoSpaceQuota(long limit,
                                                       SpaceViolationPolicy violationPolicy)

Builds a protocol buffer SpaceQuota.

Parameters:: limit - The maximum space usage for the quota in bytes.; violationPolicy - The policy to apply when the quota is violated.
Returns:: The protocol buffer SpaceQuota.

toBulkLoadDescriptor

public static WALProtos.BulkLoadDescriptor toBulkLoadDescriptor(TableName tableName,
                                                                org.apache.hbase.thirdparty.com.google.protobuf.ByteString encodedRegionName,
                                                                Map<byte[],List<org.apache.hadoop.fs.Path>> storeFiles,
                                                                Map<String,Long> storeFilesSize,
                                                                long bulkloadSeqId)

Generates a marker for the WAL so that we propagate the notion of a bulk region load throughout the WAL.

Parameters:: tableName - The tableName into which the bulk load is being imported into.; encodedRegionName - Encoded region name of the region which is being bulk loaded.; storeFiles - A set of store files of a column family are bulk loaded.; storeFilesSize - Map of store files and their lengths; bulkloadSeqId - sequence ID (by a force flush) used to create bulk load hfile name
Returns:: The WAL log marker for bulk loads.

mergeDelimitedFrom

public static void mergeDelimitedFrom(org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder builder,
                                      InputStream in)
                               throws IOException

This version of protobuf's mergeDelimitedFrom avoid the hard-coded 64MB limit for decoding buffers

Parameters:: builder - current message builder; in - Inputsream with delimited protobuf data
Throws:: IOException

mergeFrom
```
public static void mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder builder,
                             InputStream in,
                             int size)
                      throws IOException
```
This version of protobuf's mergeFrom avoids the hard-coded 64MB limit for decoding buffers where the message size is known

Parameters:

builder - current message builder

in - InputStream containing protobuf data

size - known size of protobuf data

Throws:

IOException

mergeFrom
```
public static void mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder builder,
                             InputStream in)
                      throws IOException
```
This version of protobuf's mergeFrom avoids the hard-coded 64MB limit for decoding buffers where the message size is not known

Parameters:

builder - current message builder

in - InputStream containing protobuf data

Throws:

IOException

mergeFrom

public static void mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder builder,
                             org.apache.hbase.thirdparty.com.google.protobuf.ByteString bs)
                      throws IOException

This version of protobuf's mergeFrom avoids the hard-coded 64MB limit for decoding buffers when working with ByteStrings

Parameters:: builder - current message builder; bs - ByteString containing the
Throws:: IOException

mergeFrom
```
public static void mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder builder,
                             byte[] b)
                      throws IOException
```
This version of protobuf's mergeFrom avoids the hard-coded 64MB limit for decoding buffers when working with byte arrays

Parameters:

builder - current message builder

b - byte array

Throws:

IOException

mergeFrom

public static void mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder builder,
                             byte[] b,
                             int offset,
                             int length)
                      throws IOException

This version of protobuf's mergeFrom avoids the hard-coded 64MB limit for decoding buffers when working with byte arrays

Parameters:: builder - current message builder; b - byte array; offset -; length -
Throws:: IOException

mergeFrom

public static void mergeFrom(org.apache.hbase.thirdparty.com.google.protobuf.Message.Builder builder,
                             org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream codedInput,
                             int length)
                      throws IOException

Throws:: IOException

toReplicationLoadSink

public static ReplicationLoadSink toReplicationLoadSink(ClusterStatusProtos.ReplicationLoadSink rls)

toReplicationLoadSource

public static ReplicationLoadSource toReplicationLoadSource(ClusterStatusProtos.ReplicationLoadSource rls)

getVersionInfo
```
public static HBaseProtos.VersionInfo getVersionInfo()
```
Get a protocol buffer VersionInfo

Returns:

the converted protocol buffer VersionInfo

toSecurityCapabilityList
```
public static List<SecurityCapability> toSecurityCapabilityList(List<MasterProtos.SecurityCapabilitiesResponse.Capability> capabilities)
```
Convert SecurityCapabilitiesResponse.Capability to SecurityCapability

Parameters:

capabilities - capabilities returned in the SecurityCapabilitiesResponse message

Returns:

the converted list of SecurityCapability elements

toTimeRange

public static TimeRange toTimeRange(HBaseProtos.TimeRange timeRange)

toColumnFamilySchema
```
public static HBaseProtos.ColumnFamilySchema toColumnFamilySchema(ColumnFamilyDescriptor hcd)
```
Converts an ColumnFamilyDescriptor to ColumnFamilySchema

Parameters:

hcd - the ColumnFamilySchema

Returns:

Convert this instance to a the pb column family type

toColumnFamilyDescriptor
```
public static ColumnFamilyDescriptor toColumnFamilyDescriptor(HBaseProtos.ColumnFamilySchema cfs)
```
Converts a ColumnFamilySchema to ColumnFamilyDescriptor

Parameters:

cfs - the ColumnFamilySchema

Returns:

An ColumnFamilyDescriptor made from the passed in cfs

toTableSchema
```
public static HBaseProtos.TableSchema toTableSchema(TableDescriptor htd)
```
Converts an TableDescriptor to TableSchema

Parameters:

htd - the TableDescriptor

Returns:

Convert the current TableDescriptor into a pb TableSchema instance.

toTableDescriptor
```
public static TableDescriptor toTableDescriptor(HBaseProtos.TableSchema ts)
```
Converts a TableSchema to TableDescriptor

Parameters:

ts - A pb TableSchema instance.

Returns:

An TableDescriptor made from the passed in pb ts.

createCompactionState
```
public static CompactionState createCompactionState(AdminProtos.GetRegionInfoResponse.CompactionState state)
```
Creates CompactionState from AdminProtos.GetRegionInfoResponse.CompactionState state

Parameters:

state - the protobuf CompactionState

Returns:

CompactionState

createCompactionState

public static AdminProtos.GetRegionInfoResponse.CompactionState createCompactionState(CompactionState state)

toOptionalTimestamp

public static Optional<Long> toOptionalTimestamp(MasterProtos.MajorCompactionTimestampResponse resp)

createProtosSnapShotDescType
```
public static SnapshotProtos.SnapshotDescription.Type createProtosSnapShotDescType(SnapshotType type)
```
Creates HBaseProtos.SnapshotDescription.Type from SnapshotType

Parameters:

type - the SnapshotDescription type

Returns:

the protobuf SnapshotDescription type

createProtosSnapShotDescType
```
public static SnapshotProtos.SnapshotDescription.Type createProtosSnapShotDescType(String snapshotDesc)
```
Creates HBaseProtos.SnapshotDescription.Type from the type of SnapshotDescription string

Parameters:

snapshotDesc - string representing the snapshot description type

Returns:

the protobuf SnapshotDescription type

createSnapshotType
```
public static SnapshotType createSnapshotType(SnapshotProtos.SnapshotDescription.Type type)
```
Creates SnapshotType from the type of HBaseProtos.SnapshotDescription

Parameters:

type - the snapshot description type

Returns:

the protobuf SnapshotDescription type

createHBaseProtosSnapshotDesc
```
public static SnapshotProtos.SnapshotDescription createHBaseProtosSnapshotDesc(SnapshotDescription snapshotDesc)
```
Convert from SnapshotDescription to HBaseProtos.SnapshotDescription

Parameters:

snapshotDesc - the POJO SnapshotDescription

Returns:

the protobuf SnapshotDescription

createSnapshotDesc
```
public static SnapshotDescription createSnapshotDesc(SnapshotProtos.SnapshotDescription snapshotDesc)
```
Convert from HBaseProtos.SnapshotDescription to SnapshotDescription

Parameters:

snapshotDesc - the protobuf SnapshotDescription

Returns:

the POJO SnapshotDescription

createRegionLoadStats

public static RegionLoadStats createRegionLoadStats(ClientProtos.RegionLoadStats stats)

toText

public static String toText(org.apache.hbase.thirdparty.com.google.protobuf.Message msg)

Parameters:: msg -
Returns:: A String version of the passed in msg

toBytes

public static byte[] toBytes(org.apache.hbase.thirdparty.com.google.protobuf.ByteString bs)

call
```
public static <T> T call(Callable<T> callable)
                  throws IOException
```
Contain ServiceException inside here. Take a callable that is doing our pb rpc and run it.

Throws:

IOException

buildGetStoreFileRequest
```
public static AdminProtos.GetStoreFileRequest buildGetStoreFileRequest(byte[] regionName,
                                                                       byte[] family)
```
Create a protocol buffer GetStoreFileRequest for a given region name

Parameters:

regionName - the name of the region to get info

family - the family to get store file list

Returns:

a protocol buffer GetStoreFileRequest

buildCloseRegionRequest

public static AdminProtos.CloseRegionRequest buildCloseRegionRequest(ServerName server,
                                                                     byte[] regionName)

Create a CloseRegionRequest for a given region name

Parameters:: regionName - the name of the region to close
Returns:: a CloseRegionRequest

buildCloseRegionRequest

public static AdminProtos.CloseRegionRequest buildCloseRegionRequest(ServerName server,
                                                                     byte[] regionName,
                                                                     ServerName destinationServer)

buildProcedureDescription

public static HBaseProtos.ProcedureDescription buildProcedureDescription(String signature,
                                                                         String instance,
                                                                         Map<String,String> props)

parseServerNameFrom
```
public static ServerName parseServerNameFrom(byte[] data)
                                      throws DeserializationException
```
Get a ServerName from the passed in data bytes.

Parameters:

data - Data with a serialize server name in it; can handle the old style servername where servername was host and port. Works too with data that begins w/ the pb 'PBUF' magic and that is then followed by a protobuf that has a serialized ServerName in it.

Returns:

Returns null if data is null else converts passed data to a ServerName instance.

Throws:

DeserializationException

toProcedureJson
```
public static String toProcedureJson(List<ProcedureProtos.Procedure> procProtos)
```
Helper to convert the protobuf Procedure to JSON String

Returns:

Convert the current Protocol Buffers Procedure to JSON String

toLockJson

public static String toLockJson(List<LockServiceProtos.LockedResource> lockedResourceProtos)

toRegionInfo
```
public static HBaseProtos.RegionInfo toRegionInfo(RegionInfo info)
```
Convert a RegionInfo to a Proto RegionInfo

Parameters:

info - the RegionInfo to convert

Returns:

the converted Proto RegionInfo

toRegionInfo
```
public static RegionInfo toRegionInfo(HBaseProtos.RegionInfo proto)
```
Convert HBaseProto.RegionInfo to a RegionInfo

Parameters:

proto - the RegionInfo to convert

Returns:

the converted RegionInfo

toRegionLocation

public static HBaseProtos.RegionLocation toRegionLocation(HRegionLocation loc)

toRegionLocation

public static HRegionLocation toRegionLocation(HBaseProtos.RegionLocation proto)

toSnapshotDescriptionList

public static List<SnapshotDescription> toSnapshotDescriptionList(MasterProtos.GetCompletedSnapshotsResponse response,
                                                                  Pattern pattern)

toCacheEvictionStats

public static CacheEvictionStats toCacheEvictionStats(HBaseProtos.CacheEvictionStats stats)
                                               throws IOException

Throws:: IOException

toCacheEvictionStats

public static HBaseProtos.CacheEvictionStats toCacheEvictionStats(CacheEvictionStats cacheEvictionStats)

toReplicationLoadSource

public static ClusterStatusProtos.ReplicationLoadSource toReplicationLoadSource(ReplicationLoadSource rls)

toReplicationLoadSink

public static ClusterStatusProtos.ReplicationLoadSink toReplicationLoadSink(ReplicationLoadSink rls)

toTimeRange

public static HBaseProtos.TimeRange toTimeRange(TimeRange timeRange)

Class ProtobufUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isClassLoaderLoaded

prependPBMagic

isPBMagicPrefix

isPBMagicPrefix

expectPBMagicPrefix

lengthOfPBMagic

toByteArrayComparable

getRemoteException

handleRemoteException

toServerName

toServerName

toServerNameList

toNamespaceDescriptorList

toTableDescriptorList

toTableDescriptorList

getSplitKeysArray

toDurability

toDurability

toGet

toConsistency

toConsistency

toPut

toPut

toDelete

toDelete

toAppend

toIncrement

toMutation

toGet

toReadType

toReadType

toScan

toScan

toCursor

toCursor

toCursor

toGet

toMutation

toMutation

toMutation

toMutation

toMutationNoData

toMutationNoData

toMutationNoData

toResult

toResult

toResultNoData

toResult

toResult

toComparator

toComparator

toFilter

toFilter

toDeleteType

fromDeleteType

toException

newServiceStub

getRegionInfo

getRegionLoadInfo

closeRegion

warmupRegion

openRegion

getOnlineRegions

getOnlineRegions

getRegionInfos

getServerInfo

getStoreFiles

getStoreFiles

getTotalRequestsCount

toDelimitedByteArray

getRegionEncodedName

toScanMetrics

toScanMetrics

toIOException

toCell

toCell