Package org.apache.nifi.api.toolkit.model

Class VersionedReportingTask

java.lang.Object

org.apache.nifi.api.toolkit.model.VersionedReportingTask

@Generated(value="io.swagger.codegen.v3.generators.java.JavaClientCodegen",
           date="2023-11-22T19:25:26.907436939-06:00[America/Chicago]")
public class VersionedReportingTask
extends Object

VersionedReportingTask

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	VersionedReportingTask.ComponentTypeEnum	Gets or Sets componentType
static enum	VersionedReportingTask.ScheduledStateEnum	Indicates the scheduled state for the Reporting Task

Field Summary

Fields

Modifier and Type	Field	Description
private String	annotationData
private Bundle	bundle
private String	comments
private VersionedReportingTask.ComponentTypeEnum	componentType
private String	groupIdentifier
private String	identifier
private String	instanceIdentifier
private String	name
private Position	position
private Map<String,String>	properties
private Map<String,VersionedPropertyDescriptor>	propertyDescriptors
private VersionedReportingTask.ScheduledStateEnum	scheduledState
private String	schedulingPeriod
private String	schedulingStrategy
private String	type

Constructor Summary

Constructors

Constructor	Description
VersionedReportingTask()

Method Summary

Modifier and Type	Method	Description
VersionedReportingTask	annotationData(String annotationData)
VersionedReportingTask	bundle(Bundle bundle)
VersionedReportingTask	comments(String comments)
VersionedReportingTask	componentType(VersionedReportingTask.ComponentTypeEnum componentType)
boolean	equals(Object o)
String	getAnnotationData()	The annotation for the reporting task.
Bundle	getBundle()	Get bundle
String	getComments()	The user-supplied comments for the component
VersionedReportingTask.ComponentTypeEnum	getComponentType()	Get componentType
String	getGroupIdentifier()	The ID of the Process Group that this component belongs to
String	getIdentifier()	The component's unique identifier
String	getInstanceIdentifier()	The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
String	getName()	The component's name
Position	getPosition()	Get position
Map<String,String>	getProperties()	The properties for the component.
Map<String,VersionedPropertyDescriptor>	getPropertyDescriptors()	The property descriptors for the component.
VersionedReportingTask.ScheduledStateEnum	getScheduledState()	Indicates the scheduled state for the Reporting Task
String	getSchedulingPeriod()	The frequency with which to schedule the reporting task.
String	getSchedulingStrategy()	Indicates scheduling strategy that should dictate how the reporting task is triggered.
String	getType()	The type of the extension component
VersionedReportingTask	groupIdentifier(String groupIdentifier)
int	hashCode()
VersionedReportingTask	identifier(String identifier)
VersionedReportingTask	instanceIdentifier(String instanceIdentifier)
VersionedReportingTask	name(String name)
VersionedReportingTask	position(Position position)
VersionedReportingTask	properties(Map<String,String> properties)
VersionedReportingTask	propertyDescriptors(Map<String,VersionedPropertyDescriptor> propertyDescriptors)
VersionedReportingTask	putPropertiesItem(String key, String propertiesItem)
VersionedReportingTask	putPropertyDescriptorsItem(String key, VersionedPropertyDescriptor propertyDescriptorsItem)
VersionedReportingTask	scheduledState(VersionedReportingTask.ScheduledStateEnum scheduledState)
VersionedReportingTask	schedulingPeriod(String schedulingPeriod)
VersionedReportingTask	schedulingStrategy(String schedulingStrategy)
void	setAnnotationData(String annotationData)
void	setBundle(Bundle bundle)
void	setComments(String comments)
void	setComponentType(VersionedReportingTask.ComponentTypeEnum componentType)
void	setGroupIdentifier(String groupIdentifier)
void	setIdentifier(String identifier)
void	setInstanceIdentifier(String instanceIdentifier)
void	setName(String name)
void	setPosition(Position position)
void	setProperties(Map<String,String> properties)
void	setPropertyDescriptors(Map<String,VersionedPropertyDescriptor> propertyDescriptors)
void	setScheduledState(VersionedReportingTask.ScheduledStateEnum scheduledState)
void	setSchedulingPeriod(String schedulingPeriod)
void	setSchedulingStrategy(String schedulingStrategy)
void	setType(String type)
private String	toIndentedString(Object o)	Convert the given object to string with each line indented by 4 spaces (except the first line).
String	toString()
VersionedReportingTask	type(String type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

identifier

private String identifier

instanceIdentifier

private String instanceIdentifier

name

private String name

comments

private String comments

position

private Position position

type

private String type

bundle

private Bundle bundle

properties

private Map<String,String> properties

propertyDescriptors

private Map<String,VersionedPropertyDescriptor> propertyDescriptors

annotationData

private String annotationData

scheduledState

private VersionedReportingTask.ScheduledStateEnum scheduledState

schedulingPeriod

private String schedulingPeriod

schedulingStrategy

private String schedulingStrategy

componentType

private VersionedReportingTask.ComponentTypeEnum componentType

groupIdentifier

private String groupIdentifier

Constructor Details

VersionedReportingTask

public VersionedReportingTask()

Method Details

identifier

public VersionedReportingTask identifier(String identifier)

getIdentifier

public String getIdentifier()

The component's unique identifier

Returns:

identifier

setIdentifier

public void setIdentifier(String identifier)

instanceIdentifier

public VersionedReportingTask instanceIdentifier(String instanceIdentifier)

getInstanceIdentifier

public String getInstanceIdentifier()

The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:

instanceIdentifier

setInstanceIdentifier

public void setInstanceIdentifier(String instanceIdentifier)

name

public VersionedReportingTask name(String name)

getName

public String getName()

The component's name

Returns:

name

setName

public void setName(String name)

comments

public VersionedReportingTask comments(String comments)

getComments

public String getComments()

The user-supplied comments for the component

Returns:

comments

setComments

public void setComments(String comments)

position

public VersionedReportingTask position(Position position)

getPosition

public Position getPosition()

Get position

Returns:

position

setPosition

public void setPosition(Position position)

type

public VersionedReportingTask type(String type)

getType

public String getType()

The type of the extension component

Returns:

type

setType

public void setType(String type)

bundle

public VersionedReportingTask bundle(Bundle bundle)

getBundle

public Bundle getBundle()

Get bundle

Returns:

bundle

setBundle

public void setBundle(Bundle bundle)

properties

public VersionedReportingTask properties(Map<String,String> properties)

putPropertiesItem

public VersionedReportingTask putPropertiesItem(String key,
 String propertiesItem)

getProperties

public Map<String,String> getProperties()

The properties for the component. Properties whose value is not set will only contain the property name.

Returns:

properties

setProperties

public void setProperties(Map<String,String> properties)

propertyDescriptors

public VersionedReportingTask propertyDescriptors(Map<String,VersionedPropertyDescriptor> propertyDescriptors)

putPropertyDescriptorsItem

public VersionedReportingTask putPropertyDescriptorsItem(String key,
 VersionedPropertyDescriptor propertyDescriptorsItem)

getPropertyDescriptors

public Map<String,VersionedPropertyDescriptor> getPropertyDescriptors()

The property descriptors for the component.

Returns:

propertyDescriptors

setPropertyDescriptors

public void setPropertyDescriptors(Map<String,VersionedPropertyDescriptor> propertyDescriptors)

annotationData

public VersionedReportingTask annotationData(String annotationData)

getAnnotationData

public String getAnnotationData()

The annotation for the reporting task. This is how the custom UI relays configuration to the reporting task.

Returns:

annotationData

setAnnotationData

public void setAnnotationData(String annotationData)

scheduledState

public VersionedReportingTask scheduledState(VersionedReportingTask.ScheduledStateEnum scheduledState)

getScheduledState

public VersionedReportingTask.ScheduledStateEnum getScheduledState()

Indicates the scheduled state for the Reporting Task

Returns:

scheduledState

setScheduledState

public void setScheduledState(VersionedReportingTask.ScheduledStateEnum scheduledState)

schedulingPeriod

public VersionedReportingTask schedulingPeriod(String schedulingPeriod)

getSchedulingPeriod

public String getSchedulingPeriod()

The frequency with which to schedule the reporting task. The format of the value will depend on the value of schedulingStrategy.

Returns:

schedulingPeriod

setSchedulingPeriod

public void setSchedulingPeriod(String schedulingPeriod)

schedulingStrategy

public VersionedReportingTask schedulingStrategy(String schedulingStrategy)

getSchedulingStrategy

public String getSchedulingStrategy()

Indicates scheduling strategy that should dictate how the reporting task is triggered.

Returns:

schedulingStrategy

setSchedulingStrategy

public void setSchedulingStrategy(String schedulingStrategy)

componentType

public VersionedReportingTask componentType(VersionedReportingTask.ComponentTypeEnum componentType)

getComponentType

public VersionedReportingTask.ComponentTypeEnum getComponentType()

Get componentType

Returns:

componentType

setComponentType

public void setComponentType(VersionedReportingTask.ComponentTypeEnum componentType)

groupIdentifier

public VersionedReportingTask groupIdentifier(String groupIdentifier)

getGroupIdentifier

public String getGroupIdentifier()

The ID of the Process Group that this component belongs to

Returns:

groupIdentifier

setGroupIdentifier

public void setGroupIdentifier(String groupIdentifier)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toIndentedString

private String toIndentedString(Object o)

Convert the given object to string with each line indented by 4 spaces (except the first line).