|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.blur.thrift.generated.TableDescriptor
public class TableDescriptor
The table descriptor defines the base structure of the table as well as properties need for setup.
Nested Class Summary | |
---|---|
static class |
TableDescriptor._Fields
The set of fields this struct contains, along with convenience methods for finding and manipulating them. |
Field Summary | |
---|---|
boolean |
blockCaching
Should block cache be enable or disabled for this table. |
Set<String> |
blockCachingFileTypes
The files extensions that you would like to allow block cache to cache. |
String |
cluster
The cluster where this table should be created. |
boolean |
defaultMissingFieldLessIndexing
If strict is not enabled, defines whether or not field less indexing is enabled on the newly created fields. |
Map<String,String> |
defaultMissingFieldProps
If strict is not enabled, defines the properties to be used in the new field creation. |
String |
defaultMissingFieldType
If strict is not enabled, the default field type. |
boolean |
enabled
Is the table enabled or not, enabled by default. |
static Map<TableDescriptor._Fields,FieldMetaData> |
metaDataMap
|
String |
name
The table name. |
List<String> |
preCacheCols
This is a list of fields to prefetch into the blockcache. |
boolean |
readOnly
If a table is set to be readonly, that means that mutates through Thrift are NOT allowed. |
int |
shardCount
The number of shards within the given table. |
String |
similarityClass
Sets the similarity class in Lucene. |
boolean |
strictTypes
Whether strict types are enabled or not (default). |
Map<String,String> |
tableProperties
The table properties that can modify the default behavior of the table. |
String |
tableUri
The location where the table should be stored this can be "file:///" for a local instance of Blur or "hdfs://" for a distributed installation of Blur. |
Constructor Summary | |
---|---|
TableDescriptor()
|
|
TableDescriptor(boolean enabled,
int shardCount,
String tableUri,
String cluster,
String name,
String similarityClass,
boolean blockCaching,
Set<String> blockCachingFileTypes,
boolean readOnly,
List<String> preCacheCols,
Map<String,String> tableProperties,
boolean strictTypes,
String defaultMissingFieldType,
boolean defaultMissingFieldLessIndexing,
Map<String,String> defaultMissingFieldProps)
|
|
TableDescriptor(TableDescriptor other)
Performs a deep copy on other. |
Method Summary | |
---|---|
void |
addToBlockCachingFileTypes(String elem)
|
void |
addToPreCacheCols(String elem)
|
void |
clear()
Return to the state of having just been initialized, as though you had just called the default constructor. |
int |
compareTo(TableDescriptor other)
|
TableDescriptor |
deepCopy()
|
boolean |
equals(Object that)
|
boolean |
equals(TableDescriptor that)
|
TableDescriptor._Fields |
fieldForId(int fieldId)
Get the F instance that corresponds to fieldId. |
Set<String> |
getBlockCachingFileTypes()
The files extensions that you would like to allow block cache to cache. |
Iterator<String> |
getBlockCachingFileTypesIterator()
|
int |
getBlockCachingFileTypesSize()
|
String |
getCluster()
The cluster where this table should be created. |
Map<String,String> |
getDefaultMissingFieldProps()
If strict is not enabled, defines the properties to be used in the new field creation. |
int |
getDefaultMissingFieldPropsSize()
|
String |
getDefaultMissingFieldType()
If strict is not enabled, the default field type. |
Object |
getFieldValue(TableDescriptor._Fields field)
Get a field's value by field variable. |
String |
getName()
The table name. |
List<String> |
getPreCacheCols()
This is a list of fields to prefetch into the blockcache. |
Iterator<String> |
getPreCacheColsIterator()
|
int |
getPreCacheColsSize()
|
int |
getShardCount()
The number of shards within the given table. |
String |
getSimilarityClass()
Sets the similarity class in Lucene. |
Map<String,String> |
getTableProperties()
The table properties that can modify the default behavior of the table. |
int |
getTablePropertiesSize()
|
String |
getTableUri()
The location where the table should be stored this can be "file:///" for a local instance of Blur or "hdfs://" for a distributed installation of Blur. |
int |
hashCode()
|
boolean |
isBlockCaching()
Should block cache be enable or disabled for this table. |
boolean |
isDefaultMissingFieldLessIndexing()
If strict is not enabled, defines whether or not field less indexing is enabled on the newly created fields. |
boolean |
isEnabled()
Is the table enabled or not, enabled by default. |
boolean |
isReadOnly()
If a table is set to be readonly, that means that mutates through Thrift are NOT allowed. |
boolean |
isSet(TableDescriptor._Fields field)
Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise |
boolean |
isSetBlockCaching()
Returns true if field blockCaching is set (has been assigned a value) and false otherwise |
boolean |
isSetBlockCachingFileTypes()
Returns true if field blockCachingFileTypes is set (has been assigned a value) and false otherwise |
boolean |
isSetCluster()
Returns true if field cluster is set (has been assigned a value) and false otherwise |
boolean |
isSetDefaultMissingFieldLessIndexing()
Returns true if field defaultMissingFieldLessIndexing is set (has been assigned a value) and false otherwise |
boolean |
isSetDefaultMissingFieldProps()
Returns true if field defaultMissingFieldProps is set (has been assigned a value) and false otherwise |
boolean |
isSetDefaultMissingFieldType()
Returns true if field defaultMissingFieldType is set (has been assigned a value) and false otherwise |
boolean |
isSetEnabled()
Returns true if field enabled is set (has been assigned a value) and false otherwise |
boolean |
isSetName()
Returns true if field name is set (has been assigned a value) and false otherwise |
boolean |
isSetPreCacheCols()
Returns true if field preCacheCols is set (has been assigned a value) and false otherwise |
boolean |
isSetReadOnly()
Returns true if field readOnly is set (has been assigned a value) and false otherwise |
boolean |
isSetShardCount()
Returns true if field shardCount is set (has been assigned a value) and false otherwise |
boolean |
isSetSimilarityClass()
Returns true if field similarityClass is set (has been assigned a value) and false otherwise |
boolean |
isSetStrictTypes()
Returns true if field strictTypes is set (has been assigned a value) and false otherwise |
boolean |
isSetTableProperties()
Returns true if field tableProperties is set (has been assigned a value) and false otherwise |
boolean |
isSetTableUri()
Returns true if field tableUri is set (has been assigned a value) and false otherwise |
boolean |
isStrictTypes()
Whether strict types are enabled or not (default). |
void |
putToDefaultMissingFieldProps(String key,
String val)
|
void |
putToTableProperties(String key,
String val)
|
void |
read(TProtocol iprot)
Reads the TObject from the given input protocol. |
TableDescriptor |
setBlockCaching(boolean blockCaching)
Should block cache be enable or disabled for this table. |
TableDescriptor |
setBlockCachingFileTypes(Set<String> blockCachingFileTypes)
The files extensions that you would like to allow block cache to cache. |
void |
setBlockCachingFileTypesIsSet(boolean value)
|
void |
setBlockCachingIsSet(boolean value)
|
TableDescriptor |
setCluster(String cluster)
The cluster where this table should be created. |
void |
setClusterIsSet(boolean value)
|
TableDescriptor |
setDefaultMissingFieldLessIndexing(boolean defaultMissingFieldLessIndexing)
If strict is not enabled, defines whether or not field less indexing is enabled on the newly created fields. |
void |
setDefaultMissingFieldLessIndexingIsSet(boolean value)
|
TableDescriptor |
setDefaultMissingFieldProps(Map<String,String> defaultMissingFieldProps)
If strict is not enabled, defines the properties to be used in the new field creation. |
void |
setDefaultMissingFieldPropsIsSet(boolean value)
|
TableDescriptor |
setDefaultMissingFieldType(String defaultMissingFieldType)
If strict is not enabled, the default field type. |
void |
setDefaultMissingFieldTypeIsSet(boolean value)
|
TableDescriptor |
setEnabled(boolean enabled)
Is the table enabled or not, enabled by default. |
void |
setEnabledIsSet(boolean value)
|
void |
setFieldValue(TableDescriptor._Fields field,
Object value)
Set a field's value by field variable. |
TableDescriptor |
setName(String name)
The table name. |
void |
setNameIsSet(boolean value)
|
TableDescriptor |
setPreCacheCols(List<String> preCacheCols)
This is a list of fields to prefetch into the blockcache. |
void |
setPreCacheColsIsSet(boolean value)
|
TableDescriptor |
setReadOnly(boolean readOnly)
If a table is set to be readonly, that means that mutates through Thrift are NOT allowed. |
void |
setReadOnlyIsSet(boolean value)
|
TableDescriptor |
setShardCount(int shardCount)
The number of shards within the given table. |
void |
setShardCountIsSet(boolean value)
|
TableDescriptor |
setSimilarityClass(String similarityClass)
Sets the similarity class in Lucene. |
void |
setSimilarityClassIsSet(boolean value)
|
TableDescriptor |
setStrictTypes(boolean strictTypes)
Whether strict types are enabled or not (default). |
void |
setStrictTypesIsSet(boolean value)
|
TableDescriptor |
setTableProperties(Map<String,String> tableProperties)
The table properties that can modify the default behavior of the table. |
void |
setTablePropertiesIsSet(boolean value)
|
TableDescriptor |
setTableUri(String tableUri)
The location where the table should be stored this can be "file:///" for a local instance of Blur or "hdfs://" for a distributed installation of Blur. |
void |
setTableUriIsSet(boolean value)
|
String |
toString()
|
void |
unsetBlockCaching()
|
void |
unsetBlockCachingFileTypes()
|
void |
unsetCluster()
|
void |
unsetDefaultMissingFieldLessIndexing()
|
void |
unsetDefaultMissingFieldProps()
|
void |
unsetDefaultMissingFieldType()
|
void |
unsetEnabled()
|
void |
unsetName()
|
void |
unsetPreCacheCols()
|
void |
unsetReadOnly()
|
void |
unsetShardCount()
|
void |
unsetSimilarityClass()
|
void |
unsetStrictTypes()
|
void |
unsetTableProperties()
|
void |
unsetTableUri()
|
void |
validate()
|
void |
write(TProtocol oprot)
Writes the objects out to the protocol |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public boolean enabled
public int shardCount
public String tableUri
public String cluster
public String name
public String similarityClass
public boolean blockCaching
public Set<String> blockCachingFileTypes
public boolean readOnly
public List<String> preCacheCols
public Map<String,String> tableProperties
public boolean strictTypes
public String defaultMissingFieldType
public boolean defaultMissingFieldLessIndexing
public Map<String,String> defaultMissingFieldProps
public static final Map<TableDescriptor._Fields,FieldMetaData> metaDataMap
Constructor Detail |
---|
public TableDescriptor()
public TableDescriptor(boolean enabled, int shardCount, String tableUri, String cluster, String name, String similarityClass, boolean blockCaching, Set<String> blockCachingFileTypes, boolean readOnly, List<String> preCacheCols, Map<String,String> tableProperties, boolean strictTypes, String defaultMissingFieldType, boolean defaultMissingFieldLessIndexing, Map<String,String> defaultMissingFieldProps)
public TableDescriptor(TableDescriptor other)
Method Detail |
---|
public TableDescriptor deepCopy()
deepCopy
in interface TBase<TableDescriptor,TableDescriptor._Fields>
public void clear()
TBase
clear
in interface TBase<TableDescriptor,TableDescriptor._Fields>
public boolean isEnabled()
public TableDescriptor setEnabled(boolean enabled)
public void unsetEnabled()
public boolean isSetEnabled()
public void setEnabledIsSet(boolean value)
public int getShardCount()
public TableDescriptor setShardCount(int shardCount)
public void unsetShardCount()
public boolean isSetShardCount()
public void setShardCountIsSet(boolean value)
public String getTableUri()
public TableDescriptor setTableUri(String tableUri)
public void unsetTableUri()
public boolean isSetTableUri()
public void setTableUriIsSet(boolean value)
public String getCluster()
public TableDescriptor setCluster(String cluster)
public void unsetCluster()
public boolean isSetCluster()
public void setClusterIsSet(boolean value)
public String getName()
public TableDescriptor setName(String name)
public void unsetName()
public boolean isSetName()
public void setNameIsSet(boolean value)
public String getSimilarityClass()
public TableDescriptor setSimilarityClass(String similarityClass)
public void unsetSimilarityClass()
public boolean isSetSimilarityClass()
public void setSimilarityClassIsSet(boolean value)
public boolean isBlockCaching()
public TableDescriptor setBlockCaching(boolean blockCaching)
public void unsetBlockCaching()
public boolean isSetBlockCaching()
public void setBlockCachingIsSet(boolean value)
public int getBlockCachingFileTypesSize()
public Iterator<String> getBlockCachingFileTypesIterator()
public void addToBlockCachingFileTypes(String elem)
public Set<String> getBlockCachingFileTypes()
public TableDescriptor setBlockCachingFileTypes(Set<String> blockCachingFileTypes)
public void unsetBlockCachingFileTypes()
public boolean isSetBlockCachingFileTypes()
public void setBlockCachingFileTypesIsSet(boolean value)
public boolean isReadOnly()
public TableDescriptor setReadOnly(boolean readOnly)
public void unsetReadOnly()
public boolean isSetReadOnly()
public void setReadOnlyIsSet(boolean value)
public int getPreCacheColsSize()
public Iterator<String> getPreCacheColsIterator()
public void addToPreCacheCols(String elem)
public List<String> getPreCacheCols()
public TableDescriptor setPreCacheCols(List<String> preCacheCols)
public void unsetPreCacheCols()
public boolean isSetPreCacheCols()
public void setPreCacheColsIsSet(boolean value)
public int getTablePropertiesSize()
public void putToTableProperties(String key, String val)
public Map<String,String> getTableProperties()
public TableDescriptor setTableProperties(Map<String,String> tableProperties)
public void unsetTableProperties()
public boolean isSetTableProperties()
public void setTablePropertiesIsSet(boolean value)
public boolean isStrictTypes()
public TableDescriptor setStrictTypes(boolean strictTypes)
public void unsetStrictTypes()
public boolean isSetStrictTypes()
public void setStrictTypesIsSet(boolean value)
public String getDefaultMissingFieldType()
public TableDescriptor setDefaultMissingFieldType(String defaultMissingFieldType)
public void unsetDefaultMissingFieldType()
public boolean isSetDefaultMissingFieldType()
public void setDefaultMissingFieldTypeIsSet(boolean value)
public boolean isDefaultMissingFieldLessIndexing()
public TableDescriptor setDefaultMissingFieldLessIndexing(boolean defaultMissingFieldLessIndexing)
public void unsetDefaultMissingFieldLessIndexing()
public boolean isSetDefaultMissingFieldLessIndexing()
public void setDefaultMissingFieldLessIndexingIsSet(boolean value)
public int getDefaultMissingFieldPropsSize()
public void putToDefaultMissingFieldProps(String key, String val)
public Map<String,String> getDefaultMissingFieldProps()
public TableDescriptor setDefaultMissingFieldProps(Map<String,String> defaultMissingFieldProps)
public void unsetDefaultMissingFieldProps()
public boolean isSetDefaultMissingFieldProps()
public void setDefaultMissingFieldPropsIsSet(boolean value)
public void setFieldValue(TableDescriptor._Fields field, Object value)
TBase
setFieldValue
in interface TBase<TableDescriptor,TableDescriptor._Fields>
public Object getFieldValue(TableDescriptor._Fields field)
TBase
getFieldValue
in interface TBase<TableDescriptor,TableDescriptor._Fields>
public boolean isSet(TableDescriptor._Fields field)
isSet
in interface TBase<TableDescriptor,TableDescriptor._Fields>
public boolean equals(Object that)
equals
in class Object
public boolean equals(TableDescriptor that)
public int hashCode()
hashCode
in class Object
public int compareTo(TableDescriptor other)
compareTo
in interface Comparable<TableDescriptor>
public TableDescriptor._Fields fieldForId(int fieldId)
TBase
fieldForId
in interface TBase<TableDescriptor,TableDescriptor._Fields>
public void read(TProtocol iprot) throws TException
TBase
read
in interface TBase<TableDescriptor,TableDescriptor._Fields>
iprot
- Input protocol
TException
public void write(TProtocol oprot) throws TException
TBase
write
in interface TBase<TableDescriptor,TableDescriptor._Fields>
oprot
- Output protocol
TException
public String toString()
toString
in class Object
public void validate() throws TException
TException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |