ProcessGroupsApi

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. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

5. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

6. def copySnippet(id: String, body: CopySnippetRequestEntity): ApiRequestT[FlowEntity]

   

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

   Expected answers: code 200 : FlowEntity (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 copy snippet request.

7. def createConnection(id: String, body: ConnectionEntity): ApiRequestT[ConnectionEntity]

   

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

   Expected answers: code 200 : ConnectionEntity (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 connection configuration details.

8. def createControllerService(id: String, body: ControllerServiceEntity): ApiRequestT[ControllerServiceEntity]

   

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

   Expected answers: code 200 : ControllerServiceEntity (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.

   body

   The controller service configuration details.

9. def createFunnel(id: String, body: FunnelEntity): ApiRequestT[FunnelEntity]

   

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

   Expected answers: code 200 : FunnelEntity (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 funnel configuration details.

10. def createInputPort(id: String, body: PortEntity): ApiRequestT[PortEntity]

    

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

    Expected answers: code 200 : PortEntity (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 input port configuration details.

11. def createLabel(id: String, body: LabelEntity): ApiRequestT[LabelEntity]

    

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

    Expected answers: code 200 : LabelEntity (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 label configuration details.

12. def createOutputPort(id: String, body: PortEntity): ApiRequestT[PortEntity]

    

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

    Expected answers: code 200 : PortEntity (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 output port configuration.

13. def createProcessGroup(id: String, body: ProcessGroupEntity): ApiRequestT[ProcessGroupEntity]

    

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

    Expected answers: code 200 : ProcessGroupEntity (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 process group configuration details.

14. def createProcessor(id: String, body: ProcessorEntity): ApiRequestT[ProcessorEntity]

    

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

    Expected answers: code 200 : ProcessorEntity (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 processor configuration details.

15. def createRemoteProcessGroup(id: String, body: RemoteProcessGroupEntity): ApiRequestT[RemoteProcessGroupEntity]

    

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

    Expected answers: code 200 : RemoteProcessGroupEntity (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 remote process group configuration details.

16. def createTemplate(id: String, body: CreateTemplateRequestEntity): ApiRequestT[TemplateEntity]

    

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

    Expected answers: code 200 : TemplateEntity (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 create template request.

17. def deleteVariableRegistryUpdateRequest(groupId: String, updateId: String, disconnectedNodeAcknowledged: Option[Boolean] = None): ApiRequestT[VariableRegistryUpdateRequestEntity]

    

    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 : VariableRegistryUpdateRequestEntity (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.)

    groupId

    The process group id.

    updateId

    The ID of the Variable Registry Update Request

    disconnectedNodeAcknowledged

    Acknowledges that this node is disconnected to allow for mutable requests to proceed.

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

    

    Definition Classes

    AnyRef

19. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

20. def exportProcessGroup(id: String): ApiRequestT[JObject]

    

    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 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.

21. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

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

    

    Definition Classes

    AnyRef → Any

23. def getConnections(id: String): ApiRequestT[ConnectionsEntity]

    

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

    Expected answers: code 200 : ConnectionsEntity (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.

24. def getFunnels(id: String): ApiRequestT[FunnelsEntity]

    

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

    Expected answers: code 200 : FunnelsEntity (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.

25. def getInputPorts(id: String): ApiRequestT[InputPortsEntity]

    

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

    Expected answers: code 200 : InputPortsEntity (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.

26. def getLabels(id: String): ApiRequestT[LabelsEntity]

    

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

    Expected answers: code 200 : LabelsEntity (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.

27. def getLocalModifications(id: String): ApiRequestT[FlowComparisonEntity]

    

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

    Expected answers: code 200 : FlowComparisonEntity (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.

28. def getOutputPorts(id: String): ApiRequestT[OutputPortsEntity]

    

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

    Expected answers: code 200 : OutputPortsEntity (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 getProcessGroup(id: String): ApiRequestT[ProcessGroupEntity]

    

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

    Expected answers: code 200 : ProcessGroupEntity (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.

30. def getProcessGroups(id: String): ApiRequestT[ProcessGroupsEntity]

    

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

    Expected answers: code 200 : ProcessGroupsEntity (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.

31. def getProcessors(id: String, includeDescendantGroups: Option[Boolean] = None): ApiRequestT[ProcessorsEntity]

    

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

    Expected answers: code 200 : ProcessorsEntity (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.

    includeDescendantGroups

    Whether or not to include processors from descendant process groups

32. def getRemoteProcessGroups(id: String): ApiRequestT[RemoteProcessGroupsEntity]

    

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

    Expected answers: code 200 : RemoteProcessGroupsEntity (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.

33. def getVariableRegistry(id: String, includeAncestorGroups: Option[Boolean] = None): ApiRequestT[VariableRegistryEntity]

    

    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 : VariableRegistryEntity (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.

    includeAncestorGroups

    Whether or not to include ancestor groups

34. def getVariableRegistryUpdateRequest(groupId: String, updateId: String): ApiRequestT[VariableRegistryUpdateRequestEntity]

    

    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 : VariableRegistryUpdateRequestEntity (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.)

    groupId

    The process group id.

    updateId

    The ID of the Variable Registry Update Request

35. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

36. def importTemplate(id: String): ApiRequestT[TemplateEntity]

    

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

    Expected answers: code 200 : TemplateEntity (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.

37. def instantiateTemplate(id: String, body: InstantiateTemplateRequestEntity): ApiRequestT[FlowEntity]

    

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

    Expected answers: code 200 : FlowEntity (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 instantiate template request.

38. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

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

    

    Definition Classes

    AnyRef

40. final def notify(): Unit

    

    Definition Classes

    AnyRef

41. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

42. def removeProcessGroup(id: String, version: Option[String] = None, clientId: Option[String] = None, disconnectedNodeAcknowledged: Option[Boolean] = None): ApiRequestT[ProcessGroupEntity]

    

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

    Expected answers: code 200 : ProcessGroupEntity (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.

    version

    The revision is used to verify the client is working with the latest version of the flow.

    clientId

    If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

    disconnectedNodeAcknowledged

    Acknowledges that this node is disconnected to allow for mutable requests to proceed.

43. def submitUpdateVariableRegistryRequest(id: String, body: VariableRegistryEntity): ApiRequestT[VariableRegistryUpdateRequestEntity]

    

    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 : VariableRegistryUpdateRequestEntity (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 variable registry configuration details.

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

    

    Definition Classes

    AnyRef

45. def toString(): String

    

    Definition Classes

    AnyRef → Any

46. def updateProcessGroup(id: String, body: ProcessGroupEntity): ApiRequestT[ProcessGroupEntity]

    

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

    Expected answers: code 200 : ProcessGroupEntity (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 process group configuration details.

47. def updateVariableRegistry(id: String, body: VariableRegistryEntity): ApiRequestT[VariableRegistryEntity]

    

    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 : VariableRegistryEntity (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 variable registry configuration details.

48. def uploadTemplate(id: String, template: File): ApiRequestT[TemplateEntity]

    

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

    Expected answers: code 200 : TemplateEntity (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.

    template

    The binary content of the template file being uploaded.

49. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )