StandardProvenanceEventRecord

java.lang.Object
- org.apache.nifi.provenance.StandardProvenanceEventRecord

All Implemented Interfaces:: ProvenanceEventRecord

public class StandardProvenanceEventRecord
extends java.lang.Object
implements ProvenanceEventRecord

Holder for provenance relevant information

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class StandardProvenanceEventRecord.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`StandardProvenanceEventRecord.Builder`

Field Summary
- Fields inherited from interface org.apache.nifi.provenance.ProvenanceEventRecord
  REMOTE_INPUT_PORT_TYPE, REMOTE_OUTPUT_PORT_TYPE

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StandardProvenanceEventRecord`	`copy(StandardProvenanceEventRecord other)`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getAlternateIdentifierUri()`
`java.lang.String`	`getAttribute(java.lang.String attributeName)` Returns the attribute with the given name
`java.util.Map<java.lang.String,java.lang.String>`	`getAttributes()`
`java.lang.String`	`getBestEventIdentifier()` Returns a unique identifier for the record.
`java.util.List<java.lang.String>`	`getChildUuids()`
`java.lang.String`	`getComponentId()`
`java.lang.String`	`getComponentType()`
`java.lang.String`	`getContentClaimContainer()`
`java.lang.String`	`getContentClaimIdentifier()`
`java.lang.Long`	`getContentClaimOffset()`
`java.lang.String`	`getContentClaimSection()`
`java.lang.String`	`getDetails()`
`long`	`getEventDuration()`
`long`	`getEventId()`
`long`	`getEventTime()`
`ProvenanceEventType`	`getEventType()`
`long`	`getFileSize()`
`long`	`getFlowFileEntryDate()`
`java.lang.String`	`getFlowFileUuid()`
`long`	`getLineageStartDate()`
`java.util.List<java.lang.String>`	`getParentUuids()`
`java.util.Map<java.lang.String,java.lang.String>`	`getPreviousAttributes()`
`java.lang.String`	`getPreviousContentClaimContainer()`
`java.lang.String`	`getPreviousContentClaimIdentifier()`
`java.lang.Long`	`getPreviousContentClaimOffset()`
`java.lang.String`	`getPreviousContentClaimSection()`
`java.lang.Long`	`getPreviousFileSize()`
`java.lang.String`	`getRelationship()`
`java.lang.String`	`getSourceQueueIdentifier()`
`java.lang.String`	`getSourceSystemFlowFileIdentifier()` Since the receiving system will usually refer to the data using a different identifier than the source system, this information is used to correlate the receive system's FlowFile with the sending system's data
`long`	`getStorageByteOffset()`
`java.lang.String`	`getStorageFilename()`
`java.lang.String`	`getTransitUri()`
`java.util.Map<java.lang.String,java.lang.String>`	`getUpdatedAttributes()`
`int`	`hashCode()`
`java.lang.String`	`toString()`

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

Methods inherited from interface org.apache.nifi.provenance.ProvenanceEventRecord
isRemotePortType

- Method Detail
  - copy
```
public static StandardProvenanceEventRecord copy(StandardProvenanceEventRecord other)
```
  - getStorageFilename
```
public java.lang.String getStorageFilename()
```
  - getStorageByteOffset
```
public long getStorageByteOffset()
```
  - getEventId
```
public long getEventId()
```
    Specified by:
    
    getEventId in interface ProvenanceEventRecord
    
    Returns:
    
    a unique ID for this Provenance Event. Depending on the implementation, the Event ID may be set to -1 until the event has been added to the ProvenanceEventRepository
  - getEventTime
```
public long getEventTime()
```
    Specified by:
    
    getEventTime in interface ProvenanceEventRecord
    
    Returns:
    
    the time at which this Provenance Event was created, as the number of milliseconds since epoch
  - getLineageStartDate
```
public long getLineageStartDate()
```
    Specified by:
    
    getLineageStartDate in interface ProvenanceEventRecord
    
    Returns:
    
    the time at which the lineage began
  - getFileSize
```
public long getFileSize()
```
    Specified by:
    
    getFileSize in interface ProvenanceEventRecord
    
    Returns:
    
    the size of the FlowFile to which this Event is associated
  - getPreviousFileSize
```
public java.lang.Long getPreviousFileSize()
```
    Specified by:
    
    getPreviousFileSize in interface ProvenanceEventRecord
    
    Returns:
    
    the previous size of the FlowFile to which this Event is associated, if the FlowFile previously had content and its size was known; otherwise, returns null
  - getEventType
```
public ProvenanceEventType getEventType()
```
    Specified by:
    
    getEventType in interface ProvenanceEventRecord
    
    Returns:
    
    the type of this Provenance Event
  - getAttributes
```
public java.util.Map<java.lang.String,java.lang.String> getAttributes()
```
    Specified by:
    
    getAttributes in interface ProvenanceEventRecord
    
    Returns:
    
    all FlowFile attributes that were associated with the FlowFile at the time that this ProvenanceEvent was created
  - getAttribute
```
public java.lang.String getAttribute(java.lang.String attributeName)
```
    Description copied from interface: ProvenanceEventRecord
    
    Returns the attribute with the given name
    
    Specified by:
    
    getAttribute in interface ProvenanceEventRecord
    
    Parameters:
    
    attributeName - the name of the attribute to get
    
    Returns:
    
    the attribute with the given name or null if no attribute exists with the given name
  - getComponentId
```
public java.lang.String getComponentId()
```
    Specified by:
    
    getComponentId in interface ProvenanceEventRecord
    
    Returns:
    
    the ID of the Processor/component that created this Provenance Event
  - getComponentType
```
public java.lang.String getComponentType()
```
    Specified by:
    
    getComponentType in interface ProvenanceEventRecord
    
    Returns:
    
    the fully-qualified Class Name of the Processor/component that created this Provenance Event
  - getTransitUri
```
public java.lang.String getTransitUri()
```
    Specified by:
    
    getTransitUri in interface ProvenanceEventRecord
    
    Returns:
    
    a URI that provides information about the System and Protocol information over which the transfer occurred. The intent of this field is such that both the sender and the receiver can publish the events to an external Enterprise-wide system that is then able to correlate the SEND and RECEIVE events.
  - getSourceSystemFlowFileIdentifier
```
public java.lang.String getSourceSystemFlowFileIdentifier()
```
    Description copied from interface: ProvenanceEventRecord
    
    Since the receiving system will usually refer to the data using a different identifier than the source system, this information is used to correlate the receive system's FlowFile with the sending system's data
    
    Specified by:
    
    getSourceSystemFlowFileIdentifier in interface ProvenanceEventRecord
    
    Returns:
    
    the UUID that the Source System used to refer to this data; this is applicable only when the ProvenanceEventType is of type RECEIVE
  - getFlowFileUuid
```
public java.lang.String getFlowFileUuid()
```
    Specified by:
    
    getFlowFileUuid in interface ProvenanceEventRecord
    
    Returns:
    
    the UUID of the FlowFile with which this Event is associated
  - getParentUuids
```
public java.util.List<java.lang.String> getParentUuids()
```
    Specified by:
    
    getParentUuids in interface ProvenanceEventRecord
    
    Returns:
    
    the UUID's of all Parent FlowFiles. This is applicable only when the ProvenanceEventType is of type SPAWN
  - getChildUuids
```
public java.util.List<java.lang.String> getChildUuids()
```
    Specified by:
    
    getChildUuids in interface ProvenanceEventRecord
    
    Returns:
    
    the UUID's of all Child FlowFiles. This is applicable only when the ProvenanceEventType is of type SPAWN
  - getAlternateIdentifierUri
```
public java.lang.String getAlternateIdentifierUri()
```
    Specified by:
    
    getAlternateIdentifierUri in interface ProvenanceEventRecord
    
    Returns:
    
    the Alternate Identifier associated with the FlowFile with which this Event is associated. This is applicable only when the ProvenanceEventType is of type ProvenanceEventType.ADDINFO
  - getEventDuration
```
public long getEventDuration()
```
    Specified by:
    
    getEventDuration in interface ProvenanceEventRecord
    
    Returns:
    
    the amount of time in milliseconds that elapsed while performing this event. If not populated, the value -1 will be returned
  - getDetails
```
public java.lang.String getDetails()
```
    Specified by:
    
    getDetails in interface ProvenanceEventRecord
    
    Returns:
    
    the details for this record, if any were supplied. Otherwise, returns null
  - getRelationship
```
public java.lang.String getRelationship()
```
    Specified by:
    
    getRelationship in interface ProvenanceEventRecord
    
    Returns:
    
    the relationship to which this record was routed if the event type is ProvenanceEventType.ROUTE. The relationship is applicable only to this type
  - getFlowFileEntryDate
```
public long getFlowFileEntryDate()
```
    Specified by:
    
    getFlowFileEntryDate in interface ProvenanceEventRecord
    
    Returns:
    
    the EntryDate of the FlowFile to which this Event is associated
  - getContentClaimSection
```
public java.lang.String getContentClaimSection()
```
    Specified by:
    
    getContentClaimSection in interface ProvenanceEventRecord
    
    Returns:
    
    the Section for the Content Claim that this Event refers to, if any; otherwise, returns null
  - getContentClaimContainer
```
public java.lang.String getContentClaimContainer()
```
    Specified by:
    
    getContentClaimContainer in interface ProvenanceEventRecord
    
    Returns:
    
    the Container for the Content Claim that this Event refers to, if any; otherwise, returns null
  - getContentClaimIdentifier
```
public java.lang.String getContentClaimIdentifier()
```
    Specified by:
    
    getContentClaimIdentifier in interface ProvenanceEventRecord
    
    Returns:
    
    the Identifier for the Content Claim that this Event refers to, if any; otherwise, returns null
  - getContentClaimOffset
```
public java.lang.Long getContentClaimOffset()
```
    Specified by:
    
    getContentClaimOffset in interface ProvenanceEventRecord
    
    Returns:
    
    the offset into the Content Claim at which the FlowFile's content begins, if any; otherwise, returns null
  - getSourceQueueIdentifier
```
public java.lang.String getSourceQueueIdentifier()
```
    Specified by:
    
    getSourceQueueIdentifier in interface ProvenanceEventRecord
    
    Returns:
    
    the identifier of the queue from which the FlowFile was taken, if any. If the FlowFile is created as a result of this event (in this case, the Event Type is one of null null null null null null null null ProvenanceEventType.CREATE, ProvenanceEventType.RECEIVE, ProvenanceEventType.FORK, ProvenanceEventType.JOIN, or ProvenanceEventType.CLONE), or if the queue identifier is unknown, then this method will return null
  - getPreviousAttributes
```
public java.util.Map<java.lang.String,java.lang.String> getPreviousAttributes()
```
    Specified by:
    
    getPreviousAttributes in interface ProvenanceEventRecord
    
    Returns:
    
    all FlowFile attributes that existed on the FlowFile before this event occurred
  - getPreviousContentClaimContainer
```
public java.lang.String getPreviousContentClaimContainer()
```
    Specified by:
    
    getPreviousContentClaimContainer in interface ProvenanceEventRecord
    
    Returns:
    
    the Container for the Content Claim that the FlowFile previously referenced, if any; otherwise, returns null
  - getPreviousContentClaimIdentifier
```
public java.lang.String getPreviousContentClaimIdentifier()
```
    Specified by:
    
    getPreviousContentClaimIdentifier in interface ProvenanceEventRecord
    
    Returns:
    
    the Identifier for the Content Claim that the FlowFile previously referenced, if any; otherwise, returns null
  - getPreviousContentClaimOffset
```
public java.lang.Long getPreviousContentClaimOffset()
```
    Specified by:
    
    getPreviousContentClaimOffset in interface ProvenanceEventRecord
    
    Returns:
    
    the offset into the Content Claim at which the FlowFile's previous content began, if any; otherwise, returns null
  - getPreviousContentClaimSection
```
public java.lang.String getPreviousContentClaimSection()
```
    Specified by:
    
    getPreviousContentClaimSection in interface ProvenanceEventRecord
    
    Returns:
    
    the Section for the Content Claim that the FlowFile previously referenced, if any; otherwise, returns null
  - getUpdatedAttributes
```
public java.util.Map<java.lang.String,java.lang.String> getUpdatedAttributes()
```
    Specified by:
    
    getUpdatedAttributes in interface ProvenanceEventRecord
    
    Returns:
    
    all FlowFile attributes that were updated as a result of this event
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getBestEventIdentifier
```
public java.lang.String getBestEventIdentifier()
```
    Returns a unique identifier for the record. By default, it uses ProvenanceEventRecord.getEventId() but if it has not been persisted to the repository, this is -1, so it constructs a String of the format <event type>_on_<flowfile UUID>_by_<component UUID>_at_<event time>.
    
    Specified by:
    
    getBestEventIdentifier in interface ProvenanceEventRecord
    
    Returns:
    
    a String identifying the record for later analysis

Class StandardProvenanceEventRecord

Nested Class Summary

Field Summary

Fields inherited from interface org.apache.nifi.provenance.ProvenanceEventRecord

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.nifi.provenance.ProvenanceEventRecord

Method Detail

copy

getStorageFilename

getStorageByteOffset

getEventId

getEventTime

getLineageStartDate

getFileSize

getPreviousFileSize

getEventType

getAttributes

getAttribute

getComponentId

getComponentType

getTransitUri

getSourceSystemFlowFileIdentifier

getFlowFileUuid

getParentUuids

getChildUuids

getAlternateIdentifierUri

getEventDuration

getDetails

getRelationship

getFlowFileEntryDate

getContentClaimSection

getContentClaimContainer

getContentClaimIdentifier

getContentClaimOffset

getSourceQueueIdentifier

getPreviousAttributes

getPreviousContentClaimContainer

getPreviousContentClaimIdentifier

getPreviousContentClaimOffset

getPreviousContentClaimSection

getUpdatedAttributes

hashCode

equals

toString

getBestEventIdentifier