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.input_ports_api.InputPortsApi(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]
get_input_port(id, **kwargs)[source]

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

Parameters:

id (str) – The input port id. (required)

Returns:

The response data.

Return type:

PortEntity

get_input_port_with_http_info(id, **kwargs)[source]

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

Parameters:

id (str) – The input port id. (required)

Returns:

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

Return type:

tuple

remove_input_port(id, **kwargs)[source]

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

Parameters:

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

PortEntity

remove_input_port_with_http_info(id, **kwargs)[source]

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

Parameters:

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

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

Return type:

tuple

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

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

Parameters:

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

  • id (str) – The input port id. (required)

Returns:

The response data.

Return type:

PortEntity

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

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

Parameters:

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

  • id (str) – The input port id. (required)

Returns:

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

Return type:

tuple

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

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

Parameters:
Returns:

The response data.

Return type:

ProcessorEntity

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

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

Parameters:
Returns:

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

Return type:

tuple