ControllerservicesApi

All URIs are relative to http://localhost/nifi-api

Method	HTTP request	Description
analyzeConfiguration	POST /controller-services/{id}/config/analysis	Performs analysis of the component's configuration, providing information about which attributes are referenced.
clearState	POST /controller-services/{id}/state/clear-requests	Clears the state for a controller service
deleteVerificationRequest	DELETE /controller-services/{id}/config/verification-requests/{requestId}	Deletes the Verification Request with the given ID
getControllerService	GET /controller-services/{id}	Gets a controller service
getControllerServiceReferences	GET /controller-services/{id}/references	Gets a controller service
getPropertyDescriptor	GET /controller-services/{id}/descriptors	Gets a controller service property descriptor
getState	GET /controller-services/{id}/state	Gets the state for a controller service
getVerificationRequest	GET /controller-services/{id}/config/verification-requests/{requestId}	Returns the Verification Request with the given ID
removeControllerService	DELETE /controller-services/{id}	Deletes a controller service
submitConfigVerificationRequest	POST /controller-services/{id}/config/verification-requests	Performs verification of the Controller Service's configuration
updateControllerService	PUT /controller-services/{id}	Updates a controller service
updateControllerServiceReferences	PUT /controller-services/{id}/references	Updates a controller services references
updateRunStatus	PUT /controller-services/{id}/run-status	Updates run status of a controller service

analyzeConfiguration

ConfigurationAnalysisEntity analyzeConfiguration(id, body)

Performs analysis of the component's configuration, providing information about which attributes are referenced.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerservicesApi;


ControllerservicesApi apiInstance = new ControllerservicesApi();
String id = "id_example"; // String | The controller service id.
ConfigurationAnalysisEntity body = new ConfigurationAnalysisEntity(); // ConfigurationAnalysisEntity | The configuration analysis request.
try {
    ConfigurationAnalysisEntity result = apiInstance.analyzeConfiguration(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerservicesApi#analyzeConfiguration");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.
body	ConfigurationAnalysisEntity	The configuration analysis request.

Return type

ConfigurationAnalysisEntity

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

clearState

ComponentStateEntity clearState(id)

Clears the state for a controller service

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerservicesApi;


ControllerservicesApi apiInstance = new ControllerservicesApi();
String id = "id_example"; // String | The controller service id.
try {
    ComponentStateEntity result = apiInstance.clearState(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerservicesApi#clearState");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.

Return type

ComponentStateEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

deleteVerificationRequest

VerifyConfigRequestEntity deleteVerificationRequest(id, requestId)

Deletes the Verification Request with the given ID

Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerservicesApi;


ControllerservicesApi apiInstance = new ControllerservicesApi();
String id = "id_example"; // String | The ID of the Controller Service
String requestId = "requestId_example"; // String | The ID of the Verification Request
try {
    VerifyConfigRequestEntity result = apiInstance.deleteVerificationRequest(id, requestId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerservicesApi#deleteVerificationRequest");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The ID of the Controller Service
requestId	String	The ID of the Verification Request

Return type

VerifyConfigRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getControllerService

ControllerServiceEntity getControllerService(id, uiOnly)

Gets a controller service

If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerservicesApi;


ControllerservicesApi apiInstance = new ControllerservicesApi();
String id = "id_example"; // String | The controller service id.
Boolean uiOnly = false; // Boolean | 
try {
    ControllerServiceEntity result = apiInstance.getControllerService(id, uiOnly);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerservicesApi#getControllerService");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.
uiOnly	Boolean		[optional] [default to false]

Return type

ControllerServiceEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getControllerServiceReferences

ControllerServiceReferencingComponentsEntity getControllerServiceReferences(id)

Gets a controller service

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerservicesApi;


ControllerservicesApi apiInstance = new ControllerservicesApi();
String id = "id_example"; // String | The controller service id.
try {
    ControllerServiceReferencingComponentsEntity result = apiInstance.getControllerServiceReferences(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerservicesApi#getControllerServiceReferences");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.

Return type

ControllerServiceReferencingComponentsEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getPropertyDescriptor

PropertyDescriptorEntity getPropertyDescriptor(id, propertyName, sensitive)

Gets a controller service property descriptor

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerservicesApi;


ControllerservicesApi apiInstance = new ControllerservicesApi();
String id = "id_example"; // String | The controller service id.
String propertyName = "propertyName_example"; // String | The property name to return the descriptor for.
Boolean sensitive = false; // Boolean | Property Descriptor requested sensitive status
try {
    PropertyDescriptorEntity result = apiInstance.getPropertyDescriptor(id, propertyName, sensitive);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerservicesApi#getPropertyDescriptor");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.
propertyName	String	The property name to return the descriptor for.
sensitive	Boolean	Property Descriptor requested sensitive status	[optional] [default to false]

Return type

PropertyDescriptorEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getState

ComponentStateEntity getState(id)

Gets the state for a controller service

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerservicesApi;


ControllerservicesApi apiInstance = new ControllerservicesApi();
String id = "id_example"; // String | The controller service id.
try {
    ComponentStateEntity result = apiInstance.getState(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerservicesApi#getState");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.

Return type

ComponentStateEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getVerificationRequest

VerifyConfigRequestEntity getVerificationRequest(id, requestId)

Returns the Verification Request with the given ID

Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerservicesApi;


ControllerservicesApi apiInstance = new ControllerservicesApi();
String id = "id_example"; // String | The ID of the Controller Service
String requestId = "requestId_example"; // String | The ID of the Verification Request
try {
    VerifyConfigRequestEntity result = apiInstance.getVerificationRequest(id, requestId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerservicesApi#getVerificationRequest");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The ID of the Controller Service
requestId	String	The ID of the Verification Request

Return type

VerifyConfigRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

removeControllerService

ControllerServiceEntity removeControllerService(id, version, clientId, disconnectedNodeAcknowledged)

Deletes a controller service

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerservicesApi;


ControllerservicesApi apiInstance = new ControllerservicesApi();
String id = "id_example"; // String | The controller service id.
String version = "version_example"; // String | The revision is used to verify the client is working with the latest version of the flow.
String clientId = "clientId_example"; // String | If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
Boolean disconnectedNodeAcknowledged = false; // Boolean | Acknowledges that this node is disconnected to allow for mutable requests to proceed.
try {
    ControllerServiceEntity result = apiInstance.removeControllerService(id, version, clientId, disconnectedNodeAcknowledged);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerservicesApi#removeControllerService");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.
version	String	The revision is used to verify the client is working with the latest version of the flow.	[optional]
clientId	String	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.	[optional]
disconnectedNodeAcknowledged	Boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.	[optional] [default to false]

Return type

ControllerServiceEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

submitConfigVerificationRequest

VerifyConfigRequestEntity submitConfigVerificationRequest(id, body)

Performs verification of the Controller Service's configuration

This will initiate the process of verifying a given Controller Service configuration. This may be a long-running task. As a result, this endpoint will immediately return a ControllerServiceConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /controller-services/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /controller-services/{serviceId}/verification-requests/{requestId}.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerservicesApi;


ControllerservicesApi apiInstance = new ControllerservicesApi();
String id = "id_example"; // String | The controller service id.
VerifyConfigRequestEntity body = new VerifyConfigRequestEntity(); // VerifyConfigRequestEntity | The controller service configuration verification request.
try {
    VerifyConfigRequestEntity result = apiInstance.submitConfigVerificationRequest(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerservicesApi#submitConfigVerificationRequest");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.
body	VerifyConfigRequestEntity	The controller service configuration verification request.

Return type

VerifyConfigRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

updateControllerService

ControllerServiceEntity updateControllerService(id, body)

Updates a controller service

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerservicesApi;


ControllerservicesApi apiInstance = new ControllerservicesApi();
String id = "id_example"; // String | The controller service id.
ControllerServiceEntity body = new ControllerServiceEntity(); // ControllerServiceEntity | The controller service configuration details.
try {
    ControllerServiceEntity result = apiInstance.updateControllerService(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerservicesApi#updateControllerService");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.
body	ControllerServiceEntity	The controller service configuration details.

Return type

ControllerServiceEntity

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

updateControllerServiceReferences

ControllerServiceReferencingComponentsEntity updateControllerServiceReferences(id, body)

Updates a controller services references

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerservicesApi;


ControllerservicesApi apiInstance = new ControllerservicesApi();
String id = "id_example"; // String | The controller service id.
UpdateControllerServiceReferenceRequestEntity body = new UpdateControllerServiceReferenceRequestEntity(); // UpdateControllerServiceReferenceRequestEntity | The controller service request update request.
try {
    ControllerServiceReferencingComponentsEntity result = apiInstance.updateControllerServiceReferences(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerservicesApi#updateControllerServiceReferences");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.
body	UpdateControllerServiceReferenceRequestEntity	The controller service request update request.

Return type

ControllerServiceReferencingComponentsEntity

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

updateRunStatus

ControllerServiceEntity updateRunStatus(id, body)

Updates run status of a controller service

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerservicesApi;


ControllerservicesApi apiInstance = new ControllerservicesApi();
String id = "id_example"; // String | The controller service id.
ControllerServiceRunStatusEntity body = new ControllerServiceRunStatusEntity(); // ControllerServiceRunStatusEntity | The controller service run status.
try {
    ControllerServiceEntity result = apiInstance.updateRunStatus(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerservicesApi#updateRunStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The controller service id.
body	ControllerServiceRunStatusEntity	The controller service run status.

Return type

ControllerServiceEntity

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

FilesExpand file tree

ControllerservicesApi.md

Latest commit

History

ControllerservicesApi.md

File metadata and controls

ControllerservicesApi

analyzeConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

clearState

Example

Parameters

Return type

Authorization

HTTP request headers

deleteVerificationRequest

Example

Parameters

Return type

Authorization

HTTP request headers

getControllerService

Example

Parameters

Return type

Authorization

HTTP request headers

getControllerServiceReferences

Example

Parameters

Return type

Authorization

HTTP request headers

getPropertyDescriptor

Example

Parameters

Return type

Authorization

HTTP request headers

getState

Example

Parameters

Return type

Authorization

HTTP request headers

getVerificationRequest

Example

Parameters

Return type

Authorization

HTTP request headers

removeControllerService

Example

Parameters

Return type

Authorization

HTTP request headers

submitConfigVerificationRequest

Example

Parameters

Return type

Authorization

HTTP request headers

updateControllerService

Example

Parameters

Return type

Authorization

HTTP request headers

updateControllerServiceReferences

Example

Parameters

Return type

Authorization

HTTP request headers

updateRunStatus