io.minio

Class MinioClient

java.lang.Object

io.minio.MinioClient

All Implemented Interfaces:

AutoCloseable

public class MinioClient
extends Object
implements AutoCloseable

Simple Storage Service (aka S3) client to perform bucket and object operations.

Bucket operations

• Create, list and delete buckets.
• Put, get and delete bucket lifecycle configuration.
• Put, get and delete bucket policy configuration.
• Put, get and delete bucket encryption configuration.
• Put and get bucket default retention configuration.
• Put and get bucket notification configuration.
• Enable and disable bucket versioning.

Object operations

• Put, get, delete and list objects.
• Create objects by combining existing objects.
• Put and get object retention and legal hold.
• Filter object content by SQL statement.

If access/secret keys are provided, all S3 operation requests are signed using AWS Signature Version 4; else they are performed anonymously.

Examples on using this library are available here.

Use MinioClient.builder() to create S3 client.

 // Create client with anonymous access.
 MinioClient minioClient = MinioClient.builder().endpoint("https://play.min.io").build();

 // Create client with credentials.
 MinioClient minioClient =
     MinioClient.builder()
         .endpoint("https://play.min.io")
         .credentials("Q3AM3UQ867SPQQA43P2F", "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MinioClient.Builder Argument builder of MinioClient.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MinioClient(MinioClient client)

Method Summary

Modifier and Type	Method and Description
boolean	bucketExists(BucketExistsArgs args) Checks if a bucket exists.
static MinioClient.Builder	builder()
void	close()
ObjectWriteResponse	composeObject(ComposeObjectArgs args) Creates an object by combining data from different source objects using server-side copy.
ObjectWriteResponse	copyObject(CopyObjectArgs args) Creates an object by server-side copying data from another object.
void	deleteBucketCors(DeleteBucketCorsArgs args) Deletes CORS configuration of a bucket.
void	deleteBucketEncryption(DeleteBucketEncryptionArgs args) Deletes encryption configuration of a bucket.
void	deleteBucketLifecycle(DeleteBucketLifecycleArgs args) Deletes lifecycle configuration of a bucket.
void	deleteBucketNotification(DeleteBucketNotificationArgs args) Deletes notification configuration of a bucket.
void	deleteBucketPolicy(DeleteBucketPolicyArgs args) Deletes bucket policy configuration to a bucket.
void	deleteBucketReplication(DeleteBucketReplicationArgs args) Deletes bucket replication configuration from a bucket.
void	deleteBucketTags(DeleteBucketTagsArgs args) Deletes tags of a bucket.
void	deleteObjectLockConfiguration(DeleteObjectLockConfigurationArgs args) Deletes default object retention in a bucket.
void	deleteObjectTags(DeleteObjectTagsArgs args) Deletes tags of an object.
void	disableAccelerateEndpoint() Deprecated. This method is no longer supported.
void	disableDualStackEndpoint() Disables dual-stack endpoint for Amazon S3 endpoint.
void	disableObjectLegalHold(DisableObjectLegalHoldArgs args) Disables legal hold on an object.
void	disableVirtualStyleEndpoint() Disables virtual-style endpoint.
void	downloadObject(DownloadObjectArgs args) Downloads data of a SSE-C encrypted object to file.
void	enableAccelerateEndpoint() Deprecated. This method is no longer supported.
void	enableDualStackEndpoint() Enables dual-stack endpoint for Amazon S3 endpoint.
void	enableObjectLegalHold(EnableObjectLegalHoldArgs args) Enables legal hold on an object.
void	enableVirtualStyleEndpoint() Enables virtual-style endpoint.
CORSConfiguration	getBucketCors(GetBucketCorsArgs args) Gets CORS configuration of a bucket.
SseConfiguration	getBucketEncryption(GetBucketEncryptionArgs args) Gets encryption configuration of a bucket.
LifecycleConfiguration	getBucketLifecycle(GetBucketLifecycleArgs args) Gets lifecycle configuration of a bucket.
NotificationConfiguration	getBucketNotification(GetBucketNotificationArgs args) Gets notification configuration of a bucket.
String	getBucketPolicy(GetBucketPolicyArgs args) Gets bucket policy configuration of a bucket.
ReplicationConfiguration	getBucketReplication(GetBucketReplicationArgs args) Gets bucket replication configuration of a bucket.
Tags	getBucketTags(GetBucketTagsArgs args) Gets tags of a bucket.
VersioningConfiguration	getBucketVersioning(GetBucketVersioningArgs args) Gets versioning configuration of a bucket.
GetObjectResponse	getObject(GetObjectArgs args) Gets data from offset to length of a SSE-C encrypted object.
AccessControlPolicy	getObjectAcl(GetObjectAclArgs args) Gets access control policy of an object.
GetObjectAttributesResponse	getObjectAttributes(GetObjectAttributesArgs args) Gets attributes of an object.
ObjectLockConfiguration	getObjectLockConfiguration(GetObjectLockConfigurationArgs args) Gets default object retention in a bucket.
Retention	getObjectRetention(GetObjectRetentionArgs args) Gets retention configuration of an object.
Tags	getObjectTags(GetObjectTagsArgs args) Gets tags of an object.
String	getPresignedObjectUrl(GetPresignedObjectUrlArgs args) Gets presigned URL of an object for HTTP method, expiry time and custom request parameters.
Map<String,String>	getPresignedPostFormData(PostPolicy policy) Gets form-data of PostPolicy of an object to upload its data using POST method.
void	ignoreCertCheck() Ignores check on server certificate for HTTPS connection.
boolean	isObjectLegalHoldEnabled(IsObjectLegalHoldEnabledArgs args) Returns true if legal hold is enabled on an object.
List<Bucket>	listBuckets() Lists bucket information of all buckets.
Iterable<Result<Bucket>>	listBuckets(ListBucketsArgs args) Lists bucket information of all buckets.
CloseableIterator<Result<NotificationRecords>>	listenBucketNotification(ListenBucketNotificationArgs args) Listens events of object prefix and suffix of a bucket.
Iterable<Result<Item>>	listObjects(ListObjectsArgs args) Lists objects information optionally with versions of a bucket.
void	makeBucket(MakeBucketArgs args) Creates a bucket with region and object lock.
PromptObjectResponse	promptObject(PromptObjectArgs args) Performs language model inference with the prompt and referenced object as context.
ObjectWriteResponse	putObject(PutObjectArgs args) Uploads data from a stream to an object.
PutObjectFanOutResponse	putObjectFanOut(PutObjectFanOutArgs args) Uploads multiple objects with same content from single stream with optional metadata and tags.
void	removeBucket(RemoveBucketArgs args) Removes an empty bucket using arguments
void	removeObject(RemoveObjectArgs args) Removes an object.
Iterable<Result<DeleteError>>	removeObjects(RemoveObjectsArgs args) Removes multiple objects lazily.
void	restoreObject(RestoreObjectArgs args) Restores an object.
SelectResponseStream	selectObjectContent(SelectObjectContentArgs args) Selects content of an object by SQL expression.
void	setAppInfo(String name, String version) Sets application's name/version to user agent.
void	setAwsS3Prefix(String awsS3Prefix) Sets AWS S3 domain prefix.
void	setBucketCors(SetBucketCorsArgs args) Sets CORS configuration to a bucket.
void	setBucketEncryption(SetBucketEncryptionArgs args) Sets encryption configuration of a bucket.
void	setBucketLifecycle(SetBucketLifecycleArgs args) Sets lifecycle configuration to a bucket.
void	setBucketNotification(SetBucketNotificationArgs args) Sets notification configuration to a bucket.
void	setBucketPolicy(SetBucketPolicyArgs args) Sets bucket policy configuration to a bucket.
void	setBucketReplication(SetBucketReplicationArgs args) Sets bucket replication configuration to a bucket.
void	setBucketTags(SetBucketTagsArgs args) Sets tags to a bucket.
void	setBucketVersioning(SetBucketVersioningArgs args) Sets versioning configuration of a bucket.
void	setObjectLockConfiguration(SetObjectLockConfigurationArgs args) Sets default object retention in a bucket.
void	setObjectRetention(SetObjectRetentionArgs args) Sets retention configuration to an object.
void	setObjectTags(SetObjectTagsArgs args) Sets tags to an object.
void	setTimeout(long connectTimeout, long writeTimeout, long readTimeout) Sets HTTP connect, write and read timeouts.
StatObjectResponse	statObject(StatObjectArgs args) Gets information of an object.
void	traceOff() Disables HTTP call tracing previously enabled.
void	traceOn(OutputStream traceStream) Enables HTTP call tracing and written to traceStream.
ObjectWriteResponse	uploadObject(UploadObjectArgs args) Uploads data from a file to an object.
ObjectWriteResponse	uploadSnowballObjects(UploadSnowballObjectsArgs args) Uploads multiple objects in a single put call.

Methods inherited from class java.lang.Object

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

Constructor Detail

MinioClient

protected MinioClient(MinioClient client)

Method Detail

statObject

public StatObjectResponse statObject(StatObjectArgs args)
                              throws ErrorResponseException,
                                     InsufficientDataException,
                                     InternalException,
                                     InvalidKeyException,
                                     InvalidResponseException,
                                     IOException,
                                     NoSuchAlgorithmException,
                                     ServerException,
                                     XmlParserException

Gets information of an object.

Example:
 // Get information of an object.
 StatObjectResponse stat =
     minioClient.statObject(
         StatObjectArgs.builder().bucket("my-bucketname").object("my-objectname").build());

 // Get information of SSE-C encrypted object.
 StatObjectResponse stat =
     minioClient.statObject(
         StatObjectArgs.builder()
             .bucket("my-bucketname")
             .object("my-objectname")
             .ssec(ssec)
             .build());

 // Get information of a versioned object.
 StatObjectResponse stat =
     minioClient.statObject(
         StatObjectArgs.builder()
             .bucket("my-bucketname")
             .object("my-objectname")
             .versionId("version-id")
             .build());

 // Get information of a SSE-C encrypted versioned object.
 StatObjectResponse stat =
     minioClient.statObject(
         StatObjectArgs.builder()
             .bucket("my-bucketname")
             .object("my-objectname")
             .versionId("version-id")
             .ssec(ssec)
             .build());
 

Parameters:

args - StatObjectArgs object.

Returns:

StatObjectResponse - Populated object information and metadata.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

See Also:

StatObjectResponse

getObject

public GetObjectResponse getObject(GetObjectArgs args)
                            throws ErrorResponseException,
                                   InsufficientDataException,
                                   InternalException,
                                   InvalidKeyException,
                                   InvalidResponseException,
                                   IOException,
                                   NoSuchAlgorithmException,
                                   ServerException,
                                   XmlParserException

Gets data from offset to length of a SSE-C encrypted object. Returned InputStream must be closed after use to release network resources.

Example:
 try (InputStream stream =
     minioClient.getObject(
   GetObjectArgs.builder()
     .bucket("my-bucketname")
     .object("my-objectname")
     .offset(offset)
     .length(len)
     .ssec(ssec)
     .build()
 ) {
   // Read data from stream
 }
 

Parameters:

args - Object of GetObjectArgs

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

downloadObject

public void downloadObject(DownloadObjectArgs args)
                    throws ErrorResponseException,
                           InsufficientDataException,
                           InternalException,
                           InvalidKeyException,
                           InvalidResponseException,
                           IOException,
                           NoSuchAlgorithmException,
                           ServerException,
                           XmlParserException

Downloads data of a SSE-C encrypted object to file.

Example:
 minioClient.downloadObject(
   DownloadObjectArgs.builder()
     .bucket("my-bucketname")
     .object("my-objectname")
     .ssec(ssec)
     .filename("my-filename")
     .build());
 

Parameters:

args - Object of DownloadObjectArgs

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

copyObject

public ObjectWriteResponse copyObject(CopyObjectArgs args)
                               throws ErrorResponseException,
                                      InsufficientDataException,
                                      InternalException,
                                      InvalidKeyException,
                                      InvalidResponseException,
                                      IOException,
                                      NoSuchAlgorithmException,
                                      ServerException,
                                      XmlParserException

Creates an object by server-side copying data from another object.

Example:
 // Create object "my-objectname" in bucket "my-bucketname" by copying from object
 // "my-objectname" in bucket "my-source-bucketname".
 minioClient.copyObject(
     CopyObjectArgs.builder()
         .bucket("my-bucketname")
         .object("my-objectname")
         .source(
             CopySource.builder()
                 .bucket("my-source-bucketname")
                 .object("my-objectname")
                 .build())
         .build());

 // Create object "my-objectname" in bucket "my-bucketname" by copying from object
 // "my-source-objectname" in bucket "my-source-bucketname".
 minioClient.copyObject(
     CopyObjectArgs.builder()
         .bucket("my-bucketname")
         .object("my-objectname")
         .source(
             CopySource.builder()
                 .bucket("my-source-bucketname")
                 .object("my-source-objectname")
                 .build())
         .build());

 // Create object "my-objectname" in bucket "my-bucketname" with SSE-KMS server-side
 // encryption by copying from object "my-objectname" in bucket "my-source-bucketname".
 minioClient.copyObject(
     CopyObjectArgs.builder()
         .bucket("my-bucketname")
         .object("my-objectname")
         .source(
             CopySource.builder()
                 .bucket("my-source-bucketname")
                 .object("my-objectname")
                 .build())
         .sse(sseKms) // Replace with actual key.
         .build());

 // Create object "my-objectname" in bucket "my-bucketname" with SSE-S3 server-side
 // encryption by copying from object "my-objectname" in bucket "my-source-bucketname".
 minioClient.copyObject(
     CopyObjectArgs.builder()
         .bucket("my-bucketname")
         .object("my-objectname")
         .source(
             CopySource.builder()
                 .bucket("my-source-bucketname")
                 .object("my-objectname")
                 .build())
         .sse(sseS3) // Replace with actual key.
         .build());

 // Create object "my-objectname" in bucket "my-bucketname" with SSE-C server-side encryption
 // by copying from object "my-objectname" in bucket "my-source-bucketname".
 minioClient.copyObject(
     CopyObjectArgs.builder()
         .bucket("my-bucketname")
         .object("my-objectname")
         .source(
             CopySource.builder()
                 .bucket("my-source-bucketname")
                 .object("my-objectname")
                 .build())
         .sse(ssec) // Replace with actual key.
         .build());

 // Create object "my-objectname" in bucket "my-bucketname" by copying from SSE-C encrypted
 // object "my-source-objectname" in bucket "my-source-bucketname".
 minioClient.copyObject(
     CopyObjectArgs.builder()
         .bucket("my-bucketname")
         .object("my-objectname")
         .source(
             CopySource.builder()
                 .bucket("my-source-bucketname")
                 .object("my-source-objectname")
                 .ssec(ssec) // Replace with actual key.
                 .build())
         .build());

 // Create object "my-objectname" in bucket "my-bucketname" with custom headers conditionally
 // by copying from object "my-objectname" in bucket "my-source-bucketname".
 minioClient.copyObject(
     CopyObjectArgs.builder()
         .bucket("my-bucketname")
         .object("my-objectname")
         .source(
             CopySource.builder()
                 .bucket("my-source-bucketname")
                 .object("my-objectname")
                 .matchETag(etag) // Replace with actual etag.
                 .build())
         .headers(headers) // Replace with actual headers.
         .build());
 

Parameters:

args - CopyObjectArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

composeObject

public ObjectWriteResponse composeObject(ComposeObjectArgs args)
                                  throws ErrorResponseException,
                                         InsufficientDataException,
                                         InternalException,
                                         InvalidKeyException,
                                         InvalidResponseException,
                                         IOException,
                                         NoSuchAlgorithmException,
                                         ServerException,
                                         XmlParserException

Creates an object by combining data from different source objects using server-side copy.

Example:
 List<ComposeSource> sourceObjectList = new ArrayList<ComposeSource>();

 sourceObjectList.add(
    ComposeSource.builder().bucket("my-job-bucket").object("my-objectname-part-one").build());
 sourceObjectList.add(
    ComposeSource.builder().bucket("my-job-bucket").object("my-objectname-part-two").build());
 sourceObjectList.add(
    ComposeSource.builder().bucket("my-job-bucket").object("my-objectname-part-three").build());

 // Create my-bucketname/my-objectname by combining source object list.
 minioClient.composeObject(
    ComposeObjectArgs.builder()
        .bucket("my-bucketname")
        .object("my-objectname")
        .sources(sourceObjectList)
        .build());

 // Create my-bucketname/my-objectname with user metadata by combining source object
 // list.
 Map<String, String> userMetadata = new HashMap<>();
 userMetadata.put("My-Project", "Project One");
 minioClient.composeObject(
     ComposeObjectArgs.builder()
        .bucket("my-bucketname")
        .object("my-objectname")
        .sources(sourceObjectList)
        .userMetadata(userMetadata)
        .build());

 // Create my-bucketname/my-objectname with user metadata and server-side encryption
 // by combining source object list.
 minioClient.composeObject(
   ComposeObjectArgs.builder()
        .bucket("my-bucketname")
        .object("my-objectname")
        .sources(sourceObjectList)
        .userMetadata(userMetadata)
        .ssec(sse)
        .build());
 

Parameters:

args - ComposeObjectArgs object.

Returns:

ObjectWriteResponse object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

getPresignedObjectUrl

public String getPresignedObjectUrl(GetPresignedObjectUrlArgs args)
                             throws ErrorResponseException,
                                    InsufficientDataException,
                                    InternalException,
                                    InvalidKeyException,
                                    InvalidResponseException,
                                    IOException,
                                    NoSuchAlgorithmException,
                                    XmlParserException,
                                    ServerException

Gets presigned URL of an object for HTTP method, expiry time and custom request parameters.

Example:
 // Get presigned URL string to delete 'my-objectname' in 'my-bucketname' and its life time
 // is one day.
 String url =
    minioClient.getPresignedObjectUrl(
        GetPresignedObjectUrlArgs.builder()
            .method(Method.DELETE)
            .bucket("my-bucketname")
            .object("my-objectname")
            .expiry(24 * 60 * 60)
            .build());
 System.out.println(url);

 // Get presigned URL string to upload 'my-objectname' in 'my-bucketname'
 // with response-content-type as application/json and life time as one day.
 Map<String, String> reqParams = new HashMap<String, String>();
 reqParams.put("response-content-type", "application/json");

 String url =
    minioClient.getPresignedObjectUrl(
        GetPresignedObjectUrlArgs.builder()
            .method(Method.PUT)
            .bucket("my-bucketname")
            .object("my-objectname")
            .expiry(1, TimeUnit.DAYS)
            .extraQueryParams(reqParams)
            .build());
 System.out.println(url);

 // Get presigned URL string to download 'my-objectname' in 'my-bucketname' and its life time
 // is 2 hours.
 String url =
    minioClient.getPresignedObjectUrl(
        GetPresignedObjectUrlArgs.builder()
            .method(Method.GET)
            .bucket("my-bucketname")
            .object("my-objectname")
            .expiry(2, TimeUnit.HOURS)
            .build());
 System.out.println(url);
 

Parameters:

args - GetPresignedObjectUrlArgs object.

Returns:

String - URL string.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

getPresignedPostFormData

public Map<String,String> getPresignedPostFormData(PostPolicy policy)
                                            throws ErrorResponseException,
                                                   InsufficientDataException,
                                                   InternalException,
                                                   InvalidKeyException,
                                                   InvalidResponseException,
                                                   IOException,
                                                   NoSuchAlgorithmException,
                                                   ServerException,
                                                   XmlParserException

Gets form-data of PostPolicy of an object to upload its data using POST method.

Example:
 // Create new post policy for 'my-bucketname' with 7 days expiry from now.
 PostPolicy policy = new PostPolicy("my-bucketname", ZonedDateTime.now().plusDays(7));

 // Add condition that 'key' (object name) equals to 'my-objectname'.
 policy.addEqualsCondition("key", "my-objectname");

 // Add condition that 'Content-Type' starts with 'image/'.
 policy.addStartsWithCondition("Content-Type", "image/");

 // Add condition that 'content-length-range' is between 64kiB to 10MiB.
 policy.addContentLengthRangeCondition(64 * 1024, 10 * 1024 * 1024);

 Map<String, String> formData = minioClient.getPresignedPostFormData(policy);

 // Upload an image using POST object with form-data.
 MultipartBody.Builder multipartBuilder = new MultipartBody.Builder();
 multipartBuilder.setType(MultipartBody.FORM);
 for (Map.Entry<String, String> entry : formData.entrySet()) {
   multipartBuilder.addFormDataPart(entry.getKey(), entry.getValue());
 }
 multipartBuilder.addFormDataPart("key", "my-objectname");
 multipartBuilder.addFormDataPart("Content-Type", "image/png");

 // "file" must be added at last.
 multipartBuilder.addFormDataPart(
     "file", "my-objectname", RequestBody.create(new File("Pictures/avatar.png"), null));

 Request request =
     new Request.Builder()
         .url("https://play.min.io/my-bucketname")
         .post(multipartBuilder.build())
         .build();
 OkHttpClient httpClient = new OkHttpClient().newBuilder().build();
 Response response = httpClient.newCall(request).execute();
 if (response.isSuccessful()) {
   System.out.println("Pictures/avatar.png is uploaded successfully using POST object");
 } else {
   System.out.println("Failed to upload Pictures/avatar.png");
 }
 

Parameters:

policy - Post policy of an object.

Returns:

Map<String, String> - Contains form-data to upload an object using POST method.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

See Also:

PostPolicy

removeObject

public void removeObject(RemoveObjectArgs args)
                  throws ErrorResponseException,
                         InsufficientDataException,
                         InternalException,
                         InvalidKeyException,
                         InvalidResponseException,
                         IOException,
                         NoSuchAlgorithmException,
                         ServerException,
                         XmlParserException

Removes an object.

Example:
 // Remove object.
 minioClient.removeObject(
     RemoveObjectArgs.builder().bucket("my-bucketname").object("my-objectname").build());

 // Remove versioned object.
 minioClient.removeObject(
     RemoveObjectArgs.builder()
         .bucket("my-bucketname")
         .object("my-versioned-objectname")
         .versionId("my-versionid")
         .build());

 // Remove versioned object bypassing Governance mode.
 minioClient.removeObject(
     RemoveObjectArgs.builder()
         .bucket("my-bucketname")
         .object("my-versioned-objectname")
         .versionId("my-versionid")
         .bypassRetentionMode(true)
         .build());
 

Parameters:

args - RemoveObjectArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

removeObjects

public Iterable<Result<DeleteError>> removeObjects(RemoveObjectsArgs args)

Removes multiple objects lazily. Its required to iterate the returned Iterable to perform removal.

Example:
 List<DeleteObject> objects = new LinkedList<>();
 objects.add(new DeleteObject("my-objectname1"));
 objects.add(new DeleteObject("my-objectname2"));
 objects.add(new DeleteObject("my-objectname3"));
 Iterable<Result<DeleteError>> results =
     minioClient.removeObjects(
         RemoveObjectsArgs.builder().bucket("my-bucketname").objects(objects).build());
 for (Result<DeleteError> result : results) {
   DeleteError error = result.get();
   System.out.println(
       "Error in deleting object " + error.objectName() + "; " + error.message());
 }
 

Parameters:

args - RemoveObjectsArgs object.

Returns:

Iterable<Result<DeleteError>> - Lazy iterator contains object removal status.

restoreObject

public void restoreObject(RestoreObjectArgs args)
                   throws ErrorResponseException,
                          InsufficientDataException,
                          InternalException,
                          InvalidKeyException,
                          InvalidResponseException,
                          IOException,
                          NoSuchAlgorithmException,
                          ServerException,
                          XmlParserException

Restores an object.

Example:
 // Restore object.
 minioClient.restoreObject(
     RestoreObjectArgs.builder()
         .bucket("my-bucketname")
         .object("my-objectname")
         .request(new RestoreRequest(null, null, null, null, null, null))
         .build());

 // Restore versioned object.
 minioClient.restoreObject(
     RestoreObjectArgs.builder()
         .bucket("my-bucketname")
         .object("my-versioned-objectname")
         .versionId("my-versionid")
         .request(new RestoreRequest(null, null, null, null, null, null))
         .build());
 

Parameters:

args - RestoreObjectArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

listObjects

public Iterable<Result<Item>> listObjects(ListObjectsArgs args)

Lists objects information optionally with versions of a bucket. Supports both the versions 1 and 2 of the S3 API. By default, the version 2 API is used.
Version 1 can be used by passing the optional argument useVersion1 as true.

Example:
 // Lists objects information.
 Iterable<Result<Item>> results = minioClient.listObjects(
     ListObjectsArgs.builder().bucket("my-bucketname").build());

 // Lists objects information recursively.
 Iterable<Result<Item>> results = minioClient.listObjects(
     ListObjectsArgs.builder().bucket("my-bucketname").recursive(true).build());

 // Lists maximum 100 objects information whose names starts with 'E' and after
 // 'ExampleGuide.pdf'.
 Iterable<Result<Item>> results = minioClient.listObjects(
     ListObjectsArgs.builder()
         .bucket("my-bucketname")
         .startAfter("ExampleGuide.pdf")
         .prefix("E")
         .maxKeys(100)
         .build());

 // Lists maximum 100 objects information with version whose names starts with 'E' and after
 // 'ExampleGuide.pdf'.
 Iterable<Result<Item>> results = minioClient.listObjects(
     ListObjectsArgs.builder()
         .bucket("my-bucketname")
         .startAfter("ExampleGuide.pdf")
         .prefix("E")
         .maxKeys(100)
         .includeVersions(true)
         .build());
 

Parameters:

args - Instance of ListObjectsArgs built using the builder

Returns:

Iterable<Result<Item>> - Lazy iterator contains object information.

Throws:

XmlParserException - upon parsing response xml

listBuckets

public List<Bucket> listBuckets()
                         throws ErrorResponseException,
                                InsufficientDataException,
                                InternalException,
                                InvalidKeyException,
                                InvalidResponseException,
                                IOException,
                                NoSuchAlgorithmException,
                                ServerException,
                                XmlParserException

Lists bucket information of all buckets.

Example:
 List<Bucket> bucketList = minioClient.listBuckets();
 for (Bucket bucket : bucketList) {
   System.out.println(bucket.creationDate() + ", " + bucket.name());
 }
 

Returns:

List<Bucket> - List of bucket information.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

listBuckets

public Iterable<Result<Bucket>> listBuckets(ListBucketsArgs args)

Lists bucket information of all buckets.

Example:
 Iterable<Result<Bucket>> results = minioClient.listBuckets(ListBucketsArgs.builder().build());
 for (Result<Bucket> result : results) {
   Bucket bucket = result.get();
   System.out.println(String.format("Bucket: %s, Region: %s, CreationDate: %s", bucket.name(), bucket.bucketRegion(), bucket.creationDate()));
 }
 

Returns:

Iterable<List<Bucket>> object.

bucketExists

public boolean bucketExists(BucketExistsArgs args)
                     throws ErrorResponseException,
                            InsufficientDataException,
                            InternalException,
                            InvalidKeyException,
                            InvalidResponseException,
                            IOException,
                            NoSuchAlgorithmException,
                            ServerException,
                            XmlParserException

Checks if a bucket exists.

Example:
 boolean found =
      minioClient.bucketExists(BucketExistsArgs.builder().bucket("my-bucketname").build());
 if (found) {
   System.out.println("my-bucketname exists");
 } else {
   System.out.println("my-bucketname does not exist");
 }
 

Parameters:

args - BucketExistsArgs object.

Returns:

boolean - True if the bucket exists.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

makeBucket

public void makeBucket(MakeBucketArgs args)
                throws ErrorResponseException,
                       InsufficientDataException,
                       InternalException,
                       InvalidKeyException,
                       InvalidResponseException,
                       IOException,
                       NoSuchAlgorithmException,
                       ServerException,
                       XmlParserException

Creates a bucket with region and object lock.

Example:
 // Create bucket with default region.
 minioClient.makeBucket(
     MakeBucketArgs.builder()
         .bucket("my-bucketname")
         .build());

 // Create bucket with specific region.
 minioClient.makeBucket(
     MakeBucketArgs.builder()
         .bucket("my-bucketname")
         .region("us-west-1")
         .build());

 // Create object-lock enabled bucket with specific region.
 minioClient.makeBucket(
     MakeBucketArgs.builder()
         .bucket("my-bucketname")
         .region("us-west-1")
         .objectLock(true)
         .build());
 

Parameters:

args - Object with bucket name, region and lock functionality

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

setBucketVersioning

public void setBucketVersioning(SetBucketVersioningArgs args)
                         throws ErrorResponseException,
                                InsufficientDataException,
                                InternalException,
                                InvalidKeyException,
                                InvalidResponseException,
                                IOException,
                                NoSuchAlgorithmException,
                                ServerException,
                                XmlParserException

Sets versioning configuration of a bucket.

Example:
 minioClient.setBucketVersioning(
     SetBucketVersioningArgs.builder().bucket("my-bucketname").config(config).build());
 

Parameters:

args - SetBucketVersioningArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

getBucketVersioning

public VersioningConfiguration getBucketVersioning(GetBucketVersioningArgs args)
                                            throws ErrorResponseException,
                                                   InsufficientDataException,
                                                   InternalException,
                                                   InvalidKeyException,
                                                   InvalidResponseException,
                                                   IOException,
                                                   NoSuchAlgorithmException,
                                                   ServerException,
                                                   XmlParserException

Gets versioning configuration of a bucket.

Example:
 VersioningConfiguration config =
     minioClient.getBucketVersioning(
         GetBucketVersioningArgs.builder().bucket("my-bucketname").build());
 

Parameters:

args - GetBucketVersioningArgs object.

Returns:

VersioningConfiguration - Versioning configuration.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

setObjectLockConfiguration

public void setObjectLockConfiguration(SetObjectLockConfigurationArgs args)
                                throws ErrorResponseException,
                                       InsufficientDataException,
                                       InternalException,
                                       InvalidKeyException,
                                       InvalidResponseException,
                                       IOException,
                                       NoSuchAlgorithmException,
                                       ServerException,
                                       XmlParserException

Sets default object retention in a bucket.

Example:
 ObjectLockConfiguration config = new ObjectLockConfiguration(
     RetentionMode.COMPLIANCE, new RetentionDurationDays(100));
 minioClient.setObjectLockConfiguration(
     SetObjectLockConfigurationArgs.builder().bucket("my-bucketname").config(config).build());
 

Parameters:

args - SetObjectLockConfigurationArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

deleteObjectLockConfiguration

public void deleteObjectLockConfiguration(DeleteObjectLockConfigurationArgs args)
                                   throws ErrorResponseException,
                                          InsufficientDataException,
                                          InternalException,
                                          InvalidKeyException,
                                          InvalidResponseException,
                                          IOException,
                                          NoSuchAlgorithmException,
                                          ServerException,
                                          XmlParserException

Deletes default object retention in a bucket.

Example:
 minioClient.deleteObjectLockConfiguration(
     DeleteObjectLockConfigurationArgs.builder().bucket("my-bucketname").build());
 

Parameters:

args - DeleteObjectLockConfigurationArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

getObjectLockConfiguration

public ObjectLockConfiguration getObjectLockConfiguration(GetObjectLockConfigurationArgs args)
                                                   throws ErrorResponseException,
                                                          InsufficientDataException,
                                                          InternalException,
                                                          InvalidKeyException,
                                                          InvalidResponseException,
                                                          IOException,
                                                          NoSuchAlgorithmException,
                                                          ServerException,
                                                          XmlParserException

Gets default object retention in a bucket.

Example:
 ObjectLockConfiguration config =
     minioClient.getObjectLockConfiguration(
         GetObjectLockConfigurationArgs.builder().bucket("my-bucketname").build());
 System.out.println("Mode: " + config.mode());
 System.out.println(
     "Duration: " + config.duration().duration() + " " + config.duration().unit());
 

Parameters:

args - GetObjectLockConfigurationArgs object.

Returns:

ObjectLockConfiguration - Default retention configuration.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

setObjectRetention

public void setObjectRetention(SetObjectRetentionArgs args)
                        throws ErrorResponseException,
                               InsufficientDataException,
                               InternalException,
                               InvalidKeyException,
                               InvalidResponseException,
                               IOException,
                               NoSuchAlgorithmException,
                               ServerException,
                               XmlParserException

Sets retention configuration to an object.

Example:
  Retention retention = new Retention(
       RetentionMode.COMPLIANCE, ZonedDateTime.now().plusYears(1));
  minioClient.setObjectRetention(
      SetObjectRetentionArgs.builder()
          .bucket("my-bucketname")
          .object("my-objectname")
          .config(config)
          .bypassGovernanceMode(true)
          .build());
 

Parameters:

args - SetObjectRetentionArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

getObjectRetention

public Retention getObjectRetention(GetObjectRetentionArgs args)
                             throws ErrorResponseException,
                                    InsufficientDataException,
                                    InternalException,
                                    InvalidKeyException,
                                    InvalidResponseException,
                                    IOException,
                                    NoSuchAlgorithmException,
                                    ServerException,
                                    XmlParserException

Gets retention configuration of an object.

Example:
 Retention retention =
     minioClient.getObjectRetention(GetObjectRetentionArgs.builder()
        .bucket(bucketName)
        .object(objectName)
        .versionId(versionId)
        .build()););
 System.out.println(
     "mode: " + retention.mode() + "until: " + retention.retainUntilDate());
 

Parameters:

args - GetObjectRetentionArgs object.

Returns:

Retention - Object retention configuration.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

enableObjectLegalHold

public void enableObjectLegalHold(EnableObjectLegalHoldArgs args)
                           throws ErrorResponseException,
                                  InsufficientDataException,
                                  InternalException,
                                  InvalidKeyException,
                                  InvalidResponseException,
                                  IOException,
                                  NoSuchAlgorithmException,
                                  ServerException,
                                  XmlParserException

Enables legal hold on an object.

Example:
 minioClient.enableObjectLegalHold(
    EnableObjectLegalHoldArgs.builder()
        .bucket("my-bucketname")
        .object("my-objectname")
        .versionId("object-versionId")
        .build());
 

Parameters:

args - EnableObjectLegalHoldArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

disableObjectLegalHold

public void disableObjectLegalHold(DisableObjectLegalHoldArgs args)
                            throws ErrorResponseException,
                                   InsufficientDataException,
                                   InternalException,
                                   InvalidKeyException,
                                   InvalidResponseException,
                                   IOException,
                                   NoSuchAlgorithmException,
                                   ServerException,
                                   XmlParserException

Disables legal hold on an object.

Example:
 minioClient.disableObjectLegalHold(
    DisableObjectLegalHoldArgs.builder()
        .bucket("my-bucketname")
        .object("my-objectname")
        .versionId("object-versionId")
        .build());
 

Parameters:

args - DisableObjectLegalHoldArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

isObjectLegalHoldEnabled

public boolean isObjectLegalHoldEnabled(IsObjectLegalHoldEnabledArgs args)
                                 throws ErrorResponseException,
                                        InsufficientDataException,
                                        InternalException,
                                        InvalidKeyException,
                                        InvalidResponseException,
                                        IOException,
                                        NoSuchAlgorithmException,
                                        ServerException,
                                        XmlParserException

Returns true if legal hold is enabled on an object.

Example:
 boolean status =
     s3Client.isObjectLegalHoldEnabled(
        IsObjectLegalHoldEnabledArgs.builder()
             .bucket("my-bucketname")
             .object("my-objectname")
             .versionId("object-versionId")
             .build());
 if (status) {
   System.out.println("Legal hold is on");
  } else {
   System.out.println("Legal hold is off");
  }
 

args IsObjectLegalHoldEnabledArgs object.

Returns:

boolean - True if legal hold is enabled.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

removeBucket

public void removeBucket(RemoveBucketArgs args)
                  throws ErrorResponseException,
                         InsufficientDataException,
                         InternalException,
                         InvalidKeyException,
                         InvalidResponseException,
                         IOException,
                         NoSuchAlgorithmException,
                         ServerException,
                         XmlParserException

Removes an empty bucket using arguments

Example:
 minioClient.removeBucket(RemoveBucketArgs.builder().bucket("my-bucketname").build());
 

Parameters:

args - RemoveBucketArgs bucket.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

putObject

public ObjectWriteResponse putObject(PutObjectArgs args)
                              throws ErrorResponseException,
                                     InsufficientDataException,
                                     InternalException,
                                     InvalidKeyException,
                                     InvalidResponseException,
                                     IOException,
                                     NoSuchAlgorithmException,
                                     ServerException,
                                     XmlParserException

Uploads data from a stream to an object.

Example:
 // Upload known sized input stream.
 minioClient.putObject(
     PutObjectArgs.builder().bucket("my-bucketname").object("my-objectname").stream(
             inputStream, size, -1)
         .contentType("video/mp4")
         .build());

 // Upload unknown sized input stream.
 minioClient.putObject(
     PutObjectArgs.builder().bucket("my-bucketname").object("my-objectname").stream(
             inputStream, -1, 10485760)
         .contentType("video/mp4")
         .build());

 // Create object ends with '/' (also called as folder or directory).
 minioClient.putObject(
     PutObjectArgs.builder().bucket("my-bucketname").object("path/to/").stream(
             new ByteArrayInputStream(new byte[] {}), 0, -1)
         .build());

 // Upload input stream with headers and user metadata.
 Map<String, String> headers = new HashMap<>();
 headers.put("X-Amz-Storage-Class", "REDUCED_REDUNDANCY");
 Map<String, String> userMetadata = new HashMap<>();
 userMetadata.put("My-Project", "Project One");
 minioClient.putObject(
     PutObjectArgs.builder().bucket("my-bucketname").object("my-objectname").stream(
             inputStream, size, -1)
         .headers(headers)
         .userMetadata(userMetadata)
         .build());

 // Upload input stream with server-side encryption.
 minioClient.putObject(
     PutObjectArgs.builder().bucket("my-bucketname").object("my-objectname").stream(
             inputStream, size, -1)
         .sse(sse)
         .build());
 

Parameters:

args - PutObjectArgs object.

Returns:

ObjectWriteResponse object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

uploadObject

public ObjectWriteResponse uploadObject(UploadObjectArgs args)
                                 throws ErrorResponseException,
                                        InsufficientDataException,
                                        InternalException,
                                        InvalidKeyException,
                                        InvalidResponseException,
                                        IOException,
                                        NoSuchAlgorithmException,
                                        ServerException,
                                        XmlParserException

Uploads data from a file to an object.

Example:
 // Upload an JSON file.
 minioClient.uploadObject(
     UploadObjectArgs.builder()
         .bucket("my-bucketname").object("my-objectname").filename("person.json").build());

 // Upload a video file.
 minioClient.uploadObject(
     UploadObjectArgs.builder()
         .bucket("my-bucketname")
         .object("my-objectname")
         .filename("my-video.avi")
         .contentType("video/mp4")
         .build());
 

Parameters:

args - UploadObjectArgs object.

Returns:

ObjectWriteResponse object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

getBucketPolicy

public String getBucketPolicy(GetBucketPolicyArgs args)
                       throws BucketPolicyTooLargeException,
                              ErrorResponseException,
                              InsufficientDataException,
                              InternalException,
                              InvalidKeyException,
                              InvalidResponseException,
                              IOException,
                              NoSuchAlgorithmException,
                              ServerException,
                              XmlParserException

Gets bucket policy configuration of a bucket.

Example:
 String config =
     minioClient.getBucketPolicy(GetBucketPolicyArgs.builder().bucket("my-bucketname").build());
 

Parameters:

args - GetBucketPolicyArgs object.

Returns:

String - Bucket policy configuration as JSON string.

Throws:

BucketPolicyTooLargeException - thrown to indicate returned bucket policy is too large.

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

setBucketPolicy

public void setBucketPolicy(SetBucketPolicyArgs args)
                     throws ErrorResponseException,
                            InsufficientDataException,
                            InternalException,
                            InvalidKeyException,
                            InvalidResponseException,
                            IOException,
                            NoSuchAlgorithmException,
                            ServerException,
                            XmlParserException

Sets bucket policy configuration to a bucket.

Example:
 // Assume policyJson contains below JSON string;
 // {
 //     "Statement": [
 //         {
 //             "Action": [
 //                 "s3:GetBucketLocation",
 //                 "s3:ListBucket"
 //             ],
 //             "Effect": "Allow",
 //             "Principal": "*",
 //             "Resource": "arn:aws:s3:::my-bucketname"
 //         },
 //         {
 //             "Action": "s3:GetObject",
 //             "Effect": "Allow",
 //             "Principal": "*",
 //             "Resource": "arn:aws:s3:::my-bucketname/myobject*"
 //         }
 //     ],
 //     "Version": "2012-10-17"
 // }
 //
 minioClient.setBucketPolicy(
     SetBucketPolicyArgs.builder().bucket("my-bucketname").config(policyJson).build());
 

Parameters:

args - SetBucketPolicyArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

deleteBucketPolicy

public void deleteBucketPolicy(DeleteBucketPolicyArgs args)
                        throws ErrorResponseException,
                               InsufficientDataException,
                               InternalException,
                               InvalidKeyException,
                               InvalidResponseException,
                               IOException,
                               NoSuchAlgorithmException,
                               ServerException,
                               XmlParserException

Deletes bucket policy configuration to a bucket.

Example:
 minioClient.deleteBucketPolicy(DeleteBucketPolicyArgs.builder().bucket("my-bucketname"));
 

Parameters:

args - DeleteBucketPolicyArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

setBucketLifecycle

public void setBucketLifecycle(SetBucketLifecycleArgs args)
                        throws ErrorResponseException,
                               InsufficientDataException,
                               InternalException,
                               InvalidKeyException,
                               InvalidResponseException,
                               IOException,
                               NoSuchAlgorithmException,
                               ServerException,
                               XmlParserException

Sets lifecycle configuration to a bucket.

Example:
 List<LifecycleRule> rules = new LinkedList<>();
 rules.add(
     new LifecycleRule(
         Status.ENABLED,
         null,
         new Expiration((ZonedDateTime) null, 365, null),
         new RuleFilter("logs/"),
         "rule2",
         null,
         null,
         null));
 LifecycleConfiguration config = new LifecycleConfiguration(rules);
 minioClient.setBucketLifecycle(
     SetBucketLifecycleArgs.builder().bucket("my-bucketname").config(config).build());
 

Parameters:

args - SetBucketLifecycleArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

deleteBucketLifecycle

public void deleteBucketLifecycle(DeleteBucketLifecycleArgs args)
                           throws ErrorResponseException,
                                  InsufficientDataException,
                                  InternalException,
                                  InvalidKeyException,
                                  InvalidResponseException,
                                  IOException,
                                  NoSuchAlgorithmException,
                                  ServerException,
                                  XmlParserException

Deletes lifecycle configuration of a bucket.

Example:
 deleteBucketLifecycle(DeleteBucketLifecycleArgs.builder().bucket("my-bucketname").build());
 

Parameters:

args - DeleteBucketLifecycleArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

getBucketLifecycle

public LifecycleConfiguration getBucketLifecycle(GetBucketLifecycleArgs args)
                                          throws ErrorResponseException,
                                                 InsufficientDataException,
                                                 InternalException,
                                                 InvalidKeyException,
                                                 InvalidResponseException,
                                                 IOException,
                                                 NoSuchAlgorithmException,
                                                 ServerException,
                                                 XmlParserException

Gets lifecycle configuration of a bucket.

Example:
 LifecycleConfiguration config =
     minioClient.getBucketLifecycle(
         GetBucketLifecycleArgs.builder().bucket("my-bucketname").build());
 

Parameters:

args - GetBucketLifecycleArgs object.

Returns:

LifecycleConfiguration object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

getBucketNotification

public NotificationConfiguration getBucketNotification(GetBucketNotificationArgs args)
                                                throws ErrorResponseException,
                                                       InsufficientDataException,
                                                       InternalException,
                                                       InvalidKeyException,
                                                       InvalidResponseException,
                                                       IOException,
                                                       NoSuchAlgorithmException,
                                                       ServerException,
                                                       XmlParserException

Gets notification configuration of a bucket.

Example:
 NotificationConfiguration config =
     minioClient.getBucketNotification(
         GetBucketNotificationArgs.builder().bucket("my-bucketname").build());
 

Parameters:

args - GetBucketNotificationArgs object.

Returns:

NotificationConfiguration - Notification configuration.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

setBucketNotification

public void setBucketNotification(SetBucketNotificationArgs args)
                           throws ErrorResponseException,
                                  InsufficientDataException,
                                  InternalException,
                                  InvalidKeyException,
                                  InvalidResponseException,
                                  IOException,
                                  NoSuchAlgorithmException,
                                  ServerException,
                                  XmlParserException

Sets notification configuration to a bucket.

Example:
 List<EventType> eventList = new LinkedList<>();
 eventList.add(EventType.OBJECT_CREATED_PUT);
 eventList.add(EventType.OBJECT_CREATED_COPY);

 QueueConfiguration queueConfiguration = new QueueConfiguration();
 queueConfiguration.setQueue("arn:minio:sqs::1:webhook");
 queueConfiguration.setEvents(eventList);
 queueConfiguration.setPrefixRule("images");
 queueConfiguration.setSuffixRule("pg");

 List<QueueConfiguration> queueConfigurationList = new LinkedList<>();
 queueConfigurationList.add(queueConfiguration);

 NotificationConfiguration config = new NotificationConfiguration();
 config.setQueueConfigurationList(queueConfigurationList);

 minioClient.setBucketNotification(
     SetBucketNotificationArgs.builder().bucket("my-bucketname").config(config).build());
 

Parameters:

args - SetBucketNotificationArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

deleteBucketNotification

public void deleteBucketNotification(DeleteBucketNotificationArgs args)
                              throws ErrorResponseException,
                                     InsufficientDataException,
                                     InternalException,
                                     InvalidKeyException,
                                     InvalidResponseException,
                                     IOException,
                                     NoSuchAlgorithmException,
                                     ServerException,
                                     XmlParserException

Deletes notification configuration of a bucket.

Example:
 minioClient.deleteBucketNotification(
     DeleteBucketNotificationArgs.builder().bucket("my-bucketname").build());
 

Parameters:

args - DeleteBucketNotificationArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

getBucketReplication

public ReplicationConfiguration getBucketReplication(GetBucketReplicationArgs args)
                                              throws ErrorResponseException,
                                                     InsufficientDataException,
                                                     InternalException,
                                                     InvalidKeyException,
                                                     InvalidResponseException,
                                                     IOException,
                                                     NoSuchAlgorithmException,
                                                     ServerException,
                                                     XmlParserException

Gets bucket replication configuration of a bucket.

Example:
 ReplicationConfiguration config =
     minioClient.getBucketReplication(
         GetBucketReplicationArgs.builder().bucket("my-bucketname").build());
 

Parameters:

args - GetBucketReplicationArgs object.

Returns:

ReplicationConfiguration object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

setBucketReplication

public void setBucketReplication(SetBucketReplicationArgs args)
                          throws ErrorResponseException,
                                 InsufficientDataException,
                                 InternalException,
                                 InvalidKeyException,
                                 InvalidResponseException,
                                 IOException,
                                 NoSuchAlgorithmException,
                                 ServerException,
                                 XmlParserException

Sets bucket replication configuration to a bucket.

Example:
 Map<String, String> tags = new HashMap<>();
 tags.put("key1", "value1");
 tags.put("key2", "value2");

 ReplicationRule rule =
     new ReplicationRule(
         new DeleteMarkerReplication(Status.DISABLED),
         new ReplicationDestination(
             null, null, "REPLACE-WITH-ACTUAL-DESTINATION-BUCKET-ARN", null, null, null, null),
         null,
         new RuleFilter(new AndOperator("TaxDocs", tags)),
         "rule1",
         null,
         1,
         null,
         Status.ENABLED);

 List<ReplicationRule> rules = new LinkedList<>();
 rules.add(rule);

 ReplicationConfiguration config =
     new ReplicationConfiguration("REPLACE-WITH-ACTUAL-ROLE", rules);

 minioClient.setBucketReplication(
     SetBucketReplicationArgs.builder().bucket("my-bucketname").config(config).build());
 

Parameters:

args - SetBucketReplicationArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

deleteBucketReplication

public void deleteBucketReplication(DeleteBucketReplicationArgs args)
                             throws ErrorResponseException,
                                    InsufficientDataException,
                                    InternalException,
                                    InvalidKeyException,
                                    InvalidResponseException,
                                    IOException,
                                    NoSuchAlgorithmException,
                                    ServerException,
                                    XmlParserException

Deletes bucket replication configuration from a bucket.

Example:
 minioClient.deleteBucketReplication(
     DeleteBucketReplicationArgs.builder().bucket("my-bucketname"));
 

Parameters:

args - DeleteBucketReplicationArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

listenBucketNotification

public CloseableIterator<Result<NotificationRecords>> listenBucketNotification(ListenBucketNotificationArgs args)
                                                                        throws ErrorResponseException,
                                                                               InsufficientDataException,
                                                                               InternalException,
                                                                               InvalidKeyException,
                                                                               InvalidResponseException,
                                                                               IOException,
                                                                               NoSuchAlgorithmException,
                                                                               ServerException,
                                                                               XmlParserException

Listens events of object prefix and suffix of a bucket. The returned closable iterator is lazily evaluated hence its required to iterate to get new records and must be used with try-with-resource to release underneath network resources.

Example:
 String[] events = {"s3:ObjectCreated:*", "s3:ObjectAccessed:*"};
 try (CloseableIterator<Result<NotificationRecords>> ci =
     minioClient.listenBucketNotification(
         ListenBucketNotificationArgs.builder()
             .bucket("bucketName")
             .prefix("")
             .suffix("")
             .events(events)
             .build())) {
   while (ci.hasNext()) {
     NotificationRecords records = ci.next().get();
     for (Event event : records.events()) {
       System.out.println("Event " + event.eventType() + " occurred at "
           + event.eventTime() + " for " + event.bucketName() + "/"
           + event.objectName());
     }
   }
 }
 

Parameters:

args - ListenBucketNotificationArgs object.

Returns:

CloseableIterator<Result<NotificationRecords>> - Lazy closable iterator contains event records.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

selectObjectContent

public SelectResponseStream selectObjectContent(SelectObjectContentArgs args)
                                         throws ErrorResponseException,
                                                InsufficientDataException,
                                                InternalException,
                                                InvalidKeyException,
                                                InvalidResponseException,
                                                IOException,
                                                NoSuchAlgorithmException,
                                                ServerException,
                                                XmlParserException

Selects content of an object by SQL expression.

Example:
 String sqlExpression = "select * from S3Object";
 InputSerialization is =
     new InputSerialization(null, false, null, null, FileHeaderInfo.USE, null, null,
         null);
 OutputSerialization os =
     new OutputSerialization(null, null, null, QuoteFields.ASNEEDED, null);
 SelectResponseStream stream =
     minioClient.selectObjectContent(
       SelectObjectContentArgs.builder()
       .bucket("my-bucketname")
       .object("my-objectname")
       .sqlExpression(sqlExpression)
       .inputSerialization(is)
       .outputSerialization(os)
       .requestProgress(true)
       .build());

 byte[] buf = new byte[512];
 int bytesRead = stream.read(buf, 0, buf.length);
 System.out.println(new String(buf, 0, bytesRead, StandardCharsets.UTF_8));

 Stats stats = stream.stats();
 System.out.println("bytes scanned: " + stats.bytesScanned());
 System.out.println("bytes processed: " + stats.bytesProcessed());
 System.out.println("bytes returned: " + stats.bytesReturned());

 stream.close();
 

Parameters:

args - instance of SelectObjectContentArgs

Returns:

SelectResponseStream - Contains filtered records and progress.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

setBucketEncryption

public void setBucketEncryption(SetBucketEncryptionArgs args)
                         throws ErrorResponseException,
                                InsufficientDataException,
                                InternalException,
                                InvalidKeyException,
                                InvalidResponseException,
                                IOException,
                                NoSuchAlgorithmException,
                                ServerException,
                                XmlParserException

Sets encryption configuration of a bucket.

Example:
 minioClient.setBucketEncryption(
     SetBucketEncryptionArgs.builder().bucket("my-bucketname").config(config).build());
 

Parameters:

args - SetBucketEncryptionArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

getBucketEncryption

public SseConfiguration getBucketEncryption(GetBucketEncryptionArgs args)
                                     throws ErrorResponseException,
                                            InsufficientDataException,
                                            InternalException,
                                            InvalidKeyException,
                                            InvalidResponseException,
                                            IOException,
                                            NoSuchAlgorithmException,
                                            ServerException,
                                            XmlParserException

Gets encryption configuration of a bucket.

Example:
 SseConfiguration config =
     minioClient.getBucketEncryption(
         GetBucketEncryptionArgs.builder().bucket("my-bucketname").build());
 

Parameters:

args - GetBucketEncryptionArgs object.

Returns:

SseConfiguration - Server-side encryption configuration.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

deleteBucketEncryption

public void deleteBucketEncryption(DeleteBucketEncryptionArgs args)
                            throws ErrorResponseException,
                                   InsufficientDataException,
                                   InternalException,
                                   InvalidKeyException,
                                   InvalidResponseException,
                                   IOException,
                                   NoSuchAlgorithmException,
                                   ServerException,
                                   XmlParserException

Deletes encryption configuration of a bucket.

Example:
 minioClient.deleteBucketEncryption(
     DeleteBucketEncryptionArgs.builder().bucket("my-bucketname").build());
 

Parameters:

args - DeleteBucketEncryptionArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

getBucketTags

public Tags getBucketTags(GetBucketTagsArgs args)
                   throws ErrorResponseException,
                          InsufficientDataException,
                          InternalException,
                          InvalidKeyException,
                          InvalidResponseException,
                          IOException,
                          NoSuchAlgorithmException,
                          ServerException,
                          XmlParserException

Gets tags of a bucket.

Example:
 Tags tags =
     minioClient.getBucketTags(GetBucketTagsArgs.builder().bucket("my-bucketname").build());
 

Parameters:

args - GetBucketTagsArgs object.

Returns:

Tags - Tags.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

setBucketTags

public void setBucketTags(SetBucketTagsArgs args)
                   throws ErrorResponseException,
                          InsufficientDataException,
                          InternalException,
                          InvalidKeyException,
                          InvalidResponseException,
                          IOException,
                          NoSuchAlgorithmException,
                          ServerException,
                          XmlParserException

Sets tags to a bucket.

Example:
 Map<String, String> map = new HashMap<>();
 map.put("Project", "Project One");
 map.put("User", "jsmith");
 minioClient.setBucketTags(
     SetBucketTagsArgs.builder().bucket("my-bucketname").tags(map).build());
 

Parameters:

args - SetBucketTagsArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

deleteBucketTags

public void deleteBucketTags(DeleteBucketTagsArgs args)
                      throws ErrorResponseException,
                             InsufficientDataException,
                             InternalException,
                             InvalidKeyException,
                             InvalidResponseException,
                             IOException,
                             NoSuchAlgorithmException,
                             ServerException,
                             XmlParserException

Deletes tags of a bucket.

Example:
 minioClient.deleteBucketTags(DeleteBucketTagsArgs.builder().bucket("my-bucketname").build());
 

Parameters:

args - DeleteBucketTagsArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

getObjectTags

public Tags getObjectTags(GetObjectTagsArgs args)
                   throws ErrorResponseException,
                          InsufficientDataException,
                          InternalException,
                          InvalidKeyException,
                          InvalidResponseException,
                          IOException,
                          NoSuchAlgorithmException,
                          ServerException,
                          XmlParserException

Gets tags of an object.

Example:
 Tags tags =
     minioClient.getObjectTags(
         GetObjectTagsArgs.builder().bucket("my-bucketname").object("my-objectname").build());
 

Parameters:

args - GetObjectTagsArgs object.

Returns:

Tags - Tags.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

setObjectTags

public void setObjectTags(SetObjectTagsArgs args)
                   throws ErrorResponseException,
                          InsufficientDataException,
                          InternalException,
                          InvalidKeyException,
                          InvalidResponseException,
                          IOException,
                          NoSuchAlgorithmException,
                          ServerException,
                          XmlParserException

Sets tags to an object.

Example:
 Map<String, String> map = new HashMap<>();
 map.put("Project", "Project One");
 map.put("User", "jsmith");
 minioClient.setObjectTags(
     SetObjectTagsArgs.builder()
         .bucket("my-bucketname")
         .object("my-objectname")
         .tags((map)
         .build());
 

Parameters:

args - SetObjectTagsArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

deleteObjectTags

public void deleteObjectTags(DeleteObjectTagsArgs args)
                      throws ErrorResponseException,
                             InsufficientDataException,
                             InternalException,
                             InvalidKeyException,
                             InvalidResponseException,
                             IOException,
                             NoSuchAlgorithmException,
                             ServerException,
                             XmlParserException

Deletes tags of an object.

Example:
 minioClient.deleteObjectTags(
     DeleteObjectTags.builder().bucket("my-bucketname").object("my-objectname").build());
 

Parameters:

args - DeleteObjectTagsArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

getBucketCors

public CORSConfiguration getBucketCors(GetBucketCorsArgs args)
                                throws ErrorResponseException,
                                       InsufficientDataException,
                                       InternalException,
                                       InvalidKeyException,
                                       InvalidResponseException,
                                       IOException,
                                       NoSuchAlgorithmException,
                                       ServerException,
                                       XmlParserException

Gets CORS configuration of a bucket.

Example:
 CORSConfiguration config =
     minioClient.getBucketCors(GetBucketCorsArgs.builder().bucket("my-bucketname").build());
 

Parameters:

args - GetBucketCorsArgs object.

Returns:

CORSConfiguration - CORSConfiguration.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

setBucketCors

public void setBucketCors(SetBucketCorsArgs args)
                   throws ErrorResponseException,
                          InsufficientDataException,
                          InternalException,
                          InvalidKeyException,
                          InvalidResponseException,
                          IOException,
                          NoSuchAlgorithmException,
                          ServerException,
                          XmlParserException

Sets CORS configuration to a bucket.

Example:
 CORSConfiguration config =
     new CORSConfiguration(
         Arrays.asList(
             new CORSConfiguration.CORSRule[] {
               // Rule 1
               new CORSConfiguration.CORSRule(
                   Arrays.asList(new String[] {"*"}), // Allowed headers
                   Arrays.asList(new String[] {"PUT", "POST", "DELETE"}), // Allowed methods
                   Arrays.asList(new String[] {"http://www.example.com"}), // Allowed origins
                   Arrays.asList(
                       new String[] {"x-amz-server-side-encryption"}), // Expose headers
                   null, // ID
                   3000), // Maximum age seconds
               // Rule 2
               new CORSConfiguration.CORSRule(
                   null, // Allowed headers
                   Arrays.asList(new String[] {"GET"}), // Allowed methods
                   Arrays.asList(new String[] {"*"}), // Allowed origins
                   null, // Expose headers
                   null, // ID
                   null // Maximum age seconds
                   )
             }));
 minioClient.setBucketCors(
     SetBucketCorsArgs.builder().bucket("my-bucketname").config(config).build());
 

Parameters:

args - SetBucketCorsArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

deleteBucketCors

public void deleteBucketCors(DeleteBucketCorsArgs args)
                      throws ErrorResponseException,
                             InsufficientDataException,
                             InternalException,
                             InvalidKeyException,
                             InvalidResponseException,
                             IOException,
                             NoSuchAlgorithmException,
                             ServerException,
                             XmlParserException

Deletes CORS configuration of a bucket.

Example:
 minioClient.deleteBucketCors(DeleteBucketCorsArgs.builder().bucket("my-bucketname").build());
 

Parameters:

args - DeleteBucketCorsArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

getObjectAcl

public AccessControlPolicy getObjectAcl(GetObjectAclArgs args)
                                 throws ErrorResponseException,
                                        InsufficientDataException,
                                        InternalException,
                                        InvalidKeyException,
                                        InvalidResponseException,
                                        IOException,
                                        NoSuchAlgorithmException,
                                        ServerException,
                                        XmlParserException

Gets access control policy of an object.

Example:
 AccessControlPolicy policy =
     minioClient.getObjectAcl(
         GetObjectAclArgs.builder().bucket("my-bucketname").object("my-objectname").build());
 

Parameters:

args - GetObjectAclArgs object.

Returns:

AccessControlPolicy - Access control policy object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

getObjectAttributes

public GetObjectAttributesResponse getObjectAttributes(GetObjectAttributesArgs args)
                                                throws ErrorResponseException,
                                                       InsufficientDataException,
                                                       InternalException,
                                                       InvalidKeyException,
                                                       InvalidResponseException,
                                                       IOException,
                                                       NoSuchAlgorithmException,
                                                       ServerException,
                                                       XmlParserException

Gets attributes of an object.

Example:
 GetObjectAttributesResponse response =
     minioClient.getObjectAttributes(
         GetObjectAttributesArgs.builder()
             .bucket("my-bucketname")
             .object("my-objectname")
             .objectAttributes(
                 new String[] {
                   "ETag", "Checksum", "ObjectParts", "StorageClass", "ObjectSize"
                 })
             .build());
 

Parameters:

args - GetObjectAttributesArgs object.

Returns:

GetObjectAttributesResponse - Response object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

uploadSnowballObjects

public ObjectWriteResponse uploadSnowballObjects(UploadSnowballObjectsArgs args)
                                          throws ErrorResponseException,
                                                 InsufficientDataException,
                                                 InternalException,
                                                 InvalidKeyException,
                                                 InvalidResponseException,
                                                 IOException,
                                                 NoSuchAlgorithmException,
                                                 ServerException,
                                                 XmlParserException

Uploads multiple objects in a single put call. It is done by creating intermediate TAR file optionally compressed which is uploaded to S3 service.

Example:
 // Upload snowball objects.
 List<SnowballObject> objects = new ArrayList<SnowballObject>();
 objects.add(
     new SnowballObject(
         "my-object-one",
         new ByteArrayInputStream("hello".getBytes(StandardCharsets.UTF_8)),
         5,
         null));
 objects.add(
     new SnowballObject(
         "my-object-two",
         new ByteArrayInputStream("java".getBytes(StandardCharsets.UTF_8)),
         4,
         null));
 minioClient.uploadSnowballObjects(
     UploadSnowballObjectsArgs.builder().bucket("my-bucketname").objects(objects).build());
 

Parameters:

args - UploadSnowballObjectsArgs object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

putObjectFanOut

public PutObjectFanOutResponse putObjectFanOut(PutObjectFanOutArgs args)
                                        throws ErrorResponseException,
                                               InsufficientDataException,
                                               InternalException,
                                               InvalidKeyException,
                                               InvalidResponseException,
                                               IOException,
                                               NoSuchAlgorithmException,
                                               ServerException,
                                               XmlParserException

Uploads multiple objects with same content from single stream with optional metadata and tags.

Example:
 Map<String, String> map = new HashMap<>();
 map.put("Project", "Project One");
 map.put("User", "jsmith");
 PutObjectFanOutResponse future =
     minioClient.putObjectFanOut(
         PutObjectFanOutArgs.builder().bucket("my-bucketname").stream(
                 new ByteArrayInputStream("somedata".getBytes(StandardCharsets.UTF_8)), 8)
             .entries(
                 Arrays.asList(
                     new PutObjectFanOutEntry[] {
                       PutObjectFanOutEntry.builder().key("fan-out.0").build(),
                       PutObjectFanOutEntry.builder().key("fan-out.1").tags(map).build()
                     }))
             .build());
 

Parameters:

args - PutObjectFanOutArgs object.

Returns:

PutObjectFanOutResponse object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

promptObject

public PromptObjectResponse promptObject(PromptObjectArgs args)
                                  throws ErrorResponseException,
                                         InsufficientDataException,
                                         InternalException,
                                         InvalidKeyException,
                                         InvalidResponseException,
                                         IOException,
                                         NoSuchAlgorithmException,
                                         ServerException,
                                         XmlParserException

Performs language model inference with the prompt and referenced object as context.

Parameters:

args - PromptObjectArgs object.

Returns:

PromptObjectResponse object.

Throws:

ErrorResponseException - thrown to indicate S3 service returned an error response.

InsufficientDataException - thrown to indicate not enough data available in InputStream.

InternalException - thrown to indicate internal library error.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

InvalidResponseException - thrown to indicate S3 service returned invalid or no error response.

IOException - thrown to indicate I/O error on S3 operation.

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

XmlParserException - thrown to indicate XML parsing error.

ServerException

setTimeout

public void setTimeout(long connectTimeout,
                       long writeTimeout,
                       long readTimeout)

Sets HTTP connect, write and read timeouts. A value of 0 means no timeout, otherwise values must be between 1 and Integer.MAX_VALUE when converted to milliseconds.

Example:
 minioClient.setTimeout(TimeUnit.SECONDS.toMillis(10), TimeUnit.SECONDS.toMillis(10),
     TimeUnit.SECONDS.toMillis(30));
 

Parameters:

connectTimeout - HTTP connect timeout in milliseconds.

writeTimeout - HTTP write timeout in milliseconds.

readTimeout - HTTP read timeout in milliseconds.

ignoreCertCheck

public void ignoreCertCheck()
                     throws KeyManagementException,
                            NoSuchAlgorithmException

Ignores check on server certificate for HTTPS connection.

Example:
 minioClient.ignoreCertCheck();
 

Throws:

KeyManagementException - thrown to indicate key management error.

NoSuchAlgorithmException - thrown to indicate missing of SSL library.

setAppInfo

public void setAppInfo(String name,
                       String version)

Sets application's name/version to user agent. For more information about user agent refer #rfc2616.

Parameters:

name - Your application name.

version - Your application version.

traceOn

public void traceOn(OutputStream traceStream)

Enables HTTP call tracing and written to traceStream.

Parameters:

traceStream - OutputStream for writing HTTP call tracing.

See Also:

traceOff()

traceOff

public void traceOff()
              throws IOException

Disables HTTP call tracing previously enabled.

Throws:

IOException - upon connection error

See Also:

traceOn(java.io.OutputStream)

enableAccelerateEndpoint

@Deprecated
public void enableAccelerateEndpoint()

Deprecated. This method is no longer supported.

Enables accelerate endpoint for Amazon S3 endpoint.

disableAccelerateEndpoint

@Deprecated
public void disableAccelerateEndpoint()

Deprecated. This method is no longer supported.

Disables accelerate endpoint for Amazon S3 endpoint.

enableDualStackEndpoint

public void enableDualStackEndpoint()

Enables dual-stack endpoint for Amazon S3 endpoint.

disableDualStackEndpoint

public void disableDualStackEndpoint()

Disables dual-stack endpoint for Amazon S3 endpoint.

enableVirtualStyleEndpoint

public void enableVirtualStyleEndpoint()

Enables virtual-style endpoint.

disableVirtualStyleEndpoint

public void disableVirtualStyleEndpoint()

Disables virtual-style endpoint.

setAwsS3Prefix

public void setAwsS3Prefix(String awsS3Prefix)

Sets AWS S3 domain prefix.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

builder

public static MinioClient.Builder builder()