Struct R3ClientStartJobBuilder

pub struct R3ClientStartJobBuilder<'f1, S: State = Empty> { /* private fields */ }

Use builder syntax to set the inputs and finish with call().

Implementations

impl<'f1, S: State> R3ClientStartJobBuilder<'f1, S>

pub fn call(self) -> Result<Response<ResponseData>, Box<dyn Error>>

where S: IsComplete,

Finishes building and performs the requested action.

pub fn file_id( self, value: String, ) -> R3ClientStartJobBuilder<'f1, SetFileId<S>>

where S::FileId: IsUnset,

Required.

The ID of the script file to run. Note that this needs to be an executable file. Get a list of files using R3Client::get_files().

pub fn device_ids( self, value: Vec<String>, ) -> R3ClientStartJobBuilder<'f1, SetDeviceIds<S>>

where S::DeviceIds: IsUnset,

Required.

The IDs of the devices to run the script on. Get a list of devices using R3Client::get_devices().

pub fn arguments( self, value: Vec<ArgumentInput>, ) -> R3ClientStartJobBuilder<'f1, SetArguments<S>>

where S::Arguments: IsUnset,

Optional (Some / Option setters). Default: <Vec<start_job::ArgumentInput> as Default>::default().

Arguments to pass to the script. These are optional. For more information on script arguments please consult the remote.it API documentation.

pub fn maybe_arguments( self, value: Option<Vec<ArgumentInput>>, ) -> R3ClientStartJobBuilder<'f1, SetArguments<S>>

where S::Arguments: IsUnset,

Optional (Some / Option setters). Default: <Vec<start_job::ArgumentInput> as Default>::default().

Arguments to pass to the script. These are optional. For more information on script arguments please consult the remote.it API documentation.