RemoteDataPath

jobs~ RemoteDataPath

Class encapsulating a remote data path.

Constructor

new RemoteDataPath(dataIdopt, signedUrlopt)

Creates a new RemoteDataPath instance.

Parameters:
Name Type Attributes Default Description
dataId string <optional>
null

the ID of the data in cloud storage

signedUrl string <optional>
null

a signed URL with access to the data of interest in third-party cloud storage

Properties:
Name Type Description
hasDataId boolean

true if this instance has a data ID, and false otherwise

hasSignedUrl boolean

true if this instance has a signed URL, and false otherwise

isValid boolean

true if this instance is valid, and false otherwise

Source:

Extends

Methods

(static) fromDataId(stringopt) → {RemoteDataPath}

Creates a RemoteDataPath instance defined by the given data ID.

Parameters:
Name Type Attributes Description
string <optional>

dataId - the ID of the data in cloud storage

Source:

(static) fromSignedUrl(stringopt) → {RemoteDataPath}

Creates a RemoteDataPath instance defined by the given signed URL.

Parameters:
Name Type Attributes Description
string <optional>

signedUrl - a signed URL with access to the data of interest in third-party cloud storage

Source:

(static) isRemotePathObject(valopt) → {boolean}

Determines whether the given value defines a valid RemoteDataPath dictionary.

Parameters:
Name Type Attributes Description
val <optional>

either a JSON object representation of a RemoteDataPath instance or another arbitrary value

Source:

(static) fromObject(objopt) → {RemoteDataPath}

Constructs a RemoteDataPath instance from a JSON object.

Parameters:
Name Type Attributes Description
obj object <optional>

a JSON object defining a RemoteDataPath instance

Source:
Throws:

if the instance creation failed

Type
RemoteDataPathError

toObject() → {object}

Generates a JSON representation of the object.

Inherited From:
Source:

toString() → {string}

Generates a string representation of the Serializable object.

Inherited From:
Source:

toJSON(path)

Writes the object to disk in JSON format.

Parameters:
Name Type Description
path string

the output JSON file path. The base output directory is created, if necessary

Inherited From:
Source: