ChukwaChunk (Apache Chukwa 0.8.0 API)

java.lang.Object
- org.apache.avro.specific.SpecificRecordBase
- - org.apache.gora.persistency.impl.PersistentBase
  - - org.apache.hadoop.chukwa.datacollection.writer.gora.ChukwaChunk

All Implemented Interfaces:

Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.GenericRecord, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord, org.apache.gora.persistency.Dirtyable, org.apache.gora.persistency.Persistent

Direct Known Subclasses:

ChukwaChunk.Tombstone
```
public class ChukwaChunk
extends org.apache.gora.persistency.impl.PersistentBase
implements org.apache.avro.specific.SpecificRecord, org.apache.gora.persistency.Persistent
```
Chukwa Adaptors emit data in Chunks. A Chunk is a sequence of bytes, with some metadata. Several of these are set automatically by the Agent or Adaptors. Two of them require user intervention: cluster name and datatype. Cluster name is specified in conf/chukwa-agent-conf.xml, and is global to each Agent process. Datatype describes the expected format of the data collected by an Adaptor instance, and it is specified when that instance is started.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ChukwaChunk.Builder` RecordBuilder for ChukwaChunk instances.
`static class`	`ChukwaChunk.Field` Enum containing all data bean's fields.
`static class`	`ChukwaChunk.Tombstone`

Nested classes/interfaces inherited from class org.apache.gora.persistency.impl.PersistentBase
org.apache.gora.persistency.impl.PersistentBase.PersistentData

Field Summary

Fields
Modifier and Type Field and Description

static String[] _ALL_FIELDS

static org.apache.avro.Schema SCHEMA$
- Fields inherited from interface org.apache.gora.persistency.Persistent
  DIRTY_BYTES_FIELD_NAME

Fields
Modifier and Type	Field and Description
`static String[]`	`_ALL_FIELDS`
`static org.apache.avro.Schema`	`SCHEMA$`

Constructor Summary

Constructors
Constructor and Description

ChukwaChunk()

Constructors
Constructor and Description
`ChukwaChunk()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`get(int field$)`
`ByteBuffer`	`getData()` Gets the value of the 'data' field.
`CharSequence`	`getDatatype()` Gets the value of the 'datatype' field.
`int`	`getFieldsCount()` Gets the total field count.
`CharSequence`	`getName()` Gets the value of the 'name' field.
`org.apache.avro.Schema`	`getSchema()`
`Long`	`getSequenceID()` Gets the value of the 'sequenceID' field.
`CharSequence`	`getSource()` Gets the value of the 'source' field.
`CharSequence`	`getTags()` Gets the value of the 'tags' field.
`ChukwaChunk.Tombstone`	`getTombstone()`
`boolean`	`isDataDirty()` Checks the dirty status of the 'data' field.
`boolean`	`isDatatypeDirty()` Checks the dirty status of the 'datatype' field.
`boolean`	`isNameDirty()` Checks the dirty status of the 'name' field.
`boolean`	`isSequenceIDDirty()` Checks the dirty status of the 'sequenceID' field.
`boolean`	`isSourceDirty()` Checks the dirty status of the 'source' field.
`boolean`	`isTagsDirty()` Checks the dirty status of the 'tags' field.
`static ChukwaChunk.Builder`	`newBuilder()` Creates a new ChukwaChunk RecordBuilder
`static ChukwaChunk.Builder`	`newBuilder(ChukwaChunk.Builder other)` Creates a new ChukwaChunk RecordBuilder by copying an existing Builder
`static ChukwaChunk.Builder`	`newBuilder(ChukwaChunk other)` Creates a new ChukwaChunk RecordBuilder by copying an existing ChukwaChunk instance
`ChukwaChunk`	`newInstance()`
`void`	`put(int field$, Object value)`
`void`	`setData(ByteBuffer value)` Sets the value of the 'data' field.
`void`	`setDatatype(CharSequence value)` Sets the value of the 'datatype' field.
`void`	`setName(CharSequence value)` Sets the value of the 'name' field.
`void`	`setSequenceID(Long value)` Sets the value of the 'sequenceID' field.
`void`	`setSource(CharSequence value)` Sets the value of the 'source' field.
`void`	`setTags(CharSequence value)` Sets the value of the 'tags' field.

Methods inherited from class org.apache.gora.persistency.impl.PersistentBase
clear, clearDirty, clearDirty, clearDirty, equals, getUnmanagedFields, isDirty, isDirty, isDirty, setDirty, setDirty, setDirty

Methods inherited from class org.apache.avro.specific.SpecificRecordBase
compareTo, get, hashCode, put, toString

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

Methods inherited from interface org.apache.gora.persistency.Persistent
clear, clearDirty, clearDirty, getUnmanagedFields, isDirty, isDirty, setDirty, setDirty, setDirty

Methods inherited from interface org.apache.gora.persistency.Dirtyable
clearDirty, isDirty

- Field Detail
  - SCHEMA$
```
public static final org.apache.avro.Schema SCHEMA$
```
  - _ALL_FIELDS
```
public static final String[] _ALL_FIELDS
```
- Constructor Detail
  - ChukwaChunk
```
public ChukwaChunk()
```
- Method Detail
  - getFieldsCount
```
public int getFieldsCount()
```
    Gets the total field count.
    
    Specified by:
    
    getFieldsCount in class org.apache.gora.persistency.impl.PersistentBase
    
    Returns:
    
    int field count
  - getSchema
```
public org.apache.avro.Schema getSchema()
```
    Specified by:
    
    getSchema in interface org.apache.avro.generic.GenericContainer
    
    Specified by:
    
    getSchema in class org.apache.avro.specific.SpecificRecordBase
  - get
```
public Object get(int field$)
```
    Specified by:
    
    get in interface org.apache.avro.generic.IndexedRecord
    
    Specified by:
    
    get in class org.apache.avro.specific.SpecificRecordBase
  - put
```
public void put(int field$,
                Object value)
```
    Specified by:
    
    put in interface org.apache.avro.generic.IndexedRecord
    
    Specified by:
    
    put in class org.apache.avro.specific.SpecificRecordBase
  - getSource
```
public CharSequence getSource()
```
    Gets the value of the 'source' field.
    
    Returns:
    
    source
  - setSource
```
public void setSource(CharSequence value)
```
    Sets the value of the 'source' field.
    
    Parameters:
    
    value - is the value to set.
  - isSourceDirty
```
public boolean isSourceDirty()
```
    Checks the dirty status of the 'source' field. A field is dirty if it represents a change that has not yet been written to the database.
    
    Returns:
    
    true if a sourcefield has not been written to database
  - getTags
```
public CharSequence getTags()
```
    Gets the value of the 'tags' field.
    
    Returns:
    
    value of tags field
  - setTags
```
public void setTags(CharSequence value)
```
    Sets the value of the 'tags' field.
    
    Parameters:
    
    value - is the value to set.
  - isTagsDirty
```
public boolean isTagsDirty()
```
    Checks the dirty status of the 'tags' field. A field is dirty if it represents a change that has not yet been written to the database.
    
    Returns:
    
    true if tags field has not been written to database
  - getDatatype
```
public CharSequence getDatatype()
```
    Gets the value of the 'datatype' field.
    
    Returns:
    
    datatype field
  - setDatatype
```
public void setDatatype(CharSequence value)
```
    Sets the value of the 'datatype' field.
    
    Parameters:
    
    value - is the value to set.
  - isDatatypeDirty
```
public boolean isDatatypeDirty()
```
    Checks the dirty status of the 'datatype' field. A field is dirty if it represents a change that has not yet been written to the database.
    
    Returns:
    
    true if datatype field has not been written to database
  - getSequenceID
```
public Long getSequenceID()
```
    Gets the value of the 'sequenceID' field.
    
    Returns:
    
    sequenceID
  - setSequenceID
```
public void setSequenceID(Long value)
```
    Sets the value of the 'sequenceID' field.
    
    Parameters:
    
    value - is the value to set.
  - isSequenceIDDirty
```
public boolean isSequenceIDDirty()
```
    Checks the dirty status of the 'sequenceID' field. A field is dirty if it represents a change that has not yet been written to the database.
    
    Returns:
    
    true if sequenceID has not been commit to database
  - getName
```
public CharSequence getName()
```
    Gets the value of the 'name' field.
    
    Returns:
    
    name
  - setName
```
public void setName(CharSequence value)
```
    Sets the value of the 'name' field.
    
    Parameters:
    
    value - is the value to set.
  - isNameDirty
```
public boolean isNameDirty()
```
    Checks the dirty status of the 'name' field. A field is dirty if it represents a change that has not yet been written to the database.
    
    Returns:
    
    true if name has not been committed to database
  - getData
```
public ByteBuffer getData()
```
    Gets the value of the 'data' field.
    
    Returns:
    
    data field
  - setData
```
public void setData(ByteBuffer value)
```
    Sets the value of the 'data' field.
    
    Parameters:
    
    value - is a string the value to set.
  - isDataDirty
```
public boolean isDataDirty()
```
    Checks the dirty status of the 'data' field. A field is dirty if it represents a change that has not yet been written to the database.
    
    Returns:
    
    true if data field has not been committed to database
  - newBuilder
```
public static ChukwaChunk.Builder newBuilder()
```
    Creates a new ChukwaChunk RecordBuilder
    
    Returns:
    
    RecordBuilder
  - newBuilder
```
public static ChukwaChunk.Builder newBuilder(ChukwaChunk.Builder other)
```
    Creates a new ChukwaChunk RecordBuilder by copying an existing Builder
    
    Parameters:
    
    other - is Chukwa chunk
    
    Returns:
    
    RecordBuilder
  - newBuilder
```
public static ChukwaChunk.Builder newBuilder(ChukwaChunk other)
```
    Creates a new ChukwaChunk RecordBuilder by copying an existing ChukwaChunk instance
    
    Parameters:
    
    other - is Chukwa chunk
    
    Returns:
    
    RecordBuilder
  - getTombstone
```
public ChukwaChunk.Tombstone getTombstone()
```
    Specified by:
    
    getTombstone in interface org.apache.gora.persistency.Persistent
  - newInstance
```
public ChukwaChunk newInstance()
```
    Specified by:
    
    newInstance in interface org.apache.gora.persistency.Persistent

Class ChukwaChunk

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.gora.persistency.impl.PersistentBase

Field Summary

Fields inherited from interface org.apache.gora.persistency.Persistent

Constructor Summary

Method Summary

Methods inherited from class org.apache.gora.persistency.impl.PersistentBase

Methods inherited from class org.apache.avro.specific.SpecificRecordBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.gora.persistency.Persistent

Methods inherited from interface org.apache.gora.persistency.Dirtyable

Field Detail

SCHEMA$

_ALL_FIELDS

Constructor Detail

ChukwaChunk

Method Detail

getFieldsCount

getSchema

get

put

getSource

setSource

isSourceDirty

getTags

setTags

isTagsDirty

getDatatype

setDatatype

isDatatypeDirty

getSequenceID

setSequenceID

isSequenceIDDirty

getName

setName

isNameDirty

getData

setData

isDataDirty

newBuilder

newBuilder

newBuilder

getTombstone

newInstance