Skip to main content

ParameterContexts

nifi_rust_client::dynamic::api::parametercontexts

Struct ParameterContexts 

Source 
pub struct ParameterContexts<'a> { /* private fields */ }

Implementations§

Source§

impl<'a> ParameterContexts<'a>

Source

pub async fn get_assets( &self, context_id: &str, ) -> Result<AssetsEntity, NifiError>

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

Calls GET /nifi-api/parameter-contexts/{contextId}/assets.

§Parameters
  • context_id: The ID of the Parameter Context
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /parameter-contexts/{id}.

Source

pub async fn get_asset_content( &self, context_id: &str, asset_id: &str, ) -> Result<Vec<u8>, NifiError>

Retrieves the content of the asset with the given id

Calls GET /nifi-api/parameter-contexts/{contextId}/assets/{assetId}.

§Parameters
  • context_id: The ID of the Parameter Context
  • asset_id: The ID of the Asset
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /parameter-contexts/{id}.

Source

pub async fn get_asset_content_stream( &self, context_id: &str, asset_id: &str, ) -> Result<BytesStream, NifiError>

Streaming variant: yields body chunks as they arrive instead of buffering the whole response.

Retrieves the content of the asset with the given id

Calls GET /nifi-api/parameter-contexts/{contextId}/assets/{assetId}.

§Parameters
  • context_id: The ID of the Parameter Context
  • asset_id: The ID of the Asset
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /parameter-contexts/{id}.

Source

pub async fn get_parameter_context_update( &self, context_id: &str, request_id: &str, ) -> Result<ParameterContextUpdateRequestEntity, NifiError>

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.

Calls GET /nifi-api/parameter-contexts/{contextId}/update-requests/{requestId}.

§Parameters
  • context_id: The ID of the Parameter Context
  • request_id: The ID of the Update Request
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Only the user that submitted the request can get it.

Source

pub async fn get_validation_request( &self, context_id: &str, id: &str, ) -> Result<ParameterContextValidationRequestEntity, NifiError>

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.

Calls GET /nifi-api/parameter-contexts/{contextId}/validation-requests/{id}.

§Parameters
  • context_id: The ID of the Parameter Context
  • id: The ID of the Validation Request
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Only the user that submitted the request can get it.

Source

pub async fn get_parameter_context( &self, id: &str, include_inherited_parameters: Option<bool>, ) -> Result<ParameterContextEntity, NifiError>

Returns the Parameter Context with the given ID

Returns the Parameter Context with the given ID.

Calls GET /nifi-api/parameter-contexts/{id}.

§Parameters
  • id: The ID of the Parameter Context
  • include_inherited_parameters: 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.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /parameter-contexts/{id}.

Source

pub async fn create_parameter_context( &self, body: &ParameterContextEntity, ) -> Result<ParameterContextEntity, NifiError>

Create a Parameter Context

Calls POST /nifi-api/parameter-contexts.

§Parameters
  • body: The Parameter Context.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions
  • Write - /parameter-contexts
  • Read - for every inherited parameter context
Source

pub async fn create_asset( &self, context_id: &str, filename: Option<&str>, data: Vec<u8>, ) -> Result<AssetDto, NifiError>

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.

Calls POST /nifi-api/parameter-contexts/{contextId}/assets.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions
  • Read - /parameter-contexts/{parameterContextId}
  • Write - /parameter-contexts/{parameterContextId}
  • Read - for every component that is affected by the update
  • Write - for every component that is affected by the update
  • Read - for every currently inherited parameter context
Source

pub async fn submit_parameter_context_update( &self, context_id: &str, body: &ParameterContextEntity, ) -> Result<ParameterContextUpdateRequestEntity, NifiError>

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

Calls POST /nifi-api/parameter-contexts/{contextId}/update-requests.

§Parameters
  • body: The updated version of the parameter context.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions
  • Read - /parameter-contexts/{parameterContextId}
  • Write - /parameter-contexts/{parameterContextId}
  • Read - for every component that is affected by the update
  • Write - for every component that is affected by the update
  • Read - for every currently inherited parameter context
  • Read - for any new inherited parameter context
Source

pub async fn submit_validation_request( &self, context_id: &str, body: &ParameterContextValidationRequestEntity, ) -> Result<ParameterContextValidationRequestEntity, NifiError>

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

Calls POST /nifi-api/parameter-contexts/{contextId}/validation-requests.

§Parameters
  • context_id: The ID of the ParameterContext
  • body: The validation request
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /parameter-contexts/{parameterContextId}.

Source

pub async fn update_parameter_context( &self, id: &str, body: &ParameterContextEntity, ) -> Result<ParameterContextEntity, NifiError>

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.

Calls PUT /nifi-api/parameter-contexts/{id}.

§Parameters
  • body: The updated Parameter Context
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions
  • Read - /parameter-contexts/{id}
  • Write - /parameter-contexts/{id}
Source

pub async fn delete_asset( &self, context_id: &str, asset_id: &str, disconnected_node_acknowledged: Option<bool>, ) -> Result<AssetDto, NifiError>

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.

Calls DELETE /nifi-api/parameter-contexts/{contextId}/assets/{assetId}.

§Parameters
  • context_id: The ID of the Parameter Context
  • asset_id: The ID of the Asset
  • disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions
  • Read - /parameter-contexts/{parameterContextId}
  • Write - /parameter-contexts/{parameterContextId}
  • Read - for every component that is affected by the update
  • Write - for every component that is affected by the update
  • Read - for every currently inherited parameter context
Source

pub async fn delete_update_request( &self, context_id: &str, request_id: &str, disconnected_node_acknowledged: Option<bool>, ) -> Result<ParameterContextUpdateRequestEntity, NifiError>

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.

Calls DELETE /nifi-api/parameter-contexts/{contextId}/update-requests/{requestId}.

§Parameters
  • context_id: The ID of the ParameterContext
  • request_id: The ID of the Update Request
  • disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Only the user that submitted the request can remove it.

Source

pub async fn delete_validation_request( &self, context_id: &str, id: &str, disconnected_node_acknowledged: Option<bool>, ) -> Result<ParameterContextValidationRequestEntity, NifiError>

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.

Calls DELETE /nifi-api/parameter-contexts/{contextId}/validation-requests/{id}.

§Parameters
  • context_id: The ID of the Parameter Context
  • id: The ID of the Update Request
  • disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Only the user that submitted the request can remove it.

Source

pub async fn delete_parameter_context( &self, id: &str, version: Option<&str>, client_id: Option<&str>, disconnected_node_acknowledged: Option<bool>, ) -> Result<ParameterContextEntity, NifiError>

Deletes the Parameter Context with the given ID

Deletes the Parameter Context with the given ID.

Calls DELETE /nifi-api/parameter-contexts/{id}.

§Parameters
  • id: The Parameter Context ID.
  • version: The version is used to verify the client is working with the latest version of the flow.
  • client_id: 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: Acknowledges that this node is disconnected to allow for mutable requests to proceed.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions
  • Read - /parameter-contexts/{uuid}
  • Write - /parameter-contexts/{uuid}
  • Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context
  • Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context

Auto Trait Implementations§

§

impl<'a> Freeze for ParameterContexts<'a>

§

impl<'a> !RefUnwindSafe for ParameterContexts<'a>

§

impl<'a> Send for ParameterContexts<'a>

§

impl<'a> Sync for ParameterContexts<'a>

§

impl<'a> Unpin for ParameterContexts<'a>

§

impl<'a> UnsafeUnpin for ParameterContexts<'a>

§

impl<'a> !UnwindSafe for ParameterContexts<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more