Apache NiFi REST API

REST API definition for Apache NiFi web services

OpenAPI spec version: 2.6.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.processors_api.ProcessorsApi(api_client=None)[source]

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

__init__(api_client=None)[source]
analyze_configuration2(body, id, **kwargs)[source]

Performs analysis of the component’s configuration, providing information about which attributes are referenced.. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding analyze_configuration2_with_http_info() method instead.

Parameters:
Returns:

The response data.

Return type:

ConfigurationAnalysisEntity

analyze_configuration2_with_http_info(body, id, **kwargs)[source]

Performs analysis of the component’s configuration, providing information about which attributes are referenced.. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding analyze_configuration2() method instead.

Parameters:
Returns:

(ConfigurationAnalysisEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

clear_state3(id, **kwargs)[source]

Clears the state for a processor. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding clear_state3_with_http_info() method instead.

Parameters:

  • id (str) – The processor id. (required)

  • body (ComponentStateEntity) – Optional component state to perform a selective key removal. If omitted, clears all state.

Returns:

The response data.

Return type:

ComponentStateEntity

clear_state3_with_http_info(id, **kwargs)[source]

Clears the state for a processor. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding clear_state3() method instead.

Parameters:

  • id (str) – The processor id. (required)

  • body (ComponentStateEntity) – Optional component state to perform a selective key removal. If omitted, clears all state.

Returns:

(ComponentStateEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

delete_processor(id, **kwargs)[source]

Deletes a processor. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding delete_processor_with_http_info() method instead.

Parameters:

  • id (str) – The processor id. (required)

  • version (LongParameter) – The revision is used to verify the client is working with the latest version of the flow.

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

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

The response data.

Return type:

ProcessorEntity

delete_processor_with_http_info(id, **kwargs)[source]

Deletes a processor. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding delete_processor() method instead.

Parameters:

  • id (str) – The processor id. (required)

  • version (LongParameter) – The revision is used to verify the client is working with the latest version of the flow.

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

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

(ProcessorEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

delete_verification_request2(id, request_id, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding delete_verification_request2_with_http_info() method instead.

Parameters:

  • id (str) – The ID of the Processor (required)

  • request_id (str) – The ID of the Verification Request (required)

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

delete_verification_request2_with_http_info(id, request_id, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding delete_verification_request2() method instead.

Parameters:

  • id (str) – The ID of the Processor (required)

  • request_id (str) – The ID of the Verification Request (required)

Returns:

(VerifyConfigRequestEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_processor(id, **kwargs)[source]

Gets a processor. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_processor_with_http_info() method instead.

Parameters:

id (str) – The processor id. (required)

Returns:

The response data.

Return type:

ProcessorEntity

get_processor_diagnostics(id, **kwargs)[source]

Gets diagnostics information about a processor.

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

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_processor_diagnostics_with_http_info() method instead.

Parameters:

id (str) – The processor id. (required)

Returns:

The response data.

Return type:

ProcessorEntity

get_processor_diagnostics_with_http_info(id, **kwargs)[source]

Gets diagnostics information about a processor.

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

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_processor_diagnostics() method instead.

Parameters:

id (str) – The processor id. (required)

Returns:

(ProcessorEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_processor_run_status_details(**kwargs)[source]

Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_processor_run_status_details_with_http_info() method instead.

Parameters:

body (RunStatusDetailsRequestEntity) – The request for the processors that should be included in the results

Returns:

The response data.

Return type:

ProcessorsRunStatusDetailsEntity

get_processor_run_status_details_with_http_info(**kwargs)[source]

Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_processor_run_status_details() method instead.

Parameters:

body (RunStatusDetailsRequestEntity) – The request for the processors that should be included in the results

Returns:

(ProcessorsRunStatusDetailsEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_processor_with_http_info(id, **kwargs)[source]

Gets a processor. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_processor() method instead.

Parameters:

id (str) – The processor id. (required)

Returns:

(ProcessorEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_property_descriptor3(id, property_name, **kwargs)[source]

Gets the descriptor for a processor property. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_property_descriptor3_with_http_info() method instead.

Parameters:

  • id (str) – The processor id. (required)

  • property_name (str) – The property name. (required)

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

  • sensitive (bool) – Property Descriptor requested sensitive status

Returns:

The response data.

Return type:

PropertyDescriptorEntity

get_property_descriptor3_with_http_info(id, property_name, **kwargs)[source]

Gets the descriptor for a processor property. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_property_descriptor3() method instead.

Parameters:

  • id (str) – The processor id. (required)

  • property_name (str) – The property name. (required)

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

  • sensitive (bool) – Property Descriptor requested sensitive status

Returns:

(PropertyDescriptorEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_state2(id, **kwargs)[source]

Gets the state for a processor. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_state2_with_http_info() method instead.

Parameters:

id (str) – The processor id. (required)

Returns:

The response data.

Return type:

ComponentStateEntity

get_state2_with_http_info(id, **kwargs)[source]

Gets the state for a processor. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_state2() method instead.

Parameters:

id (str) – The processor id. (required)

Returns:

(ComponentStateEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_verification_request2(id, request_id, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_verification_request2_with_http_info() method instead.

Parameters:

  • id (str) – The ID of the Processor (required)

  • request_id (str) – The ID of the Verification Request (required)

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

get_verification_request2_with_http_info(id, request_id, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_verification_request2() method instead.

Parameters:

  • id (str) – The ID of the Processor (required)

  • request_id (str) – The ID of the Verification Request (required)

Returns:

(VerifyConfigRequestEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

submit_processor_verification_request(body, id, **kwargs)[source]

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

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding submit_processor_verification_request_with_http_info() method instead.

Parameters:

  • body (VerifyConfigRequestEntity) – The processor configuration verification request. (required)

  • id (str) – The processor id. (required)

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

submit_processor_verification_request_with_http_info(body, id, **kwargs)[source]

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

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding submit_processor_verification_request() method instead.

Parameters:

  • body (VerifyConfigRequestEntity) – The processor configuration verification request. (required)

  • id (str) – The processor id. (required)

Returns:

(VerifyConfigRequestEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

terminate_processor(id, **kwargs)[source]

Terminates a processor, essentially “deleting” its threads and any active tasks. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding terminate_processor_with_http_info() method instead.

Parameters:

id (str) – The processor id. (required)

Returns:

The response data.

Return type:

ProcessorEntity

terminate_processor_with_http_info(id, **kwargs)[source]

Terminates a processor, essentially “deleting” its threads and any active tasks. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding terminate_processor() method instead.

Parameters:

id (str) – The processor id. (required)

Returns:

(ProcessorEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

update_processor(body, id, **kwargs)[source]

Updates a processor. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding update_processor_with_http_info() method instead.

Parameters:

  • body (ProcessorEntity) – The processor configuration details. (required)

  • id (str) – The processor id. (required)

Returns:

The response data.

Return type:

ProcessorEntity

update_processor_with_http_info(body, id, **kwargs)[source]

Updates a processor. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding update_processor() method instead.

Parameters:

  • body (ProcessorEntity) – The processor configuration details. (required)

  • id (str) – The processor id. (required)

Returns:

(ProcessorEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

update_run_status4(body, id, **kwargs)[source]

Updates run status of a processor. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding update_run_status4_with_http_info() method instead.

Parameters:
Returns:

The response data.

Return type:

ProcessorEntity

update_run_status4_with_http_info(body, id, **kwargs)[source]

Updates run status of a processor. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding update_run_status4() method instead.

Parameters:
Returns:

(ProcessorEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple