MinioClient (api 7.1.4 API)

java.lang.Object
- io.minio.MinioClient

```
public class MinioClient
extends Object
```
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

Nested Classes
Modifier and Type	Class and Description
`static class`	`MinioClient.Builder`

Constructor Summary

Constructors
Constructor and Description
`MinioClient(okhttp3.HttpUrl url)` Deprecated.
`MinioClient(okhttp3.HttpUrl url, String accessKey, String secretKey)` Deprecated.
`MinioClient(String endpoint)` Deprecated.
`MinioClient(String endpoint, Integer port, String accessKey, String secretKey, String region, Boolean secure, okhttp3.OkHttpClient httpClient)` Deprecated.
`MinioClient(String endpoint, int port, String accessKey, String secretKey)` Deprecated.
`MinioClient(String endpoint, int port, String accessKey, String secretKey, boolean secure)` Deprecated.
`MinioClient(String endpoint, int port, String accessKey, String secretKey, String region, boolean secure)` Deprecated.
`MinioClient(String endpoint, String accessKey, String secretKey)` Deprecated.
`MinioClient(String endpoint, String accessKey, String secretKey, boolean secure)` Deprecated.
`MinioClient(String endpoint, String accessKey, String secretKey, String region)` Deprecated.
`MinioClient(URL url)` Deprecated.
`MinioClient(URL url, String accessKey, String secretKey)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`abortMultipartUpload(String bucketName, String objectName, String uploadId)` Do AbortMultipartUpload S3 API.
`boolean`	`bucketExists(BucketExistsArgs args)` Checks if a bucket exists.
`boolean`	`bucketExists(String bucketName)` Deprecated. use `bucketExists(BucketExistsArgs)`
`static MinioClient.Builder`	`builder()`
`protected void`	`completeMultipartUpload(String bucketName, String objectName, String uploadId, Part[] parts)` Deprecated.
`protected ObjectWriteResponse`	`completeMultipartUpload(String bucketName, String region, String objectName, String uploadId, Part[] parts, com.google.common.collect.Multimap<String,String> extraHeaders, com.google.common.collect.Multimap<String,String> extraQueryParams)` Do CompleteMultipartUpload S3 API.
`ObjectWriteResponse`	`composeObject(ComposeObjectArgs args)` Creates an object by combining data from different source objects using server-side copy.
`void`	`composeObject(String bucketName, String objectName, List<ComposeSource> sources, Map<String,String> headerMap, ServerSideEncryption sse)` Deprecated. use `composeObject(ComposeObjectArgs)`
`ObjectWriteResponse`	`copyObject(CopyObjectArgs args)` Creates an object by server-side copying data from another object.
`void`	`copyObject(String bucketName, String objectName, Map<String,String> headerMap, ServerSideEncryption sse, String srcBucketName, String srcObjectName, ServerSideEncryption srcSse, CopyConditions copyConditions)` Deprecated. use `copyObject(CopyObjectArgs)`
`protected String`	`createMultipartUpload(String bucketName, String objectName, Map<String,String> headerMap)` Deprecated.
`protected String`	`createMultipartUpload(String bucketName, String region, String objectName, com.google.common.collect.Multimap<String,String> headers, com.google.common.collect.Multimap<String,String> extraQueryParams)` Do CreateMultipartUpload S3 API.
`void`	`deleteBucketEncryption(DeleteBucketEncryptionArgs args)` Deletes encryption configuration of a bucket.
`void`	`deleteBucketLifeCycle(DeleteBucketLifeCycleArgs args)` Deletes life-cycle configuration of a bucket.
`void`	`deleteBucketLifeCycle(String bucketName)` Deprecated. use `deleteBucketLifeCycle(DeleteBucketLifeCycleArgs)`
`void`	`deleteBucketNotification(DeleteBucketNotificationArgs args)` Deletes notification configuration of a bucket.
`void`	`deleteBucketPolicy(DeleteBucketPolicyArgs args)` Deletes bucket policy configuration to a bucket.
`void`	`deleteBucketTags(DeleteBucketTagsArgs args)` Deletes tags of a bucket.
`void`	`deleteDefaultRetention(DeleteDefaultRetentionArgs args)` Deletes default object retention in a bucket.
`protected DeleteResult`	`deleteObjects(String bucketName, List<DeleteObject> objectList, boolean quiet, boolean bypassGovernanceMode)` Do DeleteObjects S3 API.
`void`	`deleteObjectTags(DeleteObjectTagsArgs args)` Deletes tags of an object.
`void`	`disableAccelerateEndpoint()` Disables accelerate endpoint for Amazon S3 endpoint.
`void`	`disableDualStackEndpoint()` Disables dual-stack endpoint for Amazon S3 endpoint.
`void`	`disableObjectLegalHold(DisableObjectLegalHoldArgs args)` Disables legal hold on an object.
`void`	`disableObjectLegalHold(String bucketName, String objectName, String versionId)` Deprecated. use `disableObjectLegalHold(DisableObjectLegalHoldArgs)`
`void`	`disableVersioning(DisableVersioningArgs args)` Disables object versioning feature in a bucket.
`void`	`disableVersioning(String bucketName)` Deprecated. use `disableVersioning(DisableVersioningArgs)`
`void`	`disableVirtualStyleEndpoint()` Disables virtual-style endpoint.
`void`	`downloadObject(DownloadObjectArgs args)` Downloads data of a SSE-C encrypted object to file.
`void`	`enableAccelerateEndpoint()` Enables accelerate endpoint for Amazon S3 endpoint.
`void`	`enableDualStackEndpoint()` Enables dual-stack endpoint for Amazon S3 endpoint.
`void`	`enableObjectLegalHold(EnableObjectLegalHoldArgs args)` Enables legal hold on an object.
`void`	`enableObjectLegalHold(String bucketName, String objectName, String versionId)` Deprecated. use `enableObjectLegalHold(EnableObjectLegalHoldArgs)`
`void`	`enableVersioning(EnableVersioningArgs args)` Enables object versioning feature in a bucket.
`void`	`enableVersioning(String bucketName)` Deprecated. use `enableVersioning(EnableVersioningArgs)`
`void`	`enableVirtualStyleEndpoint()` Enables virtual-style endpoint.
`SseConfiguration`	`getBucketEncryption(GetBucketEncryptionArgs args)` Gets encryption configuration of a bucket.
`String`	`getBucketLifeCycle(GetBucketLifeCycleArgs args)` Gets life-cycle configuration of a bucket.
`String`	`getBucketLifeCycle(String bucketName)` Deprecated. use `getBucketLifeCycle(GetBucketLifeCycleArgs)`
`NotificationConfiguration`	`getBucketNotification(GetBucketNotificationArgs args)` Gets notification configuration of a bucket.
`NotificationConfiguration`	`getBucketNotification(String bucketName)` Deprecated. use `getBucketNotification(GetBucketNotificationArgs)`
`String`	`getBucketPolicy(GetBucketPolicyArgs args)` Gets bucket policy configuration of a bucket.
`String`	`getBucketPolicy(String bucketName)` Deprecated. use `getBucketPolicy(GetBucketPolicyArgs)`
`Tags`	`getBucketTags(GetBucketTagsArgs args)` Gets tags of a bucket.
`ObjectLockConfiguration`	`getDefaultRetention(GetDefaultRetentionArgs args)` Gets default object retention in a bucket.
`ObjectLockConfiguration`	`getDefaultRetention(String bucketName)` Deprecated. use `getDefaultRetention(GetDefaultRetentionArgs)`
`InputStream`	`getObject(GetObjectArgs args)` Gets data from offset to length of a SSE-C encrypted object.
`InputStream`	`getObject(String bucketName, String objectName)` Deprecated. use `getObject(GetObjectArgs)`
`InputStream`	`getObject(String bucketName, String objectName, long offset)` Deprecated. use `getObject(GetObjectArgs)`
`InputStream`	`getObject(String bucketName, String objectName, long offset, Long length)` Deprecated. use `getObject(GetObjectArgs)`
`InputStream`	`getObject(String bucketName, String objectName, Long offset, Long length, ServerSideEncryptionCustomerKey ssec)` Deprecated. use `getObject(GetObjectArgs)`
`InputStream`	`getObject(String bucketName, String objectName, ServerSideEncryptionCustomerKey ssec)` Deprecated. use `getObject(GetObjectArgs)`
`void`	`getObject(String bucketName, String objectName, ServerSideEncryptionCustomerKey ssec, String fileName)` Deprecated. use `getObject(GetObjectArgs)`
`void`	`getObject(String bucketName, String objectName, String fileName)` Deprecated. use `getObject(GetObjectArgs)`
`Retention`	`getObjectRetention(GetObjectRetentionArgs args)` Gets retention configuration of an object.
`Retention`	`getObjectRetention(String bucketName, String objectName, String versionId)` Deprecated. use `getObjectRetention(GetObjectRetentionArgs)`
`Tags`	`getObjectTags(GetObjectTagsArgs args)` Gets tags of an object.
`String`	`getObjectUrl(String bucketName, String objectName)` Gets URL of an object useful when this object has public read access.
`String`	`getPresignedObjectUrl(GetPresignedObjectUrlArgs args)` Gets presigned URL of an object for HTTP method, expiry time and custom request parameters.
`String`	`getPresignedObjectUrl(Method method, String bucketName, String objectName, Integer expires, Map<String,String> reqParams)` Deprecated. use `getPresignedObjectUrl(GetPresignedObjectUrlArgs)`
`void`	`ignoreCertCheck()` Ignores check on server certificate for HTTPS connection.
`boolean`	`isObjectLegalHoldEnabled(IsObjectLegalHoldEnabledArgs args)` Returns true if legal hold is enabled on an object.
`boolean`	`isObjectLegalHoldEnabled(String bucketName, String objectName, String versionId)` Deprecated. use `isObjectLegalHoldEnabled(IsObjectLegalHoldEnabledArgs)`
`boolean`	`isVersioningEnabled(IsVersioningEnabledArgs args)` Returns true if versioning is enabled on the bucket.
`List<Bucket>`	`listBuckets()` Lists bucket information of all buckets.
`CloseableIterator<Result<NotificationRecords>>`	`listenBucketNotification(ListenBucketNotificationArgs args)` Listens events of object prefix and suffix of a bucket.
`CloseableIterator<Result<NotificationRecords>>`	`listenBucketNotification(String bucketName, String prefix, String suffix, String[] events)` Deprecated. use `listenBucketNotification(ListenBucketNotificationArgs)`
`Iterable<Result<Upload>>`	`listIncompleteUploads(ListIncompleteUploadsArgs args)` Lists incomplete object upload information of a bucket for prefix recursively.
`Iterable<Result<Upload>>`	`listIncompleteUploads(String bucketName)` Deprecated. use `listIncompleteUploads(ListIncompleteUploadsArgs)`
`Iterable<Result<Upload>>`	`listIncompleteUploads(String bucketName, String prefix)` Deprecated. use `listIncompleteUploads(ListIncompleteUploadsArgs)`
`Iterable<Result<Upload>>`	`listIncompleteUploads(String bucketName, String prefix, boolean recursive)` Deprecated. use `listIncompleteUploads(ListIncompleteUploadsArgs)`
`protected ListMultipartUploadsResult`	`listMultipartUploads(String bucketName, String delimiter, String keyMarker, Integer maxUploads, String prefix, String uploadIdMarker)` Do ListMultipartUploads S3 API.
`Iterable<Result<Item>>`	`listObjects(ListObjectsArgs args)` Lists objects information optionally with versions of a bucket.
`Iterable<Result<Item>>`	`listObjects(String bucketName)` Deprecated. use `listObjects(ListObjectsArgs)`
`Iterable<Result<Item>>`	`listObjects(String bucketName, String prefix)` Deprecated. use `listObjects(ListObjectsArgs)`
`Iterable<Result<Item>>`	`listObjects(String bucketName, String prefix, boolean recursive)` Deprecated. use `listObjects(ListObjectsArgs)`
`Iterable<Result<Item>>`	`listObjects(String bucketName, String prefix, boolean recursive, boolean useVersion1)` Deprecated. use `listObjects(ListObjectsArgs)`
`Iterable<Result<Item>>`	`listObjects(String bucketName, String prefix, boolean recursive, boolean includeUserMetadata, boolean useVersion1)` Deprecated. use `listObjects(ListObjectsArgs)`
`protected ListBucketResultV1`	`listObjectsV1(String bucketName, String region, String delimiter, boolean useUrlEncodingType, String marker, int maxKeys, String prefix, com.google.common.collect.Multimap<String,String> extraHeaders, com.google.common.collect.Multimap<String,String> extraQueryParams)`
`protected ListBucketResultV2`	`listObjectsV2(String bucketName, String region, String delimiter, boolean useUrlEncodingType, String startAfter, int maxKeys, String prefix, String continuationToken, boolean fetchOwner, boolean includeUserMetadata, com.google.common.collect.Multimap<String,String> extraHeaders, com.google.common.collect.Multimap<String,String> extraQueryParams)`
`protected ListVersionsResult`	`listObjectVersions(String bucketName, String region, String delimiter, boolean useUrlEncodingType, String keyMarker, int maxKeys, String prefix, String versionIdMarker, com.google.common.collect.Multimap<String,String> extraHeaders, com.google.common.collect.Multimap<String,String> extraQueryParams)`
`protected ListPartsResult`	`listParts(String bucketName, String objectName, Integer maxParts, Integer partNumberMarker, String uploadId)` Do ListParts S3 API.
`void`	`makeBucket(MakeBucketArgs args)` Creates a bucket with region and object lock.
`void`	`makeBucket(String bucketName)` Deprecated. use `makeBucket(MakeBucketArgs)`
`void`	`makeBucket(String bucketName, String region)` Deprecated. use `makeBucket(MakeBucketArgs)`
`void`	`makeBucket(String bucketName, String region, boolean objectLock)` Deprecated. use `makeBucket(MakeBucketArgs)`
`String`	`presignedGetObject(String bucketName, String objectName)` Deprecated. use `getPresignedObjectUrl(GetPresignedObjectUrlArgs)`
`String`	`presignedGetObject(String bucketName, String objectName, Integer expires)` Deprecated. use `getPresignedObjectUrl(GetPresignedObjectUrlArgs)`
`String`	`presignedGetObject(String bucketName, String objectName, Integer expires, Map<String,String> reqParams)` Deprecated. use `getPresignedObjectUrl(GetPresignedObjectUrlArgs)`
`Map<String,String>`	`presignedPostPolicy(PostPolicy policy)` Gets form-data of `PostPolicy` of an object to upload its data using POST method.
`String`	`presignedPutObject(String bucketName, String objectName)` Deprecated. use `getPresignedObjectUrl(GetPresignedObjectUrlArgs)`
`String`	`presignedPutObject(String bucketName, String objectName, Integer expires)` Deprecated. use `getPresignedObjectUrl(GetPresignedObjectUrlArgs)`
`ObjectWriteResponse`	`putObject(PutObjectArgs args)` Uploads data from a stream to an object.
`void`	`putObject(String bucketName, String objectName, InputStream stream, PutObjectOptions options)` Deprecated. use `putObject(PutObjectArgs)`
`protected String`	`putObject(String bucketName, String objectName, Object data, int length, Map<String,String> headerMap)` Deprecated.
`protected ObjectWriteResponse`	`putObject(String bucketName, String region, String objectName, Object data, int length, com.google.common.collect.Multimap<String,String> headers, com.google.common.collect.Multimap<String,String> extraQueryParams)` Do PutObject S3 API.
`void`	`putObject(String bucketName, String objectName, String filename, PutObjectOptions options)` Deprecated. use `uploadObject(UploadObjectArgs)`
`void`	`removeAllBucketNotification(String bucketName)` Deprecated. use `deleteBucketNotification(DeleteBucketNotificationArgs)`
`void`	`removeBucket(RemoveBucketArgs args)` Removes an empty bucket using arguments
`void`	`removeBucket(String bucketName)` Deprecated. use `removeBucket(RemoveBucketArgs)`
`void`	`removeIncompleteUpload(RemoveIncompleteUploadArgs args)` Removes incomplete uploads of an object.
`void`	`removeIncompleteUpload(String bucketName, String objectName)` Deprecated. use `removeIncompleteUpload(RemoveIncompleteUploadArgs)`
`void`	`removeObject(RemoveObjectArgs args)` Removes an object.
`void`	`removeObject(String bucketName, String objectName)` Deprecated. use `removeObject(RemoveObjectArgs)`
`Iterable<Result<DeleteError>>`	`removeObjects(RemoveObjectsArgs args)` Removes multiple objects lazily.
`Iterable<Result<DeleteError>>`	`removeObjects(String bucketName, Iterable<String> objectNames)` Deprecated. use `removeObjects(RemoveObjectsArgs)`
`SelectResponseStream`	`selectObjectContent(SelectObjectContentArgs args)` Selects content of an object by SQL expression.
`SelectResponseStream`	`selectObjectContent(String bucketName, String objectName, String sqlExpression, InputSerialization is, OutputSerialization os, boolean requestProgress, Long scanStartRange, Long scanEndRange, ServerSideEncryptionCustomerKey ssec)` Deprecated. use `selectObjectContent(SelectObjectContentArgs)`
`void`	`setAppInfo(String name, String version)` Sets application's name/version to user agent.
`void`	`setBucketEncryption(SetBucketEncryptionArgs args)` Sets encryption configuration of a bucket.
`void`	`setBucketLifeCycle(SetBucketLifeCycleArgs args)` Sets life-cycle configuration to a bucket.
`void`	`setBucketLifeCycle(String bucketName, String lifeCycle)` Deprecated. use `setBucketLifeCycle(SetBucketLifeCycleArgs)`
`void`	`setBucketNotification(SetBucketNotificationArgs args)` Sets notification configuration to a bucket.
`void`	`setBucketNotification(String bucketName, NotificationConfiguration notificationConfiguration)` Deprecated. use `setBucketNotification(SetBucketNotificationArgs)`
`void`	`setBucketPolicy(SetBucketPolicyArgs args)` Sets bucket policy configuration to a bucket.
`void`	`setBucketPolicy(String bucketName, String policy)` Deprecated. use `setBucketPolicy(SetBucketPolicyArgs)`
`void`	`setBucketTags(SetBucketTagsArgs args)` Sets tags to a bucket.
`void`	`setDefaultRetention(SetDefaultRetentionArgs args)` Sets default object retention in a bucket.
`void`	`setDefaultRetention(String bucketName, ObjectLockConfiguration config)` Deprecated. use `setDefaultRetention(SetDefaultRetentionArgs)`
`void`	`setObjectRetention(SetObjectRetentionArgs args)` Sets retention configuration to an object.
`void`	`setObjectRetention(String bucketName, String objectName, String versionId, Retention config, boolean bypassGovernanceMode)` Deprecated. use `setObjectRetention(SetObjectRetentionArgs)`
`void`	`setObjectTags(SetObjectTagsArgs args)` Sets tags to an object.
`void`	`setTimeout(long connectTimeout, long writeTimeout, long readTimeout)` Sets HTTP connect, write and read timeouts.
`ObjectStat`	`statObject(StatObjectArgs args)` Gets information of an object.
`ObjectStat`	`statObject(String bucketName, String objectName)` Deprecated. use `statObject(StatObjectArgs)`
`ObjectStat`	`statObject(String bucketName, String objectName, ServerSideEncryptionCustomerKey ssec)` Deprecated. use `statObject(StatObjectArgs)`
`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.
`protected String`	`uploadPart(String bucketName, String objectName, Object data, int length, String uploadId, int partNumber, Map<String,String> headerMap)` Do UploadPart S3 API.
`protected String`	`uploadPartCopy(String bucketName, String objectName, String uploadId, int partNumber, com.google.common.collect.Multimap<String,String> headers)` Do UploadPartCopy S3 API.

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

Constructor Detail

MinioClient

@Deprecated
public MinioClient(String endpoint)
                        throws IllegalArgumentException

Deprecated.

Creates MinIO client object with given endpoint using anonymous access.

Example:
 MinioClient minioClient = new MinioClient("https://play.min.io");

Parameters:

endpoint - Endpoint is an URL, domain name, IPv4 or IPv6 address of S3 service.

           Examples:
             * https://s3.amazonaws.com
             * https://s3.amazonaws.com/
             * https://play.min.io
             * http://play.min.io:9010/
             * localhost
             * localhost.localdomain
             * play.min.io
             * 127.0.0.1
             * 192.168.1.60
             * ::1

Throws:

IllegalArgumentException - Throws to indicate invalid argument passed.

See Also:

builder()

MinioClient

@Deprecated
public MinioClient(URL url)
                        throws InvalidEndpointException,
                               InvalidPortException

Deprecated.

Creates MinIO client object with given URL object using anonymous access.

Example:
 MinioClient minioClient = new MinioClient(new URL("https://play.min.io"));

Parameters:: url - Endpoint as URL object.
Throws:: IllegalArgumentException - Throws to indicate invalid argument passed.; InvalidEndpointException; InvalidPortException
See Also:: builder()

MinioClient
```
@Deprecated
public MinioClient(okhttp3.HttpUrl url)
                        throws IllegalArgumentException
```
Deprecated.
Creates MinIO client object with given HttpUrl object using anonymous access.
```
Example:
 MinioClient minioClient = new MinioClient(new HttpUrl.parse("https://play.min.io"));
 
```
Parameters:

url - Endpoint as HttpUrl object.

Throws:

IllegalArgumentException - Throws to indicate invalid argument passed.

See Also:

builder()

MinioClient

@Deprecated
public MinioClient(String endpoint,
                               String accessKey,
                               String secretKey)
                        throws IllegalArgumentException

Deprecated.

Creates MinIO client object with given endpoint, access key and secret key.

Example:
 MinioClient minioClient = new MinioClient("https://play.min.io",
     "Q3AM3UQ867SPQQA43P2F", "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG");

Parameters:

endpoint - Endpoint is an URL, domain name, IPv4 or IPv6 address of S3 service.

           Examples:
             * https://s3.amazonaws.com
             * https://s3.amazonaws.com/
             * https://play.min.io
             * http://play.min.io:9010/
             * localhost
             * localhost.localdomain
             * play.min.io
             * 127.0.0.1
             * 192.168.1.60
             * ::1

accessKey - Access key (aka user ID) of your account in S3 service.

secretKey - Secret Key (aka password) of your account in S3 service.

Throws:

IllegalArgumentException - Throws to indicate invalid argument passed.

See Also:

builder()

MinioClient

@Deprecated
public MinioClient(String endpoint,
                               String accessKey,
                               String secretKey,
                               String region)
                        throws IllegalArgumentException

Deprecated.

Creates MinIO client object with given endpoint, access key, secret key and region name.

Example:
 MinioClient minioClient = new MinioClient("https://play.min.io",
     "Q3AM3UQ867SPQQA43P2F", "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG", "us-west-1");

Parameters:

endpoint - Endpoint is an URL, domain name, IPv4 or IPv6 address of S3 service.

           Examples:
             * https://s3.amazonaws.com
             * https://s3.amazonaws.com/
             * https://play.min.io
             * http://play.min.io:9010/
             * localhost
             * localhost.localdomain
             * play.min.io
             * 127.0.0.1
             * 192.168.1.60
             * ::1

accessKey - Access key (aka user ID) of your account in S3 service.

secretKey - Secret Key (aka password) of your account in S3 service.

region - Region name of buckets in S3 service.

Throws:

IllegalArgumentException - Throws to indicate invalid argument passed.

See Also:

builder()

MinioClient
```
@Deprecated
public MinioClient(URL url,
                               String accessKey,
                               String secretKey)
                        throws IllegalArgumentException
```
Deprecated.
Creates MinIO client object with given URL object, access key and secret key.
```
 MinioClient minioClient = new MinioClient(new URL("https://play.min.io"),
     "Q3AM3UQ867SPQQA43P2F", "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG");
```
Parameters:

url - Endpoint as URL object.

accessKey - Access key (aka user ID) of your account in S3 service.

secretKey - Secret Key (aka password) of your account in S3 service.

Throws:

IllegalArgumentException - Throws to indicate invalid argument passed.

See Also:

MinioClient(String endpoint), MinioClient(URL url), MinioClient(String endpoint, String accessKey, String secretKey), MinioClient(String endpoint, String accessKey, String secretKey, String region), MinioClient(String endpoint, int port, String accessKey, String secretKey), MinioClient(String endpoint, String accessKey, String secretKey, boolean secure), MinioClient(String endpoint, int port, String accessKey, String secretKey, boolean secure), MinioClient(String endpoint, int port, String accessKey, String secretKey, String region, boolean secure), MinioClient(String endpoint, Integer port, String accessKey, String secretKey, String region, Boolean secure, OkHttpClient httpClient)

MinioClient

@Deprecated
public MinioClient(okhttp3.HttpUrl url,
                               String accessKey,
                               String secretKey)
                        throws IllegalArgumentException

Deprecated.

Creates MinIO client object with given URL object, access key and secret key.

Example:
 MinioClient minioClient = new MinioClient(HttpUrl.parse("https://play.min.io"),
     "Q3AM3UQ867SPQQA43P2F", "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG");

Parameters:: url - Endpoint as HttpUrl object.; accessKey - Access key (aka user ID) of your account in S3 service.; secretKey - Secret Key (aka password) of your account in S3 service.
Throws:: IllegalArgumentException - Throws to indicate invalid argument passed.
See Also:: builder()

MinioClient

@Deprecated
public MinioClient(String endpoint,
                               int port,
                               String accessKey,
                               String secretKey)
                        throws IllegalArgumentException

Deprecated.

Creates MinIO client object with given endpoint, port, access key and secret key.

Example:
 MinioClient minioClient = new MinioClient("play.min.io", 9000,
     "Q3AM3UQ867SPQQA43P2F", "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG");

Parameters:

endpoint - Endpoint is an URL, domain name, IPv4 or IPv6 address of S3 service.

           Examples:
             * https://s3.amazonaws.com
             * https://s3.amazonaws.com/
             * https://play.min.io
             * http://play.min.io:9010/
             * localhost
             * localhost.localdomain
             * play.min.io
             * 127.0.0.1
             * 192.168.1.60
             * ::1

port - TCP/IP port number between 1 and 65535. Unused if endpoint is an URL.

accessKey - Access key (aka user ID) of your account in S3 service.

secretKey - Secret Key (aka password) of your account in S3 service.

Throws:

IllegalArgumentException - Throws to indicate invalid argument passed.

See Also:

builder()

MinioClient

@Deprecated
public MinioClient(String endpoint,
                               String accessKey,
                               String secretKey,
                               boolean secure)
                        throws IllegalArgumentException

Deprecated.

Creates MinIO client object with given endpoint, access key and secret key using secure (TLS) connection.

Example:
 MinioClient minioClient = new MinioClient("play.min.io",
     "Q3AM3UQ867SPQQA43P2F", "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG", true);

Parameters:

endpoint - Endpoint is an URL, domain name, IPv4 or IPv6 address of S3 service.

           Examples:
             * https://s3.amazonaws.com
             * https://s3.amazonaws.com/
             * https://play.min.io
             * http://play.min.io:9010/
             * localhost
             * localhost.localdomain
             * play.min.io
             * 127.0.0.1
             * 192.168.1.60
             * ::1

accessKey - Access key (aka user ID) of your account in S3 service.

secretKey - Secret Key (aka password) of your account in S3 service.

secure - Flag to indicate to use secure (TLS) connection to S3 service or not.

Throws:

IllegalArgumentException - Throws to indicate invalid argument passed.

See Also:

builder()

MinioClient

@Deprecated
public MinioClient(String endpoint,
                               int port,
                               String accessKey,
                               String secretKey,
                               boolean secure)
                        throws IllegalArgumentException

Deprecated.

Creates MinIO client object using given endpoint, port, access key, secret key and secure (TLS) connection.

Example:
 MinioClient minioClient = new MinioClient("play.min.io", 9000,
     "Q3AM3UQ867SPQQA43P2F", "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG", true);

Parameters:

endpoint - Endpoint is an URL, domain name, IPv4 or IPv6 address of S3 service.

           Examples:
             * https://s3.amazonaws.com
             * https://s3.amazonaws.com/
             * https://play.min.io
             * http://play.min.io:9010/
             * localhost
             * localhost.localdomain
             * play.min.io
             * 127.0.0.1
             * 192.168.1.60
             * ::1

port - TCP/IP port number between 1 and 65535. Unused if endpoint is an URL.

accessKey - Access key (aka user ID) of your account in S3 service.

secretKey - Secret Key (aka password) of your account in S3 service.

secure - Flag to indicate to use secure (TLS) connection to S3 service or not.

Throws:

IllegalArgumentException - Throws to indicate invalid argument passed.

See Also:

builder()

MinioClient

@Deprecated
public MinioClient(String endpoint,
                               int port,
                               String accessKey,
                               String secretKey,
                               String region,
                               boolean secure)
                        throws IllegalArgumentException

Deprecated.

Creates MinIO client object using given endpoint, port, access key, secret key, region and secure (TLS) connection.

Example:
 MinioClient minioClient = new MinioClient("play.min.io", 9000,
     "Q3AM3UQ867SPQQA43P2F", "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG", true);

Parameters:

endpoint - Endpoint is an URL, domain name, IPv4 or IPv6 address of S3 service.

           Examples:
             * https://s3.amazonaws.com
             * https://s3.amazonaws.com/
             * https://play.min.io
             * http://play.min.io:9010/
             * localhost
             * localhost.localdomain
             * play.min.io
             * 127.0.0.1
             * 192.168.1.60
             * ::1

port - TCP/IP port number between 1 and 65535. Unused if endpoint is an URL.

accessKey - Access key (aka user ID) of your account in S3 service.

secretKey - Secret Key (aka password) of your account in S3 service.

region - Region name of buckets in S3 service.

secure - Flag to indicate to use secure (TLS) connection to S3 service or not.

Throws:

IllegalArgumentException - Throws to indicate invalid argument passed.

See Also:

builder()

MinioClient

@Deprecated
public MinioClient(String endpoint,
                               Integer port,
                               String accessKey,
                               String secretKey,
                               String region,
                               Boolean secure,
                               okhttp3.OkHttpClient httpClient)
                        throws IllegalArgumentException

Deprecated.

Creates MinIO client object using given endpoint, port, access key, secret key, region and secure (TLS) connection.

Example:
 MinioClient minioClient = new MinioClient("play.min.io", 9000,
     "Q3AM3UQ867SPQQA43P2F", "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG", true,
     customHttpClient);

Parameters:

endpoint - Endpoint is an URL, domain name, IPv4 or IPv6 address of S3 service.

           Examples:
             * https://s3.amazonaws.com
             * https://s3.amazonaws.com/
             * https://play.min.io
             * http://play.min.io:9010/
             * localhost
             * localhost.localdomain
             * play.min.io
             * 127.0.0.1
             * 192.168.1.60
             * ::1

port - TCP/IP port number between 1 and 65535. Overrides if it is non-null.

accessKey - Access key (aka user ID) of your account in S3 service.

secretKey - Secret Key (aka password) of your account in S3 service.

region - Region name of buckets in S3 service.

secure - Flag to indicate to use secure (TLS) connection to S3 service or not. Overrides if it is non-null.

httpClient - Customized HTTP client object.

Throws:

IllegalArgumentException - Throws to indicate invalid argument passed.

See Also:

builder()

Method Detail

statObject

@Deprecated
public ObjectStat statObject(String bucketName,
                                         String objectName)
                                  throws ErrorResponseException,
                                         IllegalArgumentException,
                                         InsufficientDataException,
                                         InternalException,
                                         InvalidBucketNameException,
                                         InvalidKeyException,
                                         InvalidResponseException,
                                         IOException,
                                         NoSuchAlgorithmException,
                                         ServerException,
                                         XmlParserException

Deprecated. use statObject(StatObjectArgs)

Gets object information and metadata of an object.

Example:
 ObjectStat objectStat = minioClient.statObject("my-bucketname", "my-objectname");

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.
Returns:: ObjectStat - Populated object information and metadata.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

statObject

@Deprecated
public ObjectStat statObject(String bucketName,
                                         String objectName,
                                         ServerSideEncryptionCustomerKey ssec)
                                  throws ErrorResponseException,
                                         IllegalArgumentException,
                                         InsufficientDataException,
                                         InternalException,
                                         InvalidBucketNameException,
                                         InvalidKeyException,
                                         InvalidResponseException,
                                         IOException,
                                         NoSuchAlgorithmException,
                                         ServerException,
                                         XmlParserException

Deprecated. use statObject(StatObjectArgs)

Gets object information and metadata of a SSE-C encrypted object.

Example:
 ObjectStat objectStat =
     minioClient.statObject("my-bucketname", "my-objectname", ssec);

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; ssec - SSE-C type server-side encryption.
Returns:: ObjectStat - Populated object information and metadata.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

statObject

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

Gets information of an object.

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

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

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

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

Parameters:: args - StatObjectArgs object.
Returns:: ObjectStat - Populated object information and metadata.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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:: ObjectStat

getObjectUrl

public String getObjectUrl(String bucketName,
                           String objectName)
                    throws ErrorResponseException,
                           IllegalArgumentException,
                           InsufficientDataException,
                           InternalException,
                           InvalidBucketNameException,
                           InvalidKeyException,
                           InvalidResponseException,
                           IOException,
                           NoSuchAlgorithmException,
                           ServerException,
                           XmlParserException

Gets URL of an object useful when this object has public read access.

Example:
 String url = minioClient.getObjectUrl("my-bucketname", "my-objectname");

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.
Returns:: String - URL string.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

getObject

@Deprecated
public InputStream getObject(String bucketName,
                                         String objectName)
                                  throws ErrorResponseException,
                                         IllegalArgumentException,
                                         InsufficientDataException,
                                         InternalException,
                                         InvalidBucketNameException,
                                         InvalidKeyException,
                                         InvalidResponseException,
                                         IOException,
                                         NoSuchAlgorithmException,
                                         ServerException,
                                         XmlParserException

Deprecated. use getObject(GetObjectArgs)

Gets data of an object. Returned InputStream must be closed after use to release network resources.

Example:
 try (InputStream stream =
     minioClient.getObject("my-bucketname", "my-objectname")) {
   // Read data from stream
 }

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.
Returns:: InputStream - Contains object data.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

getObject

@Deprecated
public InputStream getObject(String bucketName,
                                         String objectName,
                                         ServerSideEncryptionCustomerKey ssec)
                                  throws ErrorResponseException,
                                         IllegalArgumentException,
                                         InsufficientDataException,
                                         InternalException,
                                         InvalidBucketNameException,
                                         InvalidKeyException,
                                         InvalidResponseException,
                                         IOException,
                                         NoSuchAlgorithmException,
                                         ServerException,
                                         XmlParserException

Deprecated. use getObject(GetObjectArgs)

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

Example:
 try (InputStream stream =
     minioClient.getObject("my-bucketname", "my-objectname", ssec)) {
   // Read data from stream
 }

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; ssec - SSE-C type server-side encryption.
Returns:: InputStream - Contains object data.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

getObject

@Deprecated
public InputStream getObject(String bucketName,
                                         String objectName,
                                         long offset)
                                  throws ErrorResponseException,
                                         IllegalArgumentException,
                                         InsufficientDataException,
                                         InternalException,
                                         InvalidBucketNameException,
                                         InvalidKeyException,
                                         InvalidResponseException,
                                         IOException,
                                         NoSuchAlgorithmException,
                                         ServerException,
                                         XmlParserException

Deprecated. use getObject(GetObjectArgs)

Gets data from offset of an object. Returned InputStream must be closed after use to release network resources.

Example:
 try (InputStream stream =
     minioClient.getObject("my-bucketname", "my-objectname", 1024L)) {
   // Read data from stream
 }

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; offset - Start byte position of object data.
Returns:: InputStream - Contains object data.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

getObject

@Deprecated
public InputStream getObject(String bucketName,
                                         String objectName,
                                         long offset,
                                         Long length)
                                  throws ErrorResponseException,
                                         IllegalArgumentException,
                                         InsufficientDataException,
                                         InternalException,
                                         InvalidBucketNameException,
                                         InvalidKeyException,
                                         InvalidResponseException,
                                         IOException,
                                         NoSuchAlgorithmException,
                                         ServerException,
                                         XmlParserException

Deprecated. use getObject(GetObjectArgs)

Gets data from offset to length of an object. Returned InputStream must be closed after use to release network resources.

Example:
 try (InputStream stream =
     minioClient.getObject("my-bucketname", "my-objectname", 1024L, 4096L)) {
   // Read data from stream
 }

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; offset - Start byte position of object data.; length - Number of bytes of object data from offset.
Returns:: InputStream - Contains object data.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

getObject

@Deprecated
public InputStream getObject(String bucketName,
                                         String objectName,
                                         Long offset,
                                         Long length,
                                         ServerSideEncryptionCustomerKey ssec)
                                  throws ErrorResponseException,
                                         IllegalArgumentException,
                                         InsufficientDataException,
                                         InternalException,
                                         InvalidBucketNameException,
                                         InvalidKeyException,
                                         InvalidResponseException,
                                         IOException,
                                         NoSuchAlgorithmException,
                                         ServerException,
                                         XmlParserException

Deprecated. use getObject(GetObjectArgs)

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("my-bucketname", "my-objectname", 1024L, 4096L, ssec)) {
   // Read data from stream
 }

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; offset - Start byte position of object data.; length - Number of bytes of object data from offset.; ssec - SSE-C type server-side encryption.
Returns:: InputStream - Contains object data.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

getObject

public InputStream getObject(GetObjectArgs args)
                      throws ErrorResponseException,
                             IllegalArgumentException,
                             InsufficientDataException,
                             InternalException,
                             InvalidBucketNameException,
                             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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

getObject

@Deprecated
public void getObject(String bucketName,
                                  String objectName,
                                  String fileName)
                           throws ErrorResponseException,
                                  IllegalArgumentException,
                                  InsufficientDataException,
                                  InternalException,
                                  InvalidBucketNameException,
                                  InvalidKeyException,
                                  InvalidResponseException,
                                  IOException,
                                  NoSuchAlgorithmException,
                                  ServerException,
                                  XmlParserException

Deprecated. use getObject(GetObjectArgs)

Downloads data of an object to file.

Example:
 minioClient.getObject("my-bucketname", "my-objectname", "my-object-file");

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; fileName - Name of the file.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

getObject

@Deprecated
public void getObject(String bucketName,
                                  String objectName,
                                  ServerSideEncryptionCustomerKey ssec,
                                  String fileName)
                           throws ErrorResponseException,
                                  IllegalArgumentException,
                                  InsufficientDataException,
                                  InternalException,
                                  InvalidBucketNameException,
                                  InvalidKeyException,
                                  InvalidResponseException,
                                  IOException,
                                  NoSuchAlgorithmException,
                                  ServerException,
                                  XmlParserException

Deprecated. use getObject(GetObjectArgs)

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

Example:
 minioClient.getObject("my-bucketname", "my-objectname", ssec, "my-object-file");

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; ssec - SSE-C type server-side encryption.; fileName - Name of the file.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                           IllegalArgumentException,
                           InsufficientDataException,
                           InternalException,
                           InvalidBucketNameException,
                           InvalidKeyException,
                           InvalidResponseException,
                           IOException,
                           NoSuchAlgorithmException,
                           ServerException,
                           XmlParserException

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

Example:
 minioClient.downloadObject(
   GetObjectArgs.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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public void copyObject(String bucketName,
                                   String objectName,
                                   Map<String,String> headerMap,
                                   ServerSideEncryption sse,
                                   String srcBucketName,
                                   String srcObjectName,
                                   ServerSideEncryption srcSse,
                                   CopyConditions copyConditions)
                            throws ErrorResponseException,
                                   IllegalArgumentException,
                                   InsufficientDataException,
                                   InternalException,
                                   InvalidBucketNameException,
                                   InvalidKeyException,
                                   InvalidResponseException,
                                   IOException,
                                   NoSuchAlgorithmException,
                                   ServerException,
                                   XmlParserException

Deprecated. use copyObject(CopyObjectArgs)

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

Example:
 // Copy data from my-source-bucketname/my-objectname to my-bucketname/my-objectname.
 minioClient.copyObject("my-bucketname", "my-objectname", null, null,
     "my-source-bucketname", null, null, null);

 // Copy data from my-source-bucketname/my-source-objectname to
 // my-bucketname/my-objectname.
 minioClient.copyObject("my-bucketname", "my-objectname", null, null,
     "my-source-bucketname", "my-source-objectname", null, null);

 // Copy data from my-source-bucketname/my-objectname to my-bucketname/my-objectname
 // by server-side encryption.
 minioClient.copyObject("my-bucketname", "my-objectname", null, sse,
     "my-source-bucketname", null, null, null);

 // Copy data from SSE-C encrypted my-source-bucketname/my-objectname to
 // my-bucketname/my-objectname.
 minioClient.copyObject("my-bucketname", "my-objectname", null, null,
     "my-source-bucketname", null, srcSsec, null);

 // Copy data from my-source-bucketname/my-objectname to my-bucketname/my-objectname
 // with user metadata and copy conditions.
 minioClient.copyObject("my-bucketname", "my-objectname", headers, null,
     "my-source-bucketname", null, null, conditions);

Parameters:: bucketName - Name of the bucket.; objectName - Object name to be created.; headerMap - (Optional) User metadata.; sse - (Optional) Server-side encryption.; srcBucketName - Source bucket name.; srcObjectName - (Optional) Source object name.; srcSse - (Optional) SSE-C type server-side encryption of source object.; copyConditions - (Optional) Conditiions to be used in copy operation.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                                      IllegalArgumentException,
                                      InsufficientDataException,
                                      InternalException,
                                      InvalidBucketNameException,
                                      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")
         .srcBucket("my-source-bucketname")
         .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")
         .srcBucket("my-source-bucketname")
         .srcObject("my-source-objectname")
         .build());

 // Create object "my-objectname" in bucket "my-bucketname" with server-side encryption by
 // copying from object "my-objectname" in bucket "my-source-bucketname".
 minioClient.copyObject(
     CopyObjectArgs.builder()
         .bucket("my-bucketname")
         .object("my-objectname")
         .srcBucket("my-source-bucketname")
         .sse(sse)
         .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")
         .srcBucket("my-source-bucketname")
         .srcObject("my-source-objectname")
         .srcSsec(ssec)
         .build());

 // Create object "my-objectname" in bucket "my-bucketname" with custom headers by copying from
 // object "my-objectname" in bucket "my-source-bucketname" using conditions.
 minioClient.copyObject(
     CopyObjectArgs.builder()
         .bucket("my-bucketname")
         .object("my-objectname")
         .srcBucket("my-source-bucketname")
         .headers(headers)
         .srcMatchETag(etag)
         .build());

Parameters:: args - CopyObjectArgs object.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public void composeObject(String bucketName,
                                      String objectName,
                                      List<ComposeSource> sources,
                                      Map<String,String> headerMap,
                                      ServerSideEncryption sse)
                               throws ErrorResponseException,
                                      IllegalArgumentException,
                                      InsufficientDataException,
                                      InternalException,
                                      InvalidBucketNameException,
                                      InvalidKeyException,
                                      InvalidResponseException,
                                      IOException,
                                      NoSuchAlgorithmException,
                                      ServerException,
                                      XmlParserException

Deprecated. use composeObject(ComposeObjectArgs)

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

Example:
 List<ComposeSource> sourceObjectList = new ArrayList<ComposeSource>();
 sourceObjectList.add(new ComposeSource("my-job-bucket", "my-objectname-part-one"));
 sourceObjectList.add(new ComposeSource("my-job-bucket", "my-objectname-part-two"));
 sourceObjectList.add(new ComposeSource("my-job-bucket", "my-objectname-part-three"));

 // Create my-bucketname/my-objectname by combining source object list.
 minioClient.composeObject("my-bucketname", "my-objectname", sourceObjectList,
     null, null);

 // Create my-bucketname/my-objectname with user metadata by combining source object
 // list.
 minioClient.composeObject("my-bucketname", "my-objectname", sourceObjectList,
     userMetadata, null);

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

Parameters:: bucketName - Destination Bucket to be created upon compose.; objectName - Destination Object to be created upon compose.; sources - List of Source Objects used to compose Object.; headerMap - User Meta data.; sse - Server Side Encryption.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                                         IllegalArgumentException,
                                         InsufficientDataException,
                                         InternalException,
                                         InvalidBucketNameException,
                                         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.
 minioClient.composeObject(
     ComposeObjectArgs.builder()
        .bucket("my-bucketname")
        .object("my-objectname")
        .sources(sourceObjectList)
        .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)
        .ssec(sse)
        .build());

Parameters:: args - ComposeObjectArgs object.
Returns:: ObjectWriteResponse object.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public String getPresignedObjectUrl(Method method,
                                                String bucketName,
                                                String objectName,
                                                Integer expires,
                                                Map<String,String> reqParams)
                                         throws ErrorResponseException,
                                                IllegalArgumentException,
                                                InsufficientDataException,
                                                InternalException,
                                                InvalidBucketNameException,
                                                InvalidExpiresRangeException,
                                                InvalidKeyException,
                                                InvalidResponseException,
                                                IOException,
                                                NoSuchAlgorithmException,
                                                ServerException,
                                                XmlParserException

Deprecated. use getPresignedObjectUrl(GetPresignedObjectUrlArgs)

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

Example:
 String url = minioClient.getPresignedObjectUrl(Method.DELETE, "my-bucketname",
     "my-objectname", 24 * 60 * 60, reqParams);

Parameters:: method - HTTP Method to generate presigned URL.; bucketName - Name of the bucket.; objectName - Object name in the bucket.; expires - Expiry in seconds; defaults to 7 days.; reqParams - Request parameters to override. Supported headers are response-expires, response-content-type, response-cache-control and response-content-disposition.
Returns:: String - URL string.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; InvalidExpiresRangeException - thrown to indicate invalid expiry duration passed.; 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,
                                    IllegalArgumentException,
                                    InsufficientDataException,
                                    InternalException,
                                    InvalidBucketNameException,
                                    InvalidExpiresRangeException,
                                    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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; InvalidExpiresRangeException - thrown to indicate invalid expiry duration passed.; 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

presignedGetObject

@Deprecated
public String presignedGetObject(String bucketName,
                                             String objectName,
                                             Integer expires,
                                             Map<String,String> reqParams)
                                      throws ErrorResponseException,
                                             IllegalArgumentException,
                                             InsufficientDataException,
                                             InternalException,
                                             InvalidBucketNameException,
                                             InvalidExpiresRangeException,
                                             InvalidKeyException,
                                             InvalidResponseException,
                                             IOException,
                                             NoSuchAlgorithmException,
                                             ServerException,
                                             XmlParserException

Deprecated. use getPresignedObjectUrl(GetPresignedObjectUrlArgs)

Gets presigned URL of an object to download its data for expiry time and request parameters.

Example:
 // Get presigned URL to download my-objectname data with one day expiry and request
 // parameters.
 String url = minioClient.presignedGetObject("my-bucketname", "my-objectname",
     24 * 60 * 60, reqParams);

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; expires - Expiry in seconds; defaults to 7 days.; reqParams - Request parameters to override. Supported headers are response-expires, response-content-type, response-cache-control and response-content-disposition.
Returns:: String - URL string to download the object.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; InvalidExpiresRangeException - thrown to indicate invalid expiry duration passed.; 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

presignedGetObject

@Deprecated
public String presignedGetObject(String bucketName,
                                             String objectName,
                                             Integer expires)
                                      throws ErrorResponseException,
                                             IllegalArgumentException,
                                             InsufficientDataException,
                                             InternalException,
                                             InvalidBucketNameException,
                                             InvalidExpiresRangeException,
                                             InvalidKeyException,
                                             InvalidResponseException,
                                             IOException,
                                             NoSuchAlgorithmException,
                                             ServerException,
                                             XmlParserException

Deprecated. use getPresignedObjectUrl(GetPresignedObjectUrlArgs)

Gets presigned URL of an object to download its data for expiry time.

Example:
 // Get presigned URL to download my-objectname data with one day expiry.
 String url = minioClient.presignedGetObject("my-bucketname", "my-objectname",
     24 * 60 * 60);

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; expires - Expiry in seconds; defaults to 7 days.
Returns:: String - URL string to download the object.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; InvalidExpiresRangeException - thrown to indicate invalid expiry duration passed.; 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

presignedGetObject

@Deprecated
public String presignedGetObject(String bucketName,
                                             String objectName)
                                      throws ErrorResponseException,
                                             IllegalArgumentException,
                                             InsufficientDataException,
                                             InternalException,
                                             InvalidBucketNameException,
                                             InvalidExpiresRangeException,
                                             InvalidKeyException,
                                             InvalidResponseException,
                                             IOException,
                                             NoSuchAlgorithmException,
                                             ServerException,
                                             XmlParserException

Deprecated. use getPresignedObjectUrl(GetPresignedObjectUrlArgs)

Gets presigned URL of an object to download its data for 7 days.

Example:
 String url = minioClient.presignedGetObject("my-bucketname", "my-objectname");

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.
Returns:: String - URL string to download the object.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; InvalidExpiresRangeException - thrown to indicate invalid expiry duration passed.; 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

presignedPutObject

@Deprecated
public String presignedPutObject(String bucketName,
                                             String objectName,
                                             Integer expires)
                                      throws ErrorResponseException,
                                             IllegalArgumentException,
                                             InsufficientDataException,
                                             InternalException,
                                             InvalidBucketNameException,
                                             InvalidExpiresRangeException,
                                             InvalidKeyException,
                                             InvalidResponseException,
                                             IOException,
                                             NoSuchAlgorithmException,
                                             ServerException,
                                             XmlParserException

Deprecated. use getPresignedObjectUrl(GetPresignedObjectUrlArgs)

Gets presigned URL of an object to upload data for expiry time.

Example:
 // Get presigned URL to upload data to my-objectname with one day expiry.
 String url =
     minioClient.presignedPutObject("my-bucketname", "my-objectname", 24 * 60 * 60);

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; expires - Expiry in seconds; defaults to 7 days.
Returns:: String - URL string to upload an object.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; InvalidExpiresRangeException - thrown to indicate invalid expiry duration passed.; 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

presignedPutObject

@Deprecated
public String presignedPutObject(String bucketName,
                                             String objectName)
                                      throws ErrorResponseException,
                                             IllegalArgumentException,
                                             InsufficientDataException,
                                             InternalException,
                                             InvalidBucketNameException,
                                             InvalidExpiresRangeException,
                                             InvalidKeyException,
                                             InvalidResponseException,
                                             IOException,
                                             NoSuchAlgorithmException,
                                             ServerException,
                                             XmlParserException

Deprecated. use getPresignedObjectUrl(GetPresignedObjectUrlArgs)

Gets presigned URL of an object to upload data for 7 days.

Example:
 String url = minioClient.presignedPutObject("my-bucketname", "my-objectname");

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.
Returns:: String - URL string to upload an object.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; InvalidExpiresRangeException - thrown to indicate invalid expiry duration passed.; 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

presignedPostPolicy

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

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

Example:
 PostPolicy policy = new PostPolicy("my-bucketname", "my-objectname",
     ZonedDateTime.now().plusDays(7));

 // 'my-objectname' should be 'image/png' content type
 policy.setContentType("image/png");

 // set success action status to 201 to receive XML document
 policy.setSuccessActionStatus(201);

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

 // Print curl command to be executed by anonymous user to upload /tmp/userpic.png.
 System.out.print("curl -X POST ");
 for (Map.Entry<String,String> entry : formData.entrySet()) {
   System.out.print(" -F " + entry.getKey() + "=" + entry.getValue());
 }
 System.out.println(" -F file=@/tmp/userpic.png https://play.min.io/my-bucketname");

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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; InvalidExpiresRangeException - thrown to indicate invalid expiry duration passed.; 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

@Deprecated
public void removeObject(String bucketName,
                                     String objectName)
                              throws ErrorResponseException,
                                     IllegalArgumentException,
                                     InsufficientDataException,
                                     InternalException,
                                     InvalidBucketNameException,
                                     InvalidKeyException,
                                     InvalidResponseException,
                                     IOException,
                                     NoSuchAlgorithmException,
                                     ServerException,
                                     XmlParserException

Deprecated. use removeObject(RemoveObjectArgs)

Removes an object.

Example:
 minioClient.removeObject("my-bucketname", "my-objectname");

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

removeObject

public void removeObject(RemoveObjectArgs args)
                  throws ErrorResponseException,
                         IllegalArgumentException,
                         InsufficientDataException,
                         InternalException,
                         InvalidBucketNameException,
                         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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public Iterable<Result<DeleteError>> removeObjects(String bucketName,
                                                               Iterable<String> objectNames)

Deprecated. use removeObjects(RemoveObjectsArgs)

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

Example:
 List<String> myObjectNames = new LinkedList<String>();
 objectNames.add("my-objectname1");
 objectNames.add("my-objectname2");
 objectNames.add("my-objectname3");
 Iterable<Result<DeleteError>> results =
     minioClient.removeObjects("my-bucketname", myObjectNames);
 for (Result<DeleteError> result : results) {
   DeleteError error = errorResult.get();
   System.out.println(
       "Error in deleting object " + error.objectName() + "; " + error.message());
 }

Parameters:: bucketName - Name of the bucket.; objectNames - List of Object names in the bucket.
Returns:: Iterable<Result<DeleteError>> - Lazy iterator contains object removal status.

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 = errorResult.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.

listObjects

@Deprecated
public Iterable<Result<Item>> listObjects(String bucketName)
                                               throws XmlParserException

Deprecated. use listObjects(ListObjectsArgs)

Lists object information of a bucket.

Example:
 Iterable<Result<Item>> results = minioClient.listObjects("my-bucketname");
 for (Result<Item> result : results) {
   Item item = result.get();
   System.out.println(
       item.lastModified() + ", " + item.size() + ", " + item.objectName());
 }

Parameters:: bucketName - Name of the bucket.
Returns:: Iterable<Result<Item>> - Lazy iterator contains object information.
Throws:: XmlParserException - upon parsing response xml

listObjects

@Deprecated
public Iterable<Result<Item>> listObjects(String bucketName,
                                                      String prefix)
                                               throws XmlParserException

Deprecated. use listObjects(ListObjectsArgs)

Lists object information of a bucket for prefix.

Example:
 Iterable<Result<Item>> results = minioClient.listObjects("my-bucketname", "my-obj");
 for (Result<Item> result : results) {
   Item item = result.get();
   System.out.println(
       item.lastModified() + ", " + item.size() + ", " + item.objectName());
 }

Parameters:: bucketName - Name of the bucket.; prefix - Object name starts with prefix.
Returns:: Iterable<Result<Item>> - Lazy iterator contains object information.
Throws:: XmlParserException - upon parsing response xml

listObjects

@Deprecated
public Iterable<Result<Item>> listObjects(String bucketName,
                                                      String prefix,
                                                      boolean recursive)

Deprecated. use listObjects(ListObjectsArgs)

Lists object information of a bucket for prefix recursively.

Example:
 Iterable<Result<Item>> results =
     minioClient.listObjects("my-bucketname", "my-obj", true);
 for (Result<Item> result : results) {
   Item item = result.get();
   System.out.println(
       item.lastModified() + ", " + item.size() + ", " + item.objectName());
 }

Parameters:: bucketName - Name of the bucket.; prefix - Object name starts with prefix.; recursive - List recursively than directory structure emulation.
Returns:: Iterable<Result<Item>> - Lazy iterator contains object information.
See Also:: listObjects(String bucketName), listObjects(String bucketName, String prefix), listObjects(String bucketName, String prefix, boolean recursive, boolean useVersion1)

listObjects

@Deprecated
public Iterable<Result<Item>> listObjects(String bucketName,
                                                      String prefix,
                                                      boolean recursive,
                                                      boolean useVersion1)

Deprecated. use listObjects(ListObjectsArgs)

Lists object information of a bucket for prefix recursively using S3 API version 1.

Example:
 Iterable<Result<Item>> results =
     minioClient.listObjects("my-bucketname", "my-obj", true, true);
 for (Result<Item> result : results) {
   Item item = result.get();
   System.out.println(
       item.lastModified() + ", " + item.size() + ", " + item.objectName());
 }

Parameters:: bucketName - Name of the bucket.; prefix - Object name starts with prefix.; recursive - List recursively than directory structure emulation.; useVersion1 - when true, version 1 of REST API is used.
Returns:: Iterable<Result<Item>> - Lazy iterator contains object information.
See Also:: listObjects(String bucketName), listObjects(String bucketName, String prefix), listObjects(String bucketName, String prefix, boolean recursive)

listObjects

@Deprecated
public Iterable<Result<Item>> listObjects(String bucketName,
                                                      String prefix,
                                                      boolean recursive,
                                                      boolean includeUserMetadata,
                                                      boolean useVersion1)

Deprecated. use listObjects(ListObjectsArgs)

Lists object information with user metadata of a bucket for prefix recursively using S3 API version 2.

Example:
 Iterable<Result<Item>> results =
     minioClient.listObjects("my-bucketname", "my-obj", true, true, false);
 for (Result<Item> result : results) {
   Item item = result.get();
   System.out.println(
       item.lastModified() + ", " + item.size() + ", " + item.objectName());
 }

Parameters:: bucketName - Name of the bucket.; prefix - Object name starts with prefix.; recursive - List recursively than directory structure emulation.; includeUserMetadata - include user metadata of each object. This is MinIO specific extension to ListObjectsV2.; useVersion1 - when true, version 1 of REST API is used.
Returns:: Iterable<Result<Item>> - Lazy iterator contains object information.
See Also:: listObjects(String bucketName), listObjects(String bucketName, String prefix), listObjects(String bucketName, String prefix, boolean recursive)

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 those 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 those 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,
                                IllegalArgumentException,
                                InsufficientDataException,
                                InternalException,
                                InvalidBucketNameException,
                                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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

bucketExists

@Deprecated
public boolean bucketExists(String bucketName)
                                 throws ErrorResponseException,
                                        IllegalArgumentException,
                                        InsufficientDataException,
                                        InternalException,
                                        InvalidBucketNameException,
                                        InvalidKeyException,
                                        InvalidResponseException,
                                        IOException,
                                        NoSuchAlgorithmException,
                                        ServerException,
                                        XmlParserException

Deprecated. use bucketExists(BucketExistsArgs)

Checks if a bucket exists.

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

Parameters:: bucketName - Name of the bucket.
Returns:: boolean - True if the bucket exists.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

bucketExists

public boolean bucketExists(BucketExistsArgs args)
                     throws ErrorResponseException,
                            IllegalArgumentException,
                            InsufficientDataException,
                            InternalException,
                            InvalidBucketNameException,
                            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.; IllegalArgumentException - throws to indicate invalid argument passed.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public void makeBucket(String bucketName)
                            throws ErrorResponseException,
                                   IllegalArgumentException,
                                   InsufficientDataException,
                                   InternalException,
                                   InvalidBucketNameException,
                                   InvalidKeyException,
                                   InvalidResponseException,
                                   IOException,
                                   NoSuchAlgorithmException,
                                   RegionConflictException,
                                   ServerException,
                                   XmlParserException

Deprecated. use makeBucket(MakeBucketArgs)

Creates a bucket with default region.

Example:
 minioClient.makeBucket("my-bucketname");

Parameters:: bucketName - Name of the bucket.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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.; RegionConflictException - thrown to indicate passed region conflict with default region.; XmlParserException - thrown to indicate XML parsing error.; ServerException

makeBucket

@Deprecated
public void makeBucket(String bucketName,
                                   String region)
                            throws ErrorResponseException,
                                   IllegalArgumentException,
                                   InsufficientDataException,
                                   InternalException,
                                   InvalidBucketNameException,
                                   InvalidKeyException,
                                   InvalidResponseException,
                                   IOException,
                                   NoSuchAlgorithmException,
                                   RegionConflictException,
                                   ServerException,
                                   XmlParserException

Deprecated. use makeBucket(MakeBucketArgs)

Creates a bucket with given region.

Example:
 minioClient.makeBucket("my-bucketname", "eu-west-1");

Parameters:: bucketName - Name of the bucket.; region - Region in which the bucket will be created.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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.; RegionConflictException - thrown to indicate passed region conflict with default region.; XmlParserException - thrown to indicate XML parsing error.; ServerException

makeBucket

@Deprecated
public void makeBucket(String bucketName,
                                   String region,
                                   boolean objectLock)
                            throws ErrorResponseException,
                                   IllegalArgumentException,
                                   InsufficientDataException,
                                   InternalException,
                                   InvalidBucketNameException,
                                   InvalidKeyException,
                                   InvalidResponseException,
                                   IOException,
                                   NoSuchAlgorithmException,
                                   RegionConflictException,
                                   ServerException,
                                   XmlParserException

Deprecated. use makeBucket(MakeBucketArgs)

Creates a bucket with object lock feature enabled.

Example:
 minioClient.makeBucket("my-bucketname", "eu-west-2", true);

Parameters:: bucketName - Name of the bucket.; region - Region in which the bucket will be created.; objectLock - Flag to enable object lock feature.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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.; RegionConflictException - thrown to indicate passed region conflict with default region.; XmlParserException - thrown to indicate XML parsing error.; ServerException

makeBucket

public void makeBucket(MakeBucketArgs args)
                throws ErrorResponseException,
                       IllegalArgumentException,
                       InsufficientDataException,
                       InternalException,
                       InvalidBucketNameException,
                       InvalidKeyException,
                       InvalidResponseException,
                       IOException,
                       NoSuchAlgorithmException,
                       RegionConflictException,
                       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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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.; RegionConflictException - thrown to indicate passed region conflict with default region.; XmlParserException - thrown to indicate XML parsing error.; ServerException

enableVersioning

@Deprecated
public void enableVersioning(String bucketName)
                                  throws ErrorResponseException,
                                         IllegalArgumentException,
                                         InsufficientDataException,
                                         InternalException,
                                         InvalidBucketNameException,
                                         InvalidKeyException,
                                         InvalidResponseException,
                                         IOException,
                                         NoSuchAlgorithmException,
                                         ServerException,
                                         XmlParserException

Deprecated. use enableVersioning(EnableVersioningArgs)

Enables object versioning feature in a bucket.

Example:
 minioClient.enableVersioning("my-bucketname");

Parameters:: bucketName - Name of the bucket.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

enableVersioning

public void enableVersioning(EnableVersioningArgs args)
                      throws ErrorResponseException,
                             IllegalArgumentException,
                             InsufficientDataException,
                             InternalException,
                             InvalidBucketNameException,
                             InvalidKeyException,
                             InvalidResponseException,
                             IOException,
                             NoSuchAlgorithmException,
                             ServerException,
                             XmlParserException

Enables object versioning feature in a bucket.

Example:
 minioClient.enableVersioning(EnableVersioningArgs.builder().bucket("my-bucketname").build());

Parameters:: args - EnableVersioningArgs object.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

disableVersioning

@Deprecated
public void disableVersioning(String bucketName)
                                   throws ErrorResponseException,
                                          IllegalArgumentException,
                                          InsufficientDataException,
                                          InternalException,
                                          InvalidBucketNameException,
                                          InvalidKeyException,
                                          InvalidResponseException,
                                          IOException,
                                          NoSuchAlgorithmException,
                                          ServerException,
                                          XmlParserException

Deprecated. use disableVersioning(DisableVersioningArgs)

Disables object versioning feature in a bucket.

Example:
 minioClient.disableVersioning("my-bucketname");

Parameters:: bucketName - Name of the bucket.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

disableVersioning

public void disableVersioning(DisableVersioningArgs args)
                       throws ErrorResponseException,
                              IllegalArgumentException,
                              InsufficientDataException,
                              InternalException,
                              InvalidBucketNameException,
                              InvalidKeyException,
                              InvalidResponseException,
                              IOException,
                              NoSuchAlgorithmException,
                              ServerException,
                              XmlParserException

Disables object versioning feature in a bucket.

Example:
 minioClient.disableVersioning(
     DisableVersioningArgs.builder().bucket("my-bucketname").build());

Parameters:: args - DisableVersioningArgs object.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

isVersioningEnabled

public boolean isVersioningEnabled(IsVersioningEnabledArgs args)
                            throws ErrorResponseException,
                                   IllegalArgumentException,
                                   InsufficientDataException,
                                   InternalException,
                                   InvalidBucketNameException,
                                   InvalidKeyException,
                                   InvalidResponseException,
                                   IOException,
                                   NoSuchAlgorithmException,
                                   ServerException,
                                   XmlParserException

Returns true if versioning is enabled on the bucket.

Example:
 boolean isVersioningEnabled =
  minioClient.isVersioningEnabled(
       IsVersioningEnabledArgs.builder().bucket("my-bucketname").build());
 if (isVersioningEnabled) {
   System.out.println("Bucket versioning is enabled");
 } else {
   System.out.println("Bucket versioning is disabled");
 }

Parameters:: args - IsVersioningEnabledArgs object.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

setDefaultRetention

@Deprecated
public void setDefaultRetention(String bucketName,
                                            ObjectLockConfiguration config)
                                     throws ErrorResponseException,
                                            IllegalArgumentException,
                                            InsufficientDataException,
                                            InternalException,
                                            InvalidBucketNameException,
                                            InvalidKeyException,
                                            InvalidResponseException,
                                            IOException,
                                            NoSuchAlgorithmException,
                                            ServerException,
                                            XmlParserException

Deprecated. use setDefaultRetention(SetDefaultRetentionArgs)

Sets default object retention in a bucket.

Example:
 ObjectLockConfiguration config = new ObjectLockConfiguration(
     RetentionMode.COMPLIANCE, new RetentionDurationDays(100));
 minioClient.setDefaultRetention("my-bucketname", config);

Parameters:: bucketName - Name of the bucket.; config - Object lock configuration.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

setDefaultRetention

public void setDefaultRetention(SetDefaultRetentionArgs args)
                         throws ErrorResponseException,
                                IllegalArgumentException,
                                InsufficientDataException,
                                InternalException,
                                InvalidBucketNameException,
                                InvalidKeyException,
                                InvalidResponseException,
                                IOException,
                                NoSuchAlgorithmException,
                                ServerException,
                                XmlParserException

Sets default object retention in a bucket.

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

Parameters:: args - SetDefaultRetentionArgs object.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

deleteDefaultRetention

public void deleteDefaultRetention(DeleteDefaultRetentionArgs args)
                            throws ErrorResponseException,
                                   IllegalArgumentException,
                                   InsufficientDataException,
                                   InternalException,
                                   InvalidBucketNameException,
                                   InvalidKeyException,
                                   InvalidResponseException,
                                   IOException,
                                   NoSuchAlgorithmException,
                                   ServerException,
                                   XmlParserException

Deletes default object retention in a bucket.

Example:
 minioClient.deleteDefaultRetention(
     DeleteDefaultRetentionArgs.builder().bucket("my-bucketname").build());

Parameters:: args - DeleteDefaultRetentionArgs object.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

getDefaultRetention

@Deprecated
public ObjectLockConfiguration getDefaultRetention(String bucketName)
                                                        throws ErrorResponseException,
                                                               IllegalArgumentException,
                                                               InsufficientDataException,
                                                               InternalException,
                                                               InvalidBucketNameException,
                                                               InvalidKeyException,
                                                               InvalidResponseException,
                                                               IOException,
                                                               NoSuchAlgorithmException,
                                                               ServerException,
                                                               XmlParserException

Deprecated. use getDefaultRetention(GetDefaultRetentionArgs)

Gets default object retention in a bucket.

Example:
 ObjectLockConfiguration config = minioClient.getDefaultRetention("my-bucketname");
 System.out.println("Mode: " + config.mode());
 System.out.println(
     "Duration: " + config.duration().duration() + " " + config.duration().unit());

Parameters:: bucketName - Name of the bucket.
Returns:: ObjectLockConfiguration - Default retention configuration.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

getDefaultRetention

public ObjectLockConfiguration getDefaultRetention(GetDefaultRetentionArgs args)
                                            throws ErrorResponseException,
                                                   IllegalArgumentException,
                                                   InsufficientDataException,
                                                   InternalException,
                                                   InvalidBucketNameException,
                                                   InvalidKeyException,
                                                   InvalidResponseException,
                                                   IOException,
                                                   NoSuchAlgorithmException,
                                                   ServerException,
                                                   XmlParserException

Gets default object retention in a bucket.

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

Parameters:: args - GetDefaultRetentionArgs object.
Returns:: ObjectLockConfiguration - Default retention configuration.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public void setObjectRetention(String bucketName,
                                           String objectName,
                                           String versionId,
                                           Retention config,
                                           boolean bypassGovernanceMode)
                                    throws ErrorResponseException,
                                           IllegalArgumentException,
                                           InsufficientDataException,
                                           InternalException,
                                           InvalidBucketNameException,
                                           InvalidKeyException,
                                           InvalidResponseException,
                                           IOException,
                                           NoSuchAlgorithmException,
                                           ServerException,
                                           XmlParserException

Deprecated. use setObjectRetention(SetObjectRetentionArgs)

Sets retention configuration to an object.

Example:
 Retention retention =
     new Retention(RetentionMode.COMPLIANCE, ZonedDateTime.now().plusYears(1));
 minioClient.setObjectRetention(
     "my-bucketname", "my-objectname", null, retention, true);

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; versionId - Version ID of the object.; config - Object retention configuration.; bypassGovernanceMode - Bypass Governance retention.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                               IllegalArgumentException,
                               InsufficientDataException,
                               InternalException,
                               InvalidBucketNameException,
                               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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public Retention getObjectRetention(String bucketName,
                                                String objectName,
                                                String versionId)
                                         throws ErrorResponseException,
                                                IllegalArgumentException,
                                                InsufficientDataException,
                                                InternalException,
                                                InvalidBucketNameException,
                                                InvalidKeyException,
                                                InvalidResponseException,
                                                IOException,
                                                NoSuchAlgorithmException,
                                                ServerException,
                                                XmlParserException

Deprecated. use getObjectRetention(GetObjectRetentionArgs)

Gets retention configuration of an object.

Example:
 Retention retention =
     minioClient.getObjectRetention("my-bucketname", "my-objectname", null);
 System.out.println(
     "mode: " + retention.mode() + "until: " + retention.retainUntilDate());

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; versionId - Version ID of the object.
Returns:: Retention - Object retention configuration.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                                    IllegalArgumentException,
                                    InsufficientDataException,
                                    InternalException,
                                    InvalidBucketNameException,
                                    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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public void enableObjectLegalHold(String bucketName,
                                              String objectName,
                                              String versionId)
                                       throws ErrorResponseException,
                                              IllegalArgumentException,
                                              InsufficientDataException,
                                              InternalException,
                                              InvalidBucketNameException,
                                              InvalidKeyException,
                                              InvalidResponseException,
                                              IOException,
                                              NoSuchAlgorithmException,
                                              ServerException,
                                              XmlParserException

Deprecated. use enableObjectLegalHold(EnableObjectLegalHoldArgs)

Enables legal hold on an object.

Example:
 minioClient.enableObjectLegalHold("my-bucketname", "my-object", null);

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; versionId - Version ID of the object.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                                  IllegalArgumentException,
                                  InsufficientDataException,
                                  InternalException,
                                  InvalidBucketNameException,
                                  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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public void disableObjectLegalHold(String bucketName,
                                               String objectName,
                                               String versionId)
                                        throws ErrorResponseException,
                                               IllegalArgumentException,
                                               InsufficientDataException,
                                               InternalException,
                                               InvalidBucketNameException,
                                               InvalidKeyException,
                                               InvalidResponseException,
                                               IOException,
                                               NoSuchAlgorithmException,
                                               ServerException,
                                               XmlParserException

Deprecated. use disableObjectLegalHold(DisableObjectLegalHoldArgs)

Disables legal hold on an object.

Example:
 minioClient.disableObjectLegalHold("my-bucketname", "my-object", null);

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; versionId - Version ID of the object.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                                   IllegalArgumentException,
                                   InsufficientDataException,
                                   InternalException,
                                   InvalidBucketNameException,
                                   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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public boolean isObjectLegalHoldEnabled(String bucketName,
                                                    String objectName,
                                                    String versionId)
                                             throws ErrorResponseException,
                                                    IllegalArgumentException,
                                                    InsufficientDataException,
                                                    InternalException,
                                                    InvalidBucketNameException,
                                                    InvalidKeyException,
                                                    InvalidResponseException,
                                                    IOException,
                                                    NoSuchAlgorithmException,
                                                    ServerException,
                                                    XmlParserException

Deprecated. use isObjectLegalHoldEnabled(IsObjectLegalHoldEnabledArgs)

Returns true if legal hold is enabled on an object.

Example:
 boolean status =
     s3Client.isObjectLegalHoldEnabled("my-bucketname", "my-objectname", null);
 if (status) {
   System.out.println("Legal hold is on");
 } else {
   System.out.println("Legal hold is off");
 }

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; versionId - Version ID of the object.
Returns:: boolean - True if legal hold is enabled.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                                        IllegalArgumentException,
                                        InsufficientDataException,
                                        InternalException,
                                        InvalidBucketNameException,
                                        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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public void removeBucket(String bucketName)
                              throws ErrorResponseException,
                                     IllegalArgumentException,
                                     InsufficientDataException,
                                     InternalException,
                                     InvalidBucketNameException,
                                     InvalidKeyException,
                                     InvalidResponseException,
                                     IOException,
                                     NoSuchAlgorithmException,
                                     ServerException,
                                     XmlParserException

Deprecated. use removeBucket(RemoveBucketArgs)

Removes an empty bucket.

Example:
 minioClient.removeBucket("my-bucketname");

Parameters:: bucketName - Name of the bucket.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                         IllegalArgumentException,
                         InsufficientDataException,
                         InternalException,
                         InvalidBucketNameException,
                         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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public void putObject(String bucketName,
                                  String objectName,
                                  String filename,
                                  PutObjectOptions options)
                           throws ErrorResponseException,
                                  IllegalArgumentException,
                                  InsufficientDataException,
                                  InternalException,
                                  InvalidBucketNameException,
                                  InvalidKeyException,
                                  InvalidResponseException,
                                  IOException,
                                  NoSuchAlgorithmException,
                                  ServerException,
                                  XmlParserException

Deprecated. use uploadObject(UploadObjectArgs)

Uploads data from a file to an object using PutObjectOptions.

Example:
 minioClient.putObject("my-bucketname", "my-objectname", "my-filename", null);

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; filename - Name of file to upload.; options - PutObjectOptions to be used during upload.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public void putObject(String bucketName,
                                  String objectName,
                                  InputStream stream,
                                  PutObjectOptions options)
                           throws ErrorResponseException,
                                  IllegalArgumentException,
                                  InsufficientDataException,
                                  InternalException,
                                  InvalidBucketNameException,
                                  InvalidKeyException,
                                  InvalidResponseException,
                                  IOException,
                                  NoSuchAlgorithmException,
                                  ServerException,
                                  XmlParserException

Deprecated. use putObject(PutObjectArgs)

Uploads data from a stream to an object using PutObjectOptions.

Example:
 PutObjectOptions options = new PutObjectOptions(7003256, -1);
 minioClient.putObject("my-bucketname", "my-objectname", stream, options);

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; stream - Stream contains object data.; options - PutObjectOptions to be used during upload.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                                     IllegalArgumentException,
                                     InsufficientDataException,
                                     InternalException,
                                     InvalidBucketNameException,
                                     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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                                        IllegalArgumentException,
                                        InsufficientDataException,
                                        InternalException,
                                        InvalidBucketNameException,
                                        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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public String getBucketPolicy(String bucketName)
                                   throws BucketPolicyTooLargeException,
                                          ErrorResponseException,
                                          IllegalArgumentException,
                                          InsufficientDataException,
                                          InternalException,
                                          InvalidBucketNameException,
                                          InvalidKeyException,
                                          InvalidResponseException,
                                          IOException,
                                          NoSuchAlgorithmException,
                                          ServerException,
                                          XmlParserException

Deprecated. use getBucketPolicy(GetBucketPolicyArgs)

Gets bucket policy configuration of a bucket.

Example:
 String config = minioClient.getBucketPolicy("my-bucketname");

Parameters:: bucketName - Name of the bucket.
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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                              IllegalArgumentException,
                              InsufficientDataException,
                              InternalException,
                              InvalidBucketNameException,
                              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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public void setBucketPolicy(String bucketName,
                                        String policy)
                                 throws ErrorResponseException,
                                        IllegalArgumentException,
                                        InsufficientDataException,
                                        InternalException,
                                        InvalidBucketNameException,
                                        InvalidKeyException,
                                        InvalidResponseException,
                                        IOException,
                                        NoSuchAlgorithmException,
                                        ServerException,
                                        XmlParserException

Deprecated. use setBucketPolicy(SetBucketPolicyArgs)

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("my-bucketname", policyJson);

Parameters:: bucketName - Name of the bucket.; policy - Bucket policy configuration as JSON string.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                            IllegalArgumentException,
                            InsufficientDataException,
                            InternalException,
                            InvalidBucketNameException,
                            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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                               IllegalArgumentException,
                               InsufficientDataException,
                               InternalException,
                               InvalidBucketNameException,
                               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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public void setBucketLifeCycle(String bucketName,
                                           String lifeCycle)
                                    throws ErrorResponseException,
                                           IllegalArgumentException,
                                           InsufficientDataException,
                                           InternalException,
                                           InvalidBucketNameException,
                                           InvalidKeyException,
                                           InvalidResponseException,
                                           IOException,
                                           NoSuchAlgorithmException,
                                           ServerException,
                                           XmlParserException

Deprecated. use setBucketLifeCycle(SetBucketLifeCycleArgs)

Sets life-cycle configuration to a bucket.

Example:
 // Lets consider variable 'lifeCycleXml' contains below XML String;
 // <LifecycleConfiguration>
 //   <Rule>
 //     <ID>expire-bucket</ID>
 //     <Prefix></Prefix>
 //     <Status>Enabled</Status>
 //     <Expiration>
 //       <Days>365</Days>
 //     </Expiration>
 //   </Rule>
 // </LifecycleConfiguration>
 //
 minioClient.setBucketLifeCycle("my-bucketname", lifeCycleXml);

Parameters:: bucketName - Name of the bucket.; lifeCycle - Life cycle configuraion as XML string.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                               IllegalArgumentException,
                               InsufficientDataException,
                               InternalException,
                               InvalidBucketNameException,
                               InvalidKeyException,
                               InvalidResponseException,
                               IOException,
                               NoSuchAlgorithmException,
                               ServerException,
                               XmlParserException

Sets life-cycle configuration to a bucket.

Example:
 // Lets consider variable 'lifeCycleXml' contains below XML String;
 // <LifecycleConfiguration>
 //   <Rule>
 //     <ID>expire-bucket</ID>
 //     <Prefix></Prefix>
 //     <Status>Enabled</Status>
 //     <Expiration>
 //       <Days>365</Days>
 //     </Expiration>
 //   </Rule>
 // </LifecycleConfiguration>
 //
 minioClient.setBucketLifeCycle(
     SetBucketLifeCycleArgs.builder().bucket("my-bucketname").config(lifeCycleXml).build());

Parameters:: args - SetBucketLifeCycleArgs object.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public void deleteBucketLifeCycle(String bucketName)
                                       throws ErrorResponseException,
                                              IllegalArgumentException,
                                              InsufficientDataException,
                                              InternalException,
                                              InvalidBucketNameException,
                                              InvalidKeyException,
                                              InvalidResponseException,
                                              IOException,
                                              NoSuchAlgorithmException,
                                              ServerException,
                                              XmlParserException

Deprecated. use deleteBucketLifeCycle(DeleteBucketLifeCycleArgs)

Deletes life-cycle configuration of a bucket.

Example:
 deleteBucketLifeCycle("my-bucketname");

Parameters:: bucketName - Name of the bucket.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                                  IllegalArgumentException,
                                  InsufficientDataException,
                                  InternalException,
                                  InvalidBucketNameException,
                                  InvalidKeyException,
                                  InvalidResponseException,
                                  IOException,
                                  NoSuchAlgorithmException,
                                  ServerException,
                                  XmlParserException

Deletes life-cycle 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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public String getBucketLifeCycle(String bucketName)
                                      throws ErrorResponseException,
                                             IllegalArgumentException,
                                             InsufficientDataException,
                                             InternalException,
                                             InvalidBucketNameException,
                                             InvalidKeyException,
                                             InvalidResponseException,
                                             IOException,
                                             NoSuchAlgorithmException,
                                             ServerException,
                                             XmlParserException

Deprecated. use getBucketLifeCycle(GetBucketLifeCycleArgs)

Gets life-cycle configuration of a bucket.

Example:
 String lifecycle = minioClient.getBucketLifeCycle("my-bucketname");

Parameters:: bucketName - Name of the bucket.
Returns:: String - Life cycle configuration as XML string.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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 String getBucketLifeCycle(GetBucketLifeCycleArgs args)
                          throws ErrorResponseException,
                                 IllegalArgumentException,
                                 InsufficientDataException,
                                 InternalException,
                                 InvalidBucketNameException,
                                 InvalidKeyException,
                                 InvalidResponseException,
                                 IOException,
                                 NoSuchAlgorithmException,
                                 ServerException,
                                 XmlParserException

Gets life-cycle configuration of a bucket.

Example:
 String lifecycle =
     minioClient.getBucketLifeCycle(
         GetBucketLifeCycleArgs.builder().bucket("my-bucketname").build());

Parameters:: args - GetBucketLifeCycleArgs object.
Returns:: String - Life cycle configuration as XML string.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public NotificationConfiguration getBucketNotification(String bucketName)
                                                            throws ErrorResponseException,
                                                                   IllegalArgumentException,
                                                                   InsufficientDataException,
                                                                   InternalException,
                                                                   InvalidBucketNameException,
                                                                   InvalidKeyException,
                                                                   InvalidResponseException,
                                                                   IOException,
                                                                   NoSuchAlgorithmException,
                                                                   ServerException,
                                                                   XmlParserException

Deprecated. use getBucketNotification(GetBucketNotificationArgs)

Gets notification configuration of a bucket.

Example:
 NotificationConfiguration config =
     minioClient.getBucketNotification("my-bucketname");

Parameters:: bucketName - Name of the bucket.
Returns:: NotificationConfiguration - Notification configuration.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                                                       IllegalArgumentException,
                                                       InsufficientDataException,
                                                       InternalException,
                                                       InvalidBucketNameException,
                                                       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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public void setBucketNotification(String bucketName,
                                              NotificationConfiguration notificationConfiguration)
                                       throws ErrorResponseException,
                                              IllegalArgumentException,
                                              InsufficientDataException,
                                              InternalException,
                                              InvalidBucketNameException,
                                              InvalidKeyException,
                                              InvalidResponseException,
                                              IOException,
                                              NoSuchAlgorithmException,
                                              ServerException,
                                              XmlParserException

Deprecated. use setBucketNotification(SetBucketNotificationArgs)

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("my-bucketname", config);

Parameters:: bucketName - Name of the bucket.; notificationConfiguration - NotificationConfiguration to be set.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                                  IllegalArgumentException,
                                  InsufficientDataException,
                                  InternalException,
                                  InvalidBucketNameException,
                                  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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

removeAllBucketNotification

@Deprecated
public void removeAllBucketNotification(String bucketName)
                                             throws ErrorResponseException,
                                                    IllegalArgumentException,
                                                    InsufficientDataException,
                                                    InternalException,
                                                    InvalidBucketNameException,
                                                    InvalidKeyException,
                                                    InvalidResponseException,
                                                    IOException,
                                                    NoSuchAlgorithmException,
                                                    ServerException,
                                                    XmlParserException

Deprecated. use deleteBucketNotification(DeleteBucketNotificationArgs)

Removes notification configuration of a bucket.

Example:
 minioClient.removeAllBucketNotification("my-bucketname");

Parameters:: bucketName - Name of the bucket.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                                     IllegalArgumentException,
                                     InsufficientDataException,
                                     InternalException,
                                     InvalidBucketNameException,
                                     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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

listIncompleteUploads

@Deprecated
public Iterable<Result<Upload>> listIncompleteUploads(String bucketName)
                                                           throws XmlParserException

Deprecated. use listIncompleteUploads(ListIncompleteUploadsArgs)

Lists incomplete object upload information of a bucket.

Example:
 Iterable<Result<Upload>> results =
     minioClient.listIncompleteUploads("my-bucketname");
 for (Result<Upload> result : results) {
   Upload upload = result.get();
   System.out.println(upload.uploadId() + ", " + upload.objectName());
 }

Parameters:: bucketName - Name of the bucket.
Returns:: Iterable<Result<Upload>> - Lazy iterator contains object upload information.
Throws:: XmlParserException

listIncompleteUploads

@Deprecated
public Iterable<Result<Upload>> listIncompleteUploads(String bucketName,
                                                                  String prefix)
                                                           throws XmlParserException

Deprecated. use listIncompleteUploads(ListIncompleteUploadsArgs)

Lists incomplete object upload information of a bucket for prefix.

Example:
 Iterable<Result<Upload>> results =
     minioClient.listIncompleteUploads("my-bucketname", "my-obj");
 for (Result<Upload> result : results) {
   Upload upload = result.get();
   System.out.println(upload.uploadId() + ", " + upload.objectName());
 }

Parameters:: bucketName - Name of the bucket.; prefix - Object name starts with prefix.
Returns:: Iterable<Result<Upload>> - Lazy iterator contains object upload information.
Throws:: XmlParserException - upon parsing response xml

listIncompleteUploads

@Deprecated
public Iterable<Result<Upload>> listIncompleteUploads(String bucketName,
                                                                  String prefix,
                                                                  boolean recursive)

Deprecated. use listIncompleteUploads(ListIncompleteUploadsArgs)

Lists incomplete object upload information of a bucket for prefix recursively.

Example:
 Iterable<Result<Upload>> results =
     minioClient.listIncompleteUploads("my-bucketname", "my-obj", true);
 for (Result<Upload> result : results) {
   Upload upload = result.get();
   System.out.println(upload.uploadId() + ", " + upload.objectName());
 }

Parameters:: bucketName - Name of the bucket.; prefix - Object name starts with prefix.; recursive - List recursively than directory structure emulation.
Returns:: Iterable<Result<Upload>> - Lazy iterator contains object upload information.

listIncompleteUploads

public Iterable<Result<Upload>> listIncompleteUploads(ListIncompleteUploadsArgs args)

Lists incomplete object upload information of a bucket for prefix recursively.

Example:
  // Lists incomplete object upload information of a bucket.
   Iterable<Result<Upload>> results =
       minioClient.listIncompleteUploads(
           ListIncompleteUploadsArgs.builder().bucket("my-bucketname").build());
   for (Result<Upload> result : results) {
     Upload upload = result.get();
     System.out.println(upload.uploadId() + ", " + upload.objectName());
   }

   // Lists incomplete object upload information of a bucket for prefix.
   Iterable<Result<Upload>> results =
       minioClient.listIncompleteUploads(
           ListIncompleteUploadsArgs.builder()
               .bucket("my-bucketname")
               .prefix("my-obj")
               .build());
   for (Result<Upload> result : results) {
     Upload upload = result.get();
     System.out.println(upload.uploadId() + ", " + upload.objectName());
   }

   // Lists incomplete object upload information of a bucket for prefix recursively.
   Iterable<Result<Upload>> results =
       minioClient.listIncompleteUploads(
           ListIncompleteUploadsArgs.builder()
               .bucket("my-bucketname")
               .prefix("my-obj")
               .recursive(true)
               .build());
   for (Result<Upload> result : results) {
    Upload upload = result.get();
    System.out.println(upload.uploadId() + ", " + upload.objectName());
   }

   // Lists incomplete object upload information of a bucket for prefix, delimiter.
   //  keyMarker, uploadIdMarker and maxUpload to 500
   Iterable<Result<Upload>> results =
       minioClient.listIncompleteUploads(
           ListIncompleteUploadsArgs.builder()
               .bucket("my-bucketname")
               .prefix("my-obj")
               .delimiter("-")
               .keyMarker("b")
               .maxUploads(500)
               .uploadIdMarker("k")
               .build());
   for (Result<Upload> result : results) {
    Upload upload = result.get();
    System.out.println(upload.uploadId() + ", " + upload.objectName());
   }

Parameters:: args - ListIncompleteUploadsArgs objects.
Returns:: Iterable<Result<Upload>> - Lazy iterator contains object upload information.

removeIncompleteUpload

@Deprecated
public void removeIncompleteUpload(String bucketName,
                                               String objectName)
                                        throws ErrorResponseException,
                                               IllegalArgumentException,
                                               InsufficientDataException,
                                               InternalException,
                                               InvalidBucketNameException,
                                               InvalidKeyException,
                                               InvalidResponseException,
                                               IOException,
                                               NoSuchAlgorithmException,
                                               ServerException,
                                               XmlParserException

Deprecated. use removeIncompleteUpload(RemoveIncompleteUploadArgs)

Removes incomplete uploads of an object.

Example:
 minioClient.removeIncompleteUpload("my-bucketname", "my-objectname");

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

removeIncompleteUpload

public void removeIncompleteUpload(RemoveIncompleteUploadArgs args)
                            throws ErrorResponseException,
                                   IllegalArgumentException,
                                   InsufficientDataException,
                                   InternalException,
                                   InvalidBucketNameException,
                                   InvalidKeyException,
                                   InvalidResponseException,
                                   IOException,
                                   NoSuchAlgorithmException,
                                   ServerException,
                                   XmlParserException

Removes incomplete uploads of an object.

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

Parameters:: args - instance of RemoveIncompleteUploadArgs
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public CloseableIterator<Result<NotificationRecords>> listenBucketNotification(String bucketName,
                                                                                           String prefix,
                                                                                           String suffix,
                                                                                           String[] events)
                                                                                    throws ErrorResponseException,
                                                                                           IllegalArgumentException,
                                                                                           InsufficientDataException,
                                                                                           InternalException,
                                                                                           InvalidBucketNameException,
                                                                                           InvalidKeyException,
                                                                                           InvalidResponseException,
                                                                                           IOException,
                                                                                           NoSuchAlgorithmException,
                                                                                           ServerException,
                                                                                           XmlParserException

Deprecated. use listenBucketNotification(ListenBucketNotificationArgs)

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<NotificationInfo>> ci =
     minioClient.listenBucketNotification("bucketName", "", "", events)) {
   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:: bucketName - Name of the bucket.; prefix - Listen events of object starts with prefix.; suffix - Listen events of object ends with suffix.; events - Events to listen.
Returns:: CloseableIterator<Result<NotificationRecords>> - Lazy closable iterator contains event records.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                                                                               IllegalArgumentException,
                                                                               InsufficientDataException,
                                                                               InternalException,
                                                                               InvalidBucketNameException,
                                                                               InvalidKeyException,
                                                                               InvalidResponseException,
                                                                               IOException,
                                                                               NoSuchAlgorithmException,
                                                                               ServerException,
                                                                               XmlParserException

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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

@Deprecated
public SelectResponseStream selectObjectContent(String bucketName,
                                                            String objectName,
                                                            String sqlExpression,
                                                            InputSerialization is,
                                                            OutputSerialization os,
                                                            boolean requestProgress,
                                                            Long scanStartRange,
                                                            Long scanEndRange,
                                                            ServerSideEncryptionCustomerKey ssec)
                                                     throws ErrorResponseException,
                                                            IllegalArgumentException,
                                                            InsufficientDataException,
                                                            InternalException,
                                                            InvalidBucketNameException,
                                                            InvalidKeyException,
                                                            InvalidResponseException,
                                                            IOException,
                                                            NoSuchAlgorithmException,
                                                            ServerException,
                                                            XmlParserException

Deprecated. use selectObjectContent(SelectObjectContentArgs)

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("my-bucketname", "my-objectName", sqlExpression,
         is, os, true, null, null, null);

 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:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; sqlExpression - SQL expression.; is - Input specification of object data.; os - Output specification of result.; requestProgress - Flag to request progress information.; scanStartRange - scan start range of the object.; scanEndRange - scan end range of the object.; ssec - SSE-C type server-side encryption.
Returns:: SelectResponseStream - Contains filtered records and progress.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                                                IllegalArgumentException,
                                                InsufficientDataException,
                                                InternalException,
                                                InvalidBucketNameException,
                                                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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                                IllegalArgumentException,
                                InsufficientDataException,
                                InternalException,
                                InvalidBucketNameException,
                                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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                                            IllegalArgumentException,
                                            InsufficientDataException,
                                            InternalException,
                                            InvalidBucketNameException,
                                            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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                                   IllegalArgumentException,
                                   InsufficientDataException,
                                   InternalException,
                                   InvalidBucketNameException,
                                   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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                          IllegalArgumentException,
                          InsufficientDataException,
                          InternalException,
                          InvalidBucketNameException,
                          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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                          IllegalArgumentException,
                          InsufficientDataException,
                          InternalException,
                          InvalidBucketNameException,
                          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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                             IllegalArgumentException,
                             InsufficientDataException,
                             InternalException,
                             InvalidBucketNameException,
                             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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                          IllegalArgumentException,
                          InsufficientDataException,
                          InternalException,
                          InvalidBucketNameException,
                          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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                          IllegalArgumentException,
                          InsufficientDataException,
                          InternalException,
                          InvalidBucketNameException,
                          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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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,
                             IllegalArgumentException,
                             InsufficientDataException,
                             InternalException,
                             InvalidBucketNameException,
                             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.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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
```
public void enableAccelerateEndpoint()
```
Enables accelerate endpoint for Amazon S3 endpoint.

disableAccelerateEndpoint
```
public void disableAccelerateEndpoint()
```
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.

abortMultipartUpload

protected void abortMultipartUpload(String bucketName,
                                    String objectName,
                                    String uploadId)
                             throws InvalidBucketNameException,
                                    IllegalArgumentException,
                                    NoSuchAlgorithmException,
                                    InsufficientDataException,
                                    IOException,
                                    InvalidKeyException,
                                    ServerException,
                                    XmlParserException,
                                    ErrorResponseException,
                                    InternalException,
                                    InvalidResponseException

Do AbortMultipartUpload S3 API.

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; uploadId - Upload ID.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

completeMultipartUpload

@Deprecated
protected void completeMultipartUpload(String bucketName,
                                                   String objectName,
                                                   String uploadId,
                                                   Part[] parts)
                                            throws InvalidBucketNameException,
                                                   IllegalArgumentException,
                                                   NoSuchAlgorithmException,
                                                   InsufficientDataException,
                                                   IOException,
                                                   InvalidKeyException,
                                                   ServerException,
                                                   XmlParserException,
                                                   ErrorResponseException,
                                                   InternalException,
                                                   InvalidResponseException

Deprecated.

Do CompleteMultipartUpload S3 API.

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; parts - List of parts.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

completeMultipartUpload

protected ObjectWriteResponse completeMultipartUpload(String bucketName,
                                                      String region,
                                                      String objectName,
                                                      String uploadId,
                                                      Part[] parts,
                                                      com.google.common.collect.Multimap<String,String> extraHeaders,
                                                      com.google.common.collect.Multimap<String,String> extraQueryParams)
                                               throws InvalidBucketNameException,
                                                      IllegalArgumentException,
                                                      NoSuchAlgorithmException,
                                                      InsufficientDataException,
                                                      IOException,
                                                      InvalidKeyException,
                                                      ServerException,
                                                      XmlParserException,
                                                      ErrorResponseException,
                                                      InternalException,
                                                      InvalidResponseException

Do CompleteMultipartUpload S3 API.

Parameters:: bucketName - Name of the bucket.; region - Region of the bucket.; objectName - Object name in the bucket.; uploadId - Upload ID.; parts - List of parts.; extraHeaders - Extra headers.; extraQueryParams - Extra query parameters.
Returns:: ObjectWriteResponse object.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

createMultipartUpload

@Deprecated
protected String createMultipartUpload(String bucketName,
                                                   String objectName,
                                                   Map<String,String> headerMap)
                                            throws InvalidBucketNameException,
                                                   IllegalArgumentException,
                                                   NoSuchAlgorithmException,
                                                   InsufficientDataException,
                                                   IOException,
                                                   InvalidKeyException,
                                                   ServerException,
                                                   XmlParserException,
                                                   ErrorResponseException,
                                                   InternalException,
                                                   InvalidResponseException

Deprecated.

Do CreateMultipartUpload S3 API.

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; headerMap - Additional headers.
Returns:: String - Contains upload ID.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

createMultipartUpload

protected String createMultipartUpload(String bucketName,
                                       String region,
                                       String objectName,
                                       com.google.common.collect.Multimap<String,String> headers,
                                       com.google.common.collect.Multimap<String,String> extraQueryParams)
                                throws InvalidBucketNameException,
                                       IllegalArgumentException,
                                       NoSuchAlgorithmException,
                                       InsufficientDataException,
                                       IOException,
                                       InvalidKeyException,
                                       ServerException,
                                       XmlParserException,
                                       ErrorResponseException,
                                       InternalException,
                                       InvalidResponseException

Do CreateMultipartUpload S3 API.

Parameters:: bucketName - Name of the bucket.; region - Region name of buckets in S3 service.; objectName - Object name in the bucket.; headers - Request headers.
Returns:: String - Contains upload ID.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

deleteObjects

protected DeleteResult deleteObjects(String bucketName,
                                     List<DeleteObject> objectList,
                                     boolean quiet,
                                     boolean bypassGovernanceMode)
                              throws InvalidBucketNameException,
                                     NoSuchAlgorithmException,
                                     InsufficientDataException,
                                     IOException,
                                     InvalidKeyException,
                                     ServerException,
                                     XmlParserException,
                                     ErrorResponseException,
                                     InternalException,
                                     InvalidResponseException

Do DeleteObjects S3 API.

Parameters:: bucketName - Name of the bucket.; objectList - List of object names.; quiet - Quiet flag.
Returns:: DeleteResult - Contains delete result.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

listObjectsV2

protected ListBucketResultV2 listObjectsV2(String bucketName,
                                           String region,
                                           String delimiter,
                                           boolean useUrlEncodingType,
                                           String startAfter,
                                           int maxKeys,
                                           String prefix,
                                           String continuationToken,
                                           boolean fetchOwner,
                                           boolean includeUserMetadata,
                                           com.google.common.collect.Multimap<String,String> extraHeaders,
                                           com.google.common.collect.Multimap<String,String> extraQueryParams)
                                    throws InvalidKeyException,
                                           InvalidBucketNameException,
                                           IllegalArgumentException,
                                           NoSuchAlgorithmException,
                                           InsufficientDataException,
                                           ServerException,
                                           XmlParserException,
                                           ErrorResponseException,
                                           InternalException,
                                           InvalidResponseException,
                                           IOException

Throws:: InvalidKeyException; InvalidBucketNameException; IllegalArgumentException; NoSuchAlgorithmException; InsufficientDataException; ServerException; XmlParserException; ErrorResponseException; InternalException; InvalidResponseException; IOException

listObjectsV1

protected ListBucketResultV1 listObjectsV1(String bucketName,
                                           String region,
                                           String delimiter,
                                           boolean useUrlEncodingType,
                                           String marker,
                                           int maxKeys,
                                           String prefix,
                                           com.google.common.collect.Multimap<String,String> extraHeaders,
                                           com.google.common.collect.Multimap<String,String> extraQueryParams)
                                    throws InvalidBucketNameException,
                                           IllegalArgumentException,
                                           NoSuchAlgorithmException,
                                           InsufficientDataException,
                                           IOException,
                                           InvalidKeyException,
                                           ServerException,
                                           XmlParserException,
                                           ErrorResponseException,
                                           InternalException,
                                           InvalidResponseException

Throws:: InvalidBucketNameException; IllegalArgumentException; NoSuchAlgorithmException; InsufficientDataException; IOException; InvalidKeyException; ServerException; XmlParserException; ErrorResponseException; InternalException; InvalidResponseException

listObjectVersions

protected ListVersionsResult listObjectVersions(String bucketName,
                                                String region,
                                                String delimiter,
                                                boolean useUrlEncodingType,
                                                String keyMarker,
                                                int maxKeys,
                                                String prefix,
                                                String versionIdMarker,
                                                com.google.common.collect.Multimap<String,String> extraHeaders,
                                                com.google.common.collect.Multimap<String,String> extraQueryParams)
                                         throws InvalidBucketNameException,
                                                IllegalArgumentException,
                                                NoSuchAlgorithmException,
                                                InsufficientDataException,
                                                IOException,
                                                InvalidKeyException,
                                                ServerException,
                                                XmlParserException,
                                                ErrorResponseException,
                                                InternalException,
                                                InvalidResponseException

Throws:: InvalidBucketNameException; IllegalArgumentException; NoSuchAlgorithmException; InsufficientDataException; IOException; InvalidKeyException; ServerException; XmlParserException; ErrorResponseException; InternalException; InvalidResponseException

putObject

@Deprecated
protected String putObject(String bucketName,
                                       String objectName,
                                       Object data,
                                       int length,
                                       Map<String,String> headerMap)
                                throws InvalidBucketNameException,
                                       IllegalArgumentException,
                                       NoSuchAlgorithmException,
                                       InsufficientDataException,
                                       IOException,
                                       InvalidKeyException,
                                       ServerException,
                                       XmlParserException,
                                       ErrorResponseException,
                                       InternalException,
                                       InvalidResponseException

Deprecated.

Do PutObject S3 API.

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; data - Object data must be BufferedInputStream, RandomAccessFile, byte[] or String.; length - Length of object data.; headerMap - Additional headers.
Returns:: String - Contains ETag.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

protected ObjectWriteResponse putObject(String bucketName,
                                        String region,
                                        String objectName,
                                        Object data,
                                        int length,
                                        com.google.common.collect.Multimap<String,String> headers,
                                        com.google.common.collect.Multimap<String,String> extraQueryParams)
                                 throws InvalidBucketNameException,
                                        IllegalArgumentException,
                                        NoSuchAlgorithmException,
                                        InsufficientDataException,
                                        IOException,
                                        InvalidKeyException,
                                        ServerException,
                                        XmlParserException,
                                        ErrorResponseException,
                                        InternalException,
                                        InvalidResponseException

Do PutObject S3 API.

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; data - Object data must be BufferedInputStream, RandomAccessFile, byte[] or String.; length - Length of object data.; headers - Additional headers.; extraQueryParams - Additional query parameters if any.
Returns:: ObjectWriteResponse object.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

listMultipartUploads

protected ListMultipartUploadsResult listMultipartUploads(String bucketName,
                                                          String delimiter,
                                                          String keyMarker,
                                                          Integer maxUploads,
                                                          String prefix,
                                                          String uploadIdMarker)
                                                   throws InvalidBucketNameException,
                                                          IllegalArgumentException,
                                                          NoSuchAlgorithmException,
                                                          InsufficientDataException,
                                                          IOException,
                                                          InvalidKeyException,
                                                          ServerException,
                                                          XmlParserException,
                                                          ErrorResponseException,
                                                          InternalException,
                                                          InvalidResponseException

Do ListMultipartUploads S3 API.

Parameters:: bucketName - Name of the bucket.; delimiter - Delimiter.; keyMarker - Key marker.; maxUploads - Maximum upload information to fetch.; prefix - Prefix.; uploadIdMarker - Upload ID marker.
Returns:: ListMultipartUploadsResult - Contains uploads information.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

listParts

protected ListPartsResult listParts(String bucketName,
                                    String objectName,
                                    Integer maxParts,
                                    Integer partNumberMarker,
                                    String uploadId)
                             throws InvalidBucketNameException,
                                    IllegalArgumentException,
                                    NoSuchAlgorithmException,
                                    InsufficientDataException,
                                    IOException,
                                    InvalidKeyException,
                                    ServerException,
                                    XmlParserException,
                                    ErrorResponseException,
                                    InternalException,
                                    InvalidResponseException

Do ListParts S3 API.

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; maxParts - Maximum parts information to fetch.; partNumberMarker - Part number marker.; uploadId - Upload ID.
Returns:: ListPartsResult - Contains parts information.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

uploadPart

protected String uploadPart(String bucketName,
                            String objectName,
                            Object data,
                            int length,
                            String uploadId,
                            int partNumber,
                            Map<String,String> headerMap)
                     throws InvalidBucketNameException,
                            IllegalArgumentException,
                            NoSuchAlgorithmException,
                            InsufficientDataException,
                            IOException,
                            InvalidKeyException,
                            ServerException,
                            XmlParserException,
                            ErrorResponseException,
                            InternalException,
                            InvalidResponseException

Do UploadPart S3 API.

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; data - Object data must be BufferedInputStream, RandomAccessFile, byte[] or String.; length - Length of object data.; uploadId - Upload ID.; partNumber - Part number.; headerMap - Additional headers.
Returns:: String - Contains ETag.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

uploadPartCopy

protected String uploadPartCopy(String bucketName,
                                String objectName,
                                String uploadId,
                                int partNumber,
                                com.google.common.collect.Multimap<String,String> headers)
                         throws InvalidBucketNameException,
                                IllegalArgumentException,
                                NoSuchAlgorithmException,
                                InsufficientDataException,
                                IOException,
                                InvalidKeyException,
                                ServerException,
                                XmlParserException,
                                ErrorResponseException,
                                InternalException,
                                InvalidResponseException

Do UploadPartCopy S3 API.

Parameters:: bucketName - Name of the bucket.; objectName - Object name in the bucket.; uploadId - Upload ID.; partNumber - Part number.; headers - Source object definitions.
Returns:: String - Contains ETag.
Throws:: ErrorResponseException - thrown to indicate S3 service returned an error response.; IllegalArgumentException - throws to indicate invalid argument passed.; InsufficientDataException - thrown to indicate not enough data available in InputStream.; InternalException - thrown to indicate internal library error.; InvalidBucketNameException - thrown to indicate invalid bucket name passed.; 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

builder

public static MinioClient.Builder builder()

Class MinioClient

Bucket operations

Object operations

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MinioClient

MinioClient

MinioClient

MinioClient

MinioClient

MinioClient

MinioClient

MinioClient

MinioClient

MinioClient

MinioClient

MinioClient

Method Detail

statObject

statObject

statObject

getObjectUrl

getObject

getObject

getObject

getObject

getObject

getObject

getObject

getObject

downloadObject

copyObject

copyObject

composeObject

composeObject

getPresignedObjectUrl

getPresignedObjectUrl

presignedGetObject

presignedGetObject

presignedGetObject

presignedPutObject

presignedPutObject

presignedPostPolicy

removeObject

removeObject

removeObjects

removeObjects

listObjects

listObjects

listObjects

listObjects

listObjects

listObjects

listBuckets

bucketExists

bucketExists

makeBucket

makeBucket

makeBucket

makeBucket

enableVersioning

enableVersioning

disableVersioning

disableVersioning

isVersioningEnabled

setDefaultRetention

setDefaultRetention

deleteDefaultRetention

getDefaultRetention

getDefaultRetention

setObjectRetention

setObjectRetention

getObjectRetention

getObjectRetention

enableObjectLegalHold

enableObjectLegalHold

disableObjectLegalHold