```
public interface ReservedColumns
```
Reserved punchplatform column names.
These columns can be generated by entry sources or by the punch bolt. They are transported on user table or on reserved tables. on the reserved stream (refer to ReservedTables).
Each has a reserved semantics.
- _ppf_latency contains monitoring records
- _ppf_platform contains the platform identifier
- _ppf_tenant contains a tenant identifier
- _ppf_channel contains a channel identifier
- _ppf_component contains a spout component identifier
- _ppf_topology contains the topology identifier
- _ppf_error_message contains the error message generated by the punch bolt, if any
- _ppf_error_document contains the input document that caused an punch bolt exception
- _ppf_timestamp contains a unix format timestamp
- _ppf_id contains a unique identifier
- _ppf_local_host contains a spout tcp/udp listening host address
- _ppf_local_port contains a spout tcp/udp listening port identifier
- _ppf_remote_host contains the tcp/udp source host address of the client application
- _ppf_remote_port contains the tcp/udp source host port of the client application
- _ppf_error (deprecated) contains the error message generated by punch bolt
- _ppf_batchid contains the persisted batch ID
- _ppf_batch_play_id contains a transient unique runtime identifier
- _ppf_batch_size contains the actual number of elements contained in a batch
- _ppf_partition_id contains the corresponding Kafka partition identifier
- _ppf_partition_offset contains the current Kafka partition offset

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`_PPF_COMPONENT`	This field contains the storm component identifier.
`static String`	`_PPF_ERROR`	Deprecated.
`static String`	`_PPF_ERROR_DOCUMENT`	This field contains the input document that caused a punch bolt exception.
`static String`	`_PPF_ERROR_MESSAGE`	This field contains the error message generated by the punch bolt, if any.
`static String`	`_PPF_ID`	This field contains a unique identifier generated by an entry spout.
`static String`	`_PPF_LATENCY`	This field contains a json string holding a metric latency record.
`static String`	`_PPF_LOCAL_HOST`	This field contains an entry spout listening (udp or tcp) ip address in dotted number format.
`static String`	`_PPF_LOCAL_PORT`	This field contains an entry spout listening (udp or tcp) port number.
`static String`	`_PPF_PARTITION_ID`	Indicate the corresponding Kafka partition identifier.
`static String`	`_PPF_PARTITION_OFFSET`	Indicate the current Kafka partition offset.
`static String`	`_PPF_REMOTE_HOST`	This field contains an entry spout remote source (udp or tcp) ip address in dotted number format.
`static String`	`_PPF_REMOTE_PORT`	This field contains an entry spout remote source (udp or tcp) port number.
`static String`	`_PPF_TIMESTAMP`	This field contains a timestamp in unix milliseconds format.
`static String`	`PREFIX`	Define the prefix used in any IReservedFields

- Field Detail
  - PREFIX
```
static final String PREFIX
```
    Define the prefix used in any IReservedFields
    
    See Also:
    
    Constant Field Values
  - _PPF_LATENCY
```
static final String _PPF_LATENCY
```
    This field contains a json string holding a metric latency record. It is emitted on the ReservedTables._PPF_METRICS stream.
    
    See Also:
    
    Constant Field Values
  - _PPF_COMPONENT
```
static final String _PPF_COMPONENT
```
    This field contains the storm component identifier. It is emitted on both user streams and the ReservedTables._PPF_ERRORS stream.
    
    See Also:
    
    Constant Field Values
  - _PPF_ERROR_DOCUMENT
```
static final String _PPF_ERROR_DOCUMENT
```
    This field contains the input document that caused a punch bolt exception. It represents the document as it was at the bolt entrance.
    It is emitted on the ReservedTables._PPF_ERRORS stream.
    
    See Also:
    
    Constant Field Values
  - _PPF_ERROR_MESSAGE
```
static final String _PPF_ERROR_MESSAGE
```
    This field contains the error message generated by the punch bolt, if any. It is emitted on the ReservedTables._PPF_ERRORS stream.
    
    See Also:
    
    Constant Field Values
  - _PPF_TIMESTAMP
```
static final String _PPF_TIMESTAMP
```
    This field contains a timestamp in unix milliseconds format. It is emitted on user streams and on the ReservedTables._PPF_ERRORS stream.
    
    See Also:
    
    Constant Field Values
  - _PPF_ID
```
static final String _PPF_ID
```
    This field contains a unique identifier generated by an entry spout. It is emitted on user streams and on the ReservedTables._PPF_ERRORS stream.
    
    See Also:
    
    Constant Field Values
  - _PPF_LOCAL_PORT
```
static final String _PPF_LOCAL_PORT
```
    This field contains an entry spout listening (udp or tcp) port number. It is emitted on user streams.
    
    See Also:
    
    Constant Field Values
  - _PPF_LOCAL_HOST
```
static final String _PPF_LOCAL_HOST
```
    This field contains an entry spout listening (udp or tcp) ip address in dotted number format. It is emitted on user streams.
    
    See Also:
    
    Constant Field Values
  - _PPF_REMOTE_PORT
```
static final String _PPF_REMOTE_PORT
```
    This field contains an entry spout remote source (udp or tcp) port number. It is emitted on user streams.
    
    See Also:
    
    Constant Field Values
  - _PPF_REMOTE_HOST
```
static final String _PPF_REMOTE_HOST
```
    This field contains an entry spout remote source (udp or tcp) ip address in dotted number format.
    It represents the sender source ip address. It is emitted on user streams.
    
    See Also:
    
    Constant Field Values
  - _PPF_ERROR
```
@Deprecated
static final String _PPF_ERROR
```
    Deprecated.
    
    DEPRECATED: the legacy name of '_ppf_error_message' and '_ppf_error_document'
    
    See Also:
    
    Constant Field Values
  - _PPF_PARTITION_ID
```
static final String _PPF_PARTITION_ID
```
    Indicate the corresponding Kafka partition identifier.
    
    See Also:
    
    Constant Field Values
  - _PPF_PARTITION_OFFSET
```
static final String _PPF_PARTITION_OFFSET
```
    Indicate the current Kafka partition offset.
    
    See Also:
    
    Constant Field Values

Interface ReservedColumns

Field Summary

Field Detail

PREFIX

_PPF_LATENCY

_PPF_COMPONENT

_PPF_ERROR_DOCUMENT

_PPF_ERROR_MESSAGE

_PPF_TIMESTAMP

_PPF_ID

_PPF_LOCAL_PORT

_PPF_LOCAL_HOST

_PPF_REMOTE_PORT

_PPF_REMOTE_HOST

_PPF_ERROR

_PPF_PARTITION_ID

_PPF_PARTITION_OFFSET