Apache NiFi REST API

REST API definition for Apache NiFi web services

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

class nipyapi.nifi.apis.controller_api.ControllerApi(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_flow_analysis_rule_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_flow_analysis_rule_configuration_with_http_info() method instead.

Parameters:
Returns:

The response data.

Return type:

ConfigurationAnalysisEntity

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

Parameters:
Returns:

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

Return type:

tuple

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

Parameters:
Returns:

The response data.

Return type:

ConfigurationAnalysisEntity

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

Parameters:
Returns:

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

Return type:

tuple

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

Clears bulletins for a flow analysis rule. 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_flow_analysis_rule_bulletins_with_http_info() method instead.

Parameters:
Returns:

The response data.

Return type:

ClearBulletinsResultEntity

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

Clears bulletins for a flow analysis rule. 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_flow_analysis_rule_bulletins() method instead.

Parameters:
Returns:

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

Return type:

tuple

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

Clears bulletins for a parameter provider. 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_parameter_provider_bulletins_with_http_info() method instead.

Parameters:
Returns:

The response data.

Return type:

ClearBulletinsResultEntity

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

Clears bulletins for a parameter provider. 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_parameter_provider_bulletins() method instead.

Parameters:
Returns:

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

Return type:

tuple

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

Clears bulletins for a registry client. 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_registry_client_bulletins_with_http_info() method instead.

Parameters:
Returns:

The response data.

Return type:

ClearBulletinsResultEntity

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

Clears bulletins for a registry client. 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_registry_client_bulletins() method instead.

Parameters:
Returns:

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

Return type:

tuple

clear_state(id, **kwargs)[source]

Clears the state for a flow analysis rule. 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_state_with_http_info() method instead.

Parameters:

  • id (str) – The flow analysis rule 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_state_with_http_info(id, **kwargs)[source]

Clears the state for a flow analysis rule. 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_state() method instead.

Parameters:

  • id (str) – The flow analysis rule 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

create_bulletin(body, **kwargs)[source]

Creates a new bulletin. 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 create_bulletin_with_http_info() method instead.

Parameters:

body (BulletinEntity) – The reporting task configuration details. (required)

Returns:

The response data.

Return type:

BulletinEntity

create_bulletin_with_http_info(body, **kwargs)[source]

Creates a new bulletin. 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 create_bulletin() method instead.

Parameters:

body (BulletinEntity) – The reporting task configuration details. (required)

Returns:

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

Return type:

tuple

create_controller_service(body, **kwargs)[source]

Creates a new 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 create_controller_service_with_http_info() method instead.

Parameters:

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

Returns:

The response data.

Return type:

ControllerServiceEntity

create_controller_service_with_http_info(body, **kwargs)[source]

Creates a new 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 create_controller_service() method instead.

Parameters:

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

Returns:

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

Return type:

tuple

create_flow_analysis_rule(body, **kwargs)[source]

Creates a new flow analysis rule. 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 create_flow_analysis_rule_with_http_info() method instead.

Parameters:

body (FlowAnalysisRuleEntity) – The flow analysis rule configuration details. (required)

Returns:

The response data.

Return type:

FlowAnalysisRuleEntity

create_flow_analysis_rule_with_http_info(body, **kwargs)[source]

Creates a new flow analysis rule. 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 create_flow_analysis_rule() method instead.

Parameters:

body (FlowAnalysisRuleEntity) – The flow analysis rule configuration details. (required)

Returns:

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

Return type:

tuple

create_flow_registry_client(body, **kwargs)[source]

Creates a new flow registry client. 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 create_flow_registry_client_with_http_info() method instead.

Parameters:

body (FlowRegistryClientEntity) – The flow registry client configuration details. (required)

Returns:

The response data.

Return type:

FlowRegistryClientEntity

create_flow_registry_client_with_http_info(body, **kwargs)[source]

Creates a new flow registry client. 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 create_flow_registry_client() method instead.

Parameters:

body (FlowRegistryClientEntity) – The flow registry client configuration details. (required)

Returns:

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

Return type:

tuple

create_parameter_provider(body, **kwargs)[source]

Creates a new parameter provider. 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 create_parameter_provider_with_http_info() method instead.

Parameters:

body (ParameterProviderEntity) – The parameter provider configuration details. (required)

Returns:

The response data.

Return type:

ParameterProviderEntity

create_parameter_provider_with_http_info(body, **kwargs)[source]

Creates a new parameter provider. 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 create_parameter_provider() method instead.

Parameters:

body (ParameterProviderEntity) – The parameter provider configuration details. (required)

Returns:

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

Return type:

tuple

create_reporting_task(body, **kwargs)[source]

Creates a new reporting task. 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 create_reporting_task_with_http_info() method instead.

Parameters:

body (ReportingTaskEntity) – The reporting task configuration details. (required)

Returns:

The response data.

Return type:

ReportingTaskEntity

create_reporting_task_with_http_info(body, **kwargs)[source]

Creates a new reporting task. 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 create_reporting_task() method instead.

Parameters:

body (ReportingTaskEntity) – The reporting task configuration details. (required)

Returns:

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

Return type:

tuple

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

Parameters:

  • id (str) – The ID of the Flow Analysis Rule (required)

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

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

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

Parameters:

  • id (str) – The ID of the Flow Analysis Rule (required)

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

Returns:

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

Return type:

tuple

delete_flow_registry_client(id, **kwargs)[source]

Deletes a flow registry client. 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_flow_registry_client_with_http_info() method instead.

Parameters:

  • id (str) – The flow registry client 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:

FlowRegistryClientEntity

delete_flow_registry_client_with_http_info(id, **kwargs)[source]

Deletes a flow registry client. 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_flow_registry_client() method instead.

Parameters:

  • id (str) – The flow registry client 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:

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

Return type:

tuple

delete_history(end_date, **kwargs)[source]

Purges history. 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_history_with_http_info() method instead.

Parameters:

end_date (DateTimeParameter) – Purge actions before this date/time. (required)

Returns:

The response data.

Return type:

HistoryEntity

delete_history_with_http_info(end_date, **kwargs)[source]

Purges history. 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_history() method instead.

Parameters:

end_date (DateTimeParameter) – Purge actions before this date/time. (required)

Returns:

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

Return type:

tuple

delete_nar(id, **kwargs)[source]

Deletes an installed NAR. 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_nar_with_http_info() method instead.

Parameters:

  • id (str) – The id of the NAR. (required)

  • disconnected_node_acknowledged (bool)

  • force (bool)

Returns:

The response data.

Return type:

NarSummaryEntity

delete_nar_with_http_info(id, **kwargs)[source]

Deletes an installed NAR. 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_nar() method instead.

Parameters:

  • id (str) – The id of the NAR. (required)

  • disconnected_node_acknowledged (bool)

  • force (bool)

Returns:

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

Return type:

tuple

delete_node(id, **kwargs)[source]

Removes a node from the cluster. 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_node_with_http_info() method instead.

Parameters:

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

Returns:

The response data.

Return type:

NodeEntity

delete_node_with_http_info(id, **kwargs)[source]

Removes a node from the cluster. 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_node() method instead.

Parameters:

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

Returns:

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

Return type:

tuple

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

Parameters:

  • id (str) – The ID of the Registry Client (required)

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

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

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

Parameters:

  • id (str) – The ID of the Registry Client (required)

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

Returns:

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

Return type:

tuple

download_nar(id, **kwargs)[source]

Retrieves the content of the NAR with the given id. 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 download_nar_with_http_info() method instead.

Parameters:

id (str) – The id of the NAR. (required)

Returns:

The response data.

Return type:

str

download_nar_with_http_info(id, **kwargs)[source]

Retrieves the content of the NAR with the given id. 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 download_nar() method instead.

Parameters:

id (str) – The id of the NAR. (required)

Returns:

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

Return type:

tuple

get_cluster(**kwargs)[source]

Gets the contents of the cluster.

Returns the contents of the cluster including all nodes and their status.

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

Args:

Returns:

The response data.

Return type:

ClusterEntity

get_cluster_with_http_info(**kwargs)[source]

Gets the contents of the cluster.

Returns the contents of the cluster including all nodes and their status.

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

Args:

Returns:

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

Return type:

tuple

get_controller_config(**kwargs)[source]

Retrieves the configuration for this NiFi Controller. 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_config_with_http_info() method instead.

Args:

Returns:

The response data.

Return type:

ControllerConfigurationEntity

get_controller_config_with_http_info(**kwargs)[source]

Retrieves the configuration for this NiFi Controller. 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_config() method instead.

Args:

Returns:

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

Return type:

tuple

get_flow_analysis_rule(id, **kwargs)[source]

Gets a flow analysis rule. 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_flow_analysis_rule_with_http_info() method instead.

Parameters:

id (str) – The flow analysis rule id. (required)

Returns:

The response data.

Return type:

FlowAnalysisRuleEntity

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

Gets a flow analysis rule 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_flow_analysis_rule_property_descriptor_with_http_info() method instead.

Parameters:

  • id (str) – The flow analysis rule id. (required)

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

  • sensitive (bool) – Property Descriptor requested sensitive status

Returns:

The response data.

Return type:

PropertyDescriptorEntity

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

Gets a flow analysis rule 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_flow_analysis_rule_property_descriptor() method instead.

Parameters:

  • id (str) – The flow analysis rule id. (required)

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

  • sensitive (bool) – Property Descriptor requested sensitive status

Returns:

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

Return type:

tuple

get_flow_analysis_rule_state(id, **kwargs)[source]

Gets the state for a flow analysis rule. 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_flow_analysis_rule_state_with_http_info() method instead.

Parameters:

id (str) – The flow analysis rule id. (required)

Returns:

The response data.

Return type:

ComponentStateEntity

get_flow_analysis_rule_state_with_http_info(id, **kwargs)[source]

Gets the state for a flow analysis rule. 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_flow_analysis_rule_state() method instead.

Parameters:

id (str) – The flow analysis rule id. (required)

Returns:

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

Return type:

tuple

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

Parameters:

  • id (str) – The ID of the Flow Analysis Rule (required)

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

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

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

Parameters:

  • id (str) – The ID of the Flow Analysis Rule (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_flow_analysis_rule_with_http_info(id, **kwargs)[source]

Gets a flow analysis rule. 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_flow_analysis_rule() method instead.

Parameters:

id (str) – The flow analysis rule id. (required)

Returns:

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

Return type:

tuple

get_flow_analysis_rules(**kwargs)[source]

Gets all flow analysis rules. 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_flow_analysis_rules_with_http_info() method instead.

Args:

Returns:

The response data.

Return type:

FlowAnalysisRulesEntity

get_flow_analysis_rules_with_http_info(**kwargs)[source]

Gets all flow analysis rules. 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_flow_analysis_rules() method instead.

Args:

Returns:

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

Return type:

tuple

get_flow_registry_client(id, **kwargs)[source]

Gets a flow registry client. 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_flow_registry_client_with_http_info() method instead.

Parameters:

id (str) – The flow registry client id. (required)

Returns:

The response data.

Return type:

FlowRegistryClientEntity

get_flow_registry_client_with_http_info(id, **kwargs)[source]

Gets a flow registry client. 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_flow_registry_client() method instead.

Parameters:

id (str) – The flow registry client id. (required)

Returns:

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

Return type:

tuple

get_flow_registry_clients(**kwargs)[source]

Gets the listing of available flow registry clients. 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_flow_registry_clients_with_http_info() method instead.

Args:

Returns:

The response data.

Return type:

FlowRegistryClientsEntity

get_flow_registry_clients_with_http_info(**kwargs)[source]

Gets the listing of available flow registry clients. 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_flow_registry_clients() method instead.

Args:

Returns:

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

Return type:

tuple

get_nar_details(id, **kwargs)[source]

Retrieves the component types available from the installed NARs. 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_nar_details_with_http_info() method instead.

Parameters:

id (str) – The id of the NAR. (required)

Returns:

The response data.

Return type:

NarDetailsEntity

get_nar_details_with_http_info(id, **kwargs)[source]

Retrieves the component types available from the installed NARs. 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_nar_details() method instead.

Parameters:

id (str) – The id of the NAR. (required)

Returns:

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

Return type:

tuple

get_nar_summaries(**kwargs)[source]

Retrieves summary information for installed NARs. 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_nar_summaries_with_http_info() method instead.

Args:

Returns:

The response data.

Return type:

NarSummariesEntity

get_nar_summaries_with_http_info(**kwargs)[source]

Retrieves summary information for installed NARs. 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_nar_summaries() method instead.

Args:

Returns:

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

Return type:

tuple

get_nar_summary(id, **kwargs)[source]

Retrieves the summary information for the NAR with the given identifier. 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_nar_summary_with_http_info() method instead.

Parameters:

id (str) – The id of the NAR. (required)

Returns:

The response data.

Return type:

NarDetailsEntity

get_nar_summary_with_http_info(id, **kwargs)[source]

Retrieves the summary information for the NAR with the given identifier. 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_nar_summary() method instead.

Parameters:

id (str) – The id of the NAR. (required)

Returns:

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

Return type:

tuple

get_node(id, **kwargs)[source]

Gets a node in the cluster. 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_node_with_http_info() method instead.

Parameters:

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

Returns:

The response data.

Return type:

NodeEntity

get_node_status_history(**kwargs)[source]

Gets status history for the node.

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

Args:

Returns:

The response data.

Return type:

ComponentHistoryEntity

get_node_status_history_with_http_info(**kwargs)[source]

Gets status history for the node.

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

Args:

Returns:

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

Return type:

tuple

get_node_with_http_info(id, **kwargs)[source]

Gets a node in the cluster. 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_node() method instead.

Parameters:

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

Returns:

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

Return type:

tuple

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

Gets a flow registry client 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_descriptor_with_http_info() method instead.

Parameters:

  • id (str) – The flow registry client id. (required)

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

  • sensitive (bool) – Property Descriptor requested sensitive status

Returns:

The response data.

Return type:

PropertyDescriptorEntity

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

Gets a flow registry client 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_descriptor() method instead.

Parameters:

  • id (str) – The flow registry client id. (required)

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

  • sensitive (bool) – Property Descriptor requested sensitive status

Returns:

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

Return type:

tuple

get_registry_client_types(**kwargs)[source]

Retrieves the types of flow that this NiFi supports.

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

Args:

Returns:

The response data.

Return type:

FlowRegistryClientTypesEntity

get_registry_client_types_with_http_info(**kwargs)[source]

Retrieves the types of flow that this NiFi supports.

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

Args:

Returns:

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

Return type:

tuple

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

Returns the Verification Request with the given ID.

Returns the Verification Request with the given ID. Once a 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_registry_client_verification_request_with_http_info() method instead.

Parameters:

  • id (str) – The ID of the Registry Client (required)

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

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

get_registry_client_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 a 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_registry_client_verification_request() method instead.

Parameters:

  • id (str) – The ID of the Registry Client (required)

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

Returns:

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

Return type:

tuple

import_reporting_task_snapshot(body, **kwargs)[source]

Imports a reporting task snapshot. 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 import_reporting_task_snapshot_with_http_info() method instead.

Parameters:

body (VersionedReportingTaskImportRequestEntity) – The import request containing the reporting task snapshot to import. (required)

Returns:

The response data.

Return type:

VersionedReportingTaskImportResponseEntity

import_reporting_task_snapshot_with_http_info(body, **kwargs)[source]

Imports a reporting task snapshot. 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 import_reporting_task_snapshot() method instead.

Parameters:

body (VersionedReportingTaskImportRequestEntity) – The import request containing the reporting task snapshot to import. (required)

Returns:

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

Return type:

tuple

remove_flow_analysis_rule(id, **kwargs)[source]

Deletes a flow analysis rule. 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_flow_analysis_rule_with_http_info() method instead.

Parameters:

  • id (str) – The flow analysis rule 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:

FlowAnalysisRuleEntity

remove_flow_analysis_rule_with_http_info(id, **kwargs)[source]

Deletes a flow analysis rule. 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_flow_analysis_rule() method instead.

Parameters:

  • id (str) – The flow analysis rule 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:

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

Return type:

tuple

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

Performs verification of the Flow Analysis Rule’s configuration.

This will initiate the process of verifying a given Flow Analysis Rule configuration. This may be a long-running task. As a result, this endpoint will immediately return a FlowAnalysisRuleConfigVerificationRequestEntity, 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 /flow-analysis-rules/{taskId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /flow-analysis-rules/{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_flow_analysis_rule_config_verification_request_with_http_info() method instead.

Parameters:

  • body (VerifyConfigRequestEntity) – The flow analysis rules configuration verification request. (required)

  • id (str) – The flow analysis rules id. (required)

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

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

Performs verification of the Flow Analysis Rule’s configuration.

This will initiate the process of verifying a given Flow Analysis Rule configuration. This may be a long-running task. As a result, this endpoint will immediately return a FlowAnalysisRuleConfigVerificationRequestEntity, 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 /flow-analysis-rules/{taskId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /flow-analysis-rules/{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_flow_analysis_rule_config_verification_request() method instead.

Parameters:

  • body (VerifyConfigRequestEntity) – The flow analysis rules configuration verification request. (required)

  • id (str) – The flow analysis rules id. (required)

Returns:

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

Return type:

tuple

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

Performs verification of the Registry Client’s configuration.

Initiates verification of a Registry Client configuration. The request returns immediately with a request entity while verification runs asynchronously. The client should poll /controller/registry-clients/{clientId}/config/verification-requests/{requestId} for status and DELETE the request once verification completes.

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

Parameters:

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

  • id (str) – The registry client id. (required)

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

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

Performs verification of the Registry Client’s configuration.

Initiates verification of a Registry Client configuration. The request returns immediately with a request entity while verification runs asynchronously. The client should poll /controller/registry-clients/{clientId}/config/verification-requests/{requestId} for status and DELETE the request once verification completes.

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

Parameters:

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

  • id (str) – The registry client id. (required)

Returns:

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

Return type:

tuple

update_controller_config(body, **kwargs)[source]

Retrieves the configuration for this NiFi. 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_config_with_http_info() method instead.

Parameters:

body (ControllerConfigurationEntity) – The controller configuration. (required)

Returns:

The response data.

Return type:

ControllerConfigurationEntity

update_controller_config_with_http_info(body, **kwargs)[source]

Retrieves the configuration for this NiFi. 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_config() method instead.

Parameters:

body (ControllerConfigurationEntity) – The controller configuration. (required)

Returns:

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

Return type:

tuple

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

Updates a flow analysis rule. 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_flow_analysis_rule_with_http_info() method instead.

Parameters:

  • body (FlowAnalysisRuleEntity) – The flow analysis rule configuration details. (required)

  • id (str) – The flow analysis rule id. (required)

Returns:

The response data.

Return type:

FlowAnalysisRuleEntity

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

Updates a flow analysis rule. 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_flow_analysis_rule() method instead.

Parameters:

  • body (FlowAnalysisRuleEntity) – The flow analysis rule configuration details. (required)

  • id (str) – The flow analysis rule id. (required)

Returns:

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

Return type:

tuple

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

Updates a flow registry client. 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_flow_registry_client_with_http_info() method instead.

Parameters:

  • body (FlowRegistryClientEntity) – The flow registry client configuration details. (required)

  • id (str) – The flow registry client id. (required)

Returns:

The response data.

Return type:

FlowRegistryClientEntity

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

Updates a flow registry client. 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_flow_registry_client() method instead.

Parameters:

  • body (FlowRegistryClientEntity) – The flow registry client configuration details. (required)

  • id (str) – The flow registry client id. (required)

Returns:

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

Return type:

tuple

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

Updates a node in the cluster. 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_node_with_http_info() method instead.

Parameters:

  • body (NodeEntity) – The node configuration. The only configuration that will be honored at this endpoint is the status. (required)

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

Returns:

The response data.

Return type:

NodeEntity

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

Updates a node in the cluster. 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_node() method instead.

Parameters:

  • body (NodeEntity) – The node configuration. The only configuration that will be honored at this endpoint is the status. (required)

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

Returns:

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

Return type:

tuple

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

Updates run status of a flow analysis rule. 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_status_with_http_info() method instead.

Parameters:
Returns:

The response data.

Return type:

FlowAnalysisRuleEntity

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

Updates run status of a flow analysis rule. 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_status() method instead.

Parameters:
Returns:

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

Return type:

tuple

upload_nar(body, **kwargs)[source]

Uploads a NAR and requests for it to be installed. 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 upload_nar_with_http_info() method instead.

Parameters:

  • body (object) – The contents of the NAR file. (required)

  • filename (str)

Returns:

The response data.

Return type:

NarSummaryEntity

upload_nar_with_http_info(body, **kwargs)[source]

Uploads a NAR and requests for it to be installed. 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 upload_nar() method instead.

Parameters:

  • body (object) – The contents of the NAR file. (required)

  • filename (str)

Returns:

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

Return type:

tuple