ProvenanceEventDTO (nifi-client-dto 1.23.2 API)

java.lang.Object
- org.apache.nifi.web.api.dto.provenance.ProvenanceEventDTO

public class ProvenanceEventDTO
extends Object

A provenance event.

Field Summary

Fields
Modifier and Type	Field and Description
`private String`	`alternateIdentifierUri`
`private Collection<AttributeDTO>`	`attributes`
`private List<String>`	`childUuids`
`private String`	`clusterNodeAddress`
`private String`	`clusterNodeId`
`private String`	`componentId`
`private String`	`componentName`
`private String`	`componentType`
`private Boolean`	`contentEqual`
`private String`	`details`
`private Long`	`eventDuration`
`private Long`	`eventId`
`private Date`	`eventTime`
`private String`	`eventType`
`private String`	`fileSize`
`private Long`	`fileSizeBytes`
`private String`	`flowFileUuid`
`private String`	`groupId`
`private String`	`id`
`private Boolean`	`inputContentAvailable`
`private String`	`inputContentClaimContainer`
`private String`	`inputContentClaimFileSize`
`private Long`	`inputContentClaimFileSizeBytes`
`private String`	`inputContentClaimIdentifier`
`private Long`	`inputContentClaimOffset`
`private String`	`inputContentClaimSection`
`private Long`	`lineageDuration`
`private Boolean`	`outputContentAvailable`
`private String`	`outputContentClaimContainer`
`private String`	`outputContentClaimFileSize`
`private Long`	`outputContentClaimFileSizeBytes`
`private String`	`outputContentClaimIdentifier`
`private Long`	`outputContentClaimOffset`
`private String`	`outputContentClaimSection`
`private List<String>`	`parentUuids`
`private String`	`relationship`
`private Boolean`	`replayAvailable`
`private String`	`replayExplanation`
`private String`	`sourceConnectionIdentifier`
`private String`	`sourceSystemFlowFileId`
`private String`	`transitUri`

Constructor Summary

Constructors
Constructor and Description

ProvenanceEventDTO()

Constructors
Constructor and Description
`ProvenanceEventDTO()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAlternateIdentifierUri()`
`Collection<AttributeDTO>`	`getAttributes()`
`List<String>`	`getChildUuids()`
`String`	`getClusterNodeAddress()`
`String`	`getClusterNodeId()`
`String`	`getComponentId()`
`String`	`getComponentName()`
`String`	`getComponentType()`
`Boolean`	`getContentEqual()`
`String`	`getDetails()`
`Long`	`getEventDuration()`
`Long`	`getEventId()`
`Date`	`getEventTime()`
`String`	`getEventType()`
`String`	`getFileSize()`
`Long`	`getFileSizeBytes()`
`String`	`getFlowFileUuid()`
`String`	`getGroupId()`
`String`	`getId()`
`Boolean`	`getInputContentAvailable()`
`String`	`getInputContentClaimContainer()`
`String`	`getInputContentClaimFileSize()`
`Long`	`getInputContentClaimFileSizeBytes()`
`String`	`getInputContentClaimIdentifier()`
`Long`	`getInputContentClaimOffset()`
`String`	`getInputContentClaimSection()`
`Long`	`getLineageDuration()`
`Boolean`	`getOutputContentAvailable()`
`String`	`getOutputContentClaimContainer()`
`String`	`getOutputContentClaimFileSize()`
`Long`	`getOutputContentClaimFileSizeBytes()`
`String`	`getOutputContentClaimIdentifier()`
`Long`	`getOutputContentClaimOffset()`
`String`	`getOutputContentClaimSection()`
`List<String>`	`getParentUuids()`
`String`	`getRelationship()`
`Boolean`	`getReplayAvailable()`
`String`	`getReplayExplanation()`
`String`	`getSourceConnectionIdentifier()`
`String`	`getSourceSystemFlowFileId()`
`String`	`getTransitUri()`
`void`	`setAlternateIdentifierUri(String alternateIdentifierUri)`
`void`	`setAttributes(Collection<AttributeDTO> attributes)`
`void`	`setChildUuids(List<String> childUuids)`
`void`	`setClusterNodeAddress(String clusterNodeAddress)`
`void`	`setClusterNodeId(String clusterNodeId)`
`void`	`setComponentId(String componentId)`
`void`	`setComponentName(String componentName)`
`void`	`setComponentType(String componentType)`
`void`	`setContentEqual(Boolean contentEqual)`
`void`	`setDetails(String details)`
`void`	`setEventDuration(Long eventDuration)`
`void`	`setEventId(Long eventId)`
`void`	`setEventTime(Date eventTime)`
`void`	`setEventType(String eventType)`
`void`	`setFileSize(String fileSize)`
`void`	`setFileSizeBytes(Long fileSizeBytes)`
`void`	`setFlowFileUuid(String flowFileUuid)`
`void`	`setGroupId(String groupId)`
`void`	`setId(String id)`
`void`	`setInputContentAvailable(Boolean inputContentAvailable)`
`void`	`setInputContentClaimContainer(String inputContentClaimContainer)`
`void`	`setInputContentClaimFileSize(String inputContentClaimFileSize)`
`void`	`setInputContentClaimFileSizeBytes(Long inputContentClaimFileSizeBytes)`
`void`	`setInputContentClaimIdentifier(String inputContentClaimIdentifier)`
`void`	`setInputContentClaimOffset(Long inputContentClaimOffset)`
`void`	`setInputContentClaimSection(String inputContentClaimSection)`
`void`	`setLineageDuration(Long lineageDuration)`
`void`	`setOutputContentAvailable(Boolean outputContentAvailable)`
`void`	`setOutputContentClaimContainer(String outputContentClaimContainer)`
`void`	`setOutputContentClaimFileSize(String outputContentClaimFileSize)`
`void`	`setOutputContentClaimFileSizeBytes(Long outputContentClaimFileSizeBytes)`
`void`	`setOutputContentClaimIdentifier(String outputContentClaimIdentifier)`
`void`	`setOutputContentClaimOffset(Long outputContentClaimOffset)`
`void`	`setOutputContentClaimSection(String contentClaimSection)`
`void`	`setParentUuids(List<String> parentUuids)`
`void`	`setRelationship(String relationship)`
`void`	`setReplayAvailable(Boolean replayAvailable)`
`void`	`setReplayExplanation(String replayExplanation)`
`void`	`setSourceConnectionIdentifier(String sourceConnectionIdentifier)`
`void`	`setSourceSystemFlowFileId(String sourceSystemFlowFileId)`
`void`	`setTransitUri(String transitUri)`

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

Field Detail

id
```
private String id
```

eventId
```
private Long eventId
```

eventTime
```
private Date eventTime
```

eventDuration
```
private Long eventDuration
```

lineageDuration
```
private Long lineageDuration
```

eventType
```
private String eventType
```

flowFileUuid
```
private String flowFileUuid
```

fileSize
```
private String fileSize
```

fileSizeBytes
```
private Long fileSizeBytes
```

clusterNodeId
```
private String clusterNodeId
```

clusterNodeAddress
```
private String clusterNodeAddress
```

groupId
```
private String groupId
```

componentId
```
private String componentId
```

componentType
```
private String componentType
```

componentName
```
private String componentName
```

sourceSystemFlowFileId
```
private String sourceSystemFlowFileId
```

alternateIdentifierUri
```
private String alternateIdentifierUri
```

attributes

private Collection<AttributeDTO> attributes

parentUuids
```
private List<String> parentUuids
```

childUuids
```
private List<String> childUuids
```

transitUri
```
private String transitUri
```

relationship
```
private String relationship
```

details
```
private String details
```

contentEqual
```
private Boolean contentEqual
```

inputContentAvailable
```
private Boolean inputContentAvailable
```

inputContentClaimSection

private String inputContentClaimSection

inputContentClaimContainer

private String inputContentClaimContainer

inputContentClaimIdentifier

private String inputContentClaimIdentifier

inputContentClaimOffset
```
private Long inputContentClaimOffset
```

inputContentClaimFileSize

private String inputContentClaimFileSize

inputContentClaimFileSizeBytes

private Long inputContentClaimFileSizeBytes

outputContentAvailable
```
private Boolean outputContentAvailable
```

outputContentClaimSection

private String outputContentClaimSection

outputContentClaimContainer

private String outputContentClaimContainer

outputContentClaimIdentifier

private String outputContentClaimIdentifier

outputContentClaimOffset
```
private Long outputContentClaimOffset
```

outputContentClaimFileSize

private String outputContentClaimFileSize

outputContentClaimFileSizeBytes

private Long outputContentClaimFileSizeBytes

replayAvailable
```
private Boolean replayAvailable
```

replayExplanation
```
private String replayExplanation
```

sourceConnectionIdentifier

private String sourceConnectionIdentifier

Constructor Detail
- ProvenanceEventDTO
```
public ProvenanceEventDTO()
```

Method Detail

getId
```
public String getId()
```
Returns:

event uuid

setId
```
public void setId(String id)
```

getEventId
```
public Long getEventId()
```
Returns:

event id

setEventId
```
public void setEventId(Long eventId)
```

getEventTime
```
public Date getEventTime()
```
Returns:

time the event occurred

setEventTime

public void setEventTime(Date eventTime)

getFlowFileUuid
```
public String getFlowFileUuid()
```
Returns:

UUID of the FlowFile for this event

setFlowFileUuid

public void setFlowFileUuid(String flowFileUuid)

getFileSize
```
public String getFileSize()
```
Returns:

size of the FlowFile for this event

setFileSize

public void setFileSize(String fileSize)

getFileSizeBytes
```
public Long getFileSizeBytes()
```
Returns:

size of the FlowFile in bytes for this event

setFileSizeBytes

public void setFileSizeBytes(Long fileSizeBytes)

getEventType
```
public String getEventType()
```
Returns:

type of this event

setEventType

public void setEventType(String eventType)

getAttributes
```
public Collection<AttributeDTO> getAttributes()
```
Returns:

attributes for the FlowFile for this event

setAttributes

public void setAttributes(Collection<AttributeDTO> attributes)

getGroupId
```
public String getGroupId()
```
Returns:

id of the group that this component resides in. If the component is no longer in the flow, the group id will not be set

setGroupId

public void setGroupId(String groupId)

getComponentId
```
public String getComponentId()
```
Returns:

id of the component that generated this event

setComponentId

public void setComponentId(String componentId)

getComponentName
```
public String getComponentName()
```
Returns:

name of the component that generated this event

setComponentName

public void setComponentName(String componentName)

getComponentType
```
public String getComponentType()
```
Returns:

type of the component that generated this event

setComponentType

public void setComponentType(String componentType)

getTransitUri
```
public String getTransitUri()
```
Returns:

source/destination system URI if the event was a RECEIVE/SEND

setTransitUri

public void setTransitUri(String transitUri)

getAlternateIdentifierUri
```
public String getAlternateIdentifierUri()
```
Returns:

alternate identifier URI for the FlowFile for this event

setAlternateIdentifierUri

public void setAlternateIdentifierUri(String alternateIdentifierUri)

getClusterNodeId
```
public String getClusterNodeId()
```
Returns:

identifier of the node where this event originated

setClusterNodeId

public void setClusterNodeId(String clusterNodeId)

getClusterNodeAddress
```
public String getClusterNodeAddress()
```
Returns:

label to use to show which node this event originated from

setClusterNodeAddress

public void setClusterNodeAddress(String clusterNodeAddress)

getParentUuids
```
public List<String> getParentUuids()
```
Returns:

parent uuids for this event

setParentUuids

public void setParentUuids(List<String> parentUuids)

getChildUuids
```
public List<String> getChildUuids()
```
Returns:

child uuids for this event

setChildUuids

public void setChildUuids(List<String> childUuids)

getEventDuration
```
public Long getEventDuration()
```
Returns:

duration of the event, in milliseconds

setEventDuration

public void setEventDuration(Long eventDuration)

getLineageDuration
```
public Long getLineageDuration()
```
Returns:

duration since the lineage began, in milliseconds

setLineageDuration

public void setLineageDuration(Long lineageDuration)

getSourceSystemFlowFileId
```
public String getSourceSystemFlowFileId()
```
Returns:

source system FlowFile id

setSourceSystemFlowFileId

public void setSourceSystemFlowFileId(String sourceSystemFlowFileId)

getRelationship
```
public String getRelationship()
```
Returns:

If this represents a route event, this is the relationship to which the flowfile was routed

setRelationship

public void setRelationship(String relationship)

getDetails
```
public String getDetails()
```
Returns:

event details

setDetails

public void setDetails(String details)

getContentEqual
```
public Boolean getContentEqual()
```
Returns:

whether or not the input and output content claim is the same

setContentEqual

public void setContentEqual(Boolean contentEqual)

getOutputContentAvailable
```
public Boolean getOutputContentAvailable()
```
Returns:

whether or not the output content is still available

setOutputContentAvailable

public void setOutputContentAvailable(Boolean outputContentAvailable)

getOutputContentClaimSection
```
public String getOutputContentClaimSection()
```
Returns:

the Section in which the output Content Claim lives, or null if no Content Claim exists

setOutputContentClaimSection

public void setOutputContentClaimSection(String contentClaimSection)

getOutputContentClaimContainer
```
public String getOutputContentClaimContainer()
```
Returns:

the Container in which the output Content Claim lives, or null if no Content Claim exists

setOutputContentClaimContainer

public void setOutputContentClaimContainer(String outputContentClaimContainer)

getOutputContentClaimIdentifier
```
public String getOutputContentClaimIdentifier()
```
Returns:

the Identifier of the output Content Claim, or null if no Content Claim exists

setOutputContentClaimIdentifier

public void setOutputContentClaimIdentifier(String outputContentClaimIdentifier)

getOutputContentClaimOffset
```
public Long getOutputContentClaimOffset()
```
Returns:

the offset into the the output Content Claim where the FlowFile's content begins, or null if no Content Claim exists

setOutputContentClaimOffset

public void setOutputContentClaimOffset(Long outputContentClaimOffset)

getOutputContentClaimFileSize
```
public String getOutputContentClaimFileSize()
```
Returns:

the formatted file size of the input content claim

setOutputContentClaimFileSize

public void setOutputContentClaimFileSize(String outputContentClaimFileSize)

getOutputContentClaimFileSizeBytes
```
public Long getOutputContentClaimFileSizeBytes()
```
Returns:

the number of bytes of the input content claim

setOutputContentClaimFileSizeBytes

public void setOutputContentClaimFileSizeBytes(Long outputContentClaimFileSizeBytes)

getInputContentAvailable
```
public Boolean getInputContentAvailable()
```
Returns:

whether or not the input content is still available

setInputContentAvailable

public void setInputContentAvailable(Boolean inputContentAvailable)

getInputContentClaimSection
```
public String getInputContentClaimSection()
```
Returns:

the Section in which the input Content Claim lives, or null if no Content Claim exists

setInputContentClaimSection

public void setInputContentClaimSection(String inputContentClaimSection)

getInputContentClaimContainer
```
public String getInputContentClaimContainer()
```
Returns:

the Container in which the input Content Claim lives, or null if no Content Claim exists

setInputContentClaimContainer

public void setInputContentClaimContainer(String inputContentClaimContainer)

getInputContentClaimIdentifier
```
public String getInputContentClaimIdentifier()
```
Returns:

the Identifier of the input Content Claim, or null if no Content Claim exists

setInputContentClaimIdentifier

public void setInputContentClaimIdentifier(String inputContentClaimIdentifier)

getInputContentClaimOffset
```
public Long getInputContentClaimOffset()
```
Returns:

the offset into the the input Content Claim where the FlowFile's content begins, or null if no Content Claim exists

setInputContentClaimOffset

public void setInputContentClaimOffset(Long inputContentClaimOffset)

getInputContentClaimFileSize
```
public String getInputContentClaimFileSize()
```
Returns:

the formatted file size of the input content claim

setInputContentClaimFileSize

public void setInputContentClaimFileSize(String inputContentClaimFileSize)

getInputContentClaimFileSizeBytes
```
public Long getInputContentClaimFileSizeBytes()
```
Returns:

the number of bytes of the input content claim

setInputContentClaimFileSizeBytes

public void setInputContentClaimFileSizeBytes(Long inputContentClaimFileSizeBytes)

getReplayAvailable
```
public Boolean getReplayAvailable()
```
Returns:

whether or not replay is available

setReplayAvailable

public void setReplayAvailable(Boolean replayAvailable)

getReplayExplanation
```
public String getReplayExplanation()
```
Returns:

the explanation as to why replay is unavailable

setReplayExplanation

public void setReplayExplanation(String replayExplanation)

getSourceConnectionIdentifier
```
public String getSourceConnectionIdentifier()
```
Returns:

identifier of the FlowFile Queue / Connection from which the FlowFile was pulled to generate this event, or null if either the queue is unknown or the FlowFile was created by this event

setSourceConnectionIdentifier

public void setSourceConnectionIdentifier(String sourceConnectionIdentifier)

Class ProvenanceEventDTO

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

eventId

eventTime

eventDuration

lineageDuration

eventType

flowFileUuid

fileSize

fileSizeBytes

clusterNodeId

clusterNodeAddress

groupId

componentId

componentType

componentName

sourceSystemFlowFileId

alternateIdentifierUri

attributes

parentUuids

childUuids

transitUri

relationship

details

contentEqual

inputContentAvailable

inputContentClaimSection

inputContentClaimContainer

inputContentClaimIdentifier

inputContentClaimOffset

inputContentClaimFileSize

inputContentClaimFileSizeBytes

outputContentAvailable

outputContentClaimSection

outputContentClaimContainer

outputContentClaimIdentifier

outputContentClaimOffset

outputContentClaimFileSize

outputContentClaimFileSizeBytes

replayAvailable

replayExplanation

sourceConnectionIdentifier

Constructor Detail

ProvenanceEventDTO

Method Detail

getId

setId

getEventId

setEventId

getEventTime

setEventTime

getFlowFileUuid

setFlowFileUuid

getFileSize

setFileSize

getFileSizeBytes

setFileSizeBytes

getEventType

setEventType

getAttributes

setAttributes

getGroupId

setGroupId

getComponentId

setComponentId

getComponentName

setComponentName

getComponentType

setComponentType

getTransitUri

setTransitUri

getAlternateIdentifierUri

setAlternateIdentifierUri

getClusterNodeId

setClusterNodeId