Class ReportingTaskDefinition
java.lang.Object
org.apache.nifi.api.toolkit.model.ReportingTaskDefinition
@Generated(value="io.swagger.codegen.v3.generators.java.JavaClientCodegen",
date="2023-11-22T19:25:26.907436939-06:00[America/Chicago]")
public class ReportingTaskDefinition
extends Object
ReportingTaskDefinition
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Boolean
private String
private BuildInfo
private String
private Boolean
private String
private List
<DynamicProperty> private List
<Restriction> private String
private Map
<String, PropertyDescriptor> private List
<DefinedType> private Boolean
private String
private Stateful
private Boolean
private Boolean
private List
<SystemResourceConsideration> private String
private String
private String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddDeprecationAlternativesItem
(String deprecationAlternativesItem) addDynamicPropertiesItem
(DynamicProperty dynamicPropertiesItem) addExplicitRestrictionsItem
(Restriction explicitRestrictionsItem) additionalDetails
(Boolean additionalDetails) addProvidedApiImplementationsItem
(DefinedType providedApiImplementationsItem) addSeeAlsoItem
(String seeAlsoItem) addSupportedSchedulingStrategiesItem
(String supportedSchedulingStrategiesItem) addSystemResourceConsiderationsItem
(SystemResourceConsideration systemResourceConsiderationsItem) addTagsItem
(String tagsItem) defaultSchedulingPeriodBySchedulingStrategy
(Map<String, String> defaultSchedulingPeriodBySchedulingStrategy) defaultSchedulingStrategy
(String defaultSchedulingStrategy) deprecated
(Boolean deprecated) deprecationAlternatives
(List<String> deprecationAlternatives) deprecationReason
(String deprecationReason) dynamicProperties
(List<DynamicProperty> dynamicProperties) boolean
explicitRestrictions
(List<Restriction> explicitRestrictions) The artifact name of the bundle that provides the referenced type.Get buildInfoThe default scheduling period for each scheduling strategy.The default scheduling strategy for the reporting task.If this component has been deprecated, this optional field provides alternatives to useIf this component has been deprecated, this optional field can be used to provide an explanationDescribes the dynamic properties supported by this componentExplicit restrictions that indicate a require permission to use the componentgetGroup()
The group name of the bundle that provides the referenced type.Descriptions of configuration properties applicable to this component.If this type represents a provider for an interface, this lists the APIs it implementsAn optional description of the general restrictionThe names of other component types that may be relatedGet statefulThe supported scheduling strategies, such as TIME_DRIVER or CRON.The system resource considerations for the given componentgetTags()
The tags associated with this typegetType()
The fully-qualified class typeThe description of the type.The version of the bundle that provides the referenced type.int
hashCode()
Indicates if the component has additional details documentationWhether or not the component has been deprecatedWhether or not the component has a general restrictionWhether or not this component makes use of dynamic (user-set) properties.Whether or not this component makes use of sensitive dynamic (user-set) properties.propertyDescriptors
(Map<String, PropertyDescriptor> propertyDescriptors) providedApiImplementations
(List<DefinedType> providedApiImplementations) putDefaultSchedulingPeriodBySchedulingStrategyItem
(String key, String defaultSchedulingPeriodBySchedulingStrategyItem) putPropertyDescriptorsItem
(String key, PropertyDescriptor propertyDescriptorsItem) restricted
(Boolean restricted) restrictedExplanation
(String restrictedExplanation) void
setAdditionalDetails
(Boolean additionalDetails) void
setArtifact
(String artifact) void
setBuildInfo
(BuildInfo buildInfo) void
setDefaultSchedulingPeriodBySchedulingStrategy
(Map<String, String> defaultSchedulingPeriodBySchedulingStrategy) void
setDefaultSchedulingStrategy
(String defaultSchedulingStrategy) void
setDeprecated
(Boolean deprecated) void
setDeprecationAlternatives
(List<String> deprecationAlternatives) void
setDeprecationReason
(String deprecationReason) void
setDynamicProperties
(List<DynamicProperty> dynamicProperties) void
setExplicitRestrictions
(List<Restriction> explicitRestrictions) void
void
setPropertyDescriptors
(Map<String, PropertyDescriptor> propertyDescriptors) void
setProvidedApiImplementations
(List<DefinedType> providedApiImplementations) void
setRestricted
(Boolean restricted) void
setRestrictedExplanation
(String restrictedExplanation) void
setSeeAlso
(List<String> seeAlso) void
setStateful
(Stateful stateful) void
setSupportedSchedulingStrategies
(List<String> supportedSchedulingStrategies) void
setSupportsDynamicProperties
(Boolean supportsDynamicProperties) void
setSupportsSensitiveDynamicProperties
(Boolean supportsSensitiveDynamicProperties) void
setSystemResourceConsiderations
(List<SystemResourceConsideration> systemResourceConsiderations) void
void
void
setTypeDescription
(String typeDescription) void
setVersion
(String version) supportedSchedulingStrategies
(List<String> supportedSchedulingStrategies) supportsDynamicProperties
(Boolean supportsDynamicProperties) supportsSensitiveDynamicProperties
(Boolean supportsSensitiveDynamicProperties) systemResourceConsiderations
(List<SystemResourceConsideration> systemResourceConsiderations) private String
Convert the given object to string with each line indented by 4 spaces (except the first line).toString()
typeDescription
(String typeDescription)
-
Field Details
-
group
-
artifact
-
version
-
type
-
typeDescription
-
buildInfo
-
providedApiImplementations
-
tags
-
seeAlso
-
deprecated
-
deprecationReason
-
deprecationAlternatives
-
restricted
-
restrictedExplanation
-
explicitRestrictions
-
stateful
-
systemResourceConsiderations
-
additionalDetails
-
propertyDescriptors
-
supportsDynamicProperties
-
supportsSensitiveDynamicProperties
-
dynamicProperties
-
supportedSchedulingStrategies
-
defaultSchedulingStrategy
-
defaultSchedulingPeriodBySchedulingStrategy
-
-
Constructor Details
-
ReportingTaskDefinition
public ReportingTaskDefinition()
-
-
Method Details
-
group
-
getGroup
The group name of the bundle that provides the referenced type.- Returns:
- group
-
setGroup
-
artifact
-
getArtifact
The artifact name of the bundle that provides the referenced type.- Returns:
- artifact
-
setArtifact
-
version
-
getVersion
The version of the bundle that provides the referenced type.- Returns:
- version
-
setVersion
-
type
-
getType
The fully-qualified class type- Returns:
- type
-
setType
-
typeDescription
-
getTypeDescription
The description of the type.- Returns:
- typeDescription
-
setTypeDescription
-
buildInfo
-
getBuildInfo
Get buildInfo- Returns:
- buildInfo
-
setBuildInfo
-
providedApiImplementations
public ReportingTaskDefinition providedApiImplementations(List<DefinedType> providedApiImplementations) -
addProvidedApiImplementationsItem
public ReportingTaskDefinition addProvidedApiImplementationsItem(DefinedType providedApiImplementationsItem) -
getProvidedApiImplementations
If this type represents a provider for an interface, this lists the APIs it implements- Returns:
- providedApiImplementations
-
setProvidedApiImplementations
-
tags
-
addTagsItem
-
getTags
The tags associated with this type- Returns:
- tags
-
setTags
-
seeAlso
-
addSeeAlsoItem
-
getSeeAlso
The names of other component types that may be related- Returns:
- seeAlso
-
setSeeAlso
-
deprecated
-
isDeprecated
Whether or not the component has been deprecated- Returns:
- deprecated
-
setDeprecated
-
deprecationReason
-
getDeprecationReason
If this component has been deprecated, this optional field can be used to provide an explanation- Returns:
- deprecationReason
-
setDeprecationReason
-
deprecationAlternatives
-
addDeprecationAlternativesItem
-
getDeprecationAlternatives
If this component has been deprecated, this optional field provides alternatives to use- Returns:
- deprecationAlternatives
-
setDeprecationAlternatives
-
restricted
-
isRestricted
Whether or not the component has a general restriction- Returns:
- restricted
-
setRestricted
-
restrictedExplanation
-
getRestrictedExplanation
An optional description of the general restriction- Returns:
- restrictedExplanation
-
setRestrictedExplanation
-
explicitRestrictions
-
addExplicitRestrictionsItem
-
getExplicitRestrictions
Explicit restrictions that indicate a require permission to use the component- Returns:
- explicitRestrictions
-
setExplicitRestrictions
-
stateful
-
getStateful
Get stateful- Returns:
- stateful
-
setStateful
-
systemResourceConsiderations
public ReportingTaskDefinition systemResourceConsiderations(List<SystemResourceConsideration> systemResourceConsiderations) -
addSystemResourceConsiderationsItem
public ReportingTaskDefinition addSystemResourceConsiderationsItem(SystemResourceConsideration systemResourceConsiderationsItem) -
getSystemResourceConsiderations
The system resource considerations for the given component- Returns:
- systemResourceConsiderations
-
setSystemResourceConsiderations
public void setSystemResourceConsiderations(List<SystemResourceConsideration> systemResourceConsiderations) -
additionalDetails
-
isAdditionalDetails
Indicates if the component has additional details documentation- Returns:
- additionalDetails
-
setAdditionalDetails
-
propertyDescriptors
public ReportingTaskDefinition propertyDescriptors(Map<String, PropertyDescriptor> propertyDescriptors) -
putPropertyDescriptorsItem
public ReportingTaskDefinition putPropertyDescriptorsItem(String key, PropertyDescriptor propertyDescriptorsItem) -
getPropertyDescriptors
Descriptions of configuration properties applicable to this component.- Returns:
- propertyDescriptors
-
setPropertyDescriptors
-
supportsDynamicProperties
-
isSupportsDynamicProperties
Whether or not this component makes use of dynamic (user-set) properties.- Returns:
- supportsDynamicProperties
-
setSupportsDynamicProperties
-
supportsSensitiveDynamicProperties
public ReportingTaskDefinition supportsSensitiveDynamicProperties(Boolean supportsSensitiveDynamicProperties) -
isSupportsSensitiveDynamicProperties
Whether or not this component makes use of sensitive dynamic (user-set) properties.- Returns:
- supportsSensitiveDynamicProperties
-
setSupportsSensitiveDynamicProperties
-
dynamicProperties
-
addDynamicPropertiesItem
-
getDynamicProperties
Describes the dynamic properties supported by this component- Returns:
- dynamicProperties
-
setDynamicProperties
-
supportedSchedulingStrategies
public ReportingTaskDefinition supportedSchedulingStrategies(List<String> supportedSchedulingStrategies) -
addSupportedSchedulingStrategiesItem
public ReportingTaskDefinition addSupportedSchedulingStrategiesItem(String supportedSchedulingStrategiesItem) -
getSupportedSchedulingStrategies
The supported scheduling strategies, such as TIME_DRIVER or CRON.- Returns:
- supportedSchedulingStrategies
-
setSupportedSchedulingStrategies
-
defaultSchedulingStrategy
-
getDefaultSchedulingStrategy
The default scheduling strategy for the reporting task.- Returns:
- defaultSchedulingStrategy
-
setDefaultSchedulingStrategy
-
defaultSchedulingPeriodBySchedulingStrategy
public ReportingTaskDefinition defaultSchedulingPeriodBySchedulingStrategy(Map<String, String> defaultSchedulingPeriodBySchedulingStrategy) -
putDefaultSchedulingPeriodBySchedulingStrategyItem
public ReportingTaskDefinition putDefaultSchedulingPeriodBySchedulingStrategyItem(String key, String defaultSchedulingPeriodBySchedulingStrategyItem) -
getDefaultSchedulingPeriodBySchedulingStrategy
The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\".- Returns:
- defaultSchedulingPeriodBySchedulingStrategy
-
setDefaultSchedulingPeriodBySchedulingStrategy
-
equals
-
hashCode
public int hashCode() -
toString
-
toIndentedString
Convert the given object to string with each line indented by 4 spaces (except the first line).
-