Package com.atgenomix.seqslab.piper.plugin.api

Class DataSource

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

com.atgenomix.seqslab.piper.plugin.api.DataSource

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

@DeveloperApi
public class DataSource
extends Properties

The main interface responsible for representing an accessible data source in SeqsLab. The underlying data source acts as the canonical object in SeqsLab Data Hub service.

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor	Description
DataSource()

Method Summary

Modifier and Type	Method	Description
String	getAccessTier()	Retrieve the access tier of the data source, e.g.
Map<String,String>	getOptions()	Retrieve the access options associated with this data source, e.g.
String	getRegion()	Retrieve the data center region, from which the data source will be accessed.
String	getType()	Retrieve type of the access method to the data source, e.g.
String	getUrl()	Retrieve the access URL to the datasets.

Methods inherited from class java.util.Properties

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, getProperty, getProperty, hashCode, isEmpty, keys, keySet, list, list, load, load, loadFromXML, merge, propertyNames, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, save, setProperty, size, store, store, storeToXML, storeToXML, storeToXML, stringPropertyNames, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DataSource

public DataSource()

Method Details

getType

public String getType()

Retrieve type of the access method to the data source, e.g. https, abfss, s3, etc.

Returns:

Access type

getUrl

public String getUrl()

Retrieve the access URL to the datasets.

Returns:

Data source URL

getOptions

public Map<String,String> getOptions()

Retrieve the access options associated with this data source, e.g. HTTPS Authentication header.

Returns:

A map containing a list of named option values

getRegion

public String getRegion()

Retrieve the data center region, from which the data source will be accessed. Depending on the data source implementations, the region might not be available.

Returns:

Data center region

getAccessTier

public String getAccessTier()

Retrieve the access tier of the data source, e.g. hot, cool. Depending on the data source implementations, the access tier might not be available.

Returns:

Data access tier