Apache NiFi REST API

REST API definition for Apache NiFi web services

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

class nipyapi.nifi.apis.remote_process_groups_api.RemoteProcessGroupsApi(api_client=None)

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)

get_remote_process_group(id, **kwargs)

Gets a remote 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_remote_process_group_with_http_info() method instead.

Parameters:

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

Returns:

The response data.

Return type:

RemoteProcessGroupEntity

get_remote_process_group_with_http_info(id, **kwargs)

Gets a remote 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_remote_process_group() method instead.

Parameters:

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

Returns:

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

Return type:

tuple

get_state3(id, **kwargs)

Gets the state for a RemoteProcessGroup. 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_state3_with_http_info() method instead.

Parameters:

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

Returns:

The response data.

Return type:

ComponentStateEntity

get_state3_with_http_info(id, **kwargs)

Gets the state for a RemoteProcessGroup. 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_state3() method instead.

Parameters:

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

Returns:

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

Return type:

tuple

remove_remote_process_group(id, **kwargs)

Deletes a remote 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_remote_process_group_with_http_info() method instead.

Parameters:

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

RemoteProcessGroupEntity

remove_remote_process_group_with_http_info(id, **kwargs)

Deletes a remote 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_remote_process_group() method instead.

Parameters:

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

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

Return type:

tuple

update_remote_process_group(body, id, **kwargs)

Updates a remote 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_remote_process_group_with_http_info() method instead.

Parameters:

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

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

Returns:

The response data.

Return type:

RemoteProcessGroupEntity

update_remote_process_group_input_port(body, id, port_id, **kwargs)

Updates a remote port.

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

Parameters:

• body (RemoteProcessGroupPortEntity) – The remote process group port. (required)

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

• port_id (str) – The remote process group port id. (required)

Returns:

The response data.

Return type:

RemoteProcessGroupPortEntity

update_remote_process_group_input_port_run_status(body, id, port_id, **kwargs)

Updates run status of a remote port.

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

Parameters:

• body (RemotePortRunStatusEntity) – The remote process group port. (required)

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

• port_id (str) – The remote process group port id. (required)

Returns:

The response data.

Return type:

RemoteProcessGroupPortEntity

update_remote_process_group_input_port_run_status_with_http_info(body, id, port_id, **kwargs)

Updates run status of a remote port.

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

Parameters:

• body (RemotePortRunStatusEntity) – The remote process group port. (required)

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

• port_id (str) – The remote process group port id. (required)

Returns:

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

Return type:

tuple

update_remote_process_group_input_port_with_http_info(body, id, port_id, **kwargs)

Updates a remote port.

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

Parameters:

• body (RemoteProcessGroupPortEntity) – The remote process group port. (required)

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

• port_id (str) – The remote process group port id. (required)

Returns:

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

Return type:

tuple

update_remote_process_group_output_port(body, id, port_id, **kwargs)

Updates a remote port.

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

Parameters:

• body (RemoteProcessGroupPortEntity) – The remote process group port. (required)

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

• port_id (str) – The remote process group port id. (required)

Returns:

The response data.

Return type:

RemoteProcessGroupPortEntity

update_remote_process_group_output_port_run_status(body, id, port_id, **kwargs)

Updates run status of a remote port.

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

Parameters:

• body (RemotePortRunStatusEntity) – The remote process group port. (required)

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

• port_id (str) – The remote process group port id. (required)

Returns:

The response data.

Return type:

RemoteProcessGroupPortEntity

update_remote_process_group_output_port_run_status_with_http_info(body, id, port_id, **kwargs)

Updates run status of a remote port.

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

Parameters:

• body (RemotePortRunStatusEntity) – The remote process group port. (required)

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

• port_id (str) – The remote process group port id. (required)

Returns:

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

Return type:

tuple

update_remote_process_group_output_port_with_http_info(body, id, port_id, **kwargs)

Updates a remote port.

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

Parameters:

• body (RemoteProcessGroupPortEntity) – The remote process group port. (required)

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

• port_id (str) – The remote process group port id. (required)

Returns:

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

Return type:

tuple

update_remote_process_group_run_status(body, id, **kwargs)

Updates run status of a remote 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_remote_process_group_run_status_with_http_info() method instead.

Parameters:

• body (RemotePortRunStatusEntity) – The remote process group run status. (required)

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

Returns:

The response data.

Return type:

RemoteProcessGroupEntity

update_remote_process_group_run_status_with_http_info(body, id, **kwargs)

Updates run status of a remote 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_remote_process_group_run_status() method instead.

Parameters:

• body (RemotePortRunStatusEntity) – The remote process group run status. (required)

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

Returns:

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

Return type:

tuple

update_remote_process_group_run_statuses(body, id, **kwargs)

Updates run status of all remote process groups in a process group (recursively). 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_remote_process_group_run_statuses_with_http_info() method instead.

Parameters:

• body (RemotePortRunStatusEntity) – The remote process groups run status. (required)

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

Returns:

The response data.

Return type:

RemoteProcessGroupEntity

update_remote_process_group_run_statuses_with_http_info(body, id, **kwargs)

Updates run status of all remote process groups in a process group (recursively). 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_remote_process_group_run_statuses() method instead.

Parameters:

• body (RemotePortRunStatusEntity) – The remote process groups run status. (required)

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

Returns:

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

Return type:

tuple

update_remote_process_group_with_http_info(body, id, **kwargs)

Updates a remote 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_remote_process_group() method instead.

Parameters:

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

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

Returns:

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

Return type:

tuple