it.agilelab.bigdata.nifi.client.api
ParameterContextsApi
Related Docs:
object ParameterContextsApi
| package api
it.agilelab.bigdata.nifi.client.api
Expected answers: code 200 : ParameterContextEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.
Expected answers: code 200 : ParameterContextEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)
The Parameter Context.
Deletes the Parameter Context with the given ID.
Deletes the Parameter Context with the given ID.
Expected answers: code 200 : ParameterContextEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)
The Parameter Context ID.
The version is used to verify the client is working with the latest version of the flow.
If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.
Acknowledges that this node is disconnected to allow for mutable requests to proceed.
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.
Expected answers: code 200 : ParameterContextUpdateRequestEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)
The ID of the ParameterContext
The ID of the Update Request
Acknowledges that this node is disconnected to allow for mutable requests to proceed.
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.
Expected answers: code 200 : ParameterContextValidationRequestEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)
The ID of the Parameter Context
The ID of the Update Request
Acknowledges that this node is disconnected to allow for mutable requests to proceed.
Returns the Parameter Context with the given ID.
Returns the Parameter Context with the given ID.
Expected answers: code 200 : ParameterContextEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)
The ID of the Parameter Context
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.
Expected answers: code 200 : ParameterContextUpdateRequestEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)
The ID of the Parameter Context
The ID of the Update Request
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.
Expected answers: code 200 : ParameterContextValidationRequestEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)
The ID of the Parameter Context
The ID of the Validation Request
This will initiate the process of updating 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 acttion 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}.
Expected answers: code 200 : ParameterContextUpdateRequestEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)
The updated version of the parameter context.
This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context.
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}.
Expected answers: code 200 : ParameterContextValidationRequestEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)
The validation request
This endpoint will update a Parameter Context to match the provided entity.
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.
Expected answers: code 200 : ParameterContextEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)
The updated Parameter Context