AutomationHandler

Struct AutomationHandler 

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

Handler for automation operations

Implementations§

Source§

impl AutomationHandler

Source

pub fn new(client: FilesClient) -> Self

Create a new automation handler

Source

pub async fn list( &self, cursor: Option<&str>, per_page: Option<i64>, automation: Option<&str>, ) -> Result<(Vec<AutomationEntity>, PaginationInfo)>

List automations

§Arguments
  • cursor - Pagination cursor
  • per_page - Results per page
  • automation - Filter by automation type
§Returns

Tuple of (automations, pagination_info)

§Example
use files_sdk::{FilesClient, AutomationHandler};

let client = FilesClient::builder().api_key("key").build()?;
let handler = AutomationHandler::new(client);
let (automations, _) = handler.list(None, None, None).await?;
Source

pub async fn get(&self, id: i64) -> Result<AutomationEntity>

Get a specific automation

§Arguments
  • id - Automation ID
Source

pub async fn create( &self, automation: &str, source: Option<&str>, destination: Option<&str>, destinations: Option<Vec<String>>, interval: Option<&str>, path: Option<&str>, trigger: Option<&str>, ) -> Result<AutomationEntity>

Create a new automation

§Arguments
  • automation - Automation type (required)
  • source - Source path/glob
  • destination - Destination path
  • destinations - Destination paths (array)
  • interval - Schedule interval
  • path - Path on which automation runs
  • trigger - Trigger type
§Returns

The created automation

§Example
use files_sdk::{FilesClient, AutomationHandler};

let client = FilesClient::builder().api_key("key").build()?;
let handler = AutomationHandler::new(client);
let automation = handler.create(
    "copy_file",
    Some("/source/*.txt"),
    Some("/destination/"),
    None,
    None,
    Some("/source"),
    Some("action")
).await?;
Source

pub async fn update( &self, id: i64, source: Option<&str>, destination: Option<&str>, interval: Option<&str>, disabled: Option<bool>, ) -> Result<AutomationEntity>

Update an automation

§Arguments
  • id - Automation ID
  • source - Source path/glob
  • destination - Destination path
  • interval - Schedule interval
  • disabled - Disable the automation
§Returns

The updated automation

Source

pub async fn delete(&self, id: i64) -> Result<()>

Delete an automation

§Arguments
  • id - Automation ID
Source

pub async fn manual_run(&self, id: i64) -> Result<Value>

Manually run an automation

§Arguments
  • id - Automation ID
§Returns

The automation run result

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,