Skip to main content

RemoteCoordinatorClient

Struct RemoteCoordinatorClient 

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

HTTP client for Mode 3 — schedule/trigger jobs without local Chronon loops.

Targets the chronon-axum API at {base_url}/api/chronon/* (see API_PREFIX). Pair with a host that mounts chronon_router on a Mode 1 or Mode 2 coordinator process.

MethodHTTP
Self::upsert_jobPOST /jobs/upsert
Self::list_jobsGET /jobs
Self::run_nowPOST /jobs/run_now

Timeout: CHRONON_REMOTE_HTTP_TIMEOUT_MS (default 3000, minimum 100). Base URL helper: resolve_remote_base_url. Optional builder mark: crate::ChrononBuilder::remote_coordinator (DeploymentShape::RemoteClient) so you do not call crate::Chronon::run by mistake.

§Examples

use chronon_core::{Job, ScheduleKind};
use chronon_runtime::{resolve_remote_base_url, RemoteCoordinatorClient};

let base = resolve_remote_base_url()
    .unwrap_or_else(|| "http://127.0.0.1:8080".into());
let client = RemoteCoordinatorClient::new(base);

let mut job = Job::new("remote-job", "nightly_cleanup");
job.schedule_kind = ScheduleKind::Manual;
client.upsert_job(job.clone()).await?;
let _run_id = client.run_now(&job.job_id).await?;
let _jobs = client.list_jobs().await?;

Runnable API mount sketch: cargo run -p uf-chronon --example axum_host --features mem,axum.

Implementations§

Source§

impl RemoteCoordinatorClient

Source

pub fn new(base_url: impl Into<String>) -> Self

Create a client for base_url (trailing slashes stripped).

Timeout from CHRONON_REMOTE_HTTP_TIMEOUT_MS (default 3s).

Source

pub async fn upsert_job(&self, job: Job) -> Result<()>

POST /jobs/upsert with fields from job.

Source

pub async fn list_jobs(&self) -> Result<Vec<JobSummary>>

GET /jobs and return non-sensitive job summaries.

Source

pub async fn run_now(&self, job_id: &str) -> Result<String>

POST /jobs/run_now and return the enqueued run_id.

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: Sized + 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: Sized + 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