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_events_api.ProvenanceEventsApi(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_content(id, **kwargs)[source]

Gets the input content for a provenance event. 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_content_with_http_info() method instead.

Parameters:

  • id (LongParameter) – The provenance event id. (required)

  • range (str) – Range of bytes requested

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

Returns:

The response data.

Return type:

StreamingOutput

get_input_content_with_http_info(id, **kwargs)[source]

Gets the input content for a provenance event. 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_content() method instead.

Parameters:

  • id (LongParameter) – The provenance event id. (required)

  • range (str) – Range of bytes requested

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

Returns:

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

Return type:

tuple

get_latest_provenance_events(component_id, **kwargs)[source]

Retrieves the latest cached Provenance Events for the specified component. 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_latest_provenance_events_with_http_info() method instead.

Parameters:

  • component_id (str) – The ID of the component to retrieve the latest Provenance Events for. (required)

  • limit (int) – The number of events to limit the response to. Defaults to 10.

Returns:

The response data.

Return type:

LatestProvenanceEventsEntity

get_latest_provenance_events_with_http_info(component_id, **kwargs)[source]

Retrieves the latest cached Provenance Events for the specified component. 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_latest_provenance_events() method instead.

Parameters:

  • component_id (str) – The ID of the component to retrieve the latest Provenance Events for. (required)

  • limit (int) – The number of events to limit the response to. Defaults to 10.

Returns:

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

Return type:

tuple

get_output_content(id, **kwargs)[source]

Gets the output content for a provenance event. 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_content_with_http_info() method instead.

Parameters:

  • id (LongParameter) – The provenance event id. (required)

  • range (str) – Range of bytes requested

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

Returns:

The response data.

Return type:

StreamingOutput

get_output_content_with_http_info(id, **kwargs)[source]

Gets the output content for a provenance event. 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_content() method instead.

Parameters:

  • id (LongParameter) – The provenance event id. (required)

  • range (str) – Range of bytes requested

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

Returns:

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

Return type:

tuple

get_provenance_event(id, **kwargs)[source]

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

Parameters:

  • id (LongParameter) – The provenance event id. (required)

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

Returns:

The response data.

Return type:

ProvenanceEventEntity

get_provenance_event_with_http_info(id, **kwargs)[source]

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

Parameters:

  • id (LongParameter) – The provenance event id. (required)

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

Returns:

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

Return type:

tuple

submit_replay(body, **kwargs)[source]

Replays content from a provenance event. 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_replay_with_http_info() method instead.

Parameters:

body (SubmitReplayRequestEntity) – The replay request. (required)

Returns:

The response data.

Return type:

ProvenanceEventEntity

submit_replay_latest_event(body, **kwargs)[source]

Replays content from a provenance event. 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_replay_latest_event_with_http_info() method instead.

Parameters:

body (ReplayLastEventRequestEntity) – The replay request. (required)

Returns:

The response data.

Return type:

ReplayLastEventResponseEntity

submit_replay_latest_event_with_http_info(body, **kwargs)[source]

Replays content from a provenance event. 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_replay_latest_event() method instead.

Parameters:

body (ReplayLastEventRequestEntity) – The replay request. (required)

Returns:

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

Return type:

tuple

submit_replay_with_http_info(body, **kwargs)[source]

Replays content from a provenance event. 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_replay() method instead.

Parameters:

body (SubmitReplayRequestEntity) – The replay request. (required)

Returns:

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

Return type:

tuple