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.process_groups_api.ProcessGroupsApi(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]
copy(body, id, **kwargs)[source]

Generates a copy response for the given copy request. 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 copy_with_http_info() method instead.

Parameters:

  • body (CopyRequestEntity) – The request including the components to be copied from the specified Process Group. (required)

  • id (str) – The process group id. (required)

Returns:

The response data.

Return type:

CopyResponseEntity

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

Copies a snippet and discards it.. 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 copy_snippet_with_http_info() method instead.

Parameters:
Returns:

The response data.

Return type:

FlowEntity

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

Copies a snippet and discards it.. 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 copy_snippet() method instead.

Parameters:
Returns:

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

Return type:

tuple

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

Generates a copy response for the given copy request. 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 copy() method instead.

Parameters:

  • body (CopyRequestEntity) – The request including the components to be copied from the specified Process Group. (required)

  • id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

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

Creates a connection. 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_connection_with_http_info() method instead.

Parameters:

  • body (ConnectionEntity) – The connection configuration details. (required)

  • id (str) – The process group id. (required)

Returns:

The response data.

Return type:

ConnectionEntity

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

Creates a connection. 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_connection() method instead.

Parameters:

  • body (ConnectionEntity) – The connection configuration details. (required)

  • id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

create_controller_service1(body, id, **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_service1_with_http_info() method instead.

Parameters:

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

  • id (str) – The process group id. (required)

Returns:

The response data.

Return type:

ControllerServiceEntity

create_controller_service1_with_http_info(body, id, **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_service1() method instead.

Parameters:

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

  • id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

create_empty_all_connections_request(id, **kwargs)[source]

Creates a request to drop all flowfiles of all connection queues in this process group.. 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_empty_all_connections_request_with_http_info() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

The response data.

Return type:

DropRequestEntity

create_empty_all_connections_request_with_http_info(id, **kwargs)[source]

Creates a request to drop all flowfiles of all connection queues in this process group.. 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_empty_all_connections_request() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

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

Creates a funnel. 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_funnel_with_http_info() method instead.

Parameters:

  • body (FunnelEntity) – The funnel configuration details. (required)

  • id (str) – The process group id. (required)

Returns:

The response data.

Return type:

FunnelEntity

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

Creates a funnel. 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_funnel() method instead.

Parameters:

  • body (FunnelEntity) – The funnel configuration details. (required)

  • id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

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

Creates an input port. 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_input_port_with_http_info() method instead.

Parameters:

  • body (PortEntity) – The input port configuration details. (required)

  • id (str) – The process group id. (required)

Returns:

The response data.

Return type:

PortEntity

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

Creates an input port. 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_input_port() method instead.

Parameters:

  • body (PortEntity) – The input port configuration details. (required)

  • id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

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

Creates a label. 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_label_with_http_info() method instead.

Parameters:

  • body (LabelEntity) – The label configuration details. (required)

  • id (str) – The process group id. (required)

Returns:

The response data.

Return type:

LabelEntity

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

Creates a label. 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_label() method instead.

Parameters:

  • body (LabelEntity) – The label configuration details. (required)

  • id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

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

Creates an output port. 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_output_port_with_http_info() method instead.

Parameters:

  • body (PortEntity) – The output port configuration. (required)

  • id (str) – The process group id. (required)

Returns:

The response data.

Return type:

PortEntity

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

Creates an output port. 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_output_port() method instead.

Parameters:

  • body (PortEntity) – The output port configuration. (required)

  • id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

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

Creates a process group. 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_process_group_with_http_info() method instead.

Parameters:

  • body (ProcessGroupEntity) – The process group configuration details. (required)

  • id (str) – The process group id. (required)

  • parameter_context_handling_strategy (str) – Handling Strategy controls whether to keep or replace Parameter Contexts

Returns:

The response data.

Return type:

ProcessGroupEntity

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

Creates a process group. 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_process_group() method instead.

Parameters:

  • body (ProcessGroupEntity) – The process group configuration details. (required)

  • id (str) – The process group id. (required)

  • parameter_context_handling_strategy (str) – Handling Strategy controls whether to keep or replace Parameter Contexts

Returns:

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

Return type:

tuple

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

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

Parameters:

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

  • id (str) – The process group id. (required)

Returns:

The response data.

Return type:

ProcessorEntity

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

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

Parameters:

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

  • id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

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

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

Parameters:

  • body (RemoteProcessGroupEntity) – The remote process group configuration details. (required)

  • id (str) – The process group id. (required)

Returns:

The response data.

Return type:

RemoteProcessGroupEntity

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

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

Parameters:

  • body (RemoteProcessGroupEntity) – The remote process group configuration details. (required)

  • id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

delete_replace_process_group_request(id, **kwargs)[source]

Deletes the Replace Request with the given ID.

Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE’ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. 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 delete_replace_process_group_request_with_http_info() method instead.

Parameters:

  • id (str) – The ID of the Update Request (required)

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

Returns:

The response data.

Return type:

ProcessGroupReplaceRequestEntity

delete_replace_process_group_request_with_http_info(id, **kwargs)[source]

Deletes the Replace Request with the given ID.

Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE’ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. 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 delete_replace_process_group_request() method instead.

Parameters:

  • id (str) – The ID of the Update Request (required)

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

Returns:

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

Return type:

tuple

export_process_group(id, **kwargs)[source]

Gets a process group for download. 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 export_process_group_with_http_info() method instead.

Parameters:

  • id (str) – The process group id. (required)

  • include_referenced_services (bool) – If referenced services from outside the target group should be included

Returns:

The response data.

Return type:

str

export_process_group_with_http_info(id, **kwargs)[source]

Gets a process group for download. 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 export_process_group() method instead.

Parameters:

  • id (str) – The process group id. (required)

  • include_referenced_services (bool) – If referenced services from outside the target group should be included

Returns:

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

Return type:

tuple

get_connections(id, **kwargs)[source]

Gets all connections. 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_connections_with_http_info() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

The response data.

Return type:

ConnectionsEntity

get_connections_with_http_info(id, **kwargs)[source]

Gets all connections. 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_connections() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

get_drop_all_flowfiles_request(id, drop_request_id, **kwargs)[source]

Gets the current status of a drop all flowfiles request.. 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_drop_all_flowfiles_request_with_http_info() method instead.

Parameters:

  • id (str) – The process group id. (required)

  • drop_request_id (str) – The drop request id. (required)

Returns:

The response data.

Return type:

DropRequestEntity

get_drop_all_flowfiles_request_with_http_info(id, drop_request_id, **kwargs)[source]

Gets the current status of a drop all flowfiles request.. 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_drop_all_flowfiles_request() method instead.

Parameters:

  • id (str) – The process group id. (required)

  • drop_request_id (str) – The drop request id. (required)

Returns:

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

Return type:

tuple

get_funnels(id, **kwargs)[source]

Gets all funnels. 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_funnels_with_http_info() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

The response data.

Return type:

FunnelsEntity

get_funnels_with_http_info(id, **kwargs)[source]

Gets all funnels. 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_funnels() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

get_input_ports(id, **kwargs)[source]

Gets all input ports. 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_input_ports_with_http_info() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

The response data.

Return type:

InputPortsEntity

get_input_ports_with_http_info(id, **kwargs)[source]

Gets all input ports. 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_input_ports() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

get_labels(id, **kwargs)[source]

Gets all labels. 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_labels_with_http_info() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

The response data.

Return type:

LabelsEntity

get_labels_with_http_info(id, **kwargs)[source]

Gets all labels. 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_labels() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

get_local_modifications(id, **kwargs)[source]

Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry. 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_local_modifications_with_http_info() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

The response data.

Return type:

FlowComparisonEntity

get_local_modifications_with_http_info(id, **kwargs)[source]

Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry. 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_local_modifications() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

get_output_ports(id, **kwargs)[source]

Gets all output ports. 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_output_ports_with_http_info() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

The response data.

Return type:

OutputPortsEntity

get_output_ports_with_http_info(id, **kwargs)[source]

Gets all output ports. 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_output_ports() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

get_process_group(id, **kwargs)[source]

Gets a process group. 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_process_group_with_http_info() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

The response data.

Return type:

ProcessGroupEntity

get_process_group_with_http_info(id, **kwargs)[source]

Gets a process group. 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_process_group() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

get_process_groups(id, **kwargs)[source]

Gets all process groups. 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_process_groups_with_http_info() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

The response data.

Return type:

ProcessGroupsEntity

get_process_groups_with_http_info(id, **kwargs)[source]

Gets all process groups. 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_process_groups() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

get_processors(id, **kwargs)[source]

Gets all processors. 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_processors_with_http_info() method instead.

Parameters:

  • id (str) – The process group id. (required)

  • include_descendant_groups (bool) – Whether or not to include processors from descendant process groups

Returns:

The response data.

Return type:

ProcessorsEntity

get_processors_with_http_info(id, **kwargs)[source]

Gets all processors. 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_processors() method instead.

Parameters:

  • id (str) – The process group id. (required)

  • include_descendant_groups (bool) – Whether or not to include processors from descendant process groups

Returns:

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

Return type:

tuple

get_remote_process_groups(id, **kwargs)[source]

Gets all remote process groups. 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_remote_process_groups_with_http_info() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

The response data.

Return type:

RemoteProcessGroupsEntity

get_remote_process_groups_with_http_info(id, **kwargs)[source]

Gets all remote process groups. 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_remote_process_groups() method instead.

Parameters:

id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

get_replace_process_group_request(id, **kwargs)[source]

Returns the Replace Request with the given ID.

Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, 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. 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_replace_process_group_request_with_http_info() method instead.

Parameters:

id (str) – The ID of the Replace Request (required)

Returns:

The response data.

Return type:

ProcessGroupReplaceRequestEntity

get_replace_process_group_request_with_http_info(id, **kwargs)[source]

Returns the Replace Request with the given ID.

Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, 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. 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_replace_process_group_request() method instead.

Parameters:

id (str) – The ID of the Replace Request (required)

Returns:

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

Return type:

tuple

import_process_group(id, **kwargs)[source]

Imports a specified process group. 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_process_group_with_http_info() method instead.

Parameters:
Returns:

The response data.

Return type:

ProcessGroupEntity

import_process_group_with_http_info(id, **kwargs)[source]

Imports a specified process group. 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_process_group() method instead.

Parameters:
Returns:

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

Return type:

tuple

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

Initiate the Replace Request of a Process Group with the given ID.

This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. 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 initiate_replace_process_group_with_http_info() method instead.

Parameters:

  • body (ProcessGroupImportEntity) – The process group replace request entity (required)

  • id (str) – The process group id. (required)

Returns:

The response data.

Return type:

ProcessGroupReplaceRequestEntity

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

Initiate the Replace Request of a Process Group with the given ID.

This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. 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 initiate_replace_process_group() method instead.

Parameters:

  • body (ProcessGroupImportEntity) – The process group replace request entity (required)

  • id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

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

Pastes into the specified process group. 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 paste_with_http_info() method instead.

Parameters:

  • body (PasteRequestEntity) – The request including the components to be pasted into the specified Process Group. (required)

  • id (str) – The process group id. (required)

Returns:

The response data.

Return type:

PasteResponseEntity

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

Pastes into the specified process group. 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 paste() method instead.

Parameters:

  • body (PasteRequestEntity) – The request including the components to be pasted into the specified Process Group. (required)

  • id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

remove_drop_request1(id, drop_request_id, **kwargs)[source]

Cancels and/or removes a request to drop all flowfiles.. 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_drop_request1_with_http_info() method instead.

Parameters:

  • id (str) – The process group id. (required)

  • drop_request_id (str) – The drop request id. (required)

Returns:

The response data.

Return type:

DropRequestEntity

remove_drop_request1_with_http_info(id, drop_request_id, **kwargs)[source]

Cancels and/or removes a request to drop all flowfiles.. 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_drop_request1() method instead.

Parameters:

  • id (str) – The process group id. (required)

  • drop_request_id (str) – The drop request id. (required)

Returns:

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

Return type:

tuple

remove_process_group(id, **kwargs)[source]

Deletes a process group. 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_process_group_with_http_info() method instead.

Parameters:

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

ProcessGroupEntity

remove_process_group_with_http_info(id, **kwargs)[source]

Deletes a process group. 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_process_group() method instead.

Parameters:

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

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

Return type:

tuple

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

Replace Process Group contents with the given ID with the specified Process Group contents.

This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. 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 replace_process_group_with_http_info() method instead.

Parameters:

  • body (ProcessGroupImportEntity) – The process group replace request entity. (required)

  • id (str) – The process group id. (required)

Returns:

The response data.

Return type:

ProcessGroupImportEntity

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

Replace Process Group contents with the given ID with the specified Process Group contents.

This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. 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 replace_process_group() method instead.

Parameters:

  • body (ProcessGroupImportEntity) – The process group replace request entity. (required)

  • id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

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

Updates a process group. 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_process_group_with_http_info() method instead.

Parameters:

  • body (ProcessGroupEntity) – The process group configuration details. (required)

  • id (str) – The process group id. (required)

Returns:

The response data.

Return type:

ProcessGroupEntity

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

Updates a process group. 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_process_group() method instead.

Parameters:

  • body (ProcessGroupEntity) – The process group configuration details. (required)

  • id (str) – The process group id. (required)

Returns:

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

Return type:

tuple

upload_process_group(id, **kwargs)[source]

Uploads a versioned flow definition and creates a process group. 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_process_group_with_http_info() method instead.

Parameters:

  • id (str) – The process group id. (required)

  • client_id (str)

  • disconnected_node_acknowledged (bool)

  • file (object)

  • group_name (str)

  • position_x (float)

  • position_y (float)

Returns:

The response data.

Return type:

ProcessGroupEntity

upload_process_group_with_http_info(id, **kwargs)[source]

Uploads a versioned flow definition and creates a process group. 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_process_group() method instead.

Parameters:

  • id (str) – The process group id. (required)

  • client_id (str)

  • disconnected_node_acknowledged (bool)

  • file (object)

  • group_name (str)

  • position_x (float)

  • position_y (float)

Returns:

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

Return type:

tuple