ControllerApi

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 createBulletin(body: BulletinEntity): ApiRequestT[BulletinEntity]

   

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

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

   body

   The reporting task configuration details.

7. def createControllerService(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.)

   body

   The controller service configuration details.

8. def createRegistryClient(body: RegistryClientEntity): ApiRequestT[RegistryClientEntity]

   

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

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

   body

   The registry configuration details.

9. def createReportingTask(body: ReportingTaskEntity): ApiRequestT[ReportingTaskEntity]

   

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

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

   body

   The reporting task configuration details.

10. def deleteHistory(endDate: String): ApiRequestT[HistoryEntity]

    

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

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

    endDate

    Purge actions before this date/time.

11. def deleteNode(id: String): ApiRequestT[NodeEntity]

    

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

    Expected answers: code 200 : NodeEntity (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 node id.

12. def deleteRegistryClient(id: String, version: Option[String] = None, clientId: Option[String] = None, disconnectedNodeAcknowledged: Option[Boolean] = None): ApiRequestT[RegistryClientEntity]

    

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

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

    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.

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

    

    Definition Classes

    AnyRef

14. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

15. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

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

    

    Definition Classes

    AnyRef → Any

17. def getCluster(): ApiRequestT[ClusterEntity]

    

    Returns the contents of the cluster including all nodes and their status.

    Returns the contents of the cluster including all nodes and their status.

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

18. def getControllerConfig(): ApiRequestT[ControllerConfigurationEntity]

    

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

    Expected answers: code 200 : ControllerConfigurationEntity (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 getNode(id: String): ApiRequestT[NodeEntity]

    

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

    Expected answers: code 200 : NodeEntity (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 node id.

20. def getRegistryClient(id: String): ApiRequestT[RegistryClientEntity]

    

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

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

21. def getRegistryClients(): 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.)

22. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

23. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

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

    

    Definition Classes

    AnyRef

25. final def notify(): Unit

    

    Definition Classes

    AnyRef

26. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

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

    

    Definition Classes

    AnyRef

28. def toString(): String

    

    Definition Classes

    AnyRef → Any

29. def updateControllerConfig(body: ControllerConfigurationEntity): ApiRequestT[ControllerConfigurationEntity]

    

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

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

    body

    The controller configuration.

30. def updateNode(id: String, body: NodeEntity): ApiRequestT[NodeEntity]

    

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

    Expected answers: code 200 : NodeEntity (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 node id.

    body

    The node configuration. The only configuration that will be honored at this endpoint is the status.

31. def updateRegistryClient(id: String, body: RegistryClientEntity): ApiRequestT[RegistryClientEntity]

    

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

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

    body

    The registry configuration details.

32. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )