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.snippets_api.SnippetsApi(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]
create_snippet(body, **kwargs)[source]

Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.. 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 create_snippet_with_http_info() method instead.

Parameters:

body (SnippetEntity) – The snippet configuration details. (required)

Returns:

The response data.

Return type:

SnippetEntity

create_snippet_with_http_info(body, **kwargs)[source]

Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.. 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 create_snippet() method instead.

Parameters:

body (SnippetEntity) – The snippet configuration details. (required)

Returns:

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

Return type:

tuple

delete_snippet(id, **kwargs)[source]

Deletes the components in a snippet and discards the snippet. 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_snippet_with_http_info() method instead.

Parameters:

  • id (str) – The snippet id. (required)

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

The response data.

Return type:

SnippetEntity

delete_snippet_with_http_info(id, **kwargs)[source]

Deletes the components in a snippet and discards the snippet. 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_snippet() method instead.

Parameters:

  • id (str) – The snippet id. (required)

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

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

Return type:

tuple

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

Move’s the components in this Snippet into a new Process Group and discards the snippet. 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_snippet_with_http_info() method instead.

Parameters:

  • body (SnippetEntity) – The snippet configuration details. (required)

  • id (str) – The snippet id. (required)

Returns:

The response data.

Return type:

SnippetEntity

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

Move’s the components in this Snippet into a new Process Group and discards the snippet. 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_snippet() method instead.

Parameters:

  • body (SnippetEntity) – The snippet configuration details. (required)

  • id (str) – The snippet id. (required)

Returns:

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

Return type:

tuple