ProcessorsApi

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

Method	HTTP request	Description
analyzeConfiguration	POST /processors/{id}/config/analysis	Performs analysis of the component's configuration, providing information about which attributes are referenced.
clearState	POST /processors/{id}/state/clear-requests	Clears the state for a processor
deleteProcessor	DELETE /processors/{id}	Deletes a processor
deleteVerificationRequest	DELETE /processors/{id}/config/verification-requests/{requestId}	Deletes the Verification Request with the given ID
getProcessor	GET /processors/{id}	Gets a processor
getProcessorDiagnostics	GET /processors/{id}/diagnostics	Gets diagnostics information about a processor
getProcessorRunStatusDetails	POST /processors/run-status-details/queries	Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs
getPropertyDescriptor	GET /processors/{id}/descriptors	Gets the descriptor for a processor property
getState	GET /processors/{id}/state	Gets the state for a processor
getVerificationRequest	GET /processors/{id}/config/verification-requests/{requestId}	Returns the Verification Request with the given ID
submitProcessorVerificationRequest	POST /processors/{id}/config/verification-requests	Performs verification of the Processor's configuration
terminateProcessor	DELETE /processors/{id}/threads	Terminates a processor, essentially "deleting" its threads and any active tasks
updateProcessor	PUT /processors/{id}	Updates a processor
updateRunStatus	PUT /processors/{id}/run-status	Updates run status of a processor

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


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

Parameters

Name	Type	Description	Notes
id	String	The processor id.
body	ConfigurationAnalysisEntity	The processor 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 processor

Example

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


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

Parameters

Name	Type	Description	Notes
id	String	The processor id.

Return type

ComponentStateEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

deleteProcessor

ProcessorEntity deleteProcessor(id, version, clientId, disconnectedNodeAcknowledged)

Deletes a processor

Example

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


ProcessorsApi apiInstance = new ProcessorsApi();
String id = "id_example"; // String | The processor 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 {
    ProcessorEntity result = apiInstance.deleteProcessor(id, version, clientId, disconnectedNodeAcknowledged);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessorsApi#deleteProcessor");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The processor 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

ProcessorEntity

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


ProcessorsApi apiInstance = new ProcessorsApi();
String id = "id_example"; // String | The ID of the Processor
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 ProcessorsApi#deleteVerificationRequest");
    e.printStackTrace();
}

Parameters

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

Return type

VerifyConfigRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getProcessor

ProcessorEntity getProcessor(id)

Gets a processor

Example

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


ProcessorsApi apiInstance = new ProcessorsApi();
String id = "id_example"; // String | The processor id.
try {
    ProcessorEntity result = apiInstance.getProcessor(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessorsApi#getProcessor");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The processor id.

Return type

ProcessorEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getProcessorDiagnostics

ProcessorEntity getProcessorDiagnostics(id)

Gets diagnostics information about a processor

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

Example

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


ProcessorsApi apiInstance = new ProcessorsApi();
String id = "id_example"; // String | The processor id.
try {
    ProcessorEntity result = apiInstance.getProcessorDiagnostics(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessorsApi#getProcessorDiagnostics");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The processor id.

Return type

ProcessorEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getProcessorRunStatusDetails

ProcessorsRunStatusDetailsEntity getProcessorRunStatusDetails(body)

Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs

Example

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


ProcessorsApi apiInstance = new ProcessorsApi();
RunStatusDetailsRequestEntity body = new RunStatusDetailsRequestEntity(); // RunStatusDetailsRequestEntity | The request for the processors that should be included in the results
try {
    ProcessorsRunStatusDetailsEntity result = apiInstance.getProcessorRunStatusDetails(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessorsApi#getProcessorRunStatusDetails");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	RunStatusDetailsRequestEntity	The request for the processors that should be included in the results	[optional]

Return type

ProcessorsRunStatusDetailsEntity

Authorization

No authorization required

HTTP request headers

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

getPropertyDescriptor

PropertyDescriptorEntity getPropertyDescriptor(id, propertyName, clientId, sensitive)

Gets the descriptor for a processor property

Example

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


ProcessorsApi apiInstance = new ProcessorsApi();
String id = "id_example"; // String | The processor id.
String propertyName = "propertyName_example"; // String | The property name.
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 sensitive = false; // Boolean | Property Descriptor requested sensitive status
try {
    PropertyDescriptorEntity result = apiInstance.getPropertyDescriptor(id, propertyName, clientId, sensitive);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessorsApi#getPropertyDescriptor");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The processor id.
propertyName	String	The property name.
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]
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 processor

Example

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


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

Parameters

Name	Type	Description	Notes
id	String	The processor 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.ProcessorsApi;


ProcessorsApi apiInstance = new ProcessorsApi();
String id = "id_example"; // String | The ID of the Processor
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 ProcessorsApi#getVerificationRequest");
    e.printStackTrace();
}

Parameters

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

Return type

VerifyConfigRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

submitProcessorVerificationRequest

VerifyConfigRequestEntity submitProcessorVerificationRequest(id, body)

Performs verification of the Processor's configuration

This will initiate the process of verifying a given Processor configuration. This may be a long-running task. As a result, this endpoint will immediately return a ProcessorConfigVerificationRequestEntity, 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 /processors/{processorId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /processors/{processorId}/verification-requests/{requestId}.

Example

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


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

Parameters

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

Return type

VerifyConfigRequestEntity

Authorization

No authorization required

HTTP request headers

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

terminateProcessor

ProcessorEntity terminateProcessor(id)

Terminates a processor, essentially "deleting" its threads and any active tasks

Example

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


ProcessorsApi apiInstance = new ProcessorsApi();
String id = "id_example"; // String | The processor id.
try {
    ProcessorEntity result = apiInstance.terminateProcessor(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessorsApi#terminateProcessor");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The processor id.

Return type

ProcessorEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

updateProcessor

ProcessorEntity updateProcessor(id, body)

Updates a processor

Example

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


ProcessorsApi apiInstance = new ProcessorsApi();
String id = "id_example"; // String | The processor id.
ProcessorEntity body = new ProcessorEntity(); // ProcessorEntity | The processor configuration details.
try {
    ProcessorEntity result = apiInstance.updateProcessor(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessorsApi#updateProcessor");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The processor id.
body	ProcessorEntity	The processor configuration details.

Return type

ProcessorEntity

Authorization

No authorization required

HTTP request headers

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

updateRunStatus

ProcessorEntity updateRunStatus(id, body)

Updates run status of a processor

Example

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


ProcessorsApi apiInstance = new ProcessorsApi();
String id = "id_example"; // String | The processor id.
ProcessorRunStatusEntity body = new ProcessorRunStatusEntity(); // ProcessorRunStatusEntity | The processor run status.
try {
    ProcessorEntity result = apiInstance.updateRunStatus(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessorsApi#updateRunStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The processor id.
body	ProcessorRunStatusEntity	The processor run status.

Return type

ProcessorEntity

Authorization

No authorization required

HTTP request headers

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

Files

ProcessorsApi.md

Latest commit

History

ProcessorsApi.md

File metadata and controls

ProcessorsApi

analyzeConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

clearState

Example

Parameters

Return type

Authorization

HTTP request headers

deleteProcessor

Example

Parameters

Return type

Authorization

HTTP request headers

deleteVerificationRequest

Example

Parameters

Return type

Authorization

HTTP request headers

getProcessor

Example

Parameters

Return type

Authorization

HTTP request headers

getProcessorDiagnostics

Example

Parameters

Return type

Authorization

HTTP request headers

getProcessorRunStatusDetails

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

submitProcessorVerificationRequest

Example

Parameters

Return type

Authorization

HTTP request headers

terminateProcessor

Example

Parameters

Return type

Authorization

HTTP request headers

updateProcessor