SessionInstance: Session class

In ReneStalitza/openEo.gdalcubes: An openEo R-package interfacing with gdalcubes

Description

Session class

Session class

Public fields

graphs

User defined process graphs

processes

Package processes

data

Data of current Session

jobs

Stored jobs of current Session

Methods

Public methods

• SessionInstance$new()

• SessionInstance$getEndpoints()

• SessionInstance$getConfig()

• SessionInstance$getToken()

• SessionInstance$setToken()

• SessionInstance$startSession()

• SessionInstance$setBaseUrl()

• SessionInstance$getBaseUrl()

• SessionInstance$initDirectory()

• SessionInstance$initEndpoints()

• SessionInstance$createEndpoint()

• SessionInstance$assignData()

• SessionInstance$assignProcess()

• SessionInstance$assignJob()

• SessionInstance$runJob()

• SessionInstance$clone()

---

Method new()

Create a new session

Usage

SessionInstance$new(configuration = NULL)

Arguments

configuration

Session configuration

---

Method getEndpoints()

Get endpoints

Usage

SessionInstance$getEndpoints()

Returns

endpoints

---

Method getConfig()

Get configuration

Usage

SessionInstance$getConfig()

Returns

configuration

---

Method getToken()

Get token

Usage

SessionInstance$getToken()

Returns

token

---

Method setToken()

Assign this token to the session

Usage

SessionInstance$setToken(new)

Arguments

new

New token

---

Method startSession()

Start the session

Usage

SessionInstance$startSession()

---

Method setBaseUrl()

Set base url

Usage

SessionInstance$setBaseUrl(port, host)

Arguments

port

Which port is currently saved

host

Which host is currently saved

---

Method getBaseUrl()

Get base url

Usage

SessionInstance$getBaseUrl()

Returns

base url

---

Method initDirectory()

initializes workspace and data paths

Usage

SessionInstance$initDirectory()

---

Method initEndpoints()

biuld a df to add the endpoints later on

Usage

SessionInstance$initEndpoints()

---

Method createEndpoint()

Create an endpoint

Usage

SessionInstance$createEndpoint(
  path,
  method,
  handler = NULL,
  filter = FALSE,
  serializer = serializer_unboxed_json()
)

Arguments

path

path for the endpoint

method

type of request

handler

function to be executed

filter

deactivate filter for several endpoints

serializer

plumber serializer to be used

Returns

created Endpoint

---

Method assignData()

Function to assign data of collection to the data path

Usage

SessionInstance$assignData(col)

Arguments

col

Collection of class 'Collection'

---

Method assignProcess()

Function to assign the process to the Session

Usage

SessionInstance$assignProcess(pro)

Arguments

pro

Process of class 'Process'

---

Method assignJob()

Function to assign a job to the Session

Usage

SessionInstance$assignJob(job)

Arguments

job

Job of class 'Job'

---

Method runJob()

Execute the job

Usage

SessionInstance$runJob(job)

Arguments

job

Job to be executed

---

Method clone()

The objects of this class are cloneable with this method.

Usage

SessionInstance$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

ReneStalitza/openEo.gdalcubes documentation built on Feb. 12, 2021, 8:01 a.m.