ParameterprovidersApi

All URIs are relative to http://localhost/nifi-api

Method	HTTP request	Description
analyzeConfiguration	POST /parameter-providers/{id}/config/analysis	Performs analysis of the component's configuration, providing information about which attributes are referenced.
clearState	POST /parameter-providers/{id}/state/clear-requests	Clears the state for a parameter provider
deleteApplyParametersRequest	DELETE /parameter-providers/{providerId}/apply-parameters-requests/{requestId}	Deletes the Apply Parameters Request with the given ID
deleteVerificationRequest	DELETE /parameter-providers/{id}/config/verification-requests/{requestId}	Deletes the Verification Request with the given ID
fetchParameters	POST /parameter-providers/{id}/parameters/fetch-requests	Fetches and temporarily caches the parameters for a provider
getParameterProvider	GET /parameter-providers/{id}	Gets a parameter provider
getParameterProviderApplyParametersRequest	GET /parameter-providers/{providerId}/apply-parameters-requests/{requestId}	Returns the Apply Parameters Request with the given ID
getParameterProviderReferences	GET /parameter-providers/{id}/references	Gets all references to a parameter provider
getPropertyDescriptor	GET /parameter-providers/{id}/descriptors	Gets a parameter provider property descriptor
getState	GET /parameter-providers/{id}/state	Gets the state for a parameter provider
getVerificationRequest	GET /parameter-providers/{id}/config/verification-requests/{requestId}	Returns the Verification Request with the given ID
removeParameterProvider	DELETE /parameter-providers/{id}	Deletes a parameter provider
submitApplyParameters	POST /parameter-providers/{providerId}/apply-parameters-requests	Initiate a request to apply the fetched parameters of a Parameter Provider
submitConfigVerificationRequest	POST /parameter-providers/{id}/config/verification-requests	Performs verification of the Parameter Provider's configuration
updateParameterProvider	PUT /parameter-providers/{id}	Updates a parameter provider

analyzeConfiguration

ConfigurationAnalysisEntity analyzeConfiguration(id, body)

Performs analysis of the component's configuration, providing information about which attributes are referenced.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ParameterprovidersApi;


ParameterprovidersApi apiInstance = new ParameterprovidersApi();
String id = "id_example"; // String | The parameter provider id.
ConfigurationAnalysisEntity body = new ConfigurationAnalysisEntity(); // ConfigurationAnalysisEntity | The configuration analysis request.
try {
    ConfigurationAnalysisEntity result = apiInstance.analyzeConfiguration(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ParameterprovidersApi#analyzeConfiguration");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The parameter provider id.
body	ConfigurationAnalysisEntity	The configuration analysis request.

Return type

ConfigurationAnalysisEntity

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

clearState

ComponentStateEntity clearState(id)

Clears the state for a parameter provider

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ParameterprovidersApi;


ParameterprovidersApi apiInstance = new ParameterprovidersApi();
String id = "id_example"; // String | The parameter provider id.
try {
    ComponentStateEntity result = apiInstance.clearState(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ParameterprovidersApi#clearState");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The parameter provider id.

Return type

ComponentStateEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

deleteApplyParametersRequest

ParameterProviderApplyParametersRequestEntity deleteApplyParametersRequest(providerId, requestId, disconnectedNodeAcknowledged)

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.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ParameterprovidersApi;


ParameterprovidersApi apiInstance = new ParameterprovidersApi();
String providerId = "providerId_example"; // String | The ID of the Parameter Provider
String requestId = "requestId_example"; // String | The ID of the Apply Parameters Request
Boolean disconnectedNodeAcknowledged = false; // Boolean | Acknowledges that this node is disconnected to allow for mutable requests to proceed.
try {
    ParameterProviderApplyParametersRequestEntity result = apiInstance.deleteApplyParametersRequest(providerId, requestId, disconnectedNodeAcknowledged);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ParameterprovidersApi#deleteApplyParametersRequest");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
providerId	String	The ID of the Parameter Provider
requestId	String	The ID of the Apply Parameters Request
disconnectedNodeAcknowledged	Boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.	[optional] [default to false]

Return type

ParameterProviderApplyParametersRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

deleteVerificationRequest

VerifyConfigRequestEntity deleteVerificationRequest(id, requestId)

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.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ParameterprovidersApi;


ParameterprovidersApi apiInstance = new ParameterprovidersApi();
String id = "id_example"; // String | The ID of the Parameter Provider
String requestId = "requestId_example"; // String | The ID of the Verification Request
try {
    VerifyConfigRequestEntity result = apiInstance.deleteVerificationRequest(id, requestId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ParameterprovidersApi#deleteVerificationRequest");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The ID of the Parameter Provider
requestId	String	The ID of the Verification Request

Return type

VerifyConfigRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

fetchParameters

ParameterProviderEntity fetchParameters(id, body)

Fetches and temporarily caches the parameters for a provider

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ParameterprovidersApi;


ParameterprovidersApi apiInstance = new ParameterprovidersApi();
String id = "id_example"; // String | The parameter provider id.
ParameterProviderParameterFetchEntity body = new ParameterProviderParameterFetchEntity(); // ParameterProviderParameterFetchEntity | The parameter fetch request.
try {
    ParameterProviderEntity result = apiInstance.fetchParameters(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ParameterprovidersApi#fetchParameters");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The parameter provider id.
body	ParameterProviderParameterFetchEntity	The parameter fetch request.

Return type

ParameterProviderEntity

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

getParameterProvider

ParameterProviderEntity getParameterProvider(id)

Gets a parameter provider

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ParameterprovidersApi;


ParameterprovidersApi apiInstance = new ParameterprovidersApi();
String id = "id_example"; // String | The parameter provider id.
try {
    ParameterProviderEntity result = apiInstance.getParameterProvider(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ParameterprovidersApi#getParameterProvider");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The parameter provider id.

Return type

ParameterProviderEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getParameterProviderApplyParametersRequest

ParameterProviderApplyParametersRequestEntity getParameterProviderApplyParametersRequest(providerId, requestId)

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.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ParameterprovidersApi;


ParameterprovidersApi apiInstance = new ParameterprovidersApi();
String providerId = "providerId_example"; // String | The ID of the Parameter Provider
String requestId = "requestId_example"; // String | The ID of the Apply Parameters Request
try {
    ParameterProviderApplyParametersRequestEntity result = apiInstance.getParameterProviderApplyParametersRequest(providerId, requestId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ParameterprovidersApi#getParameterProviderApplyParametersRequest");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
providerId	String	The ID of the Parameter Provider
requestId	String	The ID of the Apply Parameters Request

Return type

ParameterProviderApplyParametersRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getParameterProviderReferences

ParameterProviderReferencingComponentsEntity getParameterProviderReferences(id)

Gets all references to a parameter provider

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ParameterprovidersApi;


ParameterprovidersApi apiInstance = new ParameterprovidersApi();
String id = "id_example"; // String | The parameter provider id.
try {
    ParameterProviderReferencingComponentsEntity result = apiInstance.getParameterProviderReferences(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ParameterprovidersApi#getParameterProviderReferences");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The parameter provider id.

Return type

ParameterProviderReferencingComponentsEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getPropertyDescriptor

PropertyDescriptorEntity getPropertyDescriptor(id, propertyName)

Gets a parameter provider property descriptor

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ParameterprovidersApi;


ParameterprovidersApi apiInstance = new ParameterprovidersApi();
String id = "id_example"; // String | The parameter provider id.
String propertyName = "propertyName_example"; // String | The property name.
try {
    PropertyDescriptorEntity result = apiInstance.getPropertyDescriptor(id, propertyName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ParameterprovidersApi#getPropertyDescriptor");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The parameter provider id.
propertyName	String	The property name.

Return type

PropertyDescriptorEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getState

ComponentStateEntity getState(id)

Gets the state for a parameter provider

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ParameterprovidersApi;


ParameterprovidersApi apiInstance = new ParameterprovidersApi();
String id = "id_example"; // String | The parameter provider id.
try {
    ComponentStateEntity result = apiInstance.getState(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ParameterprovidersApi#getState");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The parameter provider id.

Return type

ComponentStateEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getVerificationRequest

VerifyConfigRequestEntity getVerificationRequest(id, requestId)

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.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ParameterprovidersApi;


ParameterprovidersApi apiInstance = new ParameterprovidersApi();
String id = "id_example"; // String | The ID of the Parameter Provider
String requestId = "requestId_example"; // String | The ID of the Verification Request
try {
    VerifyConfigRequestEntity result = apiInstance.getVerificationRequest(id, requestId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ParameterprovidersApi#getVerificationRequest");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The ID of the Parameter Provider
requestId	String	The ID of the Verification Request

Return type

VerifyConfigRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

removeParameterProvider

ParameterProviderEntity removeParameterProvider(id, version, clientId, disconnectedNodeAcknowledged)

Deletes a parameter provider

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ParameterprovidersApi;


ParameterprovidersApi apiInstance = new ParameterprovidersApi();
String id = "id_example"; // String | The parameter provider id.
String version = "version_example"; // String | The revision is used to verify the client is working with the latest version of the flow.
String clientId = "clientId_example"; // String | If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
Boolean disconnectedNodeAcknowledged = false; // Boolean | Acknowledges that this node is disconnected to allow for mutable requests to proceed.
try {
    ParameterProviderEntity result = apiInstance.removeParameterProvider(id, version, clientId, disconnectedNodeAcknowledged);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ParameterprovidersApi#removeParameterProvider");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The parameter provider id.
version	String	The revision is used to verify the client is working with the latest version of the flow.	[optional]
clientId	String	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.	[optional]
disconnectedNodeAcknowledged	Boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.	[optional] [default to false]

Return type

ParameterProviderEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

submitApplyParameters

ParameterProviderApplyParametersRequestEntity submitApplyParameters(providerId, body)

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}.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ParameterprovidersApi;


ParameterprovidersApi apiInstance = new ParameterprovidersApi();
String providerId = "providerId_example"; // String | 
ParameterProviderParameterApplicationEntity body = new ParameterProviderParameterApplicationEntity(); // ParameterProviderParameterApplicationEntity | The apply parameters request.
try {
    ParameterProviderApplyParametersRequestEntity result = apiInstance.submitApplyParameters(providerId, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ParameterprovidersApi#submitApplyParameters");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
providerId	String
body	ParameterProviderParameterApplicationEntity	The apply parameters request.

Return type

ParameterProviderApplyParametersRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

submitConfigVerificationRequest

VerifyConfigRequestEntity submitConfigVerificationRequest(id, body)

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}.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ParameterprovidersApi;


ParameterprovidersApi apiInstance = new ParameterprovidersApi();
String id = "id_example"; // String | The parameter provider id.
VerifyConfigRequestEntity body = new VerifyConfigRequestEntity(); // VerifyConfigRequestEntity | The parameter provider configuration verification request.
try {
    VerifyConfigRequestEntity result = apiInstance.submitConfigVerificationRequest(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ParameterprovidersApi#submitConfigVerificationRequest");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The parameter provider id.
body	VerifyConfigRequestEntity	The parameter provider configuration verification request.

Return type

VerifyConfigRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

updateParameterProvider

ParameterProviderEntity updateParameterProvider(id, body)

Updates a parameter provider

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ParameterprovidersApi;


ParameterprovidersApi apiInstance = new ParameterprovidersApi();
String id = "id_example"; // String | The parameter provider id.
ParameterProviderEntity body = new ParameterProviderEntity(); // ParameterProviderEntity | The parameter provider configuration details.
try {
    ParameterProviderEntity result = apiInstance.updateParameterProvider(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ParameterprovidersApi#updateParameterProvider");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The parameter provider id.
body	ParameterProviderEntity	The parameter provider configuration details.

Return type

ParameterProviderEntity

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

FilesExpand file tree

ParameterprovidersApi.md

Latest commit

History

ParameterprovidersApi.md

File metadata and controls

ParameterprovidersApi

analyzeConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

clearState

Example

Parameters

Return type

Authorization

HTTP request headers

deleteApplyParametersRequest

Example

Parameters

Return type

Authorization

HTTP request headers

deleteVerificationRequest

Example

Parameters

Return type

Authorization

HTTP request headers

fetchParameters

Example

Parameters

Return type

Authorization

HTTP request headers

getParameterProvider

Example

Parameters

Return type

Authorization

HTTP request headers

getParameterProviderApplyParametersRequest

Example

Parameters

Return type

Authorization

HTTP request headers

getParameterProviderReferences

Example

Parameters

Return type

Authorization

HTTP request headers

getPropertyDescriptor

Example

Parameters

Return type

Authorization

HTTP request headers

getState

Example

Parameters

Return type

Authorization

HTTP request headers

getVerificationRequest

Example

Parameters

Return type

Authorization

HTTP request headers

removeParameterProvider

Example

Parameters

Return type

Authorization

HTTP request headers

submitApplyParameters