Skip to main content

DynamicClient

Struct DynamicClient 

Source
pub struct DynamicClient { /* private fields */ }
Expand description

DynamicClient — the new canonical dispatch path. Reachable only via the #[doc(hidden)] dynamic re-export in Phase 4a.

Implementations§

Source§

impl DynamicClient

Source

pub fn access(&self) -> Access<'_>

Access the Access API (canonical dynamic).

Source

pub fn authentication(&self) -> Authentication<'_>

Access the Authentication API (canonical dynamic).

Source

pub fn connections(&self) -> Connections<'_>

Access the Connections API (canonical dynamic).

Source

pub fn connectors(&self) -> Connectors<'_>

Access the Connectors API (canonical dynamic).

Source

pub fn controller(&self) -> Controller<'_>

Access the Controller API (canonical dynamic).

Source

pub fn controller_services(&self) -> ControllerServices<'_>

Access the Controller Services API (canonical dynamic).

Source

pub fn counters(&self) -> Counters<'_>

Access the Counters API (canonical dynamic).

Source

pub fn datatransfer(&self) -> DataTransfer<'_>

Access the DataTransfer API (canonical dynamic).

Source

pub fn flow(&self) -> Flow<'_>

Access the Flow API (canonical dynamic).

Source

pub fn flowfilequeues(&self) -> FlowFileQueues<'_>

Access the FlowFileQueues API (canonical dynamic).

Source

pub fn funnels(&self) -> Funnels<'_>

Access the Funnels API (canonical dynamic).

Source

pub fn inputports(&self) -> InputPorts<'_>

Access the InputPorts API (canonical dynamic).

Source

pub fn labels(&self) -> Labels<'_>

Access the Labels API (canonical dynamic).

Source

pub fn outputports(&self) -> OutputPorts<'_>

Access the OutputPorts API (canonical dynamic).

Source

pub fn parametercontexts(&self) -> ParameterContexts<'_>

Access the ParameterContexts API (canonical dynamic).

Source

pub fn parameterproviders(&self) -> ParameterProviders<'_>

Access the ParameterProviders API (canonical dynamic).

Source

pub fn policies(&self) -> Policies<'_>

Access the Policies API (canonical dynamic).

Source

pub fn processgroups(&self) -> ProcessGroups<'_>

Access the ProcessGroups API (canonical dynamic).

Source

pub fn processors(&self) -> Processors<'_>

Access the Processors API (canonical dynamic).

Source

pub fn provenance(&self) -> Provenance<'_>

Access the Provenance API (canonical dynamic).

Source

pub fn provenanceevents(&self) -> ProvenanceEvents<'_>

Access the ProvenanceEvents API (canonical dynamic).

Source

pub fn remoteprocessgroups(&self) -> RemoteProcessGroups<'_>

Access the RemoteProcessGroups API (canonical dynamic).

Source

pub fn reportingtasks(&self) -> ReportingTasks<'_>

Access the ReportingTasks API (canonical dynamic).

Source

pub fn resources(&self) -> Resources<'_>

Access the Resources API (canonical dynamic).

Source

pub fn sitetosite(&self) -> SiteToSite<'_>

Access the SiteToSite API (canonical dynamic).

Source

pub fn snippets(&self) -> Snippets<'_>

Access the Snippets API (canonical dynamic).

Source

pub fn systemdiagnostics(&self) -> SystemDiagnostics<'_>

Access the SystemDiagnostics API (canonical dynamic).

Source

pub fn tenants(&self) -> Tenants<'_>

Access the Tenants API (canonical dynamic).

Source

pub fn versions(&self) -> Versions<'_>

Access the Versions API (canonical dynamic).

Source§

impl DynamicClient

Source

pub fn new(client: NifiClient) -> Self

Wrap a NifiClient. Uses the default VersionResolutionStrategy. Version detection happens lazily on the first call to a method that consults require_endpoint.

Source

pub fn with_strategy( client: NifiClient, strategy: VersionResolutionStrategy, ) -> Self

Wrap a NifiClient with a specific VersionResolutionStrategy.

Source

pub async fn from_client(client: NifiClient) -> Result<Self, NifiError>

Async constructor that eagerly detects the version and discovers cluster topology. Mirrors the legacy DynamicClient::from_client.

Source

pub fn inner(&self) -> &NifiClient

Underlying NifiClient used by generated methods to issue HTTP requests.

Source

pub fn strategy(&self) -> VersionResolutionStrategy

The configured VersionResolutionStrategy.

Source

pub async fn login( &self, username: &str, password: &str, ) -> Result<(), NifiError>

Authenticate and detect the server version. Mirrors the legacy DynamicClient::login.

Source

pub async fn logout(&self) -> Result<(), NifiError>

Log out the current session.

Source

pub async fn token(&self) -> Option<String>

Return the current bearer token, if any.

Useful for persisting the token between process restarts. See NifiClient::token for details.

Source

pub async fn set_token(&self, token: String)

Restore a previously obtained bearer token.

See NifiClient::set_token for details.

Source

pub async fn authenticate(&self) -> Result<(), NifiError>

Re-authenticate using the configured AuthProvider.

See NifiClient::authenticate for details.

Source

pub async fn detect_version(&self) -> Result<DetectedVersion, NifiError>

Detect the NiFi server version via GET /flow/about. Idempotent — subsequent calls return the cached result. Honors the configured VersionResolutionStrategy.

Source

pub fn detected_version(&self) -> Option<DetectedVersion>

Currently-detected version, or None if detect_version has not yet completed successfully.

Source

pub fn detected_version_str(&self) -> String

Currently-detected version string, or an empty string if detect_version has not yet completed. Returned as an owned String so the generated URL-building code can pass it by value into the UnsupportedQueryParam error constructor without cloning.

Source

pub fn cluster_node_id(&self) -> Option<&str>

The cluster node ID of the connected (primary) node, if this NiFi instance is part of a cluster. None for standalone instances or if cluster discovery has not yet been performed.

Source

pub async fn require_endpoint( &self, endpoint: Endpoint, ) -> Result<(), NifiError>

Returns Ok(()) if endpoint is supported by the currently-detected server version. Detects the version lazily if not yet done.

Source

pub fn supports(&self, endpoint: Endpoint) -> bool

Synchronous variant: returns true if endpoint is supported by the currently-detected version. Returns false if no version has been detected yet (callers should detect_version().await first).

Trait Implementations§

Source§

impl Debug for DynamicClient

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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