FlowApi

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. def activateControllerServices(id: String, body: ActivateControllerServicesEntity): ApiRequestT[ActivateControllerServicesEntity]

   

   Expected answers: code 200 : ActivateControllerServicesEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

   Expected answers: code 200 : ActivateControllerServicesEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

   id

   The process group id.

   body

   The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.

5. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

6. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

7. final def eq(arg0: AnyRef): Boolean

   

   Definition Classes

   AnyRef

8. def equals(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

9. def finalize(): Unit

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( classOf[java.lang.Throwable] )

10. def generateClientId(): ApiRequestT[String]

    

    Expected answers: code 200 : String (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : String (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

11. def getAboutInfo(): ApiRequestT[AboutEntity]

    

    Expected answers: code 200 : AboutEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : AboutEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

12. def getAction(id: String): ApiRequestT[ActionEntity]

    

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Expected answers: code 200 : ActionEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The action id.

13. def getBanners(): ApiRequestT[BannerEntity]

    

    Expected answers: code 200 : BannerEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : BannerEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

14. def getBuckets(id: String): ApiRequestT[BucketsEntity]

    

    Expected answers: code 200 : BucketsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : BucketsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The registry id.

15. def getBulletinBoard(after: Option[String] = None, sourceName: Option[String] = None, message: Option[String] = None, sourceId: Option[String] = None, groupId: Option[String] = None, limit: Option[String] = None): ApiRequestT[BulletinBoardEntity]

    

    Expected answers: code 200 : BulletinBoardEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : BulletinBoardEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    after

    Includes bulletins with an id after this value.

    sourceName

    Includes bulletins originating from this sources whose name match this regular expression.

    message

    Includes bulletins whose message that match this regular expression.

    sourceId

    Includes bulletins originating from this sources whose id match this regular expression.

    groupId

    Includes bulletins originating from this sources whose group id match this regular expression.

    limit

    The number of bulletins to limit the response to.

16. def getBulletins(): ApiRequestT[ControllerBulletinsEntity]

    

    Expected answers: code 200 : ControllerBulletinsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : ControllerBulletinsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

17. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

18. def getClusterSummary(): ApiRequestT[ClusteSummaryEntity]

    

    Expected answers: code 200 : ClusteSummaryEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : ClusteSummaryEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

19. def getComponentHistory(componentId: String): ApiRequestT[ComponentHistoryEntity]

    

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Expected answers: code 200 : ComponentHistoryEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    componentId

    The component id.

20. def getConnectionStatistics(id: String, nodewise: Option[Boolean] = None, clusterNodeId: Option[String] = None): ApiRequestT[ConnectionStatisticsEntity]

    

    Expected answers: code 200 : ConnectionStatisticsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : ConnectionStatisticsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The connection id.

    nodewise

    Whether or not to include the breakdown per node. Optional, defaults to false

    clusterNodeId

    The id of the node where to get the statistics.

21. def getConnectionStatus(id: String, nodewise: Option[Boolean] = None, clusterNodeId: Option[String] = None): ApiRequestT[ConnectionStatusEntity]

    

    Expected answers: code 200 : ConnectionStatusEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : ConnectionStatusEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The connection id.

    nodewise

    Whether or not to include the breakdown per node. Optional, defaults to false

    clusterNodeId

    The id of the node where to get the status.

22. def getConnectionStatusHistory(id: String): ApiRequestT[StatusHistoryEntity]

    

    Expected answers: code 200 : StatusHistoryEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : StatusHistoryEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The connection id.

23. def getControllerServiceTypes(serviceType: Option[String] = None, serviceBundleGroup: Option[String] = None, serviceBundleArtifact: Option[String] = None, serviceBundleVersion: Option[String] = None, bundleGroupFilter: Option[String] = None, bundleArtifactFilter: Option[String] = None, typeFilter: Option[String] = None): ApiRequestT[ControllerServiceTypesEntity]

    

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Expected answers: code 200 : ControllerServiceTypesEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    serviceType

    If specified, will only return controller services that are compatible with this type of service.

    serviceBundleGroup

    If serviceType specified, is the bundle group of the serviceType.

    serviceBundleArtifact

    If serviceType specified, is the bundle artifact of the serviceType.

    serviceBundleVersion

    If serviceType specified, is the bundle version of the serviceType.

    bundleGroupFilter

    If specified, will only return types that are a member of this bundle group.

    bundleArtifactFilter

    If specified, will only return types that are a member of this bundle artifact.

    typeFilter

    If specified, will only return types whose fully qualified classname matches.

24. def getControllerServicesFromController(): ApiRequestT[ControllerServicesEntity]

    

    Expected answers: code 200 : ControllerServicesEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : ControllerServicesEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

25. def getControllerServicesFromGroup(id: String, includeAncestorGroups: Option[Boolean] = None, includeDescendantGroups: Option[Boolean] = None): ApiRequestT[ControllerServicesEntity]

    

    Expected answers: code 200 : ControllerServicesEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : ControllerServicesEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The process group id.

    includeAncestorGroups

    Whether or not to include parent/ancestory process groups

    includeDescendantGroups

    Whether or not to include descendant process groups

26. def getControllerStatus(): ApiRequestT[ControllerStatusEntity]

    

    Expected answers: code 200 : ControllerStatusEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : ControllerStatusEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

27. def getCurrentUser(): ApiRequestT[CurrentUserEntity]

    

    Expected answers: code 200 : CurrentUserEntity (successful operation)

28. def getFlow(id: String): ApiRequestT[ProcessGroupFlowEntity]

    

    Expected answers: code 200 : ProcessGroupFlowEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : ProcessGroupFlowEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The process group id.

29. def getFlowConfig(): ApiRequestT[FlowConfigurationEntity]

    

    Expected answers: code 200 : FlowConfigurationEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : FlowConfigurationEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

30. def getFlows(registryId: String, bucketId: String): ApiRequestT[VersionedFlowsEntity]

    

    Expected answers: code 200 : VersionedFlowsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : VersionedFlowsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    registryId

    The registry id.

    bucketId

    The bucket id.

31. def getInputPortStatus(id: String, nodewise: Option[Boolean] = None, clusterNodeId: Option[String] = None): ApiRequestT[PortStatusEntity]

    

    Expected answers: code 200 : PortStatusEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : PortStatusEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The input port id.

    nodewise

    Whether or not to include the breakdown per node. Optional, defaults to false

    clusterNodeId

    The id of the node where to get the status.

32. def getOutputPortStatus(id: String, nodewise: Option[Boolean] = None, clusterNodeId: Option[String] = None): ApiRequestT[PortStatusEntity]

    

    Expected answers: code 200 : PortStatusEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : PortStatusEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The output port id.

    nodewise

    Whether or not to include the breakdown per node. Optional, defaults to false

    clusterNodeId

    The id of the node where to get the status.

33. def getParameterContexts(): ApiRequestT[ParameterContextsEntity]

    

    Expected answers: code 200 : ParameterContextsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : ParameterContextsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

34. def getPrioritizers(): ApiRequestT[PrioritizerTypesEntity]

    

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Expected answers: code 200 : PrioritizerTypesEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

35. def getProcessGroupStatus(id: String, recursive: Option[Boolean] = None, nodewise: Option[Boolean] = None, clusterNodeId: Option[String] = None): ApiRequestT[ProcessGroupStatusEntity]

    

    The status for a process group includes status for all descendent components.

    The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.

    Expected answers: code 200 : ProcessGroupStatusEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The process group id.

    recursive

    Whether all descendant groups and the status of their content will be included. Optional, defaults to false

    nodewise

    Whether or not to include the breakdown per node. Optional, defaults to false

    clusterNodeId

    The id of the node where to get the status.

36. def getProcessGroupStatusHistory(id: String): ApiRequestT[StatusHistoryEntity]

    

    Expected answers: code 200 : StatusHistoryEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : StatusHistoryEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The process group id.

37. def getProcessorStatus(id: String, nodewise: Option[Boolean] = None, clusterNodeId: Option[String] = None): ApiRequestT[ProcessorStatusEntity]

    

    Expected answers: code 200 : ProcessorStatusEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : ProcessorStatusEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The processor id.

    nodewise

    Whether or not to include the breakdown per node. Optional, defaults to false

    clusterNodeId

    The id of the node where to get the status.

38. def getProcessorStatusHistory(id: String): ApiRequestT[StatusHistoryEntity]

    

    Expected answers: code 200 : StatusHistoryEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : StatusHistoryEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The processor id.

39. def getProcessorTypes(bundleGroupFilter: Option[String] = None, bundleArtifactFilter: Option[String] = None, tpe: Option[String] = None): ApiRequestT[ProcessorTypesEntity]

    

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Expected answers: code 200 : ProcessorTypesEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    bundleGroupFilter

    If specified, will only return types that are a member of this bundle group.

    bundleArtifactFilter

    If specified, will only return types that are a member of this bundle artifact.

40. def getRegistries(): ApiRequestT[RegistryClientsEntity]

    

    Expected answers: code 200 : RegistryClientsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : RegistryClientsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

41. def getRemoteProcessGroupStatus(id: String, nodewise: Option[Boolean] = None, clusterNodeId: Option[String] = None): ApiRequestT[RemoteProcessGroupStatusEntity]

    

    Expected answers: code 200 : RemoteProcessGroupStatusEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : RemoteProcessGroupStatusEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The remote process group id.

    nodewise

    Whether or not to include the breakdown per node. Optional, defaults to false

    clusterNodeId

    The id of the node where to get the status.

42. def getRemoteProcessGroupStatusHistory(id: String): ApiRequestT[StatusHistoryEntity]

    

    Expected answers: code 200 : StatusHistoryEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : StatusHistoryEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The remote process group id.

43. def getReportingTaskTypes(bundleGroupFilter: Option[String] = None, bundleArtifactFilter: Option[String] = None, tpe: Option[String] = None): ApiRequestT[ReportingTaskTypesEntity]

    

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Expected answers: code 200 : ReportingTaskTypesEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    bundleGroupFilter

    If specified, will only return types that are a member of this bundle group.

    bundleArtifactFilter

    If specified, will only return types that are a member of this bundle artifact.

44. def getReportingTasks(): ApiRequestT[ReportingTasksEntity]

    

    Expected answers: code 200 : ReportingTasksEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : ReportingTasksEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

45. def getTemplates(): ApiRequestT[TemplatesEntity]

    

    Expected answers: code 200 : TemplatesEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : TemplatesEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

46. def getVersions(registryId: String, bucketId: String, flowId: String): ApiRequestT[VersionedFlowSnapshotMetadataSetEntity]

    

    Expected answers: code 200 : VersionedFlowSnapshotMetadataSetEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : VersionedFlowSnapshotMetadataSetEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    registryId

    The registry id.

    bucketId

    The bucket id.

    flowId

    The flow id.

47. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

48. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

49. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

50. final def notify(): Unit

    

    Definition Classes

    AnyRef

51. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

52. def queryHistory(offset: String, count: String, sortColumn: Option[String] = None, sortOrder: Option[String] = None, startDate: Option[String] = None, endDate: Option[String] = None, userIdentity: Option[String] = None, sourceId: Option[String] = None): ApiRequestT[HistoryEntity]

    

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Expected answers: code 200 : HistoryEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    offset

    The offset into the result set.

    count

    The number of actions to return.

    sortColumn

    The field to sort on.

    sortOrder

    The direction to sort.

    startDate

    Include actions after this date.

    endDate

    Include actions before this date.

    userIdentity

    Include actions performed by this user.

    sourceId

    Include actions on this component.

53. def scheduleComponents(id: String, body: ScheduleComponentsEntity): ApiRequestT[ScheduleComponentsEntity]

    

    Expected answers: code 200 : ScheduleComponentsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : ScheduleComponentsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The process group id.

    body

    The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.

54. def searchCluster(q: String): ApiRequestT[ClusterSearchResultsEntity]

    

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Note: This endpoint is subject to change as NiFi and it's REST API evolve.

    Expected answers: code 200 : ClusterSearchResultsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

55. def searchFlow(q: Option[String] = None): ApiRequestT[SearchResultsEntity]

    

    Only search results from authorized components will be returned.

    Only search results from authorized components will be returned.

    Expected answers: code 200 : SearchResultsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

56. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

57. def toString(): String

    

    Definition Classes

    AnyRef → Any

58. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

59. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

60. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )