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.parameter_contexts_api.ParameterContextsApi(api_client=None)

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)

create_asset(body, context_id, **kwargs)

Creates a new Asset in the given Parameter Context.

This endpoint will create a new Asset in the given Parameter Context. The Asset will be created with the given name and the contents of the file that is uploaded. The Asset will be created in the given Parameter Context, and will be available for use by any component that references the Parameter Context.

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

Parameters:

• body (object) – The contents of the asset. (required)

• context_id (str) – (required)

• filename (str)

Returns:

The response data.

Return type:

AssetEntity

create_asset_with_http_info(body, context_id, **kwargs)

Creates a new Asset in the given Parameter Context.

This endpoint will create a new Asset in the given Parameter Context. The Asset will be created with the given name and the contents of the file that is uploaded. The Asset will be created in the given Parameter Context, and will be available for use by any component that references the Parameter Context.

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

Parameters:

• body (object) – The contents of the asset. (required)

• context_id (str) – (required)

• filename (str)

Returns:

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

Return type:

tuple

create_parameter_context(body, **kwargs)

Create a Parameter Context. 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_parameter_context_with_http_info() method instead.

Parameters:

body (ParameterContextEntity) – The Parameter Context. (required)

Returns:

The response data.

Return type:

ParameterContextEntity

create_parameter_context_with_http_info(body, **kwargs)

Create a Parameter Context. 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_parameter_context() method instead.

Parameters:

body (ParameterContextEntity) – The Parameter Context. (required)

Returns:

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

Return type:

tuple

delete_asset(context_id, asset_id, **kwargs)

Deletes an Asset from the given Parameter Context.

This endpoint will create a new Asset in the given Parameter Context. The Asset will be created with the given name and the contents of the file that is uploaded. The Asset will be created in the given Parameter Context, and will be available for use by any component that references the Parameter Context.

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

Parameters:

• context_id (str) – The ID of the Parameter Context (required)

• asset_id (str) – The ID of the Asset (required)

• disconnected_node_acknowledged (bool)

Returns:

The response data.

Return type:

AssetEntity

delete_asset_with_http_info(context_id, asset_id, **kwargs)

Deletes an Asset from the given Parameter Context.

This endpoint will create a new Asset in the given Parameter Context. The Asset will be created with the given name and the contents of the file that is uploaded. The Asset will be created in the given Parameter Context, and will be available for use by any component that references the Parameter Context.

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

Parameters:

• context_id (str) – The ID of the Parameter Context (required)

• asset_id (str) – The ID of the Asset (required)

• disconnected_node_acknowledged (bool)

Returns:

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

Return type:

tuple

delete_parameter_context(id, **kwargs)

Deletes the Parameter Context with the given ID.

Deletes the Parameter Context with the given ID.

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

Parameters:

• id (str) – The Parameter Context ID. (required)

• version (LongParameter) – The version 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, a 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:

ParameterContextEntity

delete_parameter_context_with_http_info(id, **kwargs)

Deletes the Parameter Context with the given ID.

Deletes the Parameter Context with the given ID.

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

Parameters:

• id (str) – The Parameter Context ID. (required)

• version (LongParameter) – The version 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, a 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:

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

Return type:

tuple

delete_update_request(context_id, request_id, **kwargs)

Deletes the Update Request with the given ID.

Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE’ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update 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_update_request_with_http_info() method instead.

Parameters:

• context_id (str) – The ID of the ParameterContext (required)

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

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

Returns:

The response data.

Return type:

ParameterContextUpdateRequestEntity

delete_update_request_with_http_info(context_id, request_id, **kwargs)

Deletes the Update Request with the given ID.

Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE’ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update 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_update_request() method instead.

Parameters:

• context_id (str) – The ID of the ParameterContext (required)

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

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

Returns:

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

Return type:

tuple

delete_validation_request(context_id, id, **kwargs)

Deletes the Validation Request with the given ID.

Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE’ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation 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_validation_request_with_http_info() method instead.

Parameters:

• context_id (str) – The ID of the Parameter Context (required)

• id (str) – The ID of the Update Request (required)

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

Returns:

The response data.

Return type:

ParameterContextValidationRequestEntity

delete_validation_request_with_http_info(context_id, id, **kwargs)

Deletes the Validation Request with the given ID.

Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE’ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation 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_validation_request() method instead.

Parameters:

• context_id (str) – The ID of the Parameter Context (required)

• id (str) – The ID of the Update Request (required)

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

Returns:

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

Return type:

tuple

get_asset_content(context_id, asset_id, **kwargs)

Retrieves the content of the asset with the given id. 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_asset_content_with_http_info() method instead.

Parameters:

• context_id (str) – The ID of the Parameter Context (required)

• asset_id (str) – The ID of the Asset (required)

Returns:

The response data.

Return type:

str

get_asset_content_with_http_info(context_id, asset_id, **kwargs)

Retrieves the content of the asset with the given id. 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_asset_content() method instead.

Parameters:

• context_id (str) – The ID of the Parameter Context (required)

• asset_id (str) – The ID of the Asset (required)

Returns:

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

Return type:

tuple

get_assets(context_id, **kwargs)

Lists the assets that belong to the Parameter Context with the given ID.

Lists the assets that belong to the Parameter Context with the given ID.

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

Parameters:

context_id (str) – The ID of the Parameter Context (required)

Returns:

The response data.

Return type:

AssetsEntity

get_assets_with_http_info(context_id, **kwargs)

Lists the assets that belong to the Parameter Context with the given ID.

Lists the assets that belong to the Parameter Context with the given ID.

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

Parameters:

context_id (str) – The ID of the Parameter Context (required)

Returns:

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

Return type:

tuple

get_parameter_context(id, **kwargs)

Returns the Parameter Context with the given ID.

Returns the Parameter Context with the given ID.

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

Parameters:

• id (str) – The ID of the Parameter Context (required)

• include_inherited_parameters (bool) – Whether or not to include inherited parameters from other parameter contexts, and therefore also overridden values. If true, the result will be the ‘effective’ parameter context.

Returns:

The response data.

Return type:

ParameterContextEntity

get_parameter_context_update(context_id, request_id, **kwargs)

Returns the Update Request with the given ID.

Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, 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_parameter_context_update_with_http_info() method instead.

Parameters:

• context_id (str) – The ID of the Parameter Context (required)

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

Returns:

The response data.

Return type:

ParameterContextUpdateRequestEntity

get_parameter_context_update_with_http_info(context_id, request_id, **kwargs)

Returns the Update Request with the given ID.

Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, 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_parameter_context_update() method instead.

Parameters:

• context_id (str) – The ID of the Parameter Context (required)

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

Returns:

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

Return type:

tuple

get_parameter_context_with_http_info(id, **kwargs)

Returns the Parameter Context with the given ID.

Returns the Parameter Context with the given ID.

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

Parameters:

• id (str) – The ID of the Parameter Context (required)

• include_inherited_parameters (bool) – Whether or not to include inherited parameters from other parameter contexts, and therefore also overridden values. If true, the result will be the ‘effective’ parameter context.

Returns:

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

Return type:

tuple

get_validation_request(context_id, id, **kwargs)

Returns the Validation Request with the given ID.

Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, 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_validation_request_with_http_info() method instead.

Parameters:

• context_id (str) – The ID of the Parameter Context (required)

• id (str) – The ID of the Validation Request (required)

Returns:

The response data.

Return type:

ParameterContextValidationRequestEntity

get_validation_request_with_http_info(context_id, id, **kwargs)

Returns the Validation Request with the given ID.

Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, 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_validation_request() method instead.

Parameters:

• context_id (str) – The ID of the Parameter Context (required)

• id (str) – The ID of the Validation Request (required)

Returns:

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

Return type:

tuple

submit_parameter_context_update(body, context_id, **kwargs)

Initiate the Update Request of a Parameter Context.

This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this action may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextUpdateRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/update-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_parameter_context_update_with_http_info() method instead.

Parameters:

• body (ParameterContextEntity) – The updated version of the parameter context. (required)

• context_id (str) – (required)

Returns:

The response data.

Return type:

ParameterContextUpdateRequestEntity

submit_parameter_context_update_with_http_info(body, context_id, **kwargs)

Initiate the Update Request of a Parameter Context.

This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this action may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextUpdateRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/update-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_parameter_context_update() method instead.

Parameters:

• body (ParameterContextEntity) – The updated version of the parameter context. (required)

• context_id (str) – (required)

Returns:

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

Return type:

tuple

submit_validation_request(body, context_id, **kwargs)

Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated.

This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-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_validation_request_with_http_info() method instead.

Parameters:

• body (ParameterContextValidationRequestEntity) – The validation request (required)

• context_id (str) – (required)

Returns:

The response data.

Return type:

ParameterContextValidationRequestEntity

submit_validation_request_with_http_info(body, context_id, **kwargs)

Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated.

This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-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_validation_request() method instead.

Parameters:

• body (ParameterContextValidationRequestEntity) – The validation request (required)

• context_id (str) – (required)

Returns:

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

Return type:

tuple

update_parameter_context(body, id, **kwargs)

Modifies a Parameter Context.

This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint.

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

Parameters:

• body (ParameterContextEntity) – The updated Parameter Context (required)

• id (str) – (required)

Returns:

The response data.

Return type:

ParameterContextEntity

update_parameter_context_with_http_info(body, id, **kwargs)

Modifies a Parameter Context.

This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint.

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

Parameters:

• body (ParameterContextEntity) – The updated Parameter Context (required)

• id (str) – (required)

Returns:

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

Return type:

tuple