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.reporting_tasks_api.ReportingTasksApi(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_configuration3(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_configuration3_with_http_info() method instead.

Parameters:
Returns:

The response data.

Return type:

ConfigurationAnalysisEntity

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

Parameters:
Returns:

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

Return type:

tuple

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

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

Parameters:

  • body (ClearBulletinsRequestEntity) – The clear bulletin request specifying the timestamp from which to clear bulletins. (required)

  • id (str) – The reporting task id. (required)

Returns:

The response data.

Return type:

ClearBulletinsResultEntity

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

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

Parameters:

  • body (ClearBulletinsRequestEntity) – The clear bulletin request specifying the timestamp from which to clear bulletins. (required)

  • id (str) – The reporting task id. (required)

Returns:

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

Return type:

tuple

clear_state4(id, **kwargs)[source]

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

Parameters:

  • id (str) – The reporting task 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_state4_with_http_info(id, **kwargs)[source]

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

Parameters:

  • id (str) – The reporting task id. (required)

  • body (ComponentStateEntity) – Optional component state to perform a selective key removal. If omitted, clears all state.

Returns:

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

Return type:

tuple

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

Deletes the Verification Request with the given ID.

Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE’ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding delete_verification_request3_with_http_info() method instead.

Parameters:

  • id (str) – The ID of the Reporting Task (required)

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

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

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

Deletes the Verification Request with the given ID.

Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE’ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding delete_verification_request3() method instead.

Parameters:

  • id (str) – The ID of the Reporting Task (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_property_descriptor4(id, property_name, **kwargs)[source]

Gets a reporting task 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_descriptor4_with_http_info() method instead.

Parameters:

  • id (str) – The reporting task 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_descriptor4_with_http_info(id, property_name, **kwargs)[source]

Gets a reporting task 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_descriptor4() method instead.

Parameters:

  • id (str) – The reporting task 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_reporting_task(id, **kwargs)[source]

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

Parameters:

id (str) – The reporting task id. (required)

Returns:

The response data.

Return type:

ReportingTaskEntity

get_reporting_task_with_http_info(id, **kwargs)[source]

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

Parameters:

id (str) – The reporting task id. (required)

Returns:

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

Return type:

tuple

get_state4(id, **kwargs)[source]

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

Parameters:

id (str) – The reporting task id. (required)

Returns:

The response data.

Return type:

ComponentStateEntity

get_state4_with_http_info(id, **kwargs)[source]

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

Parameters:

id (str) – The reporting task id. (required)

Returns:

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

Return type:

tuple

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

Returns the Verification Request with the given ID.

Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_verification_request3_with_http_info() method instead.

Parameters:

  • id (str) – The ID of the Reporting Task (required)

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

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

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

Returns the Verification Request with the given ID.

Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_verification_request3() method instead.

Parameters:

  • id (str) – The ID of the Reporting Task (required)

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

Returns:

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

Return type:

tuple

remove_reporting_task(id, **kwargs)[source]

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

Parameters:

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

ReportingTaskEntity

remove_reporting_task_with_http_info(id, **kwargs)[source]

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

Parameters:

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

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

Return type:

tuple

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

Performs verification of the Reporting Task’s configuration.

This will initiate the process of verifying a given Reporting Task configuration. This may be a long-running task. As a result, this endpoint will immediately return a ReportingTaskConfigVerificationRequestEntity, 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 /reporting-tasks/{taskId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /reporting-tasks/{serviceId}/verification-requests/{requestId}.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding submit_config_verification_request2_with_http_info() method instead.

Parameters:

  • body (VerifyConfigRequestEntity) – The reporting task configuration verification request. (required)

  • id (str) – The reporting task id. (required)

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

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

Performs verification of the Reporting Task’s configuration.

This will initiate the process of verifying a given Reporting Task configuration. This may be a long-running task. As a result, this endpoint will immediately return a ReportingTaskConfigVerificationRequestEntity, 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 /reporting-tasks/{taskId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /reporting-tasks/{serviceId}/verification-requests/{requestId}.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding submit_config_verification_request2() method instead.

Parameters:

  • body (VerifyConfigRequestEntity) – The reporting task configuration verification request. (required)

  • id (str) – The reporting task id. (required)

Returns:

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

Return type:

tuple

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

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

Parameters:

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

  • id (str) – The reporting task id. (required)

Returns:

The response data.

Return type:

ReportingTaskEntity

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

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

Parameters:

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

  • id (str) – The reporting task id. (required)

Returns:

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

Return type:

tuple

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

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

Parameters:
Returns:

The response data.

Return type:

ReportingTaskEntity

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

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

Parameters:
Returns:

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

Return type:

tuple