Minio class

Available extensions

• MinioX

Constructors

Minio.new()

factory

Properties

accessKey → String

accessKey is like user-id that uniquely identifies your account.

final

enableTrace → bool

Set this value to enable tracing. (Optional)

final

endPoint → String

endPoint is a host name or an IP address.

final

hashCode → int

The hash code for this object.

no setter, inherited

maximumPartSize → int

maximum part size for multipart uploads.

final

maxObjectSize → int

maximum object size (5TB)

final

partSize → int

default part size for multipart uploads.

final

port → int

TCP/IP port number. This input is optional. Default value set to 80 for HTTP and 443 for HTTPs.

final

region → String?

Set this value to override region cache. (Optional)

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

secretKey → String

secretKey is the password to your account.

final

sessionToken → String?

Set this value to provide x-amz-security-token (AWS S3 specific). (Optional)

final

useSSL → bool

If set to true, https is used instead of http. Default is true.

final

Methods

bucketExists(String bucket) → Future<bool>

Checks if a bucket exists.

completeMultipartUpload(String bucket, String object, String uploadId, List<CompletedPart> parts) → Future<String>

Complete the multipart upload. After all the parts are uploaded issuing this call will aggregate the parts on the server into a single object.

copyObject(String bucket, String object, String srcObject, [CopyConditions? conditions]) → Future<CopyObjectResult>

Copy the object.

fGetObject(String bucket, String object, String filePath) → Future<void>

Available on Minio, provided by the MinioX extension

Downloads and saves the object as a file in the local filesystem.

findUploadId(String bucket, String object) → Future<String?>

Find uploadId of an incomplete upload.

fPutObject(String bucket, String object, String filePath, [Map<String, String>? metadata]) → Future<String>

Available on Minio, provided by the MinioX extension

getBucketNotification(String bucket) → Future<NotificationConfiguration>

Return the list of notification configurations stored in the S3 provider

getBucketPolicy(String bucket) → Future<Map<String, dynamic>?>

Get the bucket policy associated with the specified bucket. If objectPrefix is not empty, the bucket policy will be filtered based on object permissions as well.

getBucketRegion(String bucket) → Future<String>

Gets the region of bucket. The region is cached for subsequent calls.

getObject(String bucket, String object) → Future<MinioByteStream>

get a readable stream of the object content.

getObjectACL(String bucket, String object) → Future<AccessControlPolicy>

getPartialObject(String bucket, String object, [int? offset, int? length]) → Future<MinioByteStream>

get a readable stream of the partial object content.

initiateNewMultipartUpload(String bucket, String object, Map<String, String>? metaData) → Future<String>

Initiate a new multipart upload.

listAllObjects(String bucket, {String prefix = '', bool recursive = false}) → Future<ListObjectsResult>

Returns all Objects in a bucket. This is a shortcut for listObjects. Use listObjects to list buckets with a large number of objects.

listAllObjectsV2(String bucket, {String prefix = '', bool recursive = false}) → Future<ListObjectsResult>

Returns all Objects in a bucket. This is a shortcut for listObjectsV2. Use listObjects to list buckets with a large number of objects. This uses ListObjectsV2 in the S3 API. For backward compatibility, use listAllObjects instead.

listBuckets() → Future<List<Bucket>>

List of buckets created.

listenBucketNotification(String bucket, {String? prefix, String? suffix, List<String>? events}) → NotificationPoller

Listen for notifications on a bucket. Additionally one can provider filters for prefix, suffix and events. There is no prior set bucket notification needed to use this API. This is an MinIO extension API where unique identifiers are regitered and unregistered by the server automatically based on incoming requests.

listIncompleteUploads(String bucket, String prefix, [bool recursive = false]) → Stream<IncompleteUpload>

Returns a stream that emits objects that are partially uploaded.

listIncompleteUploadsQuery(String bucket, String prefix, String? keyMarker, String? uploadIdMarker, String delimiter) → Future<ListMultipartUploadsOutput>

Called by listIncompleteUploads to fetch a batch of incomplete uploads.

listObjects(String bucket, {String prefix = '', bool recursive = false}) → Stream<ListObjectsResult>

Returns all Objects in a bucket. To list objects in a bucket with prefix, set prefix to the desired prefix.

listObjectsQuery(String bucket, String prefix, String? marker, String delimiter, int? maxKeys) → Future<ListObjectsOutput>

list a batch of objects

listObjectsV2(String bucket, {String prefix = '', bool recursive = false, String? startAfter}) → Stream<ListObjectsResult>

Returns all Objects in a bucket. To list objects in a bucket with prefix, set prefix to the desired prefix. This uses ListObjectsV2 in the S3 API. For backward compatibility, use listObjects instead.

listObjectsV2Query(String bucket, String prefix, String? continuationToken, String delimiter, int? maxKeys, String? startAfter) → Future<ListObjectsV2Output>

listObjectsV2Query - (List Objects V2) - List some or all (up to 1000) of the objects in a bucket.

listParts(String bucket, String object, String uploadId) → Stream<Part>

Get part-info of all parts of an incomplete upload specified by uploadId.

listPartsQuery(String? bucket, String? object, String? uploadId, int? marker) → Future<ListPartsOutput>

Called by listParts to fetch a batch of part-info

makeBucket(String bucket, [String? region]) → Future<void>

Creates the bucket bucket.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

presignedGetObject(String bucket, String object, {int? expires, Map<String, String>? respHeaders, DateTime? requestDate}) → Future<String>

Generate a presigned URL for GET

presignedPostPolicy(PostPolicy postPolicy) → Future<PostPolicyResult>

presignedPostPolicy can be used in situations where we want more control on the upload than what presignedPutObject() provides. i.e Using presignedPostPolicy we will be able to put policy restrictions on the object's name bucket expiry Content-Type

presignedPutObject(String bucket, String object, {int? expires}) → Future<String>

Generate a presigned URL for PUT. Using this URL, the browser can upload to S3 only with the specified object name.

presignedUrl(String method, String bucket, String object, {int? expires, String? resource, Map<String, String>? reqParams, DateTime? requestDate}) → Future<String>

Generate a generic presigned URL which can be used for HTTP methods GET, PUT, HEAD and DELETE

putObject(String bucket, String object, Stream<Uint8List> data, {int? size, int? chunkSize, Map<String, String>? metadata, void onProgress(int)?}) → Future<String>

Uploads the object. Returns the ETag of the uploaded object.

removeAllBucketNotification(String bucket) → Future<void>

Remove all bucket notification

removeBucket(String bucket) → Future<void>

Remove a bucket.

removeIncompleteUpload(String bucket, String object) → Future<void>

Remove the partially uploaded object.

removeObject(String bucket, String object) → Future<void>

Remove the specified object.

removeObjects(String bucket, List<String> objects) → Future<void>

Remove all the objects residing in the objectsList.

setBucketNotification(String bucket, NotificationConfiguration config) → Future<void>

setBucketPolicy(String bucket, [Map<String, dynamic>? policy]) → Future<void>

Set the bucket policy on the specified bucket.

setObjectACL(String bucket, String object, String policy) → Future<void>

statObject(String bucket, String object, {bool retrieveACLs = true}) → Future<StatObjectResult>

Stat information of the object.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

shared ↔ Minio

getter/setter pair

Static Methods

init({required String endPoint, required String accessKey, required String secretKey, int? port, bool useSSL = true, String? sessionToken, String? region, bool enableTrace = false}) → Minio