OpenEOClient: openEO client class
In Open-EO/openeo-r-client: Client Interface for 'openEO' Servers
OpenEOClient R Documentation
openEO client class
Description
An R6Class that interacts with an openEO compliant back-end.
Fields
user_idThe user_id obtained after authentication
api.mappingThe mapping of the API endpoints and the back-end published ones
Methods
$new(host=NULL)the constructor with an optional host URL to connect to
$getBackendEndpoint(endpoint_name)returns the URL for the requested endpoint tag
$request(tag,parameters=NULL,authorized=FALSE, ...)performs the desired HTTP request by endpoint tag with
path parameters and whether or not authorization (access_token) is necessary
$isConnected()whether or not the client has a host set
$isLoggedIn()returns a logical describing whether the user is logged in
$getHost()returns the host URL
$stopIfNotConnected()throws an error if called and the client is not connected
$connect(url=NULL,version=NULL)connects to a specific version of a back-end
$disconnect()disconnects from the back-end by logout and clearing of active back-end package variables
$api_version()returns the openEO API version this client is compliant to
$login(user=NULL, password=NULL,provider=NULL,config=NULL)creates an IAuth() object
$logout()invalidates the access_token and terminates the current session
$getAuthClient()returns the authentication client
$setAuthClient(value)sets the authentication client if it was configured and set externally
$getCapabilities()service exploration to retrieve the supported openEO endpoints
$getId()returns the ID of the Connection as stated in the getCapabilities document
$getTitle()returns the title of the connection as stated in the getCapabilities document
Arguments
hostthe openEO host URL
endpoint_namethe endpoint tag the client uses for the endpoints
tagendpoint tag
parametersnamed list of values to be replaced in the endpoint
authorizedwhether or not the endpoint requires authentication via access_token
urlurl of an openEO back-end either directly versioned or with the separate version statement
versionthe openEO API version to be used, or a list of available API versions if set to NULL
userthe user name
passwordthe user password
valuean authentication object
Open-EO/openeo-r-client documentation built on Feb. 21, 2024, 12:20 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| OpenEOClient | R Documentation |
openEO client class
Description
An R6Class that interacts with an openEO compliant back-end.
Fields
user_idThe user_id obtained after authentication
api.mappingThe mapping of the API endpoints and the back-end published ones
Methods
$new(host=NULL)the constructor with an optional host URL to connect to
$getBackendEndpoint(endpoint_name)returns the URL for the requested endpoint tag
$request(tag,parameters=NULL,authorized=FALSE, ...)performs the desired HTTP request by endpoint tag with path parameters and whether or not authorization (access_token) is necessary
$isConnected()whether or not the client has a host set
$isLoggedIn()returns a logical describing whether the user is logged in
$getHost()returns the host URL
$stopIfNotConnected()throws an error if called and the client is not connected
$connect(url=NULL,version=NULL)connects to a specific version of a back-end
$disconnect()disconnects from the back-end by logout and clearing of active back-end package variables
$api_version()returns the openEO API version this client is compliant to
$login(user=NULL, password=NULL,provider=NULL,config=NULL)creates an
IAuth()object$logout()invalidates the access_token and terminates the current session
$getAuthClient()returns the authentication client
$setAuthClient(value)sets the authentication client if it was configured and set externally
$getCapabilities()service exploration to retrieve the supported openEO endpoints
$getId()returns the ID of the Connection as stated in the getCapabilities document
$getTitle()returns the title of the connection as stated in the getCapabilities document
Arguments
hostthe openEO host URL
endpoint_namethe endpoint tag the client uses for the endpoints
tagendpoint tag
parametersnamed list of values to be replaced in the endpoint
authorizedwhether or not the endpoint requires authentication via access_token
urlurl of an openEO back-end either directly versioned or with the separate version statement
versionthe openEO API version to be used, or a list of available API versions if set to NULL
userthe user name
passwordthe user password
valuean authentication object
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.