S3FileResourceGetter: AWS S3 file resource getter
In s3.resourcer: S3 Resource Resolver
S3FileResourceGetter R Documentation
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
-
-
-
-
Inherited methods
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
resourceThe 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
resourceA 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
deepWhether to make a deep clone.
s3.resourcer documentation built on April 3, 2025, 10:56 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| S3FileResourceGetter | R Documentation |
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
Inherited methods
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
resourceThe 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
resourceA 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
deepWhether to make a deep clone.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.