Parameter: Parameter class
In flahn/openeo-r-client: openEO client interface

Description Details Value Methods Arguments

This class defines parameters of Process. They store information about the type, format and the pattern. Those classes are designed to not carry any value, because if the would it would be a Argument.

The parameters are parsed from the specific description and format of the JSON objects returned for the parameters in processes. Find a list of openEO specific formats here: https://open-eo.github.io/openeo-api/processes/#openeo-specific-formats

Object of R6Class which represents a parameter.

$new(name, description,required=FALSE)
$getName: returns the name of a parameter as string
$setName(name): sets the name of a parameter
$getDescription(): returns the description of a parameter
$setDescription(description): sets the description of a parameter
$getPattern(): returns a string with the pattern of a parameter description
$setPattern(pattern): sets the pattern (string) for a parameter
$getDefault(): returns the parameters default value
$setDefault(default): sets the default value of a parameter
$matchesSchema(schema): returns TRUE if the given schema - a list of the parsed openEO API schema object - matches this parameters schema, which is used for finding the corresponding parameter
$getSchema(): returns the schema definition
$asParameterInfo(): returns a list representation of this parameter for being sent in a JSON to the openEO service
$isNullable(): returns TRUE if the parameter is allowed to be nullable, FALSE otherwise
$isRequired(): return whether a parameter is mandatory or not
$isAny(): return TRUE if this parameter describes a choice of parameters

name: character - The name of a parameter
description: character - The description of a parameter
required: logical - whether or not
pattern: the regexp as a string how to formulate the value
default: the regexp as a string how to formulate the value
schema: the parsed schema object of a process parameter as a list