Struct nakadion::api::ApiClient

pub struct ApiClient { /* fields omitted */ }

A client to connect to the API of Nakadi.

The actual HTTP client is pluggable via the DispatchHttpRequest trait.

The ApiClient does retries with exponential backoff and jitter except for the following trait methods:

• SubscriptionApi::request_stream
• SubscriptionApi::commit_cursors
• PublishApi::publish_events_batch

on_retry

A closure to be called before a retry. The error which caused the retry and the time until the retry will be made is passed. This closure overrides the current one and will be used for all subsequent clones of this instance. This allows users to give context on the call site.

Implementations

impl ApiClient

pub fn builder() -> Builder

👎 Deprecated since 0.28.12:

misleading name. builder is just the empty defaulte. use default_builder

pub fn default_builder() -> Builder

Get a default builder

There are also methods to get a Builder which is initialized from the environment:

• Builder::builder_from_env
• Builder::builder_from_env_prefixed

pub fn builder_from_env_prefixed<T: AsRef<str>>(
    prefix: T
) -> Result<Builder, Error>

Get a builde filled from the environment

Values are filled from prefixed environment variables

pub fn builder_from_env() -> Result<Builder, Error>

Get a builde filled from the environment

Values must be prefixed with NAKADION

pub fn set_on_retry<F: Fn(&NakadiApiError, Duration) + Send + Sync + 'static>(
    &mut self,
    on_retry: F
)

pub fn on_retry<F: Fn(&NakadiApiError, Duration) + Send + Sync + 'static>(
    mut self: Self,
    on_retry: F
) -> Self

Trait Implementations

impl Clone for ApiClient

pub fn clone(&self) -> ApiClient

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApiClient

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

Formats the value using the given formatter.

impl MonitoringApi for ApiClient

pub fn get_cursor_distances<T: Into<FlowId>>(
    &self,
    name: &EventTypeName,
    query: &[CursorDistanceQuery],
    flow_id: T
) -> ApiFuture<'_, Vec<CursorDistanceResult>>

Deletes an EventType identified by its name.

pub fn get_cursor_lag<T: Into<FlowId>>(
    &self,
    name: &EventTypeName,
    cursors: &[Cursor],
    flow_id: T
) -> ApiFuture<'_, Vec<Partition>>

Used when a consumer wants to know how far behind in the stream its application is lagging.

pub fn get_event_type_partitions<T: Into<FlowId>>(
    &self,
    event_type: &EventTypeName,
    flow_id: T
) -> ApiFuture<'_, Vec<Partition>>

Lists the Partitions for the given event-type.

impl PublishApi for ApiClient

pub fn publish_events_batch<'a, B: Into<Bytes>, T: Into<FlowId>>(
    &'a self,
    event_type: &'a EventTypeName,
    events: B,
    flow_id: T
) -> PublishFuture<'a>

Publishes a batch of Events of this EventType. All items must be of the EventType identified by name.

impl SchemaRegistryApi for ApiClient

pub fn list_event_types<T: Into<FlowId>>(
    &self,
    flow_id: T
) -> ApiFuture<'_, Vec<EventType>>

Returns a list of all registered EventTypes

See also Nakadi Manual

pub fn create_event_type<T: Into<FlowId>>(
    &self,
    event_type: &EventTypeInput,
    flow_id: T
) -> ApiFuture<'_, ()>

Creates a new EventType.

See also Nakadi Manual

pub fn get_event_type<T: Into<FlowId>>(
    &self,
    name: &EventTypeName,
    flow_id: T
) -> ApiFuture<'_, EventType>

Returns the EventType identified by its name.

pub fn update_event_type<T: Into<FlowId>>(
    &self,
    name: &EventTypeName,
    event_type: &EventType,
    flow_id: T
) -> ApiFuture<'_, ()>

Updates the EventType identified by its name.

pub fn delete_event_type<T: Into<FlowId>>(
    &self,
    name: &EventTypeName,
    flow_id: T
) -> ApiFuture<'_, ()>

Deletes an EventType identified by its name.

See also Nakadi Manual

impl SubscriptionApi for ApiClient

pub fn create_subscription<T: Into<FlowId>>(
    &self,
    input: &SubscriptionInput,
    flow_id: T
) -> ApiFuture<'_, Subscription>

This endpoint creates a subscription for EventTypes.

See also Nakadi Manual

pub fn get_subscription<T: Into<FlowId>>(
    &self,
    id: SubscriptionId,
    flow_id: T
) -> ApiFuture<'_, Subscription>

Returns a subscription identified by id.

See also Nakadi Manual

pub fn list_subscriptions<T: Into<FlowId>>(
    &self,
    event_type: Option<&EventTypeName>,
    owning_application: Option<&OwningApplication>,
    limit: Option<usize>,
    offset: Option<usize>,
    show_status: bool,
    flow_id: T
) -> BoxStream<'static, Result<Subscription, NakadiApiError>>

Lists all subscriptions that exist in a system.

pub fn update_auth<T: Into<FlowId>>(
    &self,
    input: &SubscriptionInput,
    flow_id: T
) -> ApiFuture<'_, ()>

This endpoint only allows to update the authorization section of a subscription.

All other properties are immutable. This operation is restricted to subjects with administrative role. This call captures the timestamp of the update request.

See also Nakadi Manual

pub fn delete_subscription<T: Into<FlowId>>(
    &self,
    id: SubscriptionId,
    flow_id: T
) -> ApiFuture<'_, ()>

Deletes a subscription.

See also Nakadi Manual

pub fn get_subscription_cursors<T: Into<FlowId>>(
    &self,
    id: SubscriptionId,
    flow_id: T
) -> ApiFuture<'_, Vec<SubscriptionCursor>>

Exposes the currently committed offsets of a subscription.

See also Nakadi Manual

pub fn get_subscription_stats<T: Into<FlowId>>(
    &self,
    id: SubscriptionId,
    show_time_lag: bool,
    flow_id: T
) -> ApiFuture<'_, SubscriptionStats>

Exposes statistics of specified subscription.

pub fn reset_subscription_cursors<T: Into<FlowId>>(
    &self,
    id: SubscriptionId,
    cursors: &[EventTypeCursor],
    flow_id: T
) -> ApiFuture<'_, ()>

Reset subscription offsets to specified values.

See also Nakadi Manual

impl SubscriptionCommitApi for ApiClient

pub fn commit_cursors<T: Into<FlowId>>(
    &self,
    id: SubscriptionId,
    stream: StreamId,
    cursors: &[SubscriptionCursor],
    flow_id: T
) -> ApiFuture<'_, CursorCommitResults>

Endpoint for committing offsets of the subscription.

impl SubscriptionStreamApi for ApiClient

pub fn request_stream<'a, T: Into<FlowId>>(
    &'a self,
    subscription_id: SubscriptionId,
    parameters: &StreamParameters,
    flow_id: T
) -> ApiFuture<'a, SubscriptionStreamChunks>

Starts a new stream for reading events from this subscription.