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.provenance_api.ProvenanceApi(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]
delete_lineage(id, **kwargs)[source]

Deletes a lineage query. 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_lineage_with_http_info() method instead.

Parameters:

  • id (str) – The id of the lineage query. (required)

  • cluster_node_id (str) – The id of the node where this query exists if clustered.

Returns:

The response data.

Return type:

LineageEntity

delete_lineage_with_http_info(id, **kwargs)[source]

Deletes a lineage query. 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_lineage() method instead.

Parameters:

  • id (str) – The id of the lineage query. (required)

  • cluster_node_id (str) – The id of the node where this query exists if clustered.

Returns:

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

Return type:

tuple

delete_provenance(id, **kwargs)[source]

Deletes a provenance query. 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_provenance_with_http_info() method instead.

Parameters:

  • id (str) – The id of the provenance query. (required)

  • cluster_node_id (str) – The id of the node where this query exists if clustered.

Returns:

The response data.

Return type:

ProvenanceEntity

delete_provenance_with_http_info(id, **kwargs)[source]

Deletes a provenance query. 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_provenance() method instead.

Parameters:

  • id (str) – The id of the provenance query. (required)

  • cluster_node_id (str) – The id of the node where this query exists if clustered.

Returns:

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

Return type:

tuple

get_lineage(id, **kwargs)[source]

Gets a lineage query. 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_lineage_with_http_info() method instead.

Parameters:

  • id (str) – The id of the lineage query. (required)

  • cluster_node_id (str) – The id of the node where this query exists if clustered.

Returns:

The response data.

Return type:

LineageEntity

get_lineage_with_http_info(id, **kwargs)[source]

Gets a lineage query. 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_lineage() method instead.

Parameters:

  • id (str) – The id of the lineage query. (required)

  • cluster_node_id (str) – The id of the node where this query exists if clustered.

Returns:

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

Return type:

tuple

get_provenance(id, **kwargs)[source]

Gets a provenance query. 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_provenance_with_http_info() method instead.

Parameters:

  • id (str) – The id of the provenance query. (required)

  • cluster_node_id (str) – The id of the node where this query exists if clustered.

  • summarize (bool) – Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.

  • incremental_results (bool) – Whether or not to summarize provenance events returned. This property is false by default.

Returns:

The response data.

Return type:

ProvenanceEntity

get_provenance_with_http_info(id, **kwargs)[source]

Gets a provenance query. 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_provenance() method instead.

Parameters:

  • id (str) – The id of the provenance query. (required)

  • cluster_node_id (str) – The id of the node where this query exists if clustered.

  • summarize (bool) – Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.

  • incremental_results (bool) – Whether or not to summarize provenance events returned. This property is false by default.

Returns:

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

Return type:

tuple

get_search_options(**kwargs)[source]

Gets the searchable attributes for provenance events. 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_search_options_with_http_info() method instead.

Args:

Returns:

The response data.

Return type:

ProvenanceOptionsEntity

get_search_options_with_http_info(**kwargs)[source]

Gets the searchable attributes for provenance events. 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_search_options() method instead.

Args:

Returns:

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

Return type:

tuple

submit_lineage_request(body, **kwargs)[source]

Submits a lineage query.

Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted 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 submit_lineage_request_with_http_info() method instead.

Parameters:

body (LineageEntity) – The lineage query details. (required)

Returns:

The response data.

Return type:

LineageEntity

submit_lineage_request_with_http_info(body, **kwargs)[source]

Submits a lineage query.

Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted 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 submit_lineage_request() method instead.

Parameters:

body (LineageEntity) – The lineage query details. (required)

Returns:

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

Return type:

tuple

submit_provenance_request(body, **kwargs)[source]

Submits a provenance query.

Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted 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 submit_provenance_request_with_http_info() method instead.

Parameters:

body (ProvenanceEntity) – The provenance query details. (required)

Returns:

The response data.

Return type:

ProvenanceEntity

submit_provenance_request_with_http_info(body, **kwargs)[source]

Submits a provenance query.

Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted 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 submit_provenance_request() method instead.

Parameters:

body (ProvenanceEntity) – The provenance query details. (required)

Returns:

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

Return type:

tuple