JobsApi: Agave Jobs API operations

Description Usage Format Details Arguments Methods See Also

Description

JobsApi Class

Usage

1
jobs <- JobsApi$new( apiClient = ApiClient$new(), cache = AgaveCache$new() )

Format

An object of class R6ClassGenerator of length 24.

Details

The Jobs service is a basic execution service that allows you to run applications registered with the Apps service across multiple, distributed, heterogeneous systems through a common REST interface. The service manages all aspects of execution and job management from data staging, job submission, monitoring, output archiving, event logging, sharing, and notifications. The Jobs service also provides a persistent reference to your job’s output data and a mechanism for sharing all aspects of your job with others. Each feature will be described in more detail below.

Read more about the Jobs API in the Agave Developer's Guide

Arguments

apiClient a rAgave::ApiClient instance preconfigured to speak to the Agave Platform.

cache an rAgave::AgaveCache instance pointing to the persistent auth cache file on disk.

responseType the default object type methods of this class should return. Valid values are:

Methods

$addJobPermission() Add a user permission for the given job.

Usage

1
jobs$addJobPermission$listJobs(jobId, body, naked, )

$clearJobPermissions() Deletes all permissions on an job.

Usage

1
jobs$clearJobPermissions$listJobs(jobId, naked, )

$deleteJob() Deletes a job from history of the user

Usage

1
jobs$deleteJob$listJobs(jobId, naked, )

$deleteJobPermission() Deletes all permissions for the given user on an job.

Usage

1
jobs$deleteJobPermission$listJobs(jobId, username, naked, )

$downloadJobOutput() Download an output file from a specific job.

Usage

1
2
jobs$downloadJobOutput$listJobs(jobId, filePath, force, search, )
jobs$downloadJobOutput$listJobs(search=list("foo"="bar"))

$getJobDetails() Get details of the job with the specific job id.

Usage

1
2
jobs$getJobDetails$listJobs(jobId, naked, search, )
jobs$getJobDetails$listJobs(search=list("foo"="bar"))

$getJobHistory() Get the history of this job.

Usage

1
2
jobs$getJobHistory$listJobs(jobId, naked, limit, offset, search, )
jobs$getJobHistory$listJobs(search=list("foo"="bar"))

$getJobPermission() Get a specific user permission for a job.

Usage

1
jobs$getJobPermission$listJobs(jobId, username, naked, )

$getJobStatus() Get the status of the job.

Usage

1
2
jobs$getJobStatus$listJobs(jobId, naked, search, )
jobs$getJobStatus$listJobs(search=list("foo"="bar"))

$listJobOutputs() List the output folder for a job.

Usage

1
2
jobs$listJobOutputs$listJobs(jobId, filePath, naked, limit, offset, search, )
jobs$listJobOutputs$listJobs(search=list("foo"="bar"))

$listJobPermissions() Get the permissions granted for this job.

Usage

1
2
jobs$listJobPermissions$listJobs(jobId, naked, limit, offset, search, )
jobs$listJobPermissions$listJobs(search=list("foo"="bar"))

$listJobs() Get a list of jobs the authenticated user had submitted.

Usage

1
2
jobs$listJobs$listJobs(naked, appId, archive, archivePath, archiveSystem, batchQueue, executionSystem, id, inputs, localId, maxRuntime, memoryPerNode, name, nodeCount, outputPath, parameters, processorsPerNode, retries, startTime, status, submitTime, visible, limit, offset, search, )
jobs$listJobs$listJobs(search=list("foo"="bar"))

$resubmitJob() Resubmits the job with the given job id as a new job with a unique id.

Usage

1
jobs$resubmitJob$listJobs(jobId, body, naked, )

$submitJob() Submit a new job request.

Usage

1
jobs$submitJob$listJobs(body, naked, )

$updateJobPermission() Update a user permission for the given job and username

Usage

1
jobs$updateJobPermission$listJobs(jobId, username, body, naked, )

See Also

rAgave::ApiClient rAgave::Agave [rAgave::FileInfo][rAgave::Job][rAgave::JobHistory][rAgave::JobRequest][rAgave::JobResubmitAction][rAgave::JobStatusSummary][rAgave::Permission]


agaveplatform/r-sdk documentation built on Sept. 22, 2018, 2:14 p.m.