Class S3Uploader

java.lang.Object

io.nosqlbench.nb.api.components.core.NBBaseComponentMetrics

io.nosqlbench.nb.api.components.core.NBBaseComponent

io.nosqlbench.nb.api.s3uploader.S3Uploader

All Implemented Interfaces:

NBComponent, NBComponentAdvisors, NBComponentEvents, NBComponentMetrics, NBComponentProps, NBComponentServices, NBComponentTimeline, NBProviderSearch, NBTokenWords, NBLabeledElement, AutoCloseable

public class S3Uploader
extends NBBaseComponent

Nested Class Summary

Nested classes/interfaces inherited from interface io.nosqlbench.nb.api.labels.NBLabeledElement

NBLabeledElement.BasicLabeledElement

Field Summary

Fields inherited from class io.nosqlbench.nb.api.components.core.NBBaseComponent

bufferOrphanedMetrics, closed_ns, error, errored_ns, labels, metricsBuffer, parent, started_epoch_ms, started_ns, state, teardown_ns

Fields inherited from interface io.nosqlbench.nb.api.components.core.NBComponent

EMPTY_COMPONENT

Fields inherited from interface io.nosqlbench.nb.api.components.core.NBComponentProps

HDRDIGITS, SUMMARY

Fields inherited from interface io.nosqlbench.nb.api.labels.NBLabeledElement

EMPTY

Constructor Summary

Constructors

Constructor	Description
S3Uploader(NBComponent baseComponent)

Method Summary

Modifier and Type	Method	Description
String	uploadDirToUrl(String localFilePath, String urlTemplate)	Upload the local file path to the specified S3 URL, then return the URL of the bucket in its fully expanded form.
String	uploadDirToUrlTokenized(String localFilePath, String urlTemplate, Map<String,String> params)	Upload the local file path to the specified S3 URL, then return the URL of the bucket in its fully expanded form.

Methods inherited from class io.nosqlbench.nb.api.components.core.NBBaseComponent

addAdvisor, addMetricsCloseable, attachChild, beforeDetach, close, create, detachChild, find, findParentService, getAdvisors, getChildren, getComponentOnlyLabels, getComponentProp, getComponentState, getLabels, getNanosSinceStart, getParent, getTokens, nanosof_close, nanosof_error, nanosof_start, nanosof_teardown, onError, onEvent, reportExecutionMetric, setComponentProp, started_epoch_ms, teardown, toString

Methods inherited from class io.nosqlbench.nb.api.components.core.NBBaseComponentMetrics

addComponentMetric, addListener, findComponentMetrics, findComponentMetrics, getComponentMetric, getComponentMetrics, removeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.nosqlbench.nb.api.components.core.NBComponentAdvisors

getAdvisorResults

Methods inherited from interface io.nosqlbench.nb.api.components.core.NBComponentMetrics

addComponentMetric, findComponentMetrics, findComponentMetrics, findOneComponentMetric, findOneComponentMetric, getComponentMetric, getComponentMetrics

Methods inherited from interface io.nosqlbench.nb.api.labels.NBLabeledElement

description

Constructor Details

S3Uploader

public S3Uploader(NBComponent baseComponent)

Method Details

uploadDirToUrl

public String uploadDirToUrl(String localFilePath,
 String urlTemplate)

Upload the local file path to the specified S3 URL, then return the URL of the bucket in its fully expanded form. See the details on token expansions in the s3.md help docs.

Parameters:

localFilePath - The path to the local directory

urlTemplate - A template that is expanded to a valid S3 URL

Returns:

The fully expanded name of the URL used for upload

uploadDirToUrlTokenized

public String uploadDirToUrlTokenized(String localFilePath,
 String urlTemplate,
 Map<String,String> params)

Upload the local file path to the specified S3 URL, then return the URL of the bucket in its fully expanded form. See the details on token expansions in the s3.md help docs. Any params which are provided supersede the normally provided values from the system.

Parameters:

localFilePath - The path to the local directory

urlTemplate - A template that is expanded to a valid S3 URL

params - Additional token expansions which will take precedence over other available values.

Returns:

The fully expanded name of the URL used for upload