<no title>

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_providers_api.ParameterProvidersApi(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_configuration1(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_configuration1_with_http_info() method instead.

Parameters:

body (ConfigurationAnalysisEntity) – The configuration analysis request. (required)
id (str) – The parameter provider id. (required)

Returns:

The response data.

Return type:

ConfigurationAnalysisEntity

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

Parameters:

body (ConfigurationAnalysisEntity) – The configuration analysis request. (required)
id (str) – The parameter provider id. (required)

Returns:

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

Return type:

tuple

clear_state2(id, **kwargs)[source]

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

Parameters:

id (str) – The parameter provider 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_state2_with_http_info(id, **kwargs)[source]

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

Parameters:

id (str) – The parameter provider 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_apply_parameters_request(provider_id, request_id, **kwargs)[source]

Deletes the Apply Parameters Request with the given ID.

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

Parameters:

provider_id (str) – The ID of the Parameter Provider (required)
request_id (str) – The ID of the Apply Parameters 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:

ParameterProviderApplyParametersRequestEntity

delete_apply_parameters_request_with_http_info(provider_id, request_id, **kwargs)[source]

Deletes the Apply Parameters Request with the given ID.

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

Parameters:

provider_id (str) – The ID of the Parameter Provider (required)
request_id (str) – The ID of the Apply Parameters Request (required)
disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

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

Return type:

tuple

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

Parameters:

id (str) – The ID of the Parameter Provider (required)
request_id (str) – The ID of the Verification Request (required)

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

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

Parameters:

id (str) – The ID of the Parameter Provider (required)
request_id (str) – The ID of the Verification Request (required)

Returns:

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

Return type:

tuple

fetch_parameters(body, id, **kwargs)[source]

Fetches and temporarily caches the parameters for a provider. 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 fetch_parameters_with_http_info() method instead.

Parameters:

body (ParameterProviderParameterFetchEntity) – The parameter fetch request. (required)
id (str) – The parameter provider id. (required)

Returns:

The response data.

Return type:

ParameterProviderEntity

fetch_parameters_with_http_info(body, id, **kwargs)[source]

Fetches and temporarily caches the parameters for a provider. 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 fetch_parameters() method instead.

Parameters:

body (ParameterProviderParameterFetchEntity) – The parameter fetch request. (required)
id (str) – The parameter provider id. (required)

Returns:

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

Return type:

tuple

get_parameter_provider(id, **kwargs)[source]

Gets a parameter provider. 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_provider_with_http_info() method instead.

Parameters:: id (str) – The parameter provider id. (required)
Returns:: The response data.
Return type:: ParameterProviderEntity

get_parameter_provider_apply_parameters_request(provider_id, request_id, **kwargs)[source]

Returns the Apply Parameters Request with the given ID.

Returns the Apply Parameters Request with the given ID. Once an Apply Parameters Request has been created by performing a POST to /nifi-api/parameter-providers, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the 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_provider_apply_parameters_request_with_http_info() method instead.

Parameters:

provider_id (str) – The ID of the Parameter Provider (required)
request_id (str) – The ID of the Apply Parameters Request (required)

Returns:

The response data.

Return type:

ParameterProviderApplyParametersRequestEntity

get_parameter_provider_apply_parameters_request_with_http_info(provider_id, request_id, **kwargs)[source]

Returns the Apply Parameters Request with the given ID.

Returns the Apply Parameters Request with the given ID. Once an Apply Parameters Request has been created by performing a POST to /nifi-api/parameter-providers, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the 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_provider_apply_parameters_request() method instead.

Parameters:

provider_id (str) – The ID of the Parameter Provider (required)
request_id (str) – The ID of the Apply Parameters Request (required)

Returns:

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

Return type:

tuple

get_parameter_provider_references(id, **kwargs)[source]

Gets all references to a parameter provider. 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_provider_references_with_http_info() method instead.

Parameters:: id (str) – The parameter provider id. (required)
Returns:: The response data.
Return type:: ParameterProviderReferencingComponentsEntity

get_parameter_provider_references_with_http_info(id, **kwargs)[source]

Gets all references to a parameter provider. 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_provider_references() method instead.

Parameters:: id (str) – The parameter provider id. (required)
Returns:: (ParameterProviderReferencingComponentsEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_parameter_provider_with_http_info(id, **kwargs)[source]

Gets a parameter provider. 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_provider() method instead.

Parameters:: id (str) – The parameter provider id. (required)
Returns:: (ParameterProviderEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_property_descriptor2(id, property_name, **kwargs)[source]

Gets a parameter provider 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_descriptor2_with_http_info() method instead.

Parameters:

id (str) – The parameter provider id. (required)
property_name (str) – The property name. (required)

Returns:

The response data.

Return type:

PropertyDescriptorEntity

get_property_descriptor2_with_http_info(id, property_name, **kwargs)[source]

Gets a parameter provider 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_descriptor2() method instead.

Parameters:

id (str) – The parameter provider id. (required)
property_name (str) – The property name. (required)

Returns:

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

Return type:

tuple

get_state1(id, **kwargs)[source]

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

Parameters:: id (str) – The parameter provider id. (required)
Returns:: The response data.
Return type:: ComponentStateEntity

get_state1_with_http_info(id, **kwargs)[source]

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

Parameters:: id (str) – The parameter provider id. (required)
Returns:: (ComponentStateEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

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

Parameters:

id (str) – The ID of the Parameter Provider (required)
request_id (str) – The ID of the Verification Request (required)

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

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

Parameters:

id (str) – The ID of the Parameter Provider (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_parameter_provider(id, **kwargs)[source]

Deletes a parameter provider. 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_parameter_provider_with_http_info() method instead.

Parameters:

id (str) – The parameter provider 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:

ParameterProviderEntity

remove_parameter_provider_with_http_info(id, **kwargs)[source]

Deletes a parameter provider. 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_parameter_provider() method instead.

Parameters:

id (str) – The parameter provider 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:

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

Return type:

tuple

submit_apply_parameters(body, provider_id, **kwargs)[source]

Initiate a request to apply the fetched parameters of a Parameter Provider.

This will initiate the process of applying fetched parameters to all referencing Parameter Contexts. 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 ParameterProviderApplyParametersRequestEntity, 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-providers/apply-parameters-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-providers/apply-parameters-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_apply_parameters_with_http_info() method instead.

Parameters:

body (ParameterProviderParameterApplicationEntity) – The apply parameters request. (required)
provider_id (str) – (required)

Returns:

The response data.

Return type:

ParameterProviderApplyParametersRequestEntity

submit_apply_parameters_with_http_info(body, provider_id, **kwargs)[source]

Initiate a request to apply the fetched parameters of a Parameter Provider.

This will initiate the process of applying fetched parameters to all referencing Parameter Contexts. 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 ParameterProviderApplyParametersRequestEntity, 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-providers/apply-parameters-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-providers/apply-parameters-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_apply_parameters() method instead.

Parameters:

body (ParameterProviderParameterApplicationEntity) – The apply parameters request. (required)
provider_id (str) – (required)

Returns:

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

Return type:

tuple

submit_config_verification_request1(body, id, **kwargs)[source]

Performs verification of the Parameter Provider’s configuration.

This will initiate the process of verifying a given Parameter Provider configuration. This may be a long-running task. As a result, this endpoint will immediately return a ParameterProviderConfigVerificationRequestEntity, 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 /parameter-providers/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-providers/{providerId}/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_request1_with_http_info() method instead.

Parameters:

body (VerifyConfigRequestEntity) – The parameter provider configuration verification request. (required)
id (str) – The parameter provider id. (required)

Returns:

The response data.

Return type:

VerifyConfigRequestEntity

submit_config_verification_request1_with_http_info(body, id, **kwargs)[source]

Performs verification of the Parameter Provider’s configuration.

This will initiate the process of verifying a given Parameter Provider configuration. This may be a long-running task. As a result, this endpoint will immediately return a ParameterProviderConfigVerificationRequestEntity, 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 /parameter-providers/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-providers/{providerId}/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_request1() method instead.

Parameters:

body (VerifyConfigRequestEntity) – The parameter provider configuration verification request. (required)
id (str) – The parameter provider id. (required)

Returns:

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

Return type:

tuple

update_parameter_provider(body, id, **kwargs)[source]

Updates a parameter provider. 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_provider_with_http_info() method instead.

Parameters:

body (ParameterProviderEntity) – The parameter provider configuration details. (required)
id (str) – The parameter provider id. (required)

Returns:

The response data.

Return type:

ParameterProviderEntity

update_parameter_provider_with_http_info(body, id, **kwargs)[source]

Updates a parameter provider. 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_provider() method instead.

Parameters:

body (ParameterProviderEntity) – The parameter provider configuration details. (required)
id (str) – The parameter provider id. (required)

Returns:

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

Return type:

tuple