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.controller_services_api.ControllerServicesApi(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_configuration(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_configuration_with_http_info() method instead.

Parameters:
Returns:

The response data.

Return type:

ConfigurationAnalysisEntity

analyze_configuration_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_configuration() method instead.

Parameters:
Returns:

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

Return type:

tuple

clear_state1(id, **kwargs)[source]

Clears the state for a controller service. 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_state1_with_http_info() method instead.

Parameters:

  • id (str) – The controller service 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_state1_with_http_info(id, **kwargs)[source]

Clears the state for a controller service. 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_state1() method instead.

Parameters:

  • id (str) – The controller service 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_verification_request(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_request_with_http_info() method instead.

Parameters:

  • id (str) – The ID of the Controller Service (required)

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

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

delete_verification_request_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_request() method instead.

Parameters:

  • id (str) – The ID of the Controller Service (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_controller_service(id, **kwargs)[source]

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.

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_controller_service_with_http_info() method instead.

Parameters:

  • id (str) – The controller service id. (required)

  • ui_only (bool)

Returns:

The response data.

Return type:

ControllerServiceEntity

get_controller_service_references(id, **kwargs)[source]

Gets a controller service. 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_controller_service_references_with_http_info() method instead.

Parameters:

id (str) – The controller service id. (required)

Returns:

The response data.

Return type:

ControllerServiceReferencingComponentsEntity

get_controller_service_references_with_http_info(id, **kwargs)[source]

Gets a controller service. 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_controller_service_references() method instead.

Parameters:

id (str) – The controller service id. (required)

Returns:

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

Return type:

tuple

get_controller_service_with_http_info(id, **kwargs)[source]

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.

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_controller_service() method instead.

Parameters:

  • id (str) – The controller service id. (required)

  • ui_only (bool)

Returns:

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

Return type:

tuple

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

Gets a controller service property descriptor. 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_descriptor1_with_http_info() method instead.

Parameters:

  • id (str) – The controller service id. (required)

  • property_name (str) – The property name to return the descriptor for. (required)

  • sensitive (bool) – Property Descriptor requested sensitive status

Returns:

The response data.

Return type:

PropertyDescriptorEntity

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

Gets a controller service property descriptor. 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_descriptor1() method instead.

Parameters:

  • id (str) – The controller service id. (required)

  • property_name (str) – The property name to return the descriptor for. (required)

  • sensitive (bool) – Property Descriptor requested sensitive status

Returns:

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

Return type:

tuple

get_state(id, **kwargs)[source]

Gets the state for a controller service. 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_state_with_http_info() method instead.

Parameters:

id (str) – The controller service id. (required)

Returns:

The response data.

Return type:

ComponentStateEntity

get_state_with_http_info(id, **kwargs)[source]

Gets the state for a controller service. 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_state() method instead.

Parameters:

id (str) – The controller service id. (required)

Returns:

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

Return type:

tuple

get_verification_request(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_request_with_http_info() method instead.

Parameters:

  • id (str) – The ID of the Controller Service (required)

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

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

get_verification_request_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_request() method instead.

Parameters:

  • id (str) – The ID of the Controller Service (required)

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

Returns:

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

Return type:

tuple

remove_controller_service(id, **kwargs)[source]

Deletes a controller service. 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 remove_controller_service_with_http_info() method instead.

Parameters:

  • id (str) – The controller service 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:

ControllerServiceEntity

remove_controller_service_with_http_info(id, **kwargs)[source]

Deletes a controller service. 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 remove_controller_service() method instead.

Parameters:

  • id (str) – The controller service 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:

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

Return type:

tuple

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

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

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_config_verification_request_with_http_info() method instead.

Parameters:

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

  • id (str) – The controller service id. (required)

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

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

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

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_config_verification_request() method instead.

Parameters:

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

  • id (str) – The controller service id. (required)

Returns:

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

Return type:

tuple

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

Updates a controller service. 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_controller_service_with_http_info() method instead.

Parameters:

  • body (ControllerServiceEntity) – The controller service configuration details. (required)

  • id (str) – The controller service id. (required)

Returns:

The response data.

Return type:

ControllerServiceEntity

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

Updates a controller services references. 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_controller_service_references_with_http_info() method instead.

Parameters:
Returns:

The response data.

Return type:

ControllerServiceReferencingComponentsEntity

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

Updates a controller services references. 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_controller_service_references() method instead.

Parameters:
Returns:

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

Return type:

tuple

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

Updates a controller service. 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_controller_service() method instead.

Parameters:

  • body (ControllerServiceEntity) – The controller service configuration details. (required)

  • id (str) – The controller service id. (required)

Returns:

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

Return type:

tuple

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

Updates run status of a controller service. 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_status1_with_http_info() method instead.

Parameters:
Returns:

The response data.

Return type:

ControllerServiceEntity

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

Updates run status of a controller service. 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_status1() method instead.

Parameters:
Returns:

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

Return type:

tuple