S3FileStorage 40.0.0 API

All Implemented Interfaces:

org.ossreviewtoolkit.utils.ort.storage.FileStorage
```
public final class S3FileStorage
 implements FileStorage
                    
```
A FileStorage that stores files in an AWS S3 bucket bucketName. The read and exists operations are blocking, but the write operation is asynchronous unless a customEndpoint is provided. Contents are compressed before store if the compression flag is set to true.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description
`S3FileStorage(String accessKeyId, String awsRegion, String bucketName, Boolean compression, String customEndpoint, String secretAccessKey)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Boolean`	`exists(String path)`	Return whether the given path exists or not.
`InputStream`	`read(String path)`	Read the file at path.
`Unit`	`write(String path, InputStream inputStream)`	Write the data from inputStream to the file at path.
`Boolean`	`delete(String path)`	Delete the file at the given path and return whether the operation was successful.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - S3FileStorage
```
S3FileStorage(String accessKeyId, String awsRegion, String bucketName, Boolean compression, String customEndpoint, String secretAccessKey)
```
- Method Detail
  - exists
```
 Boolean exists(String path)
```
    Return whether the given path exists or not.
  - read
```
 InputStream read(String path)
```
    Read the file at path. It is the caller's responsibility to close the returned InputStream after consuming it.
  - write
```
 Unit write(String path, InputStream inputStream)
```
    Write the data from inputStream to the file at path. If the file already exists it is overwritten. The provided inputStream is closed after writing it to the file.
  - delete
```
 Boolean delete(String path)
```
    Delete the file at the given path and return whether the operation was successful.