S3FileResourceGetter {s3.resourcer}

AWS S3 file resource getter

Description

AWS S3 file resource getter

AWS S3 file resource getter

Format

A R6 object of class S3FileResourceGetter

Details

Access a file that is in the Amazon Web Services S3 file store or in a HTTP S3 compatible file store such as Minio. For AWS S3 the host name is the bucket name. For Minio, the url will include http or https base protocol. Credentials may apply.

Super class

resourcer::FileResourceGetter -> S3FileResourceGetter

Methods

Public methods

• S3FileResourceGetter$new()

• S3FileResourceGetter$isFor()

• S3FileResourceGetter$downloadFile()

• S3FileResourceGetter$clone()

Inherited methods

• resourcer::FileResourceGetter$extractFileName()
• resourcer::FileResourceGetter$makeDownloadDir()

Method new()

Creates a new S3FileResourceGetter instance.

Usage

S3FileResourceGetter$new()

Returns

A S3FileResourceGetter object.

Method isFor()

Check that the provided resource has a URL that locates a file accessible through "s3" protocol or "s3+http" or "s3+https" protocol (i.e. using Minio implementation of the AWS S3 file store API over HTTP).

Usage

S3FileResourceGetter$isFor(resource)

Arguments

resource

The resource object to validate.

Returns

A logical.

Method downloadFile()

Download the file from the remote address in a temporary location. Applies authentication if credentials are provided in the resource.

Usage

S3FileResourceGetter$downloadFile(resource, ...)

Arguments

resource

A valid resource object.

...

Unused additional parameters.

Returns

The "resource.file" object.

Method clone()

The objects of this class are cloneable with this method.

Usage

S3FileResourceGetter$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.