update_job: Modifies a job with given parameter

Description Usage Arguments Details

View source: R/jobs.R

Description

The function will mofidy a stored job with the given parameter. The dot parameter will contain all the values that shall be replaced or removed. Shows a message of result or failure.

Usage

1
2
3
4
5
6
7
8
9
update_job(
  id,
  title = NULL,
  description = NULL,
  process = NULL,
  plan = NULL,
  budget = NULL,
  con = NULL
)

Arguments

id

the job id of a created job

title

update title for the job

description

update description

process

A Graph, a function returning a ProcessNode as an endpoint, the ProcessNode will return the results or a self defined Process

plan

replaces plan with the set value

budget

replaces or sets the credits that can be spent at maximum

con

connected and authenticated openeo client (optional) otherwise active_connection is used.

Details

The '...' operator shall contain all the values that are to be replaced in the job. There are some reserved keys. 'process_graph' will replace the process graph with a newly defined one, therefore the process graph needs to be a Graph object. 'format' will change the desired output format. All other parameter will be assumed to be special output parameter. Remember, you don't need to specify a process graph or graph_id, e.g. if you just want to update the output format. To leave parameter unchanged, then don't mention it. If you want to delete some, then set them to NA.


flahn/openeo-r-client documentation built on Sept. 18, 2020, 5:16 a.m.