Skip to main content

TaskApiService

Struct TaskApiService 

Source
pub struct TaskApiService<H> { /* private fields */ }
Expand description

Generated TaskService implementation over an ApiHandler.

This is the lower-level service implementation. It converts protobuf values and records optional metrics. Use GrpcApi to also install message limits and authentication.

§See Also

  • GrpcApi builds the configured public service.
  • ApiError defines gRPC error mapping.

Implementations§

Source§

impl<H> TaskApiService<H>
where H: ApiHandler,

Source

pub fn new(handler: Arc<H>) -> Self

Creates a service with the no-op metrics backend.

Source

pub fn new_with_metrics(handler: Arc<H>, metrics: ApiMetricsHandle) -> Self

Creates a service with an explicit metrics backend.

Trait Implementations§

Source§

impl<H> TaskService for TaskApiService<H>
where H: ApiHandler,

Source§

type WatchTasksStream = Pin<Box<dyn Stream<Item = Result<WatchTasksResponse, Status>> + Send>>

Server-streaming Task collection watch.

Source§

type StreamTaskLogsStream = Pin<Box<dyn Stream<Item = Result<StreamTaskLogsResponse, Status>> + Send>>

Server-streaming RPC.

Source§

fn create_task<'life0, 'async_trait>( &'life0 self, request: Request<CreateTaskRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<CreateTaskResponse>, Status>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Create a named Task resource.
Source§

fn apply_task<'life0, 'async_trait>( &'life0 self, request: Request<ApplyTaskRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<ApplyTaskResponse>, Status>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Declaratively create or update one named Task resource.
Source§

fn get_task<'life0, 'async_trait>( &'life0 self, request: Request<GetTaskRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<GetTaskResponse>, Status>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Get one Task resource.
Source§

fn list_tasks<'life0, 'async_trait>( &'life0 self, request: Request<ListTasksRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<ListTasksResponse>, Status>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

List tasks with optional filters and pagination.
Source§

fn watch_tasks<'life0, 'async_trait>( &'life0 self, request: Request<WatchTasksRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<Self::WatchTasksStream>, Status>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Watch task collection changes.
Source§

fn list_task_runs<'life0, 'async_trait>( &'life0 self, request: Request<ListTaskRunsRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<ListTaskRunsResponse>, Status>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

List the attempt history of one task.
Source§

fn delete_task<'life0, 'async_trait>( &'life0 self, request: Request<DeleteTaskRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<DeleteTaskResponse>, Status>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Stop a task and purge its history.
Source§

fn stream_task_logs<'life0, 'async_trait>( &'life0 self, request: Request<StreamTaskLogsRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<Self::StreamTaskLogsStream>, Status>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Live-tail stdout/stderr events for a task.

Auto Trait Implementations§

§

impl<H> !RefUnwindSafe for TaskApiService<H>

§

impl<H> !UnwindSafe for TaskApiService<H>

§

impl<H> Freeze for TaskApiService<H>

§

impl<H> Send for TaskApiService<H>
where H: Sync + Send,

§

impl<H> Sync for TaskApiService<H>
where H: Sync + Send,

§

impl<H> Unpin for TaskApiService<H>

§

impl<H> UnsafeUnpin for TaskApiService<H>

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> IntoApi for T

Source§

fn into_api<A>(self) -> UseApi<T, A>
where T: Sized,

into UseApi
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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