JobManagementApi

fireblocks_sdk::apis::job_management_api

Trait JobManagementApi 

Source 
pub trait JobManagementApi: Send + Sync {
    // Required methods
    fn cancel_job<'life0, 'async_trait>(
        &'life0 self,
        params: CancelJobParams,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<CancelJobError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn continue_job<'life0, 'async_trait>(
        &'life0 self,
        params: ContinueJobParams,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<ContinueJobError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_job<'life0, 'async_trait>(
        &'life0 self,
        params: GetJobParams,
    ) -> Pin<Box<dyn Future<Output = Result<Job, Error<GetJobError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_job_tasks<'life0, 'async_trait>(
        &'life0 self,
        params: GetJobTasksParams,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Task>, Error<GetJobTasksError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_jobs<'life0, 'async_trait>(
        &'life0 self,
        params: GetJobsParams,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Job>, Error<GetJobsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn pause_job<'life0, 'async_trait>(
        &'life0 self,
        params: PauseJobParams,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<PauseJobError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
}

Required Methods§

Source

fn cancel_job<'life0, 'async_trait>( &'life0 self, params: CancelJobParams, ) -> Pin<Box<dyn Future<Output = Result<(), Error<CancelJobError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /batch/{jobId}/cancel

Stop the given job immediately. If the job is in the ‘Active’ state, the job will be canceled after completing the current task. Vault accounts and Wallets that are already created will not be affected.

Source

fn continue_job<'life0, 'async_trait>( &'life0 self, params: ContinueJobParams, ) -> Pin<Box<dyn Future<Output = Result<(), Error<ContinueJobError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /batch/{jobId}/continue

Continue the given paused job.

Source

fn get_job<'life0, 'async_trait>( &'life0 self, params: GetJobParams, ) -> Pin<Box<dyn Future<Output = Result<Job, Error<GetJobError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /batch/{jobId}

Get an object describing the given job

Source

fn get_job_tasks<'life0, 'async_trait>( &'life0 self, params: GetJobTasksParams, ) -> Pin<Box<dyn Future<Output = Result<Vec<Task>, Error<GetJobTasksError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /batch/{jobId}/tasks

Return a list of tasks for given job

Source

fn get_jobs<'life0, 'async_trait>( &'life0 self, params: GetJobsParams, ) -> Pin<Box<dyn Future<Output = Result<Vec<Job>, Error<GetJobsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /batch/jobs

Get an array of objects including all active, paused, canceled, and complete jobs in a workspace.

Source

fn pause_job<'life0, 'async_trait>( &'life0 self, params: PauseJobParams, ) -> Pin<Box<dyn Future<Output = Result<(), Error<PauseJobError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /batch/{jobId}/pause

Pause the given job, after the current task is done. A paused job can later be resumed by calling ‘continue’, or canceled.

Implementors§