SystemStorageConfig: SystemStorageConfig Class

Description Usage Format Fields

Description

SystemStorageConfig Class

Usage

1

Format

An object of class R6ClassGenerator of length 24.

Fields

auth
containerName

The name of the bucket to interact with when using an object store.

homeDir

The path on the remote system to use as the home directory for all API requests. For cases where the home directory should be dynamically defined, the $USERNAME token can be included in the homeDir value to represent the username of the authenticated user. ex. /home/$USERNAME.

host

The hostname or ip address of the storage server

port

The port number of the storage server.

mirror

Whether the permissions set on the server should be pushed to the storage system itself. This only applies to IRODS and AWS systems.

protocol
publicAppsDir

The path on the remote system where apps will be stored if this is set as the default public storage system.

resource

The name of the target resource when defining an IRODS system.

rootDir

The path on the remote system to use as the root for all API requests.

zone

The name of the zone when defining an IRODS system.


agaveplatform/r-sdk documentation built on May 13, 2019, 8:20 a.m.