Package org.apache.nifi.toolkit.client

Interface ControllerServicesClient

All Known Implementing Classes:

JerseyControllerServicesClient

public interface ControllerServicesClient

Client for interacting with NiFi's Controller Services Resource.

Method Summary

Modifier and Type	Method	Description
ControllerServiceEntity	activateControllerService(String id, ControllerServiceRunStatusEntity runStatusEntity)
ControllerServiceEntity	createControllerService(String parentGroupdId, ControllerServiceEntity controllerServiceEntity)
VerifyConfigRequestEntity	deleteConfigVerificationRequest(String serviceId, String verificationRequestId)
ControllerServiceEntity	deleteControllerService(ControllerServiceEntity controllerServiceEntity)
VerifyConfigRequestEntity	getConfigVerificationRequest(String serviceId, String verificationRequestId)
ControllerServiceEntity	getControllerService(String id)
ControllerServiceReferencingComponentsEntity	getControllerServiceReferences(String id)
PropertyDescriptorEntity	getPropertyDescriptor(String serviceId, String propertyName, Boolean sensitive)
VerifyConfigRequestEntity	submitConfigVerificationRequest(VerifyConfigRequestEntity configRequestEntity)
ControllerServiceEntity	updateControllerService(ControllerServiceEntity controllerServiceEntity)
ControllerServiceReferencingComponentsEntity	updateControllerServiceReferences(UpdateControllerServiceReferenceRequestEntity referencesEntity)

Method Details

getControllerService

ControllerServiceEntity getControllerService(String id)
                                      throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

activateControllerService

ControllerServiceEntity activateControllerService(String id,
 ControllerServiceRunStatusEntity runStatusEntity)
                                           throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

createControllerService

ControllerServiceEntity createControllerService(String parentGroupdId,
 ControllerServiceEntity controllerServiceEntity)
                                         throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

updateControllerService

ControllerServiceEntity updateControllerService(ControllerServiceEntity controllerServiceEntity)
                                         throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

deleteControllerService

ControllerServiceEntity deleteControllerService(ControllerServiceEntity controllerServiceEntity)
                                         throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

getControllerServiceReferences

ControllerServiceReferencingComponentsEntity getControllerServiceReferences(String id)
                                                                     throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

updateControllerServiceReferences

ControllerServiceReferencingComponentsEntity updateControllerServiceReferences(UpdateControllerServiceReferenceRequestEntity referencesEntity)
                                                                        throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

submitConfigVerificationRequest

VerifyConfigRequestEntity submitConfigVerificationRequest(VerifyConfigRequestEntity configRequestEntity)
                                                   throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

getConfigVerificationRequest

VerifyConfigRequestEntity getConfigVerificationRequest(String serviceId,
 String verificationRequestId)
                                                throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

deleteConfigVerificationRequest

VerifyConfigRequestEntity deleteConfigVerificationRequest(String serviceId,
 String verificationRequestId)
                                                   throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException

getPropertyDescriptor

PropertyDescriptorEntity getPropertyDescriptor(String serviceId,
 String propertyName,
 Boolean sensitive)
                                        throws NiFiClientException,
IOException

Throws:

NiFiClientException

IOException