Parameter class — Parameter • openeo

This class defines parameters of Process(). They store information about the type, format and pattern. A parameter class is designed to not carry any value, as opposed to an Argument().

Value

Object of R6Class() which represents a parameter.

Details

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: RFC7946

Methods

$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 parameter's 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 the parameter's 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(): returns whether a parameter is mandatory or not
$isAny(): returns TRUE if this parameter describes a choice of parameters

Arguments

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