org.apache.hadoop.hbase.rest.model

Class NamespacesInstanceModel

java.lang.Object

org.apache.hadoop.hbase.rest.model.NamespacesInstanceModel

All Implemented Interfaces:

Serializable, ProtobufMessageHandler

@InterfaceAudience.Private
public class NamespacesInstanceModel
extends Object
implements Serializable, ProtobufMessageHandler

List a HBase namespace's key/value properties.

• NamespaceProperties: outer element
• properties: sequence property elements
• entry
• key: property key
• value: property value

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.hadoop.hbase.rest.ProtobufMessageHandler

BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
NamespacesInstanceModel() Default constructor.
NamespacesInstanceModel(Admin admin, String namespaceName) Constructor
NamespacesInstanceModel(String namespaceName) Constructor to use if namespace does not exist in HBASE.

Method Summary

Modifier and Type	Method and Description
void	addProperty(String key, String value) Add property to the namespace.
String	getNamespaceName()
ProtobufMessageHandler	getObjectFromMessage(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream cis)
Map<String,String>	getProperties() Returns The map of uncategorized namespace properties.
org.apache.hbase.thirdparty.com.google.protobuf.Message	messageFromObject() Convert to model to a protobuf Message object
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.rest.ProtobufMessageHandler

createProtobufOutput, getObjectFromMessage, getObjectFromMessage, writeProtobufOutput

Constructor Detail

NamespacesInstanceModel

public NamespacesInstanceModel()

Default constructor. Do not use.

NamespacesInstanceModel

public NamespacesInstanceModel(String namespaceName)
                        throws IOException

Constructor to use if namespace does not exist in HBASE.

Parameters:

namespaceName - the namespace name.

Throws:

IOException

NamespacesInstanceModel

public NamespacesInstanceModel(Admin admin,
                               String namespaceName)
                        throws IOException

Constructor

Parameters:

admin - the administrative API

namespaceName - the namespace name.

Throws:

IOException

Method Detail

addProperty

public void addProperty(String key,
                        String value)

Add property to the namespace.

Parameters:

key - attribute name

value - attribute value

getProperties

public Map<String,String> getProperties()

Returns The map of uncategorized namespace properties.

getNamespaceName

public String getNamespaceName()

toString

public String toString()

Overrides:

toString in class Object

messageFromObject

public org.apache.hbase.thirdparty.com.google.protobuf.Message messageFromObject()

Description copied from interface: ProtobufMessageHandler

Convert to model to a protobuf Message object

Specified by:

messageFromObject in interface ProtobufMessageHandler

Returns:

the protobuf Message object

getObjectFromMessage

public ProtobufMessageHandler getObjectFromMessage(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream cis)
                                            throws IOException

Specified by:

getObjectFromMessage in interface ProtobufMessageHandler

Throws:

IOException