MinioClient (api 7.0.1 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.

Constructor Summary

Constructors
Constructor and Description
`MinioClient(okhttp3.HttpUrl url)` Creates MinIO client object with given HttpUrl object using anonymous access.
`MinioClient(okhttp3.HttpUrl url, String accessKey, String secretKey)` Creates MinIO client object with given URL object, access key and secret key.
`MinioClient(String endpoint)` Creates MinIO client object with given endpoint using anonymous access.
`MinioClient(String endpoint, int port, String accessKey, String secretKey)` Creates MinIO client object with given endpoint, port, access key and secret key.
`MinioClient(String endpoint, int port, String accessKey, String secretKey, boolean secure)` Creates MinIO client object using given endpoint, port, access key, secret key and secure (TLS) connection.
`MinioClient(String endpoint, int port, String accessKey, String secretKey, String region, boolean secure)` Creates MinIO client object using given endpoint, port, access key, secret key, region and secure (TLS) connection.
`MinioClient(String endpoint, int port, String accessKey, String secretKey, String region, boolean secure, okhttp3.OkHttpClient httpClient)` Creates MinIO client object using given endpoint, port, access key, secret key, region and secure (TLS) connection.
`MinioClient(String endpoint, String accessKey, String secretKey)` Creates MinIO client object with given endpoint, access key and secret key.
`MinioClient(String endpoint, String accessKey, String secretKey, boolean secure)` Creates MinIO client object with given endpoint, access key and secret key using secure (TLS) connection.
`MinioClient(String endpoint, String accessKey, String secretKey, String region)` Creates MinIO client object with given endpoint, access key, secret key and region name.
`MinioClient(URL url)` Creates MinIO client object with given URL object using anonymous access.
`MinioClient(URL url, String accessKey, String secretKey)` Creates MinIO client object with given URL object, access key and secret key.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`bucketExists(String bucketName)` Checks if given bucket exist and is having read access.
`void`	`composeObject(String bucketName, String objectName, List<ComposeSource> sources, Map<String,String> headerMap, ServerSideEncryption sse)` Create an object by concatenating a list of source objects using server-side copying.
`void`	`copyObject(String bucketName, String objectName, Map<String,String> headerMap, ServerSideEncryption sse, String srcBucketName, String srcObjectName, ServerSideEncryption srcSse, CopyConditions copyConditions)` Copy a source object into a new object with the provided name in the provided bucket.
`void`	`deleteBucketLifeCycle(String bucketName)` Delete the LifeCycle of bucket.
`void`	`disableObjectLegalHold(String bucketName, String objectName, String versionId)` Disable object legal hold on an object.
`void`	`disableVersioning(String bucketName)` Disable object versioning in given bucket.
`void`	`enableObjectLegalHold(String bucketName, String objectName, String versionId)` Enables object legal hold on an object.
`void`	`enableVersioning(String bucketName)` Enable object versioning in given bucket.
`String`	`getBucketLifeCycle(String bucketName)` Get bucket life cycle configuration.
`NotificationConfiguration`	`getBucketNotification(String bucketName)` Get bucket notification configuration
`String`	`getBucketPolicy(String bucketName)` Get JSON string of bucket policy of the given bucket.
`ObjectLockConfiguration`	`getDefaultRetention(String bucketName)` Gets default object retention in given bucket.
`InputStream`	`getObject(String bucketName, String objectName)` Gets entire object's data as `InputStream` in given bucket.
`InputStream`	`getObject(String bucketName, String objectName, long offset)` Gets object's data starting from given offset as `InputStream` in the given bucket.
`InputStream`	`getObject(String bucketName, String objectName, long offset, Long length)` Gets object's data of given offset and length as `InputStream` in the given bucket.
`InputStream`	`getObject(String bucketName, String objectName, Long offset, Long length, ServerSideEncryption sse)` Gets object's data of given offset and length as `InputStream` in the given bucket.
`InputStream`	`getObject(String bucketName, String objectName, ServerSideEncryption sse)` Gets entire object's data as `InputStream` in given bucket.
`void`	`getObject(String bucketName, String objectName, ServerSideEncryption sse, String fileName)` Gets encrypted object's data in the given bucket and stores it to given file name.
`void`	`getObject(String bucketName, String objectName, String fileName)` Gets object's data in the given bucket and stores it to given file name.
`Retention`	`getObjectRetention(String bucketName, String objectName, String versionId)` Fetches object retention lock of an object.
`String`	`getObjectUrl(String bucketName, String objectName)` Gets object's URL in given bucket.
`String`	`getPresignedObjectUrl(Method method, String bucketName, String objectName, Integer expires, Map<String,String> reqParams)` Returns a presigned URL string with given HTTP method, expiry time and custom request params for a specific object in the bucket.
`void`	`ignoreCertCheck()` Ignores check on server certificate for HTTPS connection.
`boolean`	`isObjectLegalHoldEnabled(String bucketName, String objectName, String versionId)` Returns true if the object legal hold is enabled.
`List<Bucket>`	`listBuckets()` Returns all bucket information owned by the current user.
`CloseableIterator<Result<NotificationRecords>>`	`listenBucketNotification(String bucketName, String prefix, String suffix, String[] events)` Listen to bucket notifications.
`Iterable<Result<Upload>>`	`listIncompleteUploads(String bucketName)` Lists incomplete uploads of objects in given bucket.
`Iterable<Result<Upload>>`	`listIncompleteUploads(String bucketName, String prefix)` Lists incomplete uploads of objects in given bucket and prefix.
`Iterable<Result<Upload>>`	`listIncompleteUploads(String bucketName, String prefix, boolean recursive)` Lists incomplete uploads of objects in given bucket, prefix and recursive flag.
`Iterable<Result<Item>>`	`listObjects(String bucketName)` Lists object information in given bucket.
`Iterable<Result<Item>>`	`listObjects(String bucketName, String prefix)` Lists object information in given bucket and prefix.
`Iterable<Result<Item>>`	`listObjects(String bucketName, String prefix, boolean recursive)` Lists object information as `Iterable<Result><Item>` in given bucket, prefix and recursive flag.
`Iterable<Result<Item>>`	`listObjects(String bucketName, String prefix, boolean recursive, boolean useVersion1)` Lists object information as `Iterable<Result><Item>` in given bucket, prefix, recursive flag and S3 API version to use.
`Iterable<Result<Item>>`	`listObjects(String bucketName, String prefix, boolean recursive, boolean includeUserMetadata, boolean useVersion1)` Lists object information as `Iterable<Result><Item>` in given bucket, prefix, recursive flag, user metadata flag and S3 API version to use.
`void`	`makeBucket(String bucketName)` Creates a bucket with default region.
`void`	`makeBucket(String bucketName, String region)` Creates a bucket with given region.
`void`	`makeBucket(String bucketName, String region, boolean objectLock)` Creates a bucket with given region and object lock option.
`String`	`presignedGetObject(String bucketName, String objectName)` Returns an presigned URL to download the object in the bucket with default expiry time.
`String`	`presignedGetObject(String bucketName, String objectName, Integer expires)` Returns an presigned URL to download the object in the bucket with given expiry time.
`String`	`presignedGetObject(String bucketName, String objectName, Integer expires, Map<String,String> reqParams)` Returns an presigned URL to download the object in the bucket with given expiry time with custom request params.
`Map<String,String>`	`presignedPostPolicy(PostPolicy policy)` Returns string map for given `PostPolicy` to upload object with various post policy conditions.
`String`	`presignedPutObject(String bucketName, String objectName)` Returns a presigned URL to upload an object in the bucket with default expiry time.
`String`	`presignedPutObject(String bucketName, String objectName, Integer expires)` Returns a presigned URL to upload an object in the bucket with given expiry time.
`void`	`putObject(String bucketName, String objectName, InputStream stream, PutObjectOptions options)` Uploads data from given stream as object to given bucket using given PutObjectOptions.
`void`	`putObject(String bucketName, String objectName, String filename, PutObjectOptions options)` Uploads data from given file as object to given bucket using given PutObjectOptions.
`void`	`removeAllBucketNotification(String bucketName)` Remove all bucket notification.
`void`	`removeBucket(String bucketName)` Removes an empty bucket.
`void`	`removeIncompleteUpload(String bucketName, String objectName)` Removes incomplete multipart upload of given object.
`void`	`removeObject(String bucketName, String objectName)` Removes an object from a bucket.
`Iterable<Result<DeleteError>>`	`removeObjects(String bucketName, Iterable<String> objectNames)` Removes multiple objects from a bucket.
`SelectResponseStream`	`selectObjectContent(String bucketName, String objectName, String sqlExpression, InputSerialization is, OutputSerialization os, boolean requestProgress, Long scanStartRange, Long scanEndRange, ServerSideEncryption sse)` Select object content using SQL expression.
`void`	`setAppInfo(String name, String version)` Sets application's name/version to user agent.
`void`	`setBucketLifeCycle(String bucketName, String lifeCycle)` Set XML string of LifeCycle on a given bucket.
`void`	`setBucketNotification(String bucketName, NotificationConfiguration notificationConfiguration)` Set bucket notification configuration
`void`	`setBucketPolicy(String bucketName, String policy)` Set JSON string of policy on given bucket.
`void`	`setDefaultRetention(String bucketName, ObjectLockConfiguration config)` Sets default object retention in given bucket.
`void`	`setObjectRetention(String bucketName, String objectName, String versionId, Retention config, boolean bypassGovernanceRetention)` Applies object retention lock onto an object.
`void`	`setTimeout(long connectTimeout, long writeTimeout, long readTimeout)` Sets HTTP connect, write and read timeouts.
`ObjectStat`	`statObject(String bucketName, String objectName)` Returns meta data information of given object in given bucket.
`ObjectStat`	`statObject(String bucketName, String objectName, ServerSideEncryption sse)` Returns meta data information of given object in given bucket.
`void`	`traceOff()` Disables HTTP call tracing previously enabled.
`void`	`traceOn(OutputStream traceStream)` Enables HTTP call tracing and written to traceStream.

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

Constructor Detail
- MinioClient
```
public MinioClient(String endpoint)
            throws InvalidEndpointException,
                   InvalidPortException
```
  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:
  
  InvalidEndpointException
  
  InvalidPortException
  
  See Also:
  
  MinioClient(URL url), MinioClient(String endpoint, String accessKey, String secretKey), MinioClient(String endpoint, String accessKey, String secretKey, String region), MinioClient(URL url, String accessKey, String secretKey), 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, int port, String accessKey, String secretKey, String region, boolean secure, OkHttpClient httpClient)
- MinioClient
```
public MinioClient(URL url)
            throws InvalidEndpointException,
                   InvalidPortException
```
  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:
  
  InvalidEndpointException
  
  InvalidPortException
  
  See Also:
  
  MinioClient(String endpoint), MinioClient(String endpoint, String accessKey, String secretKey), MinioClient(String endpoint, String accessKey, String secretKey, String region), MinioClient(URL url, String accessKey, String secretKey), 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, int port, String accessKey, String secretKey, String region, boolean secure, OkHttpClient httpClient)
- MinioClient
```
public MinioClient(okhttp3.HttpUrl url)
            throws InvalidEndpointException,
                   InvalidPortException
```
  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:
  
  InvalidEndpointException
  
  InvalidPortException
  
  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(URL url, String accessKey, String secretKey), 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, int port, String accessKey, String secretKey, String region, boolean secure, OkHttpClient httpClient)
- MinioClient
```
public MinioClient(String endpoint,
                   String accessKey,
                   String secretKey)
            throws InvalidEndpointException,
                   InvalidPortException
```
  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:
  
  InvalidEndpointException
  
  InvalidPortException
  
  See Also:
  
  MinioClient(String endpoint), MinioClient(URL url), MinioClient(URL url, String accessKey, String secretKey), 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, int port, String accessKey, String secretKey, String region, boolean secure, OkHttpClient httpClient)
- MinioClient
```
public MinioClient(String endpoint,
                   String accessKey,
                   String secretKey,
                   String region)
            throws InvalidEndpointException,
                   InvalidPortException
```
  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:
  
  InvalidEndpointException
  
  InvalidPortException
  
  See Also:
  
  MinioClient(String endpoint), MinioClient(URL url), MinioClient(URL url, String accessKey, String secretKey), 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, int port, String accessKey, String secretKey, String region, boolean secure, OkHttpClient httpClient)
- MinioClient
```
public MinioClient(URL url,
                   String accessKey,
                   String secretKey)
            throws InvalidEndpointException,
                   InvalidPortException
```
  Creates MinIO client object with given URL object, access key and secret key.
  Example:
```
 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:
  
  InvalidEndpointException
  
  InvalidPortException
  
  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, int port, String accessKey, String secretKey, String region, boolean secure, OkHttpClient httpClient)
- MinioClient
```
public MinioClient(okhttp3.HttpUrl url,
                   String accessKey,
                   String secretKey)
            throws InvalidEndpointException,
                   InvalidPortException
```
  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:
  
  InvalidEndpointException
  
  InvalidPortException
  
  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(URL url, String accessKey, String secretKey), 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, int port, String accessKey, String secretKey, String region, boolean secure, OkHttpClient httpClient)
- MinioClient
```
public MinioClient(String endpoint,
                   int port,
                   String accessKey,
                   String secretKey)
            throws InvalidEndpointException,
                   InvalidPortException
```
  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:
  
  InvalidEndpointException
  
  InvalidPortException
  
  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(URL url, 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, int port, String accessKey, String secretKey, String region, boolean secure, OkHttpClient httpClient)
- MinioClient
```
public MinioClient(String endpoint,
                   String accessKey,
                   String secretKey,
                   boolean secure)
            throws InvalidEndpointException,
                   InvalidPortException
```
  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:
  
  InvalidEndpointException
  
  InvalidPortException
  
  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(URL url, String accessKey, String secretKey), MinioClient(String endpoint, int port, String accessKey, String secretKey), 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, int port, String accessKey, String secretKey, String region, boolean secure, OkHttpClient httpClient)
- MinioClient
```
public MinioClient(String endpoint,
                   int port,
                   String accessKey,
                   String secretKey,
                   boolean secure)
            throws InvalidEndpointException,
                   InvalidPortException
```
  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:
  
  InvalidEndpointException
  
  InvalidPortException
  
  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(URL url, String accessKey, String secretKey), 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, String region, boolean secure), MinioClient(String endpoint, int port, String accessKey, String secretKey, String region, boolean secure, OkHttpClient httpClient)
- MinioClient
```
public MinioClient(String endpoint,
                   int port,
                   String accessKey,
                   String secretKey,
                   String region,
                   boolean secure)
            throws InvalidEndpointException,
                   InvalidPortException
```
  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:
  
  InvalidEndpointException
  
  InvalidPortException
  
  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(URL url, String accessKey, String secretKey), 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, String region, boolean secure, OkHttpClient httpClient)
- MinioClient
```
public MinioClient(String endpoint,
                   int port,
                   String accessKey,
                   String secretKey,
                   String region,
                   boolean secure,
                   okhttp3.OkHttpClient httpClient)
            throws InvalidEndpointException,
                   InvalidPortException
```
  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. 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.
  
  httpClient - Customized HTTP client object.
  
  Throws:
  
  InvalidEndpointException
  
  InvalidPortException
  
  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(URL url, String accessKey, String secretKey), 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, String region, boolean secure)

Method Detail

statObject

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

Returns meta data information of given object in given bucket.

Example:

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

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.
Returns:: Populated object meta data.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException
See Also:: ObjectStat

statObject

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

Returns meta data information of given object in given bucket.

Example:

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

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.; sse - SSE-C type of server-side encryption.
Returns:: Populated object meta data.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; IllegalArgumentException - upon invalid value is passed to a method.; InvalidResponseException - upon a non-xml response from server
See Also:: ObjectStat

getObjectUrl

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

Gets object's URL in given bucket. The URL is ONLY useful to retrieve the object's data if the object has public read permissions.

Example:

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

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.
Returns:: string contains URL to download the object.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

getObject

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

Gets entire object's data as InputStream in given bucket. The InputStream must be closed after use else the connection will remain open.

Example:

 InputStream stream = minioClient.getObject("my-bucketname", "my-objectname");

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.
Returns:: InputStream containing the object data.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; IllegalArgumentException - upon invalid value is passed to a method.; InvalidResponseException - upon a non-xml response from server

getObject

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

Gets entire object's data as InputStream in given bucket. The InputStream must be closed after use else the connection will remain open.

Example:

 InputStream stream = minioClient.getObject("my-bucketname", "my-objectname", sse);

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.; sse - Encryption metadata only required for SSE-C.
Returns:: InputStream containing the object data.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; IllegalArgumentException - upon invalid value is passed to a method.; InvalidResponseException - upon a non-xml response from server

getObject

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

Gets object's data starting from given offset as InputStream in the given bucket. The InputStream must be closed after use else the connection will remain open.

Example:

  InputStream stream = minioClient.getObject("my-bucketname", "my-objectname", 1024L);

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.; offset - Offset to read at.
Returns:: InputStream containing the object's data.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; IllegalArgumentException - upon invalid value is passed to a method.; InvalidResponseException - upon a non-xml response from server

getObject

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

Gets object's data of given offset and length as InputStream in the given bucket. The InputStream must be closed after use else the connection will remain open.

Example:

  InputStream stream = minioClient.getObject("my-bucketname", "my-objectname", 1024L, 4096L);

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.; offset - Offset to read at.; length - Length to read.
Returns:: InputStream containing the object's data.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; IllegalArgumentException - upon invalid value is passed to a method.; InvalidResponseException - upon a non-xml response from server

getObject

public InputStream getObject(String bucketName,
                             String objectName,
                             Long offset,
                             Long length,
                             ServerSideEncryption sse)
                      throws InvalidBucketNameException,
                             NoSuchAlgorithmException,
                             InsufficientDataException,
                             IOException,
                             InvalidKeyException,
                             XmlParserException,
                             ErrorResponseException,
                             InternalException,
                             IllegalArgumentException,
                             InvalidResponseException

Gets object's data of given offset and length as InputStream in the given bucket. The InputStream must be closed after use else the connection will remain open.

Example:

  InputStream stream = minioClient.getObject("my-bucketname", "my-objectname", 1024L, 4096L, sse);

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.; offset - Offset to read at.; length - Length to read.; sse - Server side encryption.
Returns:: InputStream containing the object's data.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; IllegalArgumentException - upon invalid value is passed to a method.; InvalidResponseException - upon a non-xml response from server

getObject

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

Gets object's data in the given bucket and stores it to given file name.

Example:

 minioClient.getObject("my-bucketname", "my-objectname", "photo.jpg");

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.; fileName - file name.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; IllegalArgumentException - upon invalid value is passed to a method.; InvalidResponseException - upon a non-xml response from server

getObject

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

Gets encrypted object's data in the given bucket and stores it to given file name.

Example:

 minioClient.getObject("my-bucketname", "my-objectname", sse, "photo.jpg");

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.; sse - encryption metadata.; fileName - file name to download into.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; IllegalArgumentException - upon invalid value is passed to a method.; InvalidResponseException - upon a non-xml response from server

copyObject

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

Copy a source object into a new object with the provided name in the provided bucket. optionally can take a key value CopyConditions and server side encryption as well for conditionally attempting copyObject.

Example:

  minioClient.copyObject("my-bucketname", "my-objectname", headers, sse, "my-srcbucketname","my-srcobjname", srcSse, copyConditions);

Parameters:: bucketName - Destination bucket name.; objectName - Destination object name.; headerMap - Destination object custom metadata.; sse - Server side encryption of destination object.; srcBucketName - Source bucket name.; srcObjectName - Source object name.; srcSse - Server side encryption of source object.; copyConditions - CopyConditions object with collection of supported CopyObject conditions.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; IllegalArgumentException - upon invalid value is passed to a method.; InvalidResponseException - upon a non-xml response from server

composeObject

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

Create an object by concatenating a list of source objects using server-side copying.

Example:

  minioClient.composeObject("my-bucketname", "my-objectname", composeSources, 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:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; IllegalArgumentException - upon invalid value is passed to a method.; InvalidResponseException - upon a non-xml response from server

getPresignedObjectUrl

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

Returns a presigned URL string with given HTTP method, expiry time and custom request params for a specific object in the bucket.

Example:

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

Parameters:: method - HTTP Method.; bucketName - Bucket name.; objectName - Object name in the bucket.; expires - Expiration time in seconds of presigned URL.; reqParams - Override values for set of response headers. Currently supported request parameters are [response-expires, response-content-type, response-cache-control, response-content-disposition]
Returns:: string contains URL to download the object.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidExpiresRangeException - upon input expires is out of range; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

presignedGetObject

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

Returns an presigned URL to download the object in the bucket with given expiry time with custom request params.

Example:

  String url = minioClient.presignedGetObject("my-bucketname", "my-objectname", 60 * 60 * 24, reqParams);

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.; expires - Expiration time in seconds of presigned URL.; reqParams - Override values for set of response headers. Currently supported request parameters are [response-expires, response-content-type, response-cache-control, response-content-disposition]
Returns:: string contains URL to download the object.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidExpiresRangeException - upon input expires is out of range; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

presignedGetObject

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

Returns an presigned URL to download the object in the bucket with given expiry time.

Example:

  String url = minioClient.presignedGetObject("my-bucketname", "my-objectname", 60 * 60 * 24);

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.; expires - Expiration time in seconds of presigned URL.
Returns:: string contains URL to download the object.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidExpiresRangeException - upon input expires is out of range; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

presignedGetObject

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

Returns an presigned URL to download the object in the bucket with default expiry time. Default expiry time is 7 days in seconds.

Example:

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

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.
Returns:: string contains URL to download the object
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidExpiresRangeException - upon input expires is out of range; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

presignedPutObject

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

Returns a presigned URL to upload an object in the bucket with given expiry time.

Example:

  String url = minioClient.presignedPutObject("my-bucketname", "my-objectname", 60 * 60 * 24);

Parameters:: bucketName - Bucket name; objectName - Object name in the bucket; expires - Expiration time in seconds to presigned URL.
Returns:: string contains URL to upload the object.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidExpiresRangeException - upon input expires is out of range; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

presignedPutObject

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

Returns a presigned URL to upload an object in the bucket with default expiry time. Default expiry time is 7 days in seconds.

Example:

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

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.
Returns:: string contains URL to upload the object.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidExpiresRangeException - upon input expires is out of range; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

presignedPostPolicy

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

Returns string map for given PostPolicy to upload object with various post policy conditions.

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 of strings to construct form-data.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; IllegalArgumentException - upon invalid value is passed to a method.; InvalidResponseException - upon a non-xml response from server
See Also:: PostPolicy

removeObject

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

Removes an object from a bucket.

Example:

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

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; IllegalArgumentException - upon invalid value is passed to a method.; InvalidResponseException - upon a non-xml response from server

removeObjects

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

Removes multiple objects from a bucket. As objects removal are lazily executed, its required to iterate the returned Iterable.

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 - Bucket name.; objectNames - List of Object names in the bucket.
Returns:: (lazy) Iterable of the Result DeleteErrors.

listObjects

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

Lists object information in given 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 - Bucket name.
Returns:: an iterator of Result Items.
Throws:: XmlParserException - upon parsing response xml

listObjects

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

Lists object information in given bucket and 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 - Bucket name.; prefix - Prefix string. List objects whose name starts with `prefix`.
Returns:: an iterator of Result Items.
Throws:: XmlParserException - upon parsing response xml

listObjects
```
public Iterable<Result<Item>> listObjects(String bucketName,
                                          String prefix,
                                          boolean recursive)
```
Lists object information as Iterable<Result><Item> in given bucket, prefix and recursive flag.
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 - Bucket name.

prefix - Prefix string. List objects whose name starts with `prefix`.

recursive - when false, emulates a directory structure where each listing returned is either a full object or part of the object's key up to the first '/'. All objects wit the same prefix up to the first '/' will be merged into one entry.

Returns:

an iterator of Result Items.

See Also:

listObjects(String bucketName), listObjects(String bucketName, String prefix), listObjects(String bucketName, String prefix, boolean recursive, boolean useVersion1)

listObjects
```
public Iterable<Result<Item>> listObjects(String bucketName,
                                          String prefix,
                                          boolean recursive,
                                          boolean useVersion1)
```
Lists object information as Iterable<Result><Item> in given bucket, prefix, recursive flag and S3 API version to use.
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 - Bucket name.

prefix - Prefix string. List objects whose name starts with `prefix`.

recursive - when false, emulates a directory structure where each listing returned is either a full object or part of the object's key up to the first '/'. All objects wit the same prefix up to the first '/' will be merged into one entry.

useVersion1 - If set, Amazon AWS S3 List Object V1 is used, else List Object V2 is used as default.

Returns:

an iterator of Result Items.

See Also:

listObjects(String bucketName), listObjects(String bucketName, String prefix), listObjects(String bucketName, String prefix, boolean recursive)

listObjects
```
public Iterable<Result<Item>> listObjects(String bucketName,
                                          String prefix,
                                          boolean recursive,
                                          boolean includeUserMetadata,
                                          boolean useVersion1)
```
Lists object information as Iterable<Result><Item> in given bucket, prefix, recursive flag, user metadata flag and S3 API version to use.
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 - Bucket name.

prefix - Prefix string. List objects whose name starts with `prefix`.

recursive - when false, emulates a directory structure where each listing returned is either a full object or part of the object's key up to the first '/'. All objects wit the same prefix up to the first '/' will be merged into one entry.

includeUserMetadata - include user metadata of each object. This is MinIO specific extension to ListObjectsV2.

useVersion1 - If set, Amazon AWS S3 List Object V1 is used, else List Object V2 is used as default.

Returns:

an iterator of Result Items.

See Also:

listObjects(String bucketName), listObjects(String bucketName, String prefix), listObjects(String bucketName, String prefix, boolean recursive)

listBuckets

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

Returns all bucket information owned by the current user.

Example:

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

Returns:: List of bucket type.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

bucketExists

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

Checks if given bucket exist and is having read access.

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 - Bucket name.
Returns:: True if the bucket exists and the user has at least read access.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

makeBucket

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

Creates a bucket with default region.

Example:

 boolean found = minioClient.makeBucket("my-bucketname");

Parameters:: bucketName - Bucket name.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; RegionConflictException - upon passed region conflicts with the one previously specified; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution.; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InsufficientDataException - upon getting EOFException while reading given; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

makeBucket

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

Creates a bucket with given region.

Example:

 boolean found = minioClient.makeBucket("my-bucketname", "eu-west-1");

Parameters:: bucketName - Bucket name.; region - region in which the bucket will be created.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; RegionConflictException - upon passed region conflicts with the one previously specified.; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InsufficientDataException - upon getting EOFException while reading given; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

makeBucket

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

Creates a bucket with given region and object lock option.

Example:

 boolean found = minioClient.makeBucket("my-bucketname", "eu-west-2", true);

Parameters:: bucketName - Bucket name.; region - region in which the bucket will be created.; objectLock - enable object lock support.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; RegionConflictException - upon passed region conflicts with the one previously specified.; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InsufficientDataException - upon getting EOFException while reading given; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

enableVersioning

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

Enable object versioning in given bucket.

Example:

 minioClient.enableVersioning("my-bucketname");

Parameters:: bucketName - Bucket name.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InsufficientDataException - upon getting EOFException while reading given; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

disableVersioning

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

Disable object versioning in given bucket.

Example:

 minioClient.disableVersioning("my-bucketname");

Parameters:: bucketName - Bucket name.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InsufficientDataException - upon getting EOFException while reading given; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

setDefaultRetention

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

Sets default object retention in given bucket.

Example:

 minioClient.setDefaultRetention("my-bucketname", config);

Parameters:: bucketName - Bucket name.; config - Object lock configuration.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

getDefaultRetention

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

Gets default object retention in given bucket.

Example:

  ObjectLockConfiguration config = minioClient.getDefaultRetention("my-bucketname");

Parameters:: bucketName - Bucket name.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

setObjectRetention

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

Applies object retention lock onto an object.

Example:

 minioClient.setObjectRetention("my-bucketname", "my-object", null, config, true);

Parameters:: bucketName - Bucket name.; objectName - Object name.; versionId - Object versio id.; config - Object lock configuration.; bypassGovernanceRetention - By pass governance retention.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException - upon invalid value is passed to a method.

getObjectRetention

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

Fetches object retention lock of an object.

Example:

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

Parameters:: bucketName - Bucket name.; objectName - Object name.; versionId - Version Id.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

enableObjectLegalHold

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

Enables object legal hold on an object.

Example:

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

Parameters:: bucketName - Bucket name.; objectName - Object name.; versionId - Object version id.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

disableObjectLegalHold

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

Disable object legal hold on an object.

Example:

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

Parameters:: bucketName - Bucket name.; objectName - Object name.; versionId - Object version id.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

isObjectLegalHoldEnabled

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

Returns true if the object legal hold is enabled.

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 - Bucket name.; objectName - Object name.; versionId - Object version id.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

removeBucket

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

Removes an empty bucket.

Example:

 minioClient.removeBucket("my-bucketname");

Parameters:: bucketName - Bucket name.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; IllegalArgumentException - upon invalid value is passed to a method.; InsufficientDataException - upon getting EOFException while reading given; InvalidResponseException - upon a non-xml response from server

putObject

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

Uploads data from given file as object to given bucket using given PutObjectOptions. If any error occurs, partial uploads are aborted.

Example:

  PutObjectOptions options = new PutObjectOptions(7003256, -1);
 minioClient.putObject("my-bucketname", "my-objectname", "trip.mp4", options);

Parameters:: bucketName - Bucket name.; objectName - Object name to create in the bucket.; filename - Name of file to upload.; options - Options to be used during object upload.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; IllegalArgumentException - upon invalid value is passed to a method.; InvalidResponseException - upon a non-xml response from server

putObject

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

Uploads data from given stream as object to given bucket using given PutObjectOptions. If any error occurs, partial uploads are aborted.

Example:

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

Parameters:: bucketName - Bucket name.; objectName - Object name to create in the bucket.; stream - Stream to upload.; options - Options to be used during object upload.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; IllegalArgumentException - upon invalid value is passed to a method.; InvalidResponseException - upon a non-xml response from server

getBucketPolicy

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

Get JSON string of bucket policy of the given bucket.

Example:

 String config = minioClient.getBucketPolicy("my-bucketname");
 System.out.println("Bucket policy: " + config);

Parameters:: bucketName - the name of the bucket for which policies are to be listed.
Returns:: bucket policy JSON string.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; BucketPolicyTooLargeException - upon bucket policy too large in size; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

setBucketPolicy

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

Set JSON string of policy on given 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 - Bucket name.; policy - Bucket policy JSON string.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

setBucketLifeCycle

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

Set XML string of LifeCycle on a given bucket. Delete the lifecycle of bucket in case a null is passed as lifeCycle.

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 - Bucket name.; lifeCycle - Bucket policy XML string.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; IllegalArgumentException - upon invalid value is passed to a method.; InvalidResponseException - upon a non-xml response from server

deleteBucketLifeCycle

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

Delete the LifeCycle of bucket.

Example:

 deleteBucketLifeCycle("my-bucketname");

Parameters:: bucketName - Bucket name.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

getBucketLifeCycle

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

Get bucket life cycle configuration.

Example:

 String lifecycle = minioClient.getBucketLifecycle("my-bucketname");
 System.out.println("Life cycle settings: " + lifecycle);

Parameters:: bucketName - Bucket name.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

getBucketNotification

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

Get bucket notification configuration

Example:

  NotificationConfiguration config = minioClient.getBucketNotification("my-bucketname");
 System.out.println(config);

Parameters:: bucketName - Bucket name.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

setBucketNotification

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

Set bucket notification configuration

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 - Bucket name.; notificationConfiguration - Notification configuration to be set.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

removeAllBucketNotification

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

Remove all bucket notification.

Example:

 minioClient.removeAllBucketNotification("my-bucketname");

Parameters:: bucketName - Bucket name.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

listIncompleteUploads

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

Lists incomplete uploads of objects in given 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 - Bucket name.
Returns:: an iterator of Upload.
Throws:: XmlParserException
See Also:: listIncompleteUploads(String, String, boolean)

listIncompleteUploads

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

Lists incomplete uploads of objects in given bucket and 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 - Bucket name.; prefix - filters the list of uploads to include only those that start with prefix.
Returns:: an iterator of Upload.
Throws:: XmlParserException - upon parsing response xml
See Also:: listIncompleteUploads(String, String, boolean)

listIncompleteUploads
```
public Iterable<Result<Upload>> listIncompleteUploads(String bucketName,
                                                      String prefix,
                                                      boolean recursive)
```
Lists incomplete uploads of objects in given bucket, prefix and recursive flag.
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 - Bucket name.

prefix - Prefix string. List objects whose name starts with `prefix`.

recursive - when false, emulates a directory structure where each listing returned is either a full object or part of the object's key up to the first '/'. All uploads with the same prefix up to the first '/' will be merged into one entry.

Returns:

an iterator of Upload.

See Also:

listIncompleteUploads(String bucketName), listIncompleteUploads(String bucketName, String prefix)

removeIncompleteUpload

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

Removes incomplete multipart upload of given object.

Example:

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

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server; IllegalArgumentException

listenBucketNotification

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

Listen to bucket notifications. As bucket notification are lazily executed, its required to iterate. The returned closeable iterator must be used with try with resource; else the stream will not be closed.

Example:

 String[] events = {"s3:ObjectCreated:*", "s3:ObjectAccessed:*"};
 try (CloseableIterator<Result<NotificationInfo>> ci =
     minioClient.listenBucketNotification("bcketName", "", "", 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 - Bucket name.; prefix - Prefix of concerned objects events.; suffix - Suffix of concerned objects events.; events - List of events to watch.
Returns:: (lazy) CloseableIterator of event records.
Throws:: IOException; InvalidKeyException; NoSuchAlgorithmException; InsufficientDataException; InvalidResponseException; InternalException; InvalidBucketNameException; XmlParserException; ErrorResponseException

selectObjectContent

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

Select object content using 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 - Bucket name.; objectName - Object name.; sqlExpression - SQL expression.; is - Input serialization.; os - Output serialization.; requestProgress - Request progress in response.; scanStartRange - scan start range.; scanEndRange - scan end range.; sse - Server side encryption.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; IllegalArgumentException - upon empty object name is given; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InsufficientDataException - upon getting EOFException while reading given InputStream even before reading given length; IOException - upon connection error; InvalidKeyException - upon an invalid access key or secret key; XmlParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidResponseException - upon a non-xml response from server

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 NoSuchAlgorithmException,
                            KeyManagementException

Ignores check on server certificate for HTTPS connection.

Example:

 minioClient.ignoreCertCheck();

Throws:: NoSuchAlgorithmException; KeyManagementException

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)

Class MinioClient

Bucket operations

Object operations

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

getObjectUrl

getObject

getObject

getObject

getObject

getObject

getObject

getObject

copyObject

composeObject

getPresignedObjectUrl

presignedGetObject

presignedGetObject

presignedGetObject

presignedPutObject

presignedPutObject

presignedPostPolicy

removeObject

removeObjects

listObjects

listObjects

listObjects

listObjects

listObjects

listBuckets

bucketExists

makeBucket

makeBucket

makeBucket

enableVersioning

disableVersioning

setDefaultRetention

getDefaultRetention

setObjectRetention

getObjectRetention

enableObjectLegalHold

disableObjectLegalHold

isObjectLegalHoldEnabled

removeBucket

putObject

putObject

getBucketPolicy

setBucketPolicy

setBucketLifeCycle

deleteBucketLifeCycle

getBucketLifeCycle

getBucketNotification

setBucketNotification

removeAllBucketNotification

listIncompleteUploads

listIncompleteUploads

listIncompleteUploads

removeIncompleteUpload

listenBucketNotification

selectObjectContent

setTimeout

ignoreCertCheck

setAppInfo