StandardProvenanceEventRecord (nifi-data-provenance-utils 1.17.0 API)

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

All Implemented Interfaces:: ProvenanceEventRecord

public class StandardProvenanceEventRecord
extends 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
Modifier and Type	Field and Description
`private String`	`alternateIdentifierUri`
`private List<String>`	`childrenUuids`
`private String`	`componentId`
`private String`	`componentType`
`private String`	`contentClaimContainer`
`private String`	`contentClaimIdentifier`
`private Long`	`contentClaimOffset`
`private String`	`contentClaimSection`
`private long`	`contentSize`
`private String`	`details`
`private long`	`entryDate`
`private long`	`eventDuration`
`private long`	`eventId`
`private long`	`eventTime`
`private ProvenanceEventType`	`eventType`
`private long`	`lineageStartDate`
`private List<String>`	`parentUuids`
`private Map<String,String>`	`previousAttributes`
`private String`	`previousClaimContainer`
`private String`	`previousClaimIdentifier`
`private Long`	`previousClaimOffset`
`private String`	`previousClaimSection`
`private Long`	`previousSize`
`private String`	`relationship`
`private String`	`sourceQueueIdentifier`
`private String`	`sourceSystemFlowFileIdentifier`
`private long`	`storageByteOffset`
`private String`	`storageFilename`
`private String`	`transitUri`
`private Map<String,String>`	`updatedAttributes`
`private String`	`uuid`

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

Constructor Summary

Constructors
Constructor and Description

StandardProvenanceEventRecord(StandardProvenanceEventRecord.Builder builder)

Constructors
Constructor and Description
`StandardProvenanceEventRecord(StandardProvenanceEventRecord.Builder builder)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StandardProvenanceEventRecord`	`copy(StandardProvenanceEventRecord other)`
`private boolean`	`different(List<String> a, List<String> b)`
`private boolean`	`different(Object a, Object b)`
`boolean`	`equals(Object obj)`
`String`	`getAlternateIdentifierUri()`
`String`	`getAttribute(String attributeName)`
`Map<String,String>`	`getAttributes()`
`String`	`getBestEventIdentifier()` Returns a unique identifier for the record.
`List<String>`	`getChildUuids()`
`String`	`getComponentId()`
`String`	`getComponentType()`
`String`	`getContentClaimContainer()`
`String`	`getContentClaimIdentifier()`
`Long`	`getContentClaimOffset()`
`String`	`getContentClaimSection()`
`String`	`getDetails()`
`long`	`getEventDuration()`
`long`	`getEventId()`
`long`	`getEventTime()`
`ProvenanceEventType`	`getEventType()`
`long`	`getFileSize()`
`long`	`getFlowFileEntryDate()`
`String`	`getFlowFileUuid()`
`long`	`getLineageStartDate()`
`List<String>`	`getParentUuids()`
`Map<String,String>`	`getPreviousAttributes()`
`String`	`getPreviousContentClaimContainer()`
`String`	`getPreviousContentClaimIdentifier()`
`Long`	`getPreviousContentClaimOffset()`
`String`	`getPreviousContentClaimSection()`
`Long`	`getPreviousFileSize()`
`String`	`getRelationship()`
`String`	`getSourceQueueIdentifier()`
`String`	`getSourceSystemFlowFileIdentifier()`
`long`	`getStorageByteOffset()`
`String`	`getStorageFilename()`
`String`	`getTransitUri()`
`Map<String,String>`	`getUpdatedAttributes()`
`int`	`hashCode()`
`(package private) void`	`setEventId(long eventId)`
`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

- Field Detail
  - eventTime
```
private final long eventTime
```
  - entryDate
```
private final long entryDate
```
  - eventType
```
private final ProvenanceEventType eventType
```
  - lineageStartDate
```
private final long lineageStartDate
```
  - componentId
```
private final String componentId
```
  - componentType
```
private final String componentType
```
  - transitUri
```
private final String transitUri
```
  - sourceSystemFlowFileIdentifier
```
private final String sourceSystemFlowFileIdentifier
```
  - uuid
```
private final String uuid
```
  - parentUuids
```
private final List<String> parentUuids
```
  - childrenUuids
```
private final List<String> childrenUuids
```
  - alternateIdentifierUri
```
private final String alternateIdentifierUri
```
  - details
```
private final String details
```
  - relationship
```
private final String relationship
```
  - storageByteOffset
```
private final long storageByteOffset
```
  - storageFilename
```
private final String storageFilename
```
  - eventDuration
```
private final long eventDuration
```
  - contentClaimSection
```
private final String contentClaimSection
```
  - contentClaimContainer
```
private final String contentClaimContainer
```
  - contentClaimIdentifier
```
private final String contentClaimIdentifier
```
  - contentClaimOffset
```
private final Long contentClaimOffset
```
  - contentSize
```
private final long contentSize
```
  - previousClaimSection
```
private final String previousClaimSection
```
  - previousClaimContainer
```
private final String previousClaimContainer
```
  - previousClaimIdentifier
```
private final String previousClaimIdentifier
```
  - previousClaimOffset
```
private final Long previousClaimOffset
```
  - previousSize
```
private final Long previousSize
```
  - sourceQueueIdentifier
```
private final String sourceQueueIdentifier
```
  - previousAttributes
```
private final Map<String,String> previousAttributes
```
  - updatedAttributes
```
private final Map<String,String> updatedAttributes
```
  - eventId
```
private volatile long eventId
```
- Constructor Detail
  - StandardProvenanceEventRecord
```
StandardProvenanceEventRecord(StandardProvenanceEventRecord.Builder builder)
```
- Method Detail
  - copy
```
public static StandardProvenanceEventRecord copy(StandardProvenanceEventRecord other)
```
  - getStorageFilename
```
public String getStorageFilename()
```
  - getStorageByteOffset
```
public long getStorageByteOffset()
```
  - setEventId
```
void setEventId(long eventId)
```
  - getEventId
```
public long getEventId()
```
    Specified by:
    
    getEventId in interface ProvenanceEventRecord
  - getEventTime
```
public long getEventTime()
```
    Specified by:
    
    getEventTime in interface ProvenanceEventRecord
  - getLineageStartDate
```
public long getLineageStartDate()
```
    Specified by:
    
    getLineageStartDate in interface ProvenanceEventRecord
  - getFileSize
```
public long getFileSize()
```
    Specified by:
    
    getFileSize in interface ProvenanceEventRecord
  - getPreviousFileSize
```
public Long getPreviousFileSize()
```
    Specified by:
    
    getPreviousFileSize in interface ProvenanceEventRecord
  - getEventType
```
public ProvenanceEventType getEventType()
```
    Specified by:
    
    getEventType in interface ProvenanceEventRecord
  - getAttributes
```
public Map<String,String> getAttributes()
```
    Specified by:
    
    getAttributes in interface ProvenanceEventRecord
  - getAttribute
```
public String getAttribute(String attributeName)
```
    Specified by:
    
    getAttribute in interface ProvenanceEventRecord
  - getComponentId
```
public String getComponentId()
```
    Specified by:
    
    getComponentId in interface ProvenanceEventRecord
  - getComponentType
```
public String getComponentType()
```
    Specified by:
    
    getComponentType in interface ProvenanceEventRecord
  - getTransitUri
```
public String getTransitUri()
```
    Specified by:
    
    getTransitUri in interface ProvenanceEventRecord
  - getSourceSystemFlowFileIdentifier
```
public String getSourceSystemFlowFileIdentifier()
```
    Specified by:
    
    getSourceSystemFlowFileIdentifier in interface ProvenanceEventRecord
  - getFlowFileUuid
```
public String getFlowFileUuid()
```
    Specified by:
    
    getFlowFileUuid in interface ProvenanceEventRecord
  - getParentUuids
```
public List<String> getParentUuids()
```
    Specified by:
    
    getParentUuids in interface ProvenanceEventRecord
  - getChildUuids
```
public List<String> getChildUuids()
```
    Specified by:
    
    getChildUuids in interface ProvenanceEventRecord
  - getAlternateIdentifierUri
```
public String getAlternateIdentifierUri()
```
    Specified by:
    
    getAlternateIdentifierUri in interface ProvenanceEventRecord
  - getEventDuration
```
public long getEventDuration()
```
    Specified by:
    
    getEventDuration in interface ProvenanceEventRecord
  - getDetails
```
public String getDetails()
```
    Specified by:
    
    getDetails in interface ProvenanceEventRecord
  - getRelationship
```
public String getRelationship()
```
    Specified by:
    
    getRelationship in interface ProvenanceEventRecord
  - getFlowFileEntryDate
```
public long getFlowFileEntryDate()
```
    Specified by:
    
    getFlowFileEntryDate in interface ProvenanceEventRecord
  - getContentClaimSection
```
public String getContentClaimSection()
```
    Specified by:
    
    getContentClaimSection in interface ProvenanceEventRecord
  - getContentClaimContainer
```
public String getContentClaimContainer()
```
    Specified by:
    
    getContentClaimContainer in interface ProvenanceEventRecord
  - getContentClaimIdentifier
```
public String getContentClaimIdentifier()
```
    Specified by:
    
    getContentClaimIdentifier in interface ProvenanceEventRecord
  - getContentClaimOffset
```
public Long getContentClaimOffset()
```
    Specified by:
    
    getContentClaimOffset in interface ProvenanceEventRecord
  - getSourceQueueIdentifier
```
public String getSourceQueueIdentifier()
```
    Specified by:
    
    getSourceQueueIdentifier in interface ProvenanceEventRecord
  - getPreviousAttributes
```
public Map<String,String> getPreviousAttributes()
```
    Specified by:
    
    getPreviousAttributes in interface ProvenanceEventRecord
  - getPreviousContentClaimContainer
```
public String getPreviousContentClaimContainer()
```
    Specified by:
    
    getPreviousContentClaimContainer in interface ProvenanceEventRecord
  - getPreviousContentClaimIdentifier
```
public String getPreviousContentClaimIdentifier()
```
    Specified by:
    
    getPreviousContentClaimIdentifier in interface ProvenanceEventRecord
  - getPreviousContentClaimOffset
```
public Long getPreviousContentClaimOffset()
```
    Specified by:
    
    getPreviousContentClaimOffset in interface ProvenanceEventRecord
  - getPreviousContentClaimSection
```
public String getPreviousContentClaimSection()
```
    Specified by:
    
    getPreviousContentClaimSection in interface ProvenanceEventRecord
  - getUpdatedAttributes
```
public Map<String,String> getUpdatedAttributes()
```
    Specified by:
    
    getUpdatedAttributes in interface ProvenanceEventRecord
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - different
```
private boolean different(Object a,
                          Object b)
```
  - different
```
private boolean different(List<String> a,
                          List<String> b)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getBestEventIdentifier
```
public 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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

eventTime

entryDate

eventType

lineageStartDate

componentId

componentType

transitUri

sourceSystemFlowFileIdentifier

uuid

parentUuids

childrenUuids

alternateIdentifierUri

details

relationship

storageByteOffset

storageFilename

eventDuration

contentClaimSection

contentClaimContainer

contentClaimIdentifier

contentClaimOffset

contentSize

previousClaimSection

previousClaimContainer

previousClaimIdentifier

previousClaimOffset

previousSize

sourceQueueIdentifier

previousAttributes

updatedAttributes

eventId

Constructor Detail

StandardProvenanceEventRecord

Method Detail

copy

getStorageFilename

getStorageByteOffset

setEventId

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